Card on File
Charge Saved Card | Card on File API
Charge saved card via the Atoa Card on File API, request parameters, response schema and code samples in cURL, Python, JavaScript, PHP, Go and Java.
POST
Charge a customer’s saved card without them being present (off-session). The customer must have a previously saved payment method (see List Payment Methods).
Response
The response always returns
status: "PENDING" to confirm that the payment processing has started. The final status (COMPLETED, AUTHORIZED, FAILED) is updated asynchronously once the card network confirms the transaction. Use Webhooks to receive real-time status updates, or poll the Get Payment Status API.For
MANUAL_CAPTURE or CAPTURE_BEFORE_EXPIRY, the payment will move to AUTHORIZED once confirmed — you must then call Manual Capture Payment to collect the funds. For AUTO_CAPTURE, the payment moves directly to COMPLETED.Authorization
Bearer<accessSecret>
Request Body Schema
string
required
The customer UUID to charge. Must be a valid UUID.
string
required
The saved card ID from List Payment Methods response (
id field). 1-64 characters.string
required
How to capture the payment.
Possible values
Possible values
AUTO_CAPTURE— Capture immediately once confirmed. Final status:COMPLETED.MANUAL_CAPTURE— Authorize only. Final status:AUTHORIZED. Call Manual Capture Payment later to collect funds.CAPTURE_BEFORE_EXPIRY— Authorize and auto-capture before expiry if not manually captured or cancelled. Final status:AUTHORIZEDuntil captured.
number
required
Payment amount in pounds. Example:
10.50 for ten pounds fifty pence. Minimum: £1.string
required
Your merchant order reference for tracking. 1-50 characters, must not be blank.
string
Short payment description or notes. Max 30 characters.
string
Store UUID. If not provided, the merchant’s primary store is used. Refer Get Stores API.
string
Always
PENDING in the initial response. Indicates that payment processing has been initiated. The final status is updated asynchronously via webhook.number
Payment amount in pounds.
string
Currency code (e.g.,
GBP).string
Your merchant order reference.
string
The charged customer’s UUID.
string
The card used for payment.
string
The capture type used.
string
ISO 8601 timestamp.
string
When the authorization expires (only for MANUAL_CAPTURE / CAPTURE_BEFORE_EXPIRY).