GET
/getOrderStatus.doEndpoint metadata is pulled from Strapi and paired with the imported GitBook reference content below.
Get Order Status
The request used to get the order status isgetOrderStatusExtended.do
Response Codes
| Code | Description |
|---|---|
| 0 | Success |
| 2 | The order is declined because of an error in the payment credentials. |
| 5 | Access is denied. The user must change the password. orderId is empty. |
| 6 | Unregistered order Id. |
| 7 | System error. |
Order Status
| Status | Description |
|---|---|
| 0 | Order was registered but not paid; |
| 1 | Order was authorized only and wasn't captured yet (for two-phase payments); |
| 2 | Order was authorized and captured; |
| 3 | Authorization canceled; |
| 4 | Transaction was refunded; |
| 5 | Access control server of the issuing bank initiated authorization procedure; |
| 6 | Authorization declined; |
| 7 | Pending order payment; |
| 8 | Intermediate completion for multiple partial completion. |
GET /getOrderStatus.do
Gets the status of an order
{
"openapi": "3.0.0",
"info": {
"title": "BomaPay API",
"version": "1.0.0"
},
"servers": [
{
"url": "https://dev.bpcbt.com/payment/rest",
"description": "Dev Sandbox"
}
],
"paths": {
"/getOrderStatus.do": {
"get": {
"description": "Gets the status of an order",
"operationId": "orderStatus",
"parameters": [
{
"name": "userName",
"in": "query"
},
{
"name": "password",
"in": "query"
},
{
"name": "orderId",
"in": "query"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderStatusResponse"
}
}
}
},
"400": {
"description": "invalid input, object invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderFailureResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"OrderStatusResponse": {
"type": "object",
"properties": {
"expiration": {
"type": "string"
},
"cardholderName": {
"type": "string"
},
"depositAmount": {
"type": "integer"
},
"currency": {
"type": "string"
},
"authorizationResponseId": {
"type": "string"
},
"ErrorCode": {
"type": "string"
},
"ErrorMessage": {
"type": "string"
},
"OrderStatus": {
"type": "string"
},
"OrderNumber": {
"type": "string"
},
"Pan": {
"type": "string"
},
"Amount": {
"type": "integer"
}
}
},
"OrderFailureResponse": {
"required": [
"errorCode",
"errorMessage"
],
"type": "object",
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
}###
POST /getOrderStatus.do
Registers an order
{
"openapi": "3.0.0",
"info": {
"title": "BomaPay API",
"version": "1.0.0"
},
"servers": [
{
"url": "https://dev.bpcbt.com/payment/rest",
"description": "Dev Sandbox"
}
],
"paths": {
"/getOrderStatus.do": {
"post": {
"description": "Registers an order",
"operationId": "registerOrder",
"requestBody": {
"description": "Order item to register",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderStatus"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderStatusResponse"
}
}
}
},
"400": {
"description": "invalid input, object invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderFailureResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"OrderStatus": {
"required": [
"userName",
"password"
],
"type": "object",
"properties": {
"userName": {
"type": "string"
},
"password": {
"type": "string"
},
"orderId": {
"type": "string",
"minLength": 1,
"maxLength": 32
}
}
},
"OrderStatusResponse": {
"type": "object",
"properties": {
"expiration": {
"type": "string"
},
"cardholderName": {
"type": "string"
},
"depositAmount": {
"type": "integer"
},
"currency": {
"type": "string"
},
"authorizationResponseId": {
"type": "string"
},
"ErrorCode": {
"type": "string"
},
"ErrorMessage": {
"type": "string"
},
"OrderStatus": {
"type": "string"
},
"OrderNumber": {
"type": "string"
},
"Pan": {
"type": "string"
},
"Amount": {
"type": "integer"
}
}
},
"OrderFailureResponse": {
"required": [
"errorCode",
"errorMessage"
],
"type": "object",
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
}The OrderStatus object
{
"openapi": "3.0.0",
"info": {
"title": "BomaPay API",
"version": "1.0.0"
},
"components": {
"schemas": {
"OrderStatus": {
"required": [
"userName",
"password"
],
"type": "object",
"properties": {
"userName": {
"type": "string"
},
"password": {
"type": "string"
},
"orderId": {
"type": "string",
"minLength": 1,
"maxLength": 32
}
}
}
}
}
}