Create Payout

This API is used to create a payout to the payee

Create a Payout

POST https://<Platform-host>/api/payouts/:merchant_id/payout

Path Parameters

Name	Type	Description
merchant_id*	string	Merchant ID

Request Body

Name	Type	Description
payee_token*	string	Payee Unique ID
client_transfer_id*	string	A client defined transfer identifier. This is the unique ID assigned to the transfer on your system. Max 50 characters.
source_currency*	string	Source Payment Currency. Currency code using ISO 4217 format. e.g. USD
source_amount*	float	Source Payment Amount
payment_description	string	Optional descriptive line item that appears on the payout statement, providing details about the transaction. This field is intended to help identify the purpose or source of each payout by displaying a brief summary or itemized description. Commonly includes information such as transaction type, merchant name, or payout reason. Note: Not all countries and banks support displaying this field. length ≤ 140

200

Field Definitions

Name	Type	Description
merchant_id*	string	Merchant ID
payout_token*	string	Unique Payout ID
status*	string	Payout Status
status_reason*	string	Reason related to status if any e.g. in case of an error
payee_token*	string	Payee Unique ID
client_transfer_id*	string	A client defined transfer identifier. This is the unique ID assigned to the transfer on your system. Max 50 characters.
source_currency	string	Source Payment Currency. Currency code using ISO 4217 format. e.g. USD
source_amount*	string	payment amount e.g 100.75
target_currency	string	Target Payment Currency. Currency code using ISO 4217 format. e.g. USD
target_amount	string	Target Payment Amount
conversion_rate	string	source to target amount conversion rate
estimated_availability	string	estimated date of payment
payment_description	string	Optional descriptive line item that appears on the payout statement, providing details about the transaction. This field is intended to help identify the purpose or source of each payout by displaying a brief summary or itemized description. Commonly includes information such as transaction type, merchant name, or payout reason. Note: Not all countries and banks support displaying this field.

Sample Request Body

{
    "merchant_id":"1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
    "data": {  
            "payee_token":"123e4567-e89b-12d3-a456-426614174000",
            "client_transfer_id":"84630957653",
            "source_currency":"USD",
            "source_amount":"3000.75",
            "payment_description":"Test Payment"
         }
}

Sample Response Body

{
 "merchant_id":"1cc7b594-b80f-4227-a0fa-299c4c6ce8ab", 
 "payout_token":"ba4275f2-bae1-488d-9d6f-20af1cd83574"
 "status":"Pending",
 "status_reason":"Test Reason",
 "payee_token":"123e4567-e89b-12d3-a456-426614174000",
 "client_transfer_id":"84630957653",
 "source_currency":"USD", 
 "source_amount":"3000.75",
 "target_currency":"USD",
 "target_amount":"3000.75",
 "conversion_rate":"0.00",
 "estimated_availability":"2020-10-02T17:32:28Z",
 "payment_description":"Test Payment"
}