Check transfer
Introduction
API URLs
Connecting Party Server |
---|
https://proxy.connectingpartyserver.com/transfer/{invoiceId}/check |
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 sent by Connecting Party’s app. |
Necessity : RequiredType : StringLength : 32-128 |
session.nonce |
Value sent by Connecting Party’s app. |
Necessity : RequiredType : StringLength : 32-128 |
session.signature |
Value sent by Connecting Party’s app. |
Necessity : RequiredType : StringLength : 32-128 |
session.token |
The session token of transfer transaction. |
Necessity : RequiredType : StringLength : 16-36 |
sourceOfFunds |
Necessity : OptionalType : Object |
|
sourceOfFunds.reference |
Necessity : OptionalType : Object |
|
sourceOfFunds.reference.clientCardId |
The source card reference identifier (on client side) if sent in Perform Transfer request. |
Necessity : OptionalType : StringLength : 1-128 |
destinationOfFunds |
Necessity : OptionalType : Object |
|
destinationOfFunds.reference |
Necessity : OptionalType : Object |
|
destinationOfFunds.reference.clientCardId |
The destination card reference identifier (on client side) if sent in Perform Transfer request. |
Necessity : OptionalType : StringLength : 1-128 |
Success Response Parameters
Parameter Name |
Description |
Value |
---|---|---|
invoiceId |
Transfer transaction identifier. |
Necessity : RequiredType : String |
session |
Necessity : RequiredType : Object |
|
session.checkSignature |
Checksum generated by hmac-sha1 (see Signature computation) from the concatenation of the consumer.device.serialNumber, session.nonce, destinationOfFunds.reference.serverCardId (if present), endpointId, invoiceId, sourceOfFunds.reference.serverCardId (if present). |
Necessity : RequiredType : String |
session.nonce |
Unique random string generated by Connecting Party’s server in Initiate transfer response. |
Necessity : RequiredType : String |
session.token |
The session token of transfer transaction. |
Necessity : RequiredType : String |
consumer.email |
Consumer’s email address. |
Necessity : OptionalType : String |
destinationOfFunds |
Necessity : OptionalType : Object |
|
destinationOfFunds.reference |
Necessity : OptionalType : Object |
|
destinationOfFunds.reference.serverCardId |
The destination card reference identifier (on server side). |
Necessity : OptionalType : String |
sourceOfFunds |
Necessity : OptionalType : Object |
|
sourceOfFunds.reference |
Necessity : OptionalType : Object |
|
sourceOfFunds.reference.serverCardId |
The source card reference identifier (on server side). |
Necessity : OptionalType : String |
transaction.currency |
Upper case letters (ISO 4217 alpha code). |
Necessity : OptionalType : String |
transaction.randomSumCentis |
Random sum amount (for random sum check), 1.00 EUR = 100 centis. |
Necessity : OptionalType : Integer |
Fail Response Parameters
Parameter Name |
Description |
Value |
---|---|---|
error |
Type : Object |
|
error.cause |
Cause of the error. Possible values: |
Type : Enum |
error.code |
The unique error code. |
Type : String |
error.message |
Description of the error. |
Type : String |
invoiceId |
Transfer transaction identifier. |
Type : String |
Request Example
{
"consumer": {
"device": {
"serialNumber": "string"
}
},
"destinationOfFunds": {
"reference": {
"clientCardId": "string"
}
},
"session": {
"accessToken": "string",
"nonce": "string",
"signature": "string",
"token": "string"
},
"sourceOfFunds": {
"reference": {
"clientCardId": "string"
}
}
}
Success Response Example
{
"consumer": {
"email": "string"
},
"destinationOfFunds": {
"card": {
"number": "string"
},
"reference": {
"serverCardId": "string"
}
},
"invoiceId": "string",
"session": {
"checkSignature": "string",
"nonce": "string",
"token": "string"
},
"sourceOfFunds": {
"card": {
"expiry": {
"month": "integer",
"year": "integer"
},
"holder":{
"firstName": "string",
"lastName": "string"
},
"number": "string"
},
"reference": {
"serverCardId": "string",
}
},
"transaction": {
"currency": "string",
"randomSumCentis": "integer"
}
}
Fail Response Example
{
"error": {
"cause": "enum",
"code": "string",
"message": "string"
},
"invoiceId": "string"
}