Sale card mapping notification
Introduction
API URLs
Connecting Party Server |
---|
https://proxy.connectingpartyserver.com/sale/notification |
Request Parameters
Parameter Name |
Description |
Value |
---|---|---|
consumer |
Necessity : RequiredType : Object |
|
consumer.device |
Necessity : RequiredType : Object |
|
consumer.device.serialNumber |
Consumer’s device serial number. |
Necessity : RequiredType : StringLength : 1-50 |
session |
Necessity : RequiredType : Object |
|
session.accessToken |
Consumer’s access token key. |
Necessity : RequiredType : StringLength : 32-128 |
session.token |
The session token of sale transaction. |
Necessity : RequiredType : StringLength : 16-36 |
sourceCard |
Necessity : OptionalType : Object |
|
sourceCard.bin |
The Source card BIN. |
Necessity : OptionalType : Integer |
sourceCard.reference |
Necessity : OptionalType : Object |
|
sourceCard.reference.serverCardId |
The Source card reference identifier (on server side). |
Necessity : OptionalType : StringLength : 1-64 |
sourceCard.reference.uniqueReferenceCardId |
The Source card unique identifier (on server side). |
Necessity : OptionalType : Integer |
Success Response Parameters
Parameter Name |
Description |
Value |
---|---|---|
invoiceId |
Sale transaction identifier. |
Type : String |
session |
Type : Object |
|
session.checkSignature |
Checksum generated by hmac-sha1 (see Signature computation) from the concatenation of session.nonce, endpointId and invoiceId. |
Type : String |
session.nonce |
Unique random string generated by Connecting Party’s server. |
Type : String |
session.token |
The session token of sale transaction. |
Type : String |
Fail Response Parameters
Parameter Name |
Description |
Value |
---|---|---|
error |
Type : Object |
|
error.cause |
Сause of the error. Possible values: |
Type : Enum |
error.code |
The unique error code. |
Type : String |
error.message |
Description of the error. |
Type : String |
invoiceId |
Sale transaction identifier. |
Type : String |
Request Example
{
"consumer": {
"device": {
"serialNumber": "string"
}
},
"session": {
"accessToken": "string",
"token":"string"
},
"sourceCard": {
"bin": "integer",
"reference": {
"serverCardId": "string",
"uniqueReferenceCardId": "integer"
}
}
}
Success Response Example
{
"invoiceId": "string",
"session": {
"checkSignature": "string",
"nonce": "string",
"token": "string"
}
}
Fail Response Example
{
"error": {
"cause": "enum",
"code": "string",
"message": "string"
},
"invoiceId": "string"
}