Transaction Details
This endpoint returns order transaction details
Resource URL
For live environment, please update the endpoint to https://api.optty.com
Headers
Key | Value |
---|---|
Content-Type | application/json |
Authorization | Bearer {GENERATED_ACCESS_TOKEN} |
Parameters
Grand Parent/Parent Request Parameters
Field | Type | Description | Required |
---|---|---|---|
merchantReference | string | The order reference generated for merchant | Yes |
merchantId | string | The merchantId that belongs to GP/P | Yes |
Merchant Request Parameters
Field | Type | Description | Required |
---|---|---|---|
merchantReference | string | The order reference generated for merchant | Yes |
Success Response Parameters
Field | Type | Description |
---|---|---|
merchantReference | string | The merchant reference passed in the request |
status | string | The status of the order transaction |
amount | numeric | The total order amount |
currency | string | The currency used for the order transaction |
provider | string | The BNPL provider processing the order transaction |
updatedAt | string | The last time an update was made to the order transaction |
failureReason | string | The Failure reason for the error transactions |
bnplOrderId | string | The BNPL OrderId for the transactions |
transactionReference | string | The unique transaction reference |
transactionHistory | array | The transaction history list |
transactionHistory[0].transactionId | string | The Id generated for the transaction |
transactionHistory[0].status | string | The status of the transaction |
transactionHistory[0].createdAt | string | The time the transaction was created |
refunds | array | The refunds made on order |
refunds[0].refundId | string | The unique generated refund Id |
refunds[0].amount | string | The order amount to be refunded |
refunds[0].currency | string | Refund currency |
refunds[0].status | string | The status of the order refund |
refunds[0].createdAt | string | The time the refund was created |
refunds[0].refundReason | string | The reason for the refund |
refunds[0].refundFailureReason | string | The reason the refund failed |
orderCaptures | array | Order captures |
orderCaptures[0].captureId | string | The reference submitted upon requesting for capture |
orderCaptures[0].amount | string | The captured amount |
orderCaptures[0].status | string | The order capture status |
orderCaptures[0].createdAt | string | The time order capture request was created |
Sample Success Response
Sample Failure Response
Last updated