Skip to main content

Execute Payout

Endpoint : POST https://api.zamp.finance/api/client/:clientid/customer/:customerid/transfer/execute

This API will execute the payout

Request Body

KeyTypeDescriptionRequired
quote_idstringQuote id generated from rfqYes
reference_idstringThis helps us cross reference orders of merchant's systems associated with payout sessionYes

Request JSON Representation

{
"quote_id": "test_vBug39YoTmvemwvddTnZi3_11_29",
"account_id":"test_63ug39fobvvemwvddTnmib_11_29",
"beneficiary_id":"test_beug39IoytvemwvddTnBIm_11_29",
"reference_id": "test_reference_id"
}

Response Body

KeyValueDescription
idtest_rfAPE5VspwyVgD4zzfoEvk_12_02This is the UUID with which merchant can uniquely identify a payout session on Zamp systems
messageTransaction QueuedStatus of the payout session

Response JSON Representation

{
"data": {
"id": "rfAPE5VspwyVgD4zzfoEvk_12_02",
"message": "Transaction Queued"
}
}

Error Codes

HTTP CodeError ResponseDescription
403{"code":"ACCESS_FORBIDDEN","message":"You are not authorized to access this record."}The Merchant is not allowed to access the requested resource (quote, corridor).
400{"code":"QUOTE_EXPIRED","message":"This quote is expired"}The requested quote has expired.
400{"code":"ALREADY_PROCESSED","message":"Transaction Already Processed"}The requested quote has already been processed.
400{"code":"AMOUNT_NOT_WITHIN_LIMITS","message":"Amount is not within limits."}The source or receiving amounts are not within acceptable limits.
400{"code":"INSUFFICIENT_BALANCE","message":"Balance is not sufficient for this transaction"}The source account balance is not sufficient for the requested transaction.