For approved businesses, the “Disbursements” parameters of Payrix’s real-time transaction APIs POST Make a live card transaction, POST Make a live tokenized card transaction and via Hosted Payment Page Tokens.
It can be used to specify custom disbursements/fees on a transaction-by-transaction basis. To do this, a JSON array with the format described below can be passed into the “Disbursements” parameter.
Examples:
Make a live card transaction (both card-provided and via token versions)
Creating a HPP token
Data Table
Field | Required | Value Type | Description |
|---|---|---|---|
BusinessID | Yes | Integer (5) | Payrix will provide you with a list of the IDs of the businesses associated with your account to which you are able to distribute funds. |
Amount | Yes | Decimal (10,2) | The amount to be paid out. The total amount of all disbursements must not exceed the transaction amount. |
ID | No | String (100)* | You have the option of including an ID from your system to identify each disbursement. Please note: Payrix does not currently provide any reporting on this ID. |
Description | No | String (100)* | You have the option of suppling a custom description for the fee/disbursement that can replace the standard type name displayed on reports such as the processing report and tax invoices that are sent to clients. |
Type | No | String (100)* | The type of fee/disbursement that the payout is for. This type is displayed on reports such as the processing reports and tax invoices that are sent to clients.
|
Method | No | String (100)* | Relevant only if the disbursement is for a fee, this specifies how the fees to collected from the business.
|
** No XML characters can be passed to the strings.