Adding sub customer details to FX Transaction
There are 2 options to add your customer details to a FX Transaction.
Option 1: Add your customer prior to the creation of a FX Transaction.
1 : Create a sub-customer
When you create a sub-customer, please enter Individual or Company in the "sub_customer.account_type.name" . There are specific required data fields for each account type. Please refer to the table below:
For Individual | For Company |
|---|---|
First Name (Mandatory) | Company Name (Mandatory) |
Last Name (Mandatory) | Company Registration Number |
Mobile | Mobile |
Address Line 1 (Mandatory) | Address Line 1 (Mandatory) |
Address Line 2 | Address Line 2 |
City | City |
Postcode | Postcode |
Country (Mandatory) | Country (Mandatory) |
Once confirmed, you will be presented with a "sub_customer.id" for usage in Create a transaction quote.
{
"sub_customer": {
"id": 10262,
"status": "active",
"gender": null,
"birth_date": null,
"company_name": "Lemons",
"registration_number": "12345567",
"account_type": {
"id": 10001,
"name": "Individual"
},
"name": {
"first_name": "Kevin",
"middle_name": "",
"last_name": "Lowe"
},
"country": {
"id": 10004,
"name": "Australia",
"country_code": "AUS"
},
"address": {
"address_line_1": "123 Test Street",
"address_line_2": null,
"suburb": "Kensley",
"city": null,
"province": "NSW",
"postcode": "2034",
"country_code": "AUS"
},
"created_date": "2026-03-27T11:46:47+11:00",
"updated_date": "2026-03-27T11:46:47+11:00"
}
}Option 2: Add your customer as part of the creation of a FX Transaction.
You can add a your customer details during Create a transaction quote. step. Below is the request to be added under "transaction.payments[0].sub_customers[0]" into the request sequence.
{
"transaction": {
"base_currency_id": 0,
"base_currency_code": "USD",
"counter_currency_id": 0,
"counter_currency_code": "USD",
"base_currency_amount": 0.1,
"counter_currency_amount": 0.1,
"value_date": "2026-03-27",
"base_currency_account_id": 0,
"exchange_rate": 0.1,
"profit_amount": 0.1,
"profit_percentage": 0.1,
"wholesale_rate": 0.1,
"update_rate_reason_id": 0,
"rate_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payments": [
{
"beneficiary_id": 0,
"amount": 0.1,
"payment_reference": "Payment for services",
"payment_type": "CHAPS",
"transaction_reason_id": 0,
"transaction_reason_name": "string",
"transaction_reason_other": "string",
"sub_customer_ids": [
0
],
"sub_customers": [
{
"country_id": 0,
"country_code": "USA",
"account_type_id": 0,
"account_type_name": "Individual",
"email": "[email protected]",
"gender": "male",
"birth_date": "2026-03-27",
"company_name": "string",
"registration_number": "string",
"name": {
"first_name": "John",
"middle_name": "James",
"last_name": "Doe"
},
"mobile": {
"isd": "64",
"number": "1234567890"
},
"phone": {
"isd": "64",
"number": "1234567890"
},
"address": {
"address_line_1": "123 Main St",
"address_line_2": "string",
"suburb": "Manhattan",
"city": "New York",
"province": "NY",
"postcode": "10001",
"country_code": "USA"
}
}
]
}
]
}
}Once confirmed, you will be presented with a "transaction.payments[0].sub_customers.id" within the Create a transaction quote. response body. This means that a deal transaction and sub customer has been created.
{
"transaction": {
"id": 214065,
"customer_id": 12905,
"user_id": 13392,
"status": "created",
"status_label": "Created",
"base_currency": {
"id": 10004,
"name": "Australian Dollar",
"currency_code": "AUD"
},
"counter_currency": {
"id": 10001,
"name": "US Dollar",
"currency_code": "USD"
},
"base_currency_amount": "22.08",
"counter_currency_amount": "15.00",
"receipt_amount": "52.08",
"receipt_account": {
"id": 10040,
"name": "AUD Account",
"receipt_text": "BSB: 802-985\nAccount Number: 115727675\nPayID: \n",
"bank_account": {
"account_number": "115727675"
}
},
"fees": "30.00",
"payments": [
{
"id": 162318,
"status": "pending",
"amount": "15.00",
"fee": "30.00",
"beneficiary": {
"id": 24567,
"name": {
"first_name": "Peter",
"middle_name": null,
"last_name": "Rabbit"
},
"status": "approved_by_client",
"country": {
"id": 10131,
"name": "United States",
"country_code": "USA"
},
"currency": {
"id": 10001,
"name": "US Dollar",
"currency_code": "USD"
},
"created_date": "2025-11-06T11:22:38+11:00",
"updated_date": "2025-11-06T11:22:38+11:00"
},
"payment_reference": null,
"payment_type": null,
"transaction_reason": {
"id": 10451,
"name": "Goods Trade"
},
"sub_customers": [
{
"id": 10263,
"status": "active",
"gender": null,
"birth_date": null,
"company_name": "Jenny Co",
"registration_number": "23465",
"account_type": {
"id": 10001,
"name": "Individual"
},
"name": {
"first_name": "Jenny",
"middle_name": null,
"last_name": "Smith"
},
"country": {
"id": 10004,
"name": "Australia",
"country_code": "AUS"
}
}
],
"created_date": "2026-03-27T14:23:08+11:00",
"updated_date": "2026-03-27T14:23:08+11:00"
}
],
"exchange_rate": "0.6793",
"value_date": "2026-03-31",
"created_date": "2026-03-27T14:23:03+11:00",
"updated_date": "2026-03-27T14:23:09+11:00"
}
}