Verification status
Introduction
API URLs
Integration |
Production |
---|---|
https://sandbox.gitpay.tech/paynet/dapi/v1/verification/{endpointId}/{invoiceId}/status |
https://gate.gitpay.tech/paynet/dapi/v1/verification/{endpointId}/{invoiceId}/status |
Request Parameters
Parameter Name |
Description |
Value |
---|---|---|
session |
Necessity : RequiredType : Object |
|
session.accessToken |
The access token key received in Optional consumer authentication. |
Necessity : RequiredType : StringLength : 32-128 |
session.token |
The session token of verification transaction. |
Necessity : RequiredType : StringLength : 16-36 |
Success Response Parameters
Parameter Name |
Description |
Value |
---|---|---|
invoiceId |
Verification transaction identifier. |
Type : String |
session |
Type : Object |
|
session.token |
The session token of verification transaction. |
Type : String |
state |
Possible values: |
Type : Enum |
bankOrderId |
Required if state is |
Necessity : ConditionalType : StringLength : 128 |
redirectUrl |
Required if state is |
Necessity : ConditionalType : StringLength : 128 |
errorCode |
Decline reason code, may present if state is |
Necessity : OptionalType : IntegerLength : 128 |
errorMessage |
Decline reason message, may present if state is |
Necessity : OptionalType : StringLength : 128 |
secure3DAuthStatus |
Possible values: |
Necessity : OptionalType : Enum |
randomSumAuthStatus |
Possible values: |
Necessity : OptionalType : Enum |
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 |
Verification transaction identifier. |
Type : String |
Request Example
{
"session": {
"accessToken": "string",
"token": "string"
}
}
Success Response Example
{
"bankOrderId": "string",
"invoiceId": "string",
"redirectUrl": "string",
"session": {
"token": "string"
},
"state": "enum"
}
Fail Response Example
{
"error": {
"cause": "enum",
"code": "string",
"message": "string"
},
"invoiceId": "string"
}
Request Builder