Capture a Payment Request

This reference describes the server-side API used to capture a payment. Use this endpoint after a transaction has been authorized to finalize the payment process.

Endpoint

Method: POST

Environment	Base URL
Sandbox	https://sandbox.codapayments.com/airtime/api/restful/v2.0/Payment/capture
Production	https://airtime.codapayments.com/airtime/api/restful/v2.0/Payment/capture

Request Body

The request body must be sent in JSON format and include the following parameters:

Parameter	Type	Required	Description
capturePaymentRequest.apiKey	string	Yes	Your Coda API key for authentication.
capturePaymentRequest.projectId	string	Yes	The unique identifier for your project.
capturePaymentRequest.txnId	string	Yes	The transaction ID associated with the payment to be captured.

Example Request

{
  "capturePaymentRequest": {
    "apiKey": "your_api_key_here",
    "projectId": "your_project_id",
    "txnId": "123456789"
  }
}

Response

A successful request returns a confirmation that the capture request has been acknowledged.

Example Response

{
  "capturePaymentResult": {
    "status": "received",
    "txnId": "123456789"
  }
}