Sale status
Introduction
Sale status is initiated throughΒ HTTPS POSTΒ request by usingΒ URLsΒ and theΒ parameters.
Sale status request is made by Connecting Partyβs app to Billblend to get the status of sale transaction.
It is recommended to send Sale status request for a period of 2-3 minutes with interval of 3-5 seconds between requests. Connecting Partyβs server should rely on the callback for final status.
API URLs
| Integration | Production |
|---|---|
| https://sandbox.billblend.com/checkout/dapi/v1/sale/{endpointId}/{invoiceId}/status | https://pay.billblend.com/checkout/dapi/v1/sale/{endpointId}/{invoiceId}/status |
Request Parameters
| Parameter Name | Description | Value |
|---|---|---|
| session | Β | Type:Β Object |
| session.accessToken | The access token key received in Optional consumer authentication. | Type: StringLength: 32-128 |
| session.token | The session token of sale transaction. | Type: StringLength: 16-36 |
Success Response Parameters
| Parameter Name | Description | Value |
|---|---|---|
| invoiceId | Sale transaction identifier. | Type: String |
| session | Β | Type:Β Object |
| session.token | The session token of sale transaction | Type: String |
| state | Possible values:Β PROCESSING,Β REDIRECT_REQUEST,Β APPROVED,Β DECLINED. |
Type: Enum |
| bankOrderId | Required if state isΒ APPROVEDΒ orΒ DECLINED. |
Necessity: ConditionalType: StringLength: 128 |
| redirectUrl | Required if state isΒ REDIRECT_REQUEST. |
Necessity: ConditionalType: StringLength: 128 |
| orderId | Order identifier in payment processing system. | Necessity: ConditionalType: String |
| transaction | Β | Necessity: ConditionalType:Β Object |
| transaction.amountCentis | Amount of money transfered in centis, 1.00 EUR = 100 centis. | Necessity: ConditionalType: Integer |
| transaction.commissionCentis | Amount of commission held in centis (depends on the integration). | Necessity: ConditionalType: Integer |
| transaction.orderCreatedDate | Order creation date in payment processing system. | Necessity: ConditionalType: String |
| transaction.transactionCreatedDate | Transaction creation date in payment processing system. | Necessity: ConditionalType: String |
| errorCode | Decline reason code, may present if state isΒ DECLINED. |
Necessity: OptionalType: Integer |
| errorMessage | Decline reason message, may present if state isΒ DECLINED. |
Necessity: OptionalType: StringLength: 128 |
| secure3DAuthStatus | Possible values:Β AUTHENTICATED,Β NOT_AUTHENTICATED,Β UNSUPPORTED,Β UNSUPPORTEDΒ means that card does not support 3-D Secure or 3DS authentication process finished with an unknown status. |
Necessity: OptionalType: Enum |
| randomSumAuthStatus | Possible values:Β AUTHENTICATED,Β NOT_AUTHENTICATED. |
Necessity: OptionalType: Enum |
Fail Response Parameters
| Parameter Name | Description | Value |
|---|---|---|
| error | Β | Type:Β Object |
| error.cause | Cause of the error. Possible values:Β FILTERED,Β INVALID_REQUEST,Β INTERNAL_ERROR,Β PROCESSING_FAILED,Β ORDER_NOT_FOUND. |
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
{
"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
Request Builder is available at this link – https://doc.billblend.com/integration/API_commands/api_mobile_device/api_sale_status.html#request-builder