Credits money from your ledger account into a holder's wallet.
Use it to pay a holder into their wallet instead of to their bank. The money lands in customerCredited, which the
holder can spend and withdraw.
Requires the Wallet Management permission (see Invite Wallet Holder).
How it works. The credit is a payment in one of your batches, created and submitted in the same call, with no
separate approval. Name an existing batch with batchId, or create one with batch. The same tax and fee rules as a
payout apply: tax withholding and fees are deducted, and creditedAmount is what reaches the wallet.
- The holder must have finished onboarding for the tax jurisdiction, or the credit is refused with
409 HOLDER_NOT_PAYABLE. - The
201response usually showspayment-created. The credit moves tocredited(orfailed) shortly after. Follow
it with Search Wallet Entries, filteringentryIdon thecreditId. No webhook is sent for credits.
Retries. Send a referenceId. A repeat with the same referenceId and the same terms returns the existing credit
with 200 and never credits twice; after a 5xx, retry this way. "Same terms" means the same sourceAmount, wallet,
holder, payorMemo and batch (batchId, or batch.name and batch.referenceId), plus paymentCategory and payeeMemo
when you send them.
Errors
400 VALIDATION_ERROR: a field is missing or invalid. Detail codes includeCREDIT_BATCH_REQUIRED(send exactly one of
batchIdandbatch),CREDIT_INVALID_PAYMENT_CATEGORY(paymentCategoryis required withbatch),
CREDIT_BATCH_INVALID(batch.nameis missing orbatch.referenceIdis not a string), or a field that is not part of
the request400 CREDIT_INVALID_AMOUNT:sourceAmounthas more decimals than the wallet's currency allows400 CREDIT_BATCH_INVALID: the batch does not exist, is archived, or cannot hold credits404 NOT_FOUND: the wallet does not exist, orholderIdis not its holder409 CREDIT_ALREADY_EXISTS: a credit with thisreferenceIdexists with different terms409 CUSTOMER_FROZEN: your wallet program is frozen. Contact Payment Labs support409 HOLDER_NOT_PAYABLE: the holder has not finished onboarding. Nothing was recorded; retry with the same
referenceIdonce they have
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
