API Reference
PricingSales

Credit Wallet

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

Credits a holder's wallet.

The credit creates a virtual payment in a batch and submits it in the same call. There is no separate approval step.
The credit moves to credited once the payment completes. Use an existing batch with batchId, or create one with batch.

Retrying with the same referenceId and the same terms returns the existing credit with 200.

Errors

  • 400 VALIDATION_ERROR: a field is missing or invalid, including sending neither or both of batchId and batch (CREDIT_BATCH_REQUIRED)
  • 400 CREDIT_INVALID_AMOUNT: sourceAmount has more decimals than the wallet's currency allows
  • 400 CREDIT_BATCH_INVALID: the batch cannot take this payment
  • 409 CREDIT_ALREADY_EXISTS: a credit with this referenceId exists with different terms
  • 409 CUSTOMER_FROZEN: the wallet program is frozen
  • 409 HOLDER_NOT_PAYABLE: the holder has not finished onboarding. Nothing was recorded, so retry with the same referenceId once they have
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 credit, used as the retry guard: sending the same referenceId with the same terms returns the existing credit.
Without it, every request creates a new credit.

string
required

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

string
enum

Category of the virtual payment. Defaults to the batch's category. Required when batch is sent

string
enum

Tax jurisdiction of the virtual payment. Defaults to the batch's jurisdiction

string

An existing batch for the virtual payment. Send exactly one of batchId or batch

batch
object

A new batch to create for the virtual payment. Send exactly one of batchId or batch

string

Memo visible to the payor

string

Memo visible to the holder

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?