Skip to main content
POST
/
payout
/
v1
/
connected-wallet
/
debit
Debit Connected Wallet
curl --request POST \
  --url https://api.example.com/payout/v1/connected-wallet/debit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "paymentInstrumentId": "<string>",
  "referenceId": "<string>",
  "remarks": "<string>"
}
'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Debit successful",
  "data": {
    "referenceId": 4379710,
    "message": "Amount deducted from the merchant balance"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request payload to debit a connected wallet

​
amount
number<decimal>
required

The amount to be debited in decimal value up to 2 precision

​
paymentInstrumentId
string
required

Identifier for the payment instrument

​
referenceId
string

Identifier for the debit transaction

​
remarks
string

Remarks for the debit transaction

Response

Debit successful

​
status
string

The status of the request

​
subCode
string

A code identifying the response or error

​
message
string

A message describing the outcome of the request

​
data
object