Create Payouts

This API allows partners to post the payout data to the accounting software for the sales.

Post a payout data to the accounting software

POST https://<PayEngine-host>/api/merchant/:merchantId/accounting/payouts

Request

Request Body

Name	Type	Description
id*	string	The unique identifier assigned to the payments object (for reconcilation and trouble shooting)
payouts*	array	The collection of the payouts object
payouts.payout_amount*	float	The payment amount of the payout reason
transaction_date*	timestamp	The date time representing the time of the payment (in GMT)
payouts.name*	string	The payout reason
payouts.id*	string	The unique identifier for the payout reason

200

Field Definitions

Field Name	Type	Description	Required?
transaction_reference	string	Transaction Reference number	Required
status	string	Allowed values - processed	Required

Sample Request Body

{
  "id": 3858154,
  "transaction_date": "2022-06-30T20:24:02",
  "payouts": [
    {
      "id": "23423432"
      "name": "Cash",
      "payout_amount": "112.50"
    }
  ]
}

Sample Response Body

{ 
    "transaction_reference": "guid",
    "order_number": "3858154"
    "status" : "processed"

}