Skip to main content
POST
Capture an authorized payment

Authorizations

x-api-key
string
header
required

API key for service-to-service or merchant authentication.

Headers

x-correlation-id
string<uuid>

Unique identifier for request tracing. Generated by the client or server if not provided.

Example:

"550e8400-e29b-41d4-a716-446655440000"

x-idempotency-key
string<uuid>

Unique key for idempotent request processing. Duplicate requests with the same key are safely ignored.

Example:

"baf6a8e2-0c89-46ef-9ca5-faa65b99bcd5"

Path Parameters

payment_id
string<uuid>
required

Unique identifier of the payment

Example:

"9822ffb8-26de-423b-ad15-0d129cf1b4ac"

Body

application/json

Capture an authorized payment

Capture amount and metadata. If amount is omitted, the full authorized amount is captured.

amount
integer

Amount to capture in minor units (e.g. 10000 for 100.00 SAR). Omit to capture full authorized amount.

Required range: x >= 1
Example:

10000

is_final
boolean

Whether this is the final capture for the payment

Example:

false

metadata
object

Additional metadata

Example:

Response

Payment accepted for processing.

payment
object
required

Available action links (HATEOAS)