Balances
Tokens operations
GET- tokens/{tokenId}(1)
AUTHORIZATIONS (2)
-
Sandbox server (uses test data)
https://api.sandbox.payerly.tech/v1/tokens/{tokenId}
Production server (uses live data)
https://api.payerly.tech/v1/tokens/{tokenId} -
BearerAuth
QUERY PARAMETERS
| Parameter | Type | Description |
|---|---|---|
accountId |
string | Customer account ID |
phone |
string | Customer phone |
email |
string | Customer e-mail |
RESPONSE HEADERS:
| Parameter | Type | Description |
|---|---|---|
Date |
string(date-time) | The Date header indicates the server time. |
RESPONSE SCHEMA: application/json
| Parameter | Type | Description |
|---|---|---|
items |
Array of objects (tokenResponse) | Array of token objects - type: Object type (TOKEN). Value: "TOKEN" - object: Payment object (see parameters below) |
Payment token response
| Parameter | Type | Description |
|---|---|---|
type |
string | Object type. Value TOKEN |
object |
object | - tokenId: Token id - expireAt: Token expiration time - customer: - accountId: Unique customer account id - fingerprint: Unique customer device fingerprint - ip: Customer IP address - phone: Customer phone (only numbers, with country code) - email: Customer e-mail address - fullName: Customer full name - DocumentType: Customer document type - Document: Customer document - country: Customer country (ISO 3166-1 alpha-3) - address: Customer address - city: Customer city - state: Customer state - postalCode: Customer postal code - neighborhood: Customer neighborhood address - birthdate: Customer birthdate - browserData: Object with browser data (acceptHeader, colorDepth, language, screenHeight, screenWidth, timezone, userAgent, javaEnabled, windowHeight, windowWidth) - paymentMethod: Value card. Payment method - paymentData: - type: Value cardResponse. Payment method type - maskedPan: Masked primary account number - expiryDate: Expiration date - cardHolder: Cardholder name - cardInfo: Card information (issuerCountry, issuerName) - additionalAction: Additional payment actions (additional customer verification) - action: Action type. Value redirect - value: Action type value (e.g., customer redirect URL) |
200
{
"items": [
{
"type": "TOKEN",
"object": {
"tokenId": "string",
"expireAt": "2019-08-24T14:15:22Z",
"customer": {
"accountId": "df1a2c9e-bc2b-11ed-8332-811eecb5ec73",
"fingerprint": "30faf01ebf161c7c7673b776820b3517|1ea851ab5b0e311ed9c690828f8dc7c6|eyJEZXZpY2VGaW5nZXJwcmludCI6IjMwZmFmMDFlYmYxNjFjN2M3NjczYjc3NjgyMGIzNTE3In0=",
"ip": "123.123.123.223",
"phone": "18001002030",
"email": "[email protected]",
"fullName": "John Doe",
"documentType": "string",
"document": "string",
"country": "USA",
"address": "Av. da Liberdade, 87",
"city": "Sao Paulo",
"state": "SP",
"postalCode": "05907",
"neighborhood": "6587 Roller Derby Lane, Toronto, ON M1R-0E9, Canada",
"birthdate": "1960-02-25",
"browserData": {
"acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
"colorDepth": 32,
"language": "en",
"screenHeight": 667,
"screenWidth": 375,
"timezone": -60,
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_7_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.6.4 Mobile/15E148 Safari/604.1",
"javaEnabled": true,
"windowHeight": 850,
"windowWidth": 375
}
},
"paymentMethod": "card",
"paymentData": {
"type": "cardResponse",
"object": {
"maskedPan": "string",
"expiryDate": "string",
"cardHolder": "string",
"cardInfo": {
"issuerCountry": "USA",
"issuerName": "string"
}
}
},
"additionalAction": {
"action": "redirect",
"value": "string"
}
}
}
]
}