Credit Wallet

post

https://api-sandbox.paymentlabs.io/wallets/{holderId}/{walletId}/credits

Credits a holder's wallet.

The credit creates a virtual payment in a batch and submits it in the same call, so this call is the approval.
The credit becomes 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

holderId

string

required

The wallet holder's user id

walletId

string

required

Body Params

referenceId

string

Your own reference for this credit. Retrying with the same referenceId and the same terms returns the existing credit instead of creating a new one

sourceAmount

string

required

The amount to credit, as a decimal string in the wallet's currency (e.g. "125.50")

paymentCategory

string

enum

Category of the virtual payment. Defaults to the batch's category, and is required when batch is given

taxJurisdiction

string

enum

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

batchId

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

payorMemo

string

Memo visible to the payor

payeeMemo

string

Memo visible to the holder

Responses

404

The wallet could not be found

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A credit with the same referenceId and terms already exists

201The credit has been created

401Unauthorized response, when the user is not authenticated or the authentication token is missing in the header.

403 Forbidden response, when the user is authenticated but does not have the necessary permissions.

409The credit was refused: CREDIT_ALREADY_EXISTS - a credit with this referenceId exists with different terms CUSTOMER_FROZEN - the wallet program is frozen HOLDER_NOT_PAYABLE - the holder has not finished onboarding