Sign in
Wallets

Top up wallet

Use when adding funds to a wallet (e.g. top-up, refund, or manual credit). Supports optional idempotency via reference.

post/wallets/{id}/top-up

Path parameters

idstring required

Wallet ID

Request body

amountstring

amount is the amount in the currency of the wallet to be added NOTE: this is not the number of credits to add, but the amount in the currency amount = credits_to_add * conversion_rate if both amount and credits_to_add are provided, amount will be ignored ex if the wallet has a conversion_rate of 2 then adding an amount of 10 USD in the wallet wil add 5 credits in the wallet

credits_to_addstring

credits_to_add is the number of credits to add to the wallet

descriptionstring

description to add any specific details about the transaction

expiry_date_utcstring

expiry_date_utc is the expiry date in UTC timezone ex 2025-01-01 00:00:00 UTC

idempotency_keystring

idempotency_key is a unique key for the transaction

metadataTypesMetadata
priorityinteger

priority is the priority of the transaction lower number means higher priority default is nil which means no priority at all

transaction_reason'INVOICE_PAYMENT' | 'FREE_CREDIT_GRANT' | 'SUBSCRIPTION_CREDIT_GRANT' | 'PURCHASED_CREDIT_INVOICED' | 'PURCHASED_CREDIT_DIRECT' | 'CREDIT_NOTE' | 'CREDIT_EXPIRED' | 'WALLET_TERMINATION' | 'MANUAL_BALANCE_DEBIT' | 'CREDIT_ADJUSTMENT' | 'INVOICE_VOID_REFUND' required

Response

OK

invoice_idstring

Invoice ID if an invoice was created (only for PURCHASED_CREDIT_INVOICED)

Changes