Artha API
  1. Funding
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Update Customer
      PATCH
  • Cards
    • Submit KYC/KYB Applicant
      POST
    • Issue Card
      POST
    • Cards List
      GET
    • Get Card
      GET
    • Get Sensitive Card Details
      GET
  • Card Operations
    • Activate Card
      POST
    • Freeze Card
      POST
    • Unfreeze Card
      POST
    • Cancel Card
      POST
    • Replace Card
      POST
    • Set / Reset Card PIN
      POST
    • Get Card Limits
      GET
    • Update Card Limits
      POST
  • Funding
    • Top Up Card
      POST
    • Get Card Balance
      GET
    • List Top-Up History
      GET
  • Transactions
    • List All Transactions
      GET
    • List Card Transactions
      GET
    • List Customer Transactions
      GET
    • Get Transaction
      GET
  • Products
    • List Products
    • Get Product
  • Utilities
    • Upload Documents
  • Webhook's
    • Webhooks
  1. Funding

Top Up Card

POST
{{baseUrl}}/api/v1/cards/{cardId}/topup
Loads funds onto a card. Returns 202 Accepted — the top-up is processed asynchronously.
The amount must be a positive number
currency must match the card's currency (3-letter ISO 4217 code, e.g., "GBP", "USD", "EUR")
The task_id in the response can be used to track processing status
Top-up fees are applied according to the product's fee schedule
Use GET /cards/{cardId}/balance to confirm the updated balance after processing.

📋 Request Body Fields#

⚠️ Required Fields
FieldTypeDescriptionConstraints
amountnumber (double)Amount to load onto the card. Must be positive. Example: 500.0-
currencystringISO 4217 currency code. Must match the card's currency. Example: GBP-

📤 Response Fields#

FieldTypeDescriptionNotes
card_idstring (uuid)--
amountnumber- Example: 500.0-
currencystring- Example: GBP-
statusstringProcessing status: processing, completed, failed. Example: processing-
transaction_idstring-nullable
task_idstring-nullable
performed_atstring (date-time)--

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢202
application/json
Top-up accepted for processing.
Body

🟠401
🟠404
🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST '{{baseUrl}}/api/v1/cards/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11/topup' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 500,
    "currency": "GBP"
}'
Response Response Example
202 - Success
{
    "data": {
        "card_id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
        "amount": 500,
        "currency": "GBP",
        "status": "processing",
        "transaction_id": "txn_topup_001",
        "task_id": "task_001",
        "performed_at": "2024-01-15T10:30:00Z"
    }
}
Modified at 2026-02-18 13:25:10
Previous
Update Card Limits
Next
Get Card Balance
Built with