Transaction Management API

Capture Payment

/v1/payments/{transactionId}/capture

This endpoint allows the merchant to capture an authorized payment transaction. The transaction must have been previously authorized and is now ready to be finalized. The payment capture is for the specified amount, and if the full amount is captured, the authorization will be marked as complete.

Request parameters

Responses

{
  "id": "05e99c36-499d-4a6f-9e5d-e93d3eb8e63e",
  "responseCode": "00",
  "networkTransactionReference": "0000003877089021874A",
  "authCode": "231351",
  "amount": 56.41,
  "orderReference": "1667207373325",
  "remainingBalance": 56.41,
  "success": "true",
  "message": "Successfully captured the transaction"
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

Refund Payment

/v1/payments/{transactionId}/refund

This endpoint allows a merchant to refund a previously captured payment. The refund amount can be partial or full, and the refund will be processed according to the transaction's original payment method.

Request parameters

{
  "orderReference": "1667207373325",
  "description": "Refund of payment for order #1667207373325"
}

Responses

{
  "id": "56b5f4ac-c95e-4b89-bd2d-3cf7369857ef",
  "responseCode": "00",
  "networkTransactionReference": "0000021266523063630A",
  "authCode": "856156",
  "amount": 15.55,
  "orderReference": "1667207373325",
  "remainingBalance": 40.86,
  "success": "true",
  "message": "Successfully refunded the transaction",
  "originalTransactionId": "c3bcfd40-285b-496a-82c3-ce1c2271aae2"
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

Cancel Payment

/v1/payments/{transactionId}/cancel

This endpoint allows the merchant to cancel a previously authorized payment transaction before it is captured. The authorization will be voided, and no further charges will occur.

Request parameters

Responses

{
  "id": "05e99c36-499d-4a6f-9e5d-e93d3eb8e63e",
  "responseCode": "00",
  "networkTransactionReference": "0000021266523063630A",
  "success": "true",
  "message": "Transaction successfully canceled."
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

{
  "message": "An error occurred while processing your request.",
  "code": 1012
}

26 August 2025