API Reference
PricingSales

Charge Wallet

post
https://api-sandbox.paymentlabs.io/wallets///charges

Charges a holder's wallet: takes the amount from its balance.

The charge is processed in the same call. Retrying with the same referenceId and the same terms returns the existing charge with 200.

Errors

  • 400 VALIDATION_ERROR: a field is missing or invalid
  • 400 CHARGE_INVALID_AMOUNT: amount has more decimals than the wallet's currency allows
  • 409 CHARGE_ALREADY_EXISTS: a charge with this referenceId exists with different terms
  • 409 WALLET_INSUFFICIENT_FUNDS: the wallet balance does not cover the amount. The charge is recorded as failed
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The wallet holder's user id, as returned by Search Wallets or Bulk Invite Wallet Holders

string
required

The wallet id, as returned by Search Wallets or Bulk Invite Wallet Holders

Body Params
string

Your own reference for this charge, used as the retry guard: sending the same referenceId with the same terms returns the existing charge.
Without it, every request creates a new charge.

string
required

The amount to charge, as a decimal string in the wallet's currency

string

Description of the charge

Responses

404

The wallet does not exist, or does not belong to this holder

Updated 22 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago

Did this page help you?