Callbacks
Notification goes to an URL which merchant provides upon integration process, or to *callbackUrl parameter from the original request. Notification is a POST request with JSON body with the data equivalent for GET responses in API
Callback is sent by HTTPS protocol on *443 port only. Certificate should be issued by any trusted center of certification (e.g. Verisign, Thawte, etc)
To minimize possible fraud notifications, merchant should verify callback signature located in request header (parameter Signature:) with public key object located on: {API_URL}/signkey Signature algorithm also located on: *{API_URL}/signkey and described in object alg.
See examples in signkey section.
Notification is successfully delivered when merchant's server responds with HTTP code 200 OK. The system will continue to deliver notification with incremental time intervals until the server responds with HTTP code 200 OK.
{
"type": "PAYMENT",
"object": {
"paymentId": "refundId",
"txnId": "string",
"orderId": "string",
"autoConfirm": true,
"createdAt": "2019-08-24T14:15:22Z",
"callbackUrl": "string",
"amount": {
"value": "7635.01",
"currency": "USD"
},
"convAmount": {
"value": "7635.01",
"currency": "USD"
},
"paymentMethod": "card",
"paymentData": {
"type": "cardResponse",
"object": {
"maskedPan": "string",
"expiryDate": "string",
"cardHolder": "string",
"cardInfo": {
"issuerCountry": "USA",
"issuerName": "string"
}
}
},
"paymentToken": {
"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",
"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"
}
}
}
}
},
"status": {
"changedAt": "2019-08-24T14:15:22Z",
"value": "RECONCILED",
"description": "string"
}
},
"error": {
"code": 65535,
"description": "string",
"traceId": "string",
"details": [
{
"value": "string",
"description": "string",
"fields": [
{
"name": "string",
"type": "string",
"value": "string"
}
]
}
]
}
}