Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Card Funding

Card Recharge

Card recharge is applicable to both SINGLE and SHARE mode cards.

post/v1/issuing/cards/{id}/recharge

Path parameters

idstring uuid required
Example:b3d9d2d5-4c12-4946-a09d-953e82sed2b0

Universally unique identifier (UUID v4) of a resource.

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring uuid

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Request body

amountstring required

Response

Card recharge successfully.

card_idstring required

Unique identifier for the card.

card_order_idstring required

ID of the card order.

order_type'CARD_CREATE' | 'CARD_RECHARGE' | 'CARD_WITHDRAW' | 'CARD_UPDATE' | 'CARD_ELEVATE_LIMIT' required

The order type.

amountstring required
card_currency'SGD' | 'USD' | 'XUSD' required

The card currency.

create_timestring date/time required

The timestamp when the record was created in the system. Timestamp follows the ISO 8601 standard.

update_timestring date/time required
complete_timestring date/time nullable required

The timestamp when the request was successfully processed and marked as COMPLETED. Returns null while the request is still in progress.

order_status'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' required

This field will contain the status of the request after processing.

  • PENDING -The initial status of the order request.
  • PROCESSING - If this status shall be subject to webhooks notification.
  • SUCCESS - The final status of the order request is successful.
  • FAILED - The final status of the order request is failed.

Example response

{
  "card_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7",
  "card_order_id": "c0cef051-29c5-4796-b86a-cd5ee34bfad7",
  "order_type": "CREATE_CARD",
  "card_currency": "USD",
  "create_time": "2024-03-01T00:00:00+08:00",
  "update_time": "2024-03-01T00:00:00+08:00",
  "complete_time": "2024-03-01T00:00:00+08:00"
}