RW Telecom 2.0
by RealWave

RW Telecom 2.0

Realwave Telecom 2.0
Documentation
HTTP Request Methods

The requests must be made using the HTTPS protocol so traffic is encrypted.

HTTP methods availables at API Telecom v2:

Method Action
GET Search Data
POST Save Data
PUT Change Data
PATCH Partial Change Data
DELETE Delete Data
HTTP Status Codes
Status Description
200 OK The request has succeeded
201 Created The request has been fulfilled and resulted in a new resource being created
304 Not Modified If the client has performed a conditional GET request and access is allowed, but the document has not been modified
400 Bad Request The request could not be understood by the server due to malformed syntax
401 Unauthorized The request requires user authentication
403 Forbidden The server understood the request, but is refusing to fulfill it
404 Not Found The server has not found anything matching the Request-URI
API Methods
SECURITY

Features related to authentication

Authentication
POST /authentications
Forgot password
POST /customers/forgot-password
Passrwod reset validation
POST /reset-password/validate
Password reset change
PUT /customers/reset-password/change
Authentication
POST /authentications

Performs a user’s authentication in Realwave.

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
login
string
Example:
poc.chatr1@gmail.com
password
string
Example:
123456

Responses

200 OK
Body
Object
expires
string
Example:
Thu Aug 24 07:52:12 EST 2017
access_token
string
Example:
eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwb2MuY2hhdHIxQGdtYWlsLmNvbSIsImV4cCI6MTUwMzU3OTEzMiwianRpIjoiMzAzIn0.rCBPhHltkZtypksH5S0Fie-y7SJkvjA0iQxqNW-VxZ4i0qetH_GW3pjnrLWgVsBFhVbexNSCayEP7fQ-t7tYvQ
action
string
Example:
LINE_DIGITAL
400 Bad Request
401 Unauthorized
500 Internal Server Error
Ok
POST /authentications HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

{
    "login": "poc.chatr1@gmail.com",
    "password": "123456"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "expires": "Thu Aug 24 07:52:12 EST 2017",
    "access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwb2MuY2hhdHIxQGdtYWlsLmNvbSIsImV4cCI6MTUwMzU3OTEzMiwianRpIjoiMzAzIn0.rCBPhHltkZtypksH5S0Fie-y7SJkvjA0iQxqNW-VxZ4i0qetH_GW3pjnrLWgVsBFhVbexNSCayEP7fQ-t7tYvQ",
    "action": "LINE_DIGITAL"
}
Forgot password
POST /customers/forgot-password

When a user forgets their access password, this feature must be used to receive a validation token for password change.

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
email
string
Example:
poc.chatr1@gmail.com

Responses

204 No Content
400 Bad Request
500 Internal Server Error
Ok
POST /customers/forgot-password HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

{
    "email": "poc.chatr1@gmail.com"
}

HTTP/1.1 204 No Content
Passrwod reset validation
POST /reset-password/validate

Validate the access token to show the screen of change password

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
email
string
Example:
poc.chatr1@gmail.com
token
string
Example:
DJ8LQ4

Responses

200 OK
Body
Object
customerId
string
Example:
a2d86ca2-a20d-4354-9dc0-f1e7ab1f3a48
400 Bad Request
422 Unprocessable Entity
Body
Object
code
string
Example:
FORGOT_PASSWORD_INVALID_TOKEN
detail
unknown nullable
title
string
Example:
Failed to validate token
message
string
Example:
The token entered is not valid
500 Internal Server Error
Ok
Unprocessable Entity
POST /reset-password/validate HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

{
    "email": "poc.chatr1@gmail.com",
    "token": "DJ8LQ4"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "customerId": "a2d86ca2-a20d-4354-9dc0-f1e7ab1f3a48"
}
POST /reset-password/validate HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

{
    "email": "poc.chatr1@gmail.com",
    "token": "dj8lq4"
}

HTTP/1.1 422 Unprocessable Entity 

Content-Type: application/json

{
    "code": "FORGOT_PASSWORD_INVALID_TOKEN",
    "detail": null,
    "title": "Failed to validate token",
    "message": "The token entered is not valid"
}
Password reset change
PUT /customers/reset-password/change

Performs the exchange of the password through the generated token

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
confirmation
string
Example:
162528
email
string
Example:
frfreitas.felipe@gmail.com
password
string
Example:
162528
token
string
Example:
DJ8LQ4

Responses

200 OK
400 Bad Request
422 Unprocessable Entity
Body
Object
code
string
Example:
FORGOT_PASSWORD_INVALID_TOKEN
detail
unknown nullable
title
string
Example:
Failed to validate token
message
string
Example:
The token entered is not valid
500 Internal Server Error
Ok
Unprocessable Entity
PUT /customers/reset-password/change HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

{
    "confirmation": "162528",
    "email": "frfreitas.felipe@gmail.com",
    "password": "162528",
    "token": "DJ8LQ4"
}

HTTP/1.1 200 OK 
PUT /customers/reset-password/change HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

{
    "confirmation": "162528",
    "email": "frfreitas.felipe@gmail.com",
    "password": "162528",
    "token": "dj8lq4"
}

HTTP/1.1 422 Unprocessable Entity 

Content-Type: application/json

{
    "code": "FORGOT_PASSWORD_INVALID_TOKEN",
    "detail": null,
    "title": "Failed to validate token",
    "message": "The token entered is not valid"
}
ACTIVATION
Customer
GET /customers
Save Customer
POST /customers
Update Customer
PUT /customers
Order Subscription
POST /orders/subscription
Save Address
POST /customers/address
Term of Acceptance
GET /terms/type/{code}
Customer
GET /customers

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Responses

200 OK
Body
Object
id
string
Example:
67e68d3d-2c14-4d1d-aa97-f01c8e11f94b
personType
string
Example:
F
country
string
Example:
Brasil
fullName
string
Example:
Poc Chatr 1
nickname
string
Example:
Chatr 1
gender
string
Example:
M
birthDate
string
Example:
1979-12-10
createdAt
string
Example:
2017-07-07
status
string
Example:
ACTIVE
documents
Array
Object
id
integer
Example:
47433
number
string
Example:
21470673851
docType
string
Example:
CPF
createdAt
string
Example:
2017-07-07T18:10:03.865
addresses
Array
Object
id
string
Example:
49050
name
string
Example:
PRINCIPAL
zipCode
string
Example:
38405-000
number
string
Example:
100
complement
string
street
string
Example:
Rua x
district
string
Example:
Centro
city
string
Example:
Uberlândia
state
string
Example:
MG
country
string
Example:
BRASIL
contacts
Array
Object
id
integer
Example:
110417
contactType
string
Example:
EMAIL
createdAt
string
Example:
2017-07-07
status
string
Example:
ACTIVE
content
Object
name
string
Example:
MAIN
email
string
Example:
chatr1@gmail.com
customFields
Object
hobbies
unknown nullable
jobCode
unknown nullable
newsletter
boolean
Example:
true
acceptTerms
boolean
Example:
true
incomeRange
integer
maritalStatus
integer
economicActivity
integer
city
string
civilState
string
occupation
string
motherName
string
fatherName
string
numberOfChildren
integer
income
Object
currency
string
Example:
BRL
amount
integer
lineStatus
string
Example:
ACTIVE
401 Unauthorized
500 Internal Server Error
Ok
GET /customers HTTP/1.1 

X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "67e68d3d-2c14-4d1d-aa97-f01c8e11f94b",
    "personType": "F",
    "country": "Brasil",
    "fullName": "Poc Chatr 1",
    "nickname": "Chatr 1 ",
    "gender": "M",
    "birthDate": "1979-12-10",
    "createdAt": "2017-07-07",
    "status": "ACTIVE",
    "documents": [
        {
            "id": 47433,
            "number": "21470673851",
            "docType": "CPF",
            "createdAt": "2017-07-07T18:10:03.865"
        }
    ],
    "addresses": [
        {
            "id": "49050",
            "name": "PRINCIPAL",
            "zipCode": "38405-000",
            "number": "100",
            "complement": "",
            "street": "Rua x",
            "district": "Centro",
            "city": "Uberlândia",
            "state": "MG",
            "country": "BRASIL"
        }
    ],
    "contacts": [
        {
            "id": 110417,
            "contactType": "EMAIL",
            "createdAt": "2017-07-07",
            "status": "ACTIVE",
            "content": {
                "name": "MAIN",
                "email": "chatr1@gmail.com"
            }
        }
    ],
    "customFields": {
        "hobbies": null,
        "jobCode": null,
        "newsletter": true,
        "acceptTerms": true,
        "incomeRange": 1,
        "maritalStatus": 1,
        "economicActivity": 1
    },
    "city": "",
    "civilState": "",
    "occupation": "",
    "motherName": "",
    "fatherName": "",
    "numberOfChildren": 1,
    "income": {
        "currency": "BRL",
        "amount": 1
    },
    "lineStatus": "ACTIVE"
}
Save Customer
POST /customers

Save the cutomer data

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
customFields
Object
credential
Object
password
string
Example:
123456
username
string
Example:
chatrpoc1@gmail.com
economicActivity
integer
incomeRange
integer
maritalStatus
integer
newsletter
boolean
Example:
true
documents
Array
Object
docType
string
Example:
CPF
number
string
Example:
22479710831
nickname
string
Example:
Client Chatr 1

Responses

200 OK
400 Bad Request
401 Unauthorized
422 Unprocessable Entity
500 Internal Server Error
Ok
POST /customers HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

{
    "customFields": {
        "credential": {
            "password": "123456",
            "username": "chatrpoc1@gmail.com"
        },
        "economicActivity": 1,
        "incomeRange": 1,
        "maritalStatus": 1,
        "newsletter": true
    },
    "documents": [
        {
            "docType": "CPF",
            "number": "22479710831"
        }
    ],
    "nickname": "Client Chatr 1"
}

HTTP/1.1 200 OK
Update Customer
PUT /customers

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
country
string
Example:
Brasil
customFields
Object
economicActivity
integer
Example:
2
hobbies
string
Example:
cinema
incomeRange
integer
Example:
4
maritalStatus
integer
Example:
1
documents
Array
Object
docType
string
Example:
CPF
number
string
Example:
07573511744
fullName
string
Example:
Client Chatr 1
gender
string
Example:
M
id
string
Example:
d9b1c3c7-cd8b-4595-80e5-bfabd91a6f8b
nickname
string
Example:
Chatr 1
numberOfChildren
integer
Example:
2
personType
string
Example:
F
status
string
Example:
ACTIVE

Responses

200 OK
Body
Object
id
string
Example:
d9b1c3c7-cd8b-4595-80e5-bfabd91a6f8b
personType
string
Example:
F
country
string
Example:
Brasil
fullName
string
Example:
Client Chatr 1
nickname
string
Example:
Chatr 1
gender
string
Example:
M
birthDate
string
Example:
1979-01-15
createdAt
string
Example:
2017-06-01
status
string
Example:
ACTIVE
documents
Array of unknown
addresses
Array of unknown
contacts
Array of unknown
customFields
Object
hobbies
string
Example:
cinema
incomeRange
integer
Example:
4
maritalStatus
integer
Example:
1
economicActivity
integer
Example:
2
city
string
civilState
string
occupation
string
motherName
string
Example:
Mother Name Client Chatr 1
fatherName
string
numberOfChildren
integer
income
Object
currency
string
Example:
BRL
amount
integer
400 Bad Request
401 Unauthorized
422 Unprocessable Entity
500 Internal Server Error
Ok
PUT /customers HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

{
    "country": "Brasil",
    "customFields": {
        "economicActivity": 2,
        "hobbies": "cinema",
        "incomeRange": 4,
        "maritalStatus": 1
    },
    "documents": [
        {
            "docType": "CPF",
            "number": "07573511744"
        }
    ],
    "fullName": "Client Chatr 1",
    "gender": "M",
    "id": "d9b1c3c7-cd8b-4595-80e5-bfabd91a6f8b",
    "nickname": "Chatr 1",
    "numberOfChildren": 2,
    "personType": "F",
    "status": "ACTIVE"
}
Order Subscription
POST /orders/subscription

Make a purchase order for an activation.

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
customFields
Object
addressId
string
Example:
49055
areaCode
integer
Example:
21
fingerprint
string
Example:
07db9ebe-3560-4085-85c8-8d39e07af81f
iccid
string
Example:
89553930500000173357
origin
string
Example:
ANDROID
order
Object
offers
Array
Object
id
string
Example:
a5a1eb05-6f00-4379-8824-61d297119d2b
offerType
string
Example:
CUSTOM
price
integer
Example:
1
serviceType
string
Example:
LOCAL_VOICE
validityPeriod
string
Example:
DAY
validityValue
integer
Example:
7
volumeType
string
Example:
TIME
volumeUnit
string
Example:
Min
volumeValue
integer
Example:
100
payment
Object
data
Object
creditCard
Object
brand
string
Example:
VISA
cvv
string
Example:
000
expirationMonth
string
Example:
08
expirationYear
string
Example:
2018
holder
string
Example:
Poc Chatr 1
main
boolean
Example:
true
number
string
Example:
4271671845280000
method
string
Example:
CREDIT_CARD

Responses

200 OK
400 Bad Request
401 Unauthorized
422 Unprocessable Entity
500 Internal Server Error
Example 1
POST /orders/subscription HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

{
    "customFields": {
        "addressId": "49055",
        "areaCode": 21,
        "fingerprint": "07db9ebe-3560-4085-85c8-8d39e07af81f",
        "iccid": "89553930500000173357",
        "origin": "ANDROID"
    },
    "order": {
        "offers": [
            {
                "id": "a5a1eb05-6f00-4379-8824-61d297119d2b",
                "offerType": "CUSTOM",
                "price": 1,
                "serviceType": "LOCAL_VOICE",
                "validityPeriod": "DAY",
                "validityValue": 7,
                "volumeType": "TIME",
                "volumeUnit": "Min",
                "volumeValue": 100
            },
            {
                "id": "6e6b0258-9158-431b-8132-d12af42463a1",
                "offerType": "CUSTOM",
                "price": 8.99,
                "serviceType": "NATIONAL_INTERNET",
                "validityPeriod": "DAY",
                "validityValue": 7,
                "volumeType": "DATA",
                "volumeUnit": "MB",
                "volumeValue": 700
            }
        ]
    },
    "payment": {
        "data": {
            "creditCard": {
                "brand": "VISA",
                "cvv": "000",
                "expirationMonth": "08",
                "expirationYear": "2018",
                "holder": "Poc Chatr 1",
                "main": true,
                "number": "4271671845280000"
            }
        },
        "method": "CREDIT_CARD"
    }
}
Save Address
POST /customers/address

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
city
string
Example:
Toronto
country
string
Example:
CANADA
name
string
Example:
PRINCIPAL
state
string
Example:
Ontario
street
string
Example:
123 Broad St
zipCode
string
Example:
A2A 2A3

Responses

201 Created
Body
Object
id
string
Example:
233
name
string
Example:
PRINCIPAL
zipCode
string
Example:
A2A 2A3
street
string
Example:
123 Broad St
city
string
Example:
Toronto
state
string
Example:
Ontario
country
string
Example:
CANADA
customFields
unknown nullable
400 Bad Request
401 Unauthorized
422 Unprocessable Entity
500 Internal Server Error
Ok
POST /customers/address HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

{
    "city": "Toronto",
    "country": "CANADA",
    "name": "PRINCIPAL",
    "state": "Ontario",
    "street": "123 Broad St",
    "zipCode": "A2A 2A3"
}
Term of Acceptance
GET /terms/type/{code}

Path variables

code
string required

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9

Responses

200 OK
Body
Object
content
string
Example:
<html> </html>
type
string
Example:
ADHERENCY
created
string
Example:
2017-08-01T00:00:01.000000
status
string
Example:
ACTIVE
404 Not Found
500 Internal Server Error
Ok
GET /terms/type/ADHERENCY HTTP/1.1 

X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
Content-Type: application/json

{
  "content": "<h1>chatr&trade; terms of service - 2017</h1><h3> <strong><font color=\"#5c2d90\">1. Introductory Information</font></strong></h3><strong><p>a. How do the chatr Terms of Service apply to me?</p></strong><p>These chatr Terms of Service (\"<strong>Terms</strong>\") govern your use of:</p><p> i. the mobile services that you receive from or through chatr (\"<strong>Services</strong>\"); and<br> ii. any phone, device or equipment used to access the Services or used with the Services (\"<strong>Equipment</strong>\").</p><p>In these Terms, \"<strong>chatr</strong>\",...",
  "type": "ADHERENCY",
  "created": "2017-08-01T00:00:01.000000",
  "status": "ACTIVE"
}
WALLET
Credit Cards
GET /billing/credit-cards
Create Credit Card
POST /billing/credit-cards
Default Card Credit
PUT /billing/credit-cards/{id}
Credit Cards
GET /billing/credit-cards

List the availabes credits cards of a Customer

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Responses

200 OK
Body
Object
id
string
Example:
6505
lastDigits
string
Example:
6175
brand
string
Example:
VISA
expirationMonth
string
Example:
10
expirationYear
string
Example:
2023
holder
string
Example:
Poc Rogers 1
main
boolean
Example:
true
active
boolean
Example:
true
401 Unauthorized
500 Internal Server Error
Ok
GET /billing/credit-cards HTTP/1.1 

X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

HTTP/1.1 200 OK 

Content-Type: application/json

[
  {
    "id": "6505",
    "lastDigits": "6175",
    "brand": "VISA",
    "expirationMonth": "10",
    "expirationYear": "2023",
    "holder": "Poc Rogers 1",
    "main": false,
    "active": true
  },
  {
    "id": "15650",
    "lastDigits": "4016",
    "brand": "MASTERCARD",
    "expirationMonth": "11",
    "expirationYear": "2017",
    "holder": "Poc Rogers 2",
    "main": true,
    "active": true
  }
]
Create Credit Card
POST /billing/credit-cards

Adds a new credit card to the platform and performs a charge to validate the credit card

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
brand
string
Example:
MASTERCARD
cvv
integer
Example:
118
expirationMonth
string
Example:
06
expirationYear
string
Example:
2023
holder
string
Example:
Poc Rogers 1
number
string
Example:
5204050634004509

Responses

200 OK
Body
Object
id
string
Example:
15658
lastDigits
string
Example:
4509
brand
string
Example:
MASTERCARD
expirationMonth
string
Example:
06
expirationYear
string
Example:
2023
holder
string
Example:
Poc Rogers 1
main
boolean
Example:
true
active
boolean
400 Bad Request
401 Unauthorized
422 Unprocessable Entity
500 Internal Server Error
Ok
POST /billing/credit-cards HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

{
    "brand": "MASTERCARD",
    "cvv": 118,
    "expirationMonth": "06",
    "expirationYear": "2023",
    "holder": "Poc Rogers 1",
    "number": "5204050634004509"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "15658",
    "lastDigits": "4509",
    "brand": "MASTERCARD",
    "expirationMonth": "06",
    "expirationYear": "2023",
    "holder": "Poc Rogers 1",
    "main": true,
    "active": true
}
Default Card Credit
PUT /billing/credit-cards/{id}

Changes a customer credit card to default. The standard card is used as for example in recurrences

Path variables

id
number required

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Responses

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error
Ok
PUT /billing/credit-cards/1234 HTTP/1.1 

X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

HTTP/1.1 200 OK
PURCHASE
Cart
GET /orders/cart
Save Cart
POST /orders/cart
Order
POST /orders
Update Subscription
PUT /orders/subscription
Cupom
GET /cupom/{code}
Cart
GET /orders/cart

Show items in the current shopping cart

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Responses

200 OK
Body
Object
items
Array
Object
id
string
Example:
996bfcfb-8ecb-43de-98fc-0e15cae7a18f
offerType
string
Example:
CUSTOM
serviceType
string
Example:
VOICE_LOCAL
volumeUnit
string
Example:
Min
volumeValue
integer
Example:
200
volumeType
string
Example:
TIME
price
integer
Example:
5
validityPeriod
string
Example:
DAY
validityValue
integer
Example:
30
401 Unauthorized
500 Internal Server Error
Ok
GET /orders/cart HTTP/1.1 

X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "items": [
        {
            "id": "996bfcfb-8ecb-43de-98fc-0e15cae7a18f",
            "offerType": "CUSTOM",
            "serviceType": "VOICE_LOCAL",
            "volumeUnit": "Min",
            "volumeValue": 200,
            "volumeType": "TIME",
            "price": 5,
            "validityPeriod": "DAY",
            "validityValue": 30
        },
        {
          "id": "21feca7c-7328-42a0-b7bb-4df0b170e680",
          "offerType": "CUSTOM",
          "serviceType": "NATIONAL_INTERNET",
          "volumeUnit": "GB",
          "volumeValue": 1.5,
          "volumeType": "DATA",
          "price": 34.99,
          "validityPeriod": "DAY",
          "validityValue": 30
        }
    ]
}
Save Cart
POST /orders/cart

Save the shopping cart with the offers that the customer selected

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
items
Array
Object
id
string
Example:
95d0fa93-8b59-4a17-9c4e-8898278e2aea
offerType
string
Example:
CUSTOM
volumeUnit
string
Example:
GB
volumeValue
number
Example:
1.5
price
integer

Responses

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error
Ok
POST /orders/cart HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

{
    "items": [
        {
            "id": "95d0fa93-8b59-4a17-9c4e-8898278e2aea",
            "offerType": "CUSTOM",
            "volumeUnit": "GB",
            "volumeValue": 1.5,
            "price": 0
        },
        {
            "id": "6747ceb9-6896-47ba-aaf3-e7754f78ca06",
            "offerType": "CUSTOM",
            "volumeUnit": "MINUTES",
            "volumeValue": 100,
            "price": 0
        }
    ]
}
Order
POST /orders

Make a purchase order

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
customFields
Object

In this structure, any custom parameter that the client wishes can be sent

origin
string
Example:
ANDROID
order
Object
offers
Array
Object
id
string
Example:
00eabecc-6010-4ebc-a558-4b651a3100a4
offerType
string
Example:
ADDON
price
integer
Example:
30
refillType
string
Example:
MANUAL
validityPeriod
integer
Example:
30
volumeUnit
string
Example:
GB
volumeValue
integer
Example:
5
payment
Object
method
string
Example:
CREDIT_CARD

Responses

200 OK
Body
Object
orderId
integer
Example:
246863
orderStatus
string
Example:
PENDING
transactionId
string
Example:
9e30468c-2b7d-41bf-bff9-722eeb993e7e
400 Bad Request
401 Unauthorized
422 Unprocessable Entity
500 Internal Server Error
Ok
POST /orders HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

{
    "customFields": {
        "fingerprint": "33d8fc35-f275-4da2-8301-49da9ac7985c",
        "origin": "ANDROID"
    },
    "order": {
        "offers": [
            {
                "id": "00eabecc-6010-4ebc-a558-4b651a3100a4",
                "offerType": "ADDON",
                "price": 30,
                "refillType": "MANUAL",
                "validityPeriod": 30,
                "volumeUnit": "GB",
                "volumeValue": 5
            }
        ]
    },
    "payment": {
        "method": "CREDIT_CARD"
    }
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "orderId": 246863,
    "orderStatus": "PENDING",
    "transactionId": "9e30468c-2b7d-41bf-bff9-722eeb993e7e"
}
Update Subscription
PUT /orders/subscription

Change the customer’s subscription plan for the selected offer

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Request body

Object
customFields
Object
fingerprint
string
Example:
c89359e8-08c7-46bf-ba7a-6b632902551b
origin
string
Example:
ANDROID
order
Object
offers
Array
Object
id
string
Example:
a472160d-9013-4a4b-844f-40cf4064d47f
offerType
string
Example:
CUSTOM
price
number
Example:
11.99
validityPeriod
integer
Example:
7
volumeUnit
string
Example:
GB
volumeValue
integer
Example:
1

Responses

200 OK
400 Bad Request
401 Unauthorized
422 Unprocessable Entity
500 Internal Server Error
Ok
PUT /orders/subscription HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

{
  "customFields": {
    "fingerprint": "c89359e8-08c7-46bf-ba7a-6b632902551b",
    "origin": "ANDROID"
  },
  "order": {
    "offers": [
      {
        "id": "a472160d-9013-4a4b-844f-40cf4064d47f",
        "offerType": "CUSTOM",
        "price": 11.99,
        "validityPeriod": 7,
        "volumeUnit": "GB",
        "volumeValue": 1
      },
      {
        "id": "a5a1eb05-6f00-4379-8824-61d297119d2b",
        "offerType": "CUSTOM",
        "price": 1,
        "validityPeriod": 7,
        "volumeUnit": "MINUTES",
        "volumeValue": 100
      }
    ]
  }
}
Cupom
GET /cupom/{code}

Path variables

code
string required

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9

Responses

200 OK
Body
Object
description
unknown nullable
discountType
string
Example:
PRICE
discountValue
integer
Example:
10
name
string
Example:
Coupon Name
type
string
Example:
DISCOUNT
422 Unprocessable Entity
500 Internal Server Error
Ok
GET /cupom/{code} HTTP/1.1 

X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "description": null,
    "discountType": "PRICE",
    "discountValue": 10,
    "name": "Coupon Name",
    "type": "DISCOUNT"
}
GENERAL
Consumptions
GET /consumptions
Transactions
GET /billing/transactions
Plans
GET /rto/plans
Addons
GET /rto/addons
Stores
GET /locations/stores
Cities
GET /cities
Protocols
GET /protocols/{type}/{year}/{month}
Consumptions
GET /consumptions

Shows real-time consumption of all customer offerings

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Responses

200 OK
Body
Object
msisdn
string
Example:
5534999998888
renewalDate
string
Example:
2017-07-13T23:59:59.999
expirationDays
integer
Example:
3
expired
boolean
bundlePrice
number
Example:
39.99
bundles
Array
Object
id
string
Example:
368329
serviceType
string
Example:
LOCAL_VOICE
rechargeVolume
integer
Example:
12000
remainingVolume
integer
Example:
11790
formattedRechargeVolume
integer
Example:
200
formattedRemainingVolume
number
Example:
196.5
formattedUsedVolume
number
Example:
3.5
formattedRechargeVolumeUnit
string
Example:
Min
formattedRemainingVolumeUnit
string
Example:
Min
formattedUsedVolumeUnit
string
Example:
Min
expirationDate
string
Example:
2017-07-14T12:00:00.000
period
string
Example:
30
periodUnit
string
Example:
DAY
price
integer
Example:
5
refillType
string
Example:
AUTO
offerType
string
Example:
CUSTOM
current
boolean
Example:
true
isBonus
boolean
offers
Array
Object
id
string
Example:
403553
serviceType
string
Example:
LOCAL_VOICE
rechargeVolume
integer
Example:
143
remainingVolume
integer
Example:
143
formattedRechargeVolume
number
Example:
2.38
formattedRemainingVolume
number
Example:
2.38
formattedUsedVolume
integer
formattedRechargeVolumeUnit
string
Example:
Min
formattedRemainingVolumeUnit
string
Example:
Min
formattedUsedVolumeUnit
string
Example:
Min
expirationDate
string
Example:
2017-07-21T12:00:00.000
period
string
Example:
30
periodUnit
string
Example:
DAY
price
integer
refillType
string
Example:
MANUAL
offerType
string
Example:
COUNTERCHARGE
current
boolean
Example:
true
isBonus
boolean
401 Unauthorized
500 Internal Server Error
Ok
GET /consumptions HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "msisdn": "5534999998888",
    "renewalDate": "2017-07-13T23:59:59.999",
    "expirationDays": 3,
    "expired": true,
    "bundlePrice": 39.99,
    "bundles": [
        {
            "id": "368329",
            "serviceType": "LOCAL_VOICE",
            "rechargeVolume": 12000,
            "remainingVolume": 11790,
            "formattedRechargeVolume": 200,
            "formattedRemainingVolume": 196.5,
            "formattedUsedVolume": 3.5,
            "formattedRechargeVolumeUnit": "Min",
            "formattedRemainingVolumeUnit": "Min",
            "formattedUsedVolumeUnit": "Min",
            "expirationDate": "2017-07-14T12:00:00.000",
            "period": "30",
            "periodUnit": "DAY",
            "price": 5,
            "refillType": "AUTO",
            "offerType": "CUSTOM",
            "current": true,
            "isBonus": true
        },
        {
              "id": "368327",
              "serviceType": "NATIONAL_INTERNET",
              "rechargeVolume": 0,
              "remainingVolume": 0,
              "formattedRechargeVolume": 1.5,
              "formattedRemainingVolume": 0,
              "formattedUsedVolume": 1.5,
              "formattedRechargeVolumeUnit": "GB",
              "formattedRemainingVolumeUnit": "GB",
              "formattedUsedVolumeUnit": "GB",
              "expirationDate": "2017-07-13T23:59:59.999",
              "period": "30",
              "periodUnit": "DAY",
              "price": 34.99,
              "refillType": "AUTO",
              "offerType": "CUSTOM",
              "current": false,
              "isBonus": false
        }
    ],
    "offers": [
        {
            "id": "403553",
            "serviceType": "LOCAL_VOICE",
            "rechargeVolume": 143,
            "remainingVolume": 143,
            "formattedRechargeVolume": 2.38,
            "formattedRemainingVolume": 2.38,
            "formattedUsedVolume": 1,
            "formattedRechargeVolumeUnit": "Min",
            "formattedRemainingVolumeUnit": "Min",
            "formattedUsedVolumeUnit": "Min",
            "expirationDate": "2017-07-21T12:00:00.000",
            "period": "30",
            "periodUnit": "DAY",
            "price": 1,
            "refillType": "MANUAL",
            "offerType": "COUNTERCHARGE",
            "current": true,
            "isBonus": true
        }
    ]
}
Transactions
GET /billing/transactions

Shows all the financial transactions of a customer

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Responses

200 OK
Body
Object
id
string
Example:
51469bf5-8367-4b3f-a390-9e540af3e1d6
currentStatus
string
Example:
CANCELLED
customerId
string
Example:
6fc8fc0f-68f1-42a3-a4e1-70c8f09d4883
amount
Object
total
integer
Example:
1
currency
string
Example:
BRL
discount
Object
total
integer
currency
string
Example:
BRL
payment
Object
method
string
Example:
CREDIT_CARD
creditCard
Object
id
string
Example:
15678
lastDigits
string
Example:
3412
brand
string
Example:
MASTERCARD
expirationMonth
string
Example:
06
expirationYear
string
Example:
2021
holder
string
Example:
Chatr 1
main
boolean
Example:
true
active
boolean
Example:
true
provider
string
Example:
Cielo
createdAt
string
Example:
2017-07-10T12:50:08.031
recurrence
boolean
items
Array
Object
id
integer
Example:
1814759
code
string
Example:
0
description
string
Example:
RW DIGITAL
quantity
integer
Example:
1
price
integer
Example:
1
externalId
Date ISO 8601 nullable
expirationDate
Date ISO 8601 nullable
401 Unauthorized
500 Internal Server Error
Plans
GET /rto/plans

Lists the plans according to the customer profile

Request parameters

areaCode
string optional

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9

Responses

200 OK
Body
Object
id
string
Example:
0d43114f-a499-479e-bca2-e5854de21648
price
integer
Example:
20
name
string
Example:
Local Talk Plan
validityPeriod
string
Example:
DAY
validityValue
integer
Example:
30
products
Array
Object
name
string
Example:
Unlimited Local Calls
volumeValue
integer
Example:
9999
volumeType
string
Example:
TIME
volumeTypeUnit
string
Example:
MINUTES
productTypeCode
string
Example:
VOICE_LOCAL
404 Not Found
500 Internal Server Error
Example 1
GET /rto/plans HTTP/1.1 

X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

HTTP/1.1 200 OK 

Content-Type: application/json

[
  {
    "id": "0d43114f-a499-479e-bca2-e5854de21648",
    "price": 20,
    "name": "Local Talk Plan",
    "validityPeriod": "DAY",
    "validityValue": 30,
    "products": [
      {
        "name": "Unlimited Local Calls",
        "volumeValue": 9999,
        "volumeType": "TIME",
        "volumeTypeUnit": "MINUTES",
        "productTypeCode": "VOICE_LOCAL"
      }
    ]
  },
  {
    "id": "5aaa337c-7a30-47d9-81a8-edf05e2b4247",
    "price": 25,
    "name": "Talk + Text Starter Pack",
    "validityPeriod": "DAY",
    "validityValue": 30,
    "products": [
      {
        "name": "Unlimited Local Calls",
        "volumeValue": 9999,
        "volumeType": "TIME",
        "volumeTypeUnit": "MINUTES",
        "productTypeCode": "VOICE_LOCAL"
      },
      {
        "name": "100 International Text",
        "volumeValue": 100,
        "volumeType": "UNITS",
        "volumeTypeUnit": "UNITS",
        "productTypeCode": "SMS_INTERNATIONAL"
      }
    ]
  },
  {
    "id": "ae5ad23f-c9f1-4f3d-804c-53d8c4a2f8c6",
    "price": 30,
    "name": "Talk, Text and 6GB Data",
    "validityPeriod": "DAY",
    "validityValue": 30,
    "products": [
      {
        "name": "Unlimited International Calls",
        "volumeValue": 9999,
        "volumeType": "TIME",
        "volumeTypeUnit": "MINUTES",
        "productTypeCode": "VOICE_INTERNATIONAL"
      },
      {
        "name": "Unlimited International Text",
        "volumeValue": 9999,
        "volumeType": "UNITS",
        "volumeTypeUnit": "UNITS",
        "productTypeCode": "SMS_INTERNATIONAL"
      },
      {
        "name": "Data 6GB",
        "volumeValue": 6,
        "volumeType": "DATA",
        "volumeTypeUnit": "GB",
        "productTypeCode": "DATA_PLAN"
      }
    ]
  },
  {
    "id": "604d855f-38fa-4e8f-821e-24edd3177ef5",
    "price": 60,
    "name": "Test Package",
    "validityPeriod": "DAY",
    "validityValue": 30,
    "products": [
      {
        "name": "Data 10GB",
        "volumeValue": 10,
        "volumeType": "DATA",
        "volumeTypeUnit": "GB",
        "productTypeCode": "DATA_PLAN"
      },
      {
        "name": "Unlimited International Calls",
        "volumeValue": 9999,
        "volumeType": "TIME",
        "volumeTypeUnit": "MINUTES",
        "productTypeCode": "VOICE_INTERNATIONAL"
      }
    ]
  }
]
Addons
GET /rto/addons

List the addons according to the client profile

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Responses

200 OK
Body
Object
expiration
integer
Example:
15
products
Array
Object
code
string
Example:
DATA_ADDON
mandatory
boolean
offers
Array
Object
id
string
Example:
ac967516-0ed5-420b-a352-4208a03d54b9
name
string
Example:
Data Addon 2GB
offerType
string
Example:
ADDON
volumeValue
integer
Example:
2
volumeUnit
string
Example:
GB
price
integer
Example:
15
focus
boolean
401 Unauthorized
500 Internal Server Error
Ok
GET /rto/addons HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

HTTP/1.1 200 OK 

Content-Type: application/json

[
  {
    "expiration": 15,
    "products": [
      {
        "code": "DATA_ADDON",
        "mandatory": false,
        "offers": [
          {
            "id": "ac967516-0ed5-420b-a352-4208a03d54b9",
            "name": "Data Addon 2GB",
            "offerType": "ADDON",
            "volumeValue": 2,
            "volumeUnit": "GB",
            "price": 15,
            "focus": false
          }
        ]
      }
    ]
  },
  {
    "expiration": 7,
    "products": [
      {
        "code": "DATA_ADDON",
        "mandatory": false,
        "offers": [
          {
            "id": "463bacbe-617f-4cf4-9986-06afda3af53a",
            "name": "Data Addon 1GB",
            "offerType": "ADDON",
            "volumeValue": 1,
            "volumeUnit": "GB",
            "price": 10,
            "focus": false
          }
        ]
      }
    ]
  }
]
Stores
GET /locations/stores

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9

Request body

Responses

200 OK
Body
Object
latitude
number
Example:
43.651189
longitude
number
Example:
-79.384465
address
Object
street
string
Example:
Queen Street West Toronto
number
string
Example:
123
district
string
city
string
Example:
Toronto
state
string
Example:
Ontario
zipCode
string
Example:
M5H3M9
complement
string
500 Internal Server Error
Ok
GET /locations/stores HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

HTTP/1.1 200 OK 

Content-Type: application/json

[
  {
    "latitude": 43.651189,
    "longitude": -79.384465,
    "address":{
      "street": "Queen Street West Toronto",
      "number": "123",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M5H3M9",
      "complement": ""
    }
  },{
    "latitude": 43.654754,
    "longitude": -79.368901,
    "address":{
      "street": "Queen St E Toronto",
      "number": "230 ",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M5A 1S3",
      "complement": ""
    }
  },{
    "latitude": 43.656501,
    "longitude": -79.435589,
    "address":{
      "street": "Dufferin St.",
      "number": "900",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M4H4A9",
      "complement": "Unit 0455"
    }
  },{
    "latitude": 43.653544,
    "longitude": -79.379984,
    "address":{
      "street": "Yonge St,",
      "number": "218",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M5B 2P9",
      "complement": ""
    }
  },{
    "latitude": 43.655838,
    "longitude": -79.381964,
    "address":{
      "street": "Dundas St W",
      "number": "65",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M5G 2C3",
      "complement": ""
    }
  },{
    "latitude": 43.643836,
    "longitude": -79.386778,
    "address":{
      "street": "Front St W",
      "number": "255",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M5V 2W6",
      "complement": ""
    }
  },{
    "latitude": 43.656643,
    "longitude": -79.377479,
    "address":{
      "street": "Dundas St. E. Toronto",
      "number": "104",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "",
      "complement": ""
    }
  },{
    "latitude": 43.656036	,
    "longitude": -79.380246,
    "address":{
      "street": "Dundas St E Toronto",
      "number": "1",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M5B 2R8",
      "complement": ""
    }
  },{
    "latitude": 43.644609	,
    "longitude": -79.370053,
    "address":{
      "street": "Lower Jarvis Street",
      "number": "10",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M5E 1Z2",
      "complement": ""
    }
  },{
    "latitude": 43.671066	,
    "longitude": -79.385743,
    "address":{
      "street": "Bloor Street East",
      "number": "2",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M4W 1A8",
      "complement": "Unit C10"
    }
  },{
    "latitude": 43.667914	,
    "longitude": -79.369676,
    "address":{
      "street": "Parliament St",
      "number": "588",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "",
      "complement": ""
    }
  },{
    "latitude": 43.671067	,
    "longitude": -79.385743,
    "address":{
      "street": "Bloor St East",
      "number": "2",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M4W 1A8",
      "complement": "Unit C12"
    }
  },{
    "latitude": 43.656221	,
    "longitude": -79.435576,
    "address":{
      "street": "Dufferin St",
      "number": "900",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M6H 4A9",
      "complement": ""
    }
  },{
    "latitude": 43.661004	,
    "longitude": -79.328335,
    "address":{
      "street": "Leslie Street",
      "number": "17",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M4M 3H9",
      "complement": ""
    }
  },{
    "latitude": 43.667504	,
    "longitude": -79.442086,
    "address":{
      "street": "Dupont Street",
      "number": "1245",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M6H 2A6",
      "complement": ""
    }
  },{
    "latitude": 43.667948	,
    "longitude": -79.484677,
    "address":{
      "street": "St Clair Ave W",
      "number": "2525",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M6N 4Z5",
      "complement": ""
    }
  },{
    "latitude": 43.677155	,
    "longitude": -79.495851,
    "address":{
      "street": "Jane Street",
      "number": "885A",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M6N 4C4",
      "complement": ""
    }
  },{
    "latitude": 43.695457,
    "longitude": -79.450700,
    "address":{
      "street": "Eglinton Ave West Toronto",
      "number": "1855",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M6E 2J3",
      "complement": ""
    }
  },{
    "latitude": 43.689680,
    "longitude": -79.290668,
    "address":{
      "street": "Danforth Avenue",
      "number": "3003",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M4C 1M9",
      "complement": ""
    }
  },{
    "latitude": 43.709093,
    "longitude": -79.362385,
    "address":{
      "street": "Laird Drive East York",
      "number": "147",
      "district": "",
      "city": "Toronto",
      "state": "Ontario",
      "zipCode": "M4G 4K1",
      "complement": ""
    }
  }
]
Cities
GET /cities

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9

Responses

200 OK
Body
Object
id
integer
Example:
11
name
string
Example:
Toronto
state
string
Example:
Ontario
areaCode
string
Example:
416
Example 1
GET /cities HTTP/1.1 

X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": 11,
    "name": "Toronto",
    "state": "Ontario",
    "areaCode": "416"
}

HTTP/1.1 200 OK 

Content-Type: application/json

[
  {
    "id": 11,
    "name": "Toronto",
    "state": "Ontario",
    "areaCode": "416"
  },
  {
    "id": 18,
    "name": "Vancouver",
    "state": "British Columbia",
    "areaCode": "604"
  },
  {
    "id": 19,
    "name": "Montreal",
    "state": "Quebec",
    "areaCode": "514"
  },
  {
    "id": 20,
    "name": "Ottawa",
    "state": "Ontario",
    "areaCode": "613"
  },
  {
    "id": 14,
    "name": "Quebec",
    "state": "Quebec",
    "areaCode": "418"
  },
  {
    "id": 21,
    "name": "Calgary",
    "state": "Alberta",
    "areaCode": "587"
  },
  {
    "id": 16,
    "name": "Regina",
    "state": "Saskatchewan",
    "areaCode": "306"
  },
  {
    "id": 5,
    "name": "Winnipeg",
    "state": "Manitoba",
    "areaCode": "204"
  },
  {
    "id": 1,
    "name": "Edmonton",
    "state": "Alberta",
    "areaCode": "780"
  }
]
Protocols
GET /protocols/{type}/{year}/{month}

Path variables

type
string required
year
string required
month
string required

Request headers

X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id
string required

Realwave application ID (Segment)

Example:
9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id
string required

Customer ID

Example:
94b6d39d-f263-48ad-9199-74deba21c007

Responses

200 OK
Body
Object
id
integer
Example:
979
number
string
Example:
201720000000979
statusDescription
string
Example:
Closed
status
string
Example:
CLOSED
title
string
Example:
Ticket for Order
createdAt
string
Example:
2017-07-10T10:55:49.912
tickets
unknown nullable
Ok
GET /protocols/{type}/{year}/{month} HTTP/1.1 

Content-Type: application/json
X-Application-Key: 0b19dcd0ebdd0134bb84021e75abe44c
X-Application-Id: 9bda286a775a2325177934ed753e3333433a3ae9
X-Customer-Id: 94b6d39d-f263-48ad-9199-74deba21c007

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": 979,
    "number": "201720000000979",
    "statusDescription": "Closed",
    "status": "CLOSED",
    "title": "Ticket for Order",
    "createdAt": "2017-07-10T10:55:49.912",
    "tickets": null
}

HTTP/1.1 200 OK 

Content-Type: application/json

[
  {
    "id": 979,
    "number": "201720000000979",
    "statusDescription": "Closed",
    "status": "CLOSED",
    "title": "Ticket for Order",
    "createdAt": "2017-07-10T10:55:49.912",
    "tickets": null
  },
  {
    "id": 978,
    "number": "201720000000978",
    "statusDescription": "Closed",
    "status": "CLOSED",
    "title": "Ticket for Change password",
    "createdAt": "2017-07-10T10:26:20.913",
    "tickets": null
  },
  {
    "id": 961,
    "number": "201720000000961",
    "statusDescription": "Closed",
    "status": "CLOSED",
    "title": "Ticket for Change password",
    "createdAt": "2017-07-10T05:25:39.982",
    "tickets": null
  },
  {
    "id": 960,
    "number": "201720000000960",
    "statusDescription": "Closed",
    "status": "CLOSED",
    "title": "Ticket for Add payment method",
    "createdAt": "2017-07-10T05:22:34.718",
    "tickets": null
  },
  {
    "id": 959,
    "number": "201720000000959",
    "statusDescription": "Closed",
    "status": "CLOSED",
    "title": "Ticket for Order",
    "createdAt": "2017-07-10T05:22:34.659",
    "tickets": null
  },
  {
    "id": 958,
    "number": "201720000000958",
    "statusDescription": "Closed",
    "status": "CLOSED",
    "title": "Ticket for Change customer details",
    "createdAt": "2017-07-10T05:22:34.526",
    "tickets": null
  }
]
Commons
X-Application-Key
string required

Authentication key of application

Example:
0b19dcd0ebdd0134bb84021e75abe44c
Operations: Addons Authentication Cart Cities Consumptions Create Credit Card Credit Cards Cupom Customer Default Card Credit Forgot password Order Order Subscription Passrwod reset validation Password reset change Plans Protocols Save Address Save Cart Save Customer Stores Term of Acceptance Transactions Update Customer Update Subscription
422 Unprocessable Entity
Body
Object
code
string
Example:
ERROR_CODE
detail
string
Example:
ERROR_CODE_DETAIL
title
string
Example:
Error title
message
string
Example:
Error message
Examples
{
    "code": "ERROR_CODE",
    "detail": "ERROR_CODE_DETAIL",
    "title": "Error title",
    "message": "Error message"
}
Operations: Cupom Order Order Subscription Save Address Save Customer Update Customer Update Subscription
Date ISO 8601

International Standard for the representation of dates and times

Object
Methods: Transactions
Example 1
2017-07-10T12:50:08.031