| Name | Description | Type | Additional information |
|---|---|---|---|
| beneficiary_id |
Beneficiary ID |
string |
None. |
| currency |
CCY |
string |
None. |
| purpose |
Purpose of payment |
string |
None. |
| fee |
Charge direction OUR|SHA|BEN (default to SHA) |
string |
None. |
| amount |
Amount instructed |
string |
Required |
| payment_reference |
Your Reference on payment |
string |
None. |
| trade_ref |
The trade Reference of the trade used to instruct this payment, set to blank if this Payment is not linked to FX trade, or set to "auto" to attempt to retrieve available trade. |
string |
None. |
| payment_guid |
A GUID defined by yourself that can be used to retrieve payment |
string |
None. |
| client_ref |
client reference |
string |
None. |
| status |
Payment Status (pending | paid | ...) |
string |
None. |
| created_by_id |
The contact that created the OPI |
integer |
None. |