Skip to main content

Credit an account

POST 

/v1/accounts/:account_id/credit

Adds money to an account, increasing both ledger_balance and available_balance.

There are two ways to prevent duplicate credits, and you should use both:

  • Idempotency-Key protects against retries. Using the same key within 24 hours returns the stored response instead of creating another credit.
  • client_transaction_id identifies the actual credit. It must be unique for the account and doesn't expire. Reusing the same ID with the same amount returns 200 with Idempotent-Replay: true and doesn't move any money. Reusing it with a different amount returns 409 adjustment_already_applied.

Send both on every funding request.

Request​

Responses​

The updated account. Carries Idempotent-Replay: true when the client_transaction_id had already been applied.

Response Headers
    Idempotent-Replay

    true when this response reproduces an earlier one — the same Idempotency-Key, or the same client_transaction_id, seen before. Absent otherwise.