Page Comparison

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.

At present only the types below are supported. You must pass in one of the following Enums:

•TXN_FEE – equivalent of 401 with SOAPversion

•MISC_FEE – equivalent of 303 with SOAPversion

If you don’t pass a type ID then MISC_FEE “Miscellaneous Fee” is used.

Method

No

String (100)*

Relevant only if the disbursement is for a fee, this specifies how the fees to collected from the business.

The following values are supported:

•“SETTLEMENT” – The fee will be collected by reducing the amount of the transaction that is settled to the client