Capture Payment

Captures a payment that was previously authorized by creating an intent with manualCapture set to true.

POST /payments/capture-payment

cURL

cURL

curl --request POST \
  --url https://api.xpaycheckout.com/payments/capture-payment \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intentId": "in_fooBOwYsaK50AEfK"
}
'

200

{
  "status": "SUCCESS",
  "errorCode": null,
  "errorMessage": null
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Idempotency-Key · string

A unique key for making the request idempotent. Must match pattern: ^[a-zA-Z0-9\-_:\.]+$. See Idempotent Requests for more details.

Maximum string length: 255

Pattern: ^[a-zA-Z0-9\-_:\.]+$

Body

application/json

Capture Payment

intentId · string · required

Unique identifier of the previously authorized payment intent

Example:

"in_fooBOwYsaK50AEfK"

Response

200

application/json

Capture Payment response

status · string

Current status of the payment intent. Refer to payment statuses.

Example:

"SUCCESS"

errorCode · string | null

Machine-readable error code when the capture is unsuccessful. Refer to error codes.

Example:

null

errorMessage · string | null

Human-readable error message when the capture is unsuccessful.

Example:

null