Account API
GET /v1/account/
Attribute | Description | Type |
N/A | | |
Attribute | Type | Condition | Description |
Destination Country | String | Mandatory | |
Destination Bank Identifier | String | Conditional | Identification of Destination Bank in local format eg sort code, BSB code. Mandatory if Destination Bank Account Number is filled in |
Destination Bank Account Number | String | Conditional | Bank Account number, mandatory if alias not present |
Destination Bank Account Alias | String | Conditional | Any valid alias. Mandatory if bank account number not present |
Value at Destination | String | Optional | Value of payment in Destination Currency so that Destination Bank is able to calculate any fees accordingly |
Quote ID | String | Mandatory | Required so Nexus can confirm the FXP has not blacklisted the Destination Bank and can inform the FX Provider for the probable payment to follow, via the webhook defined above |
Attribute | Type | Condition | Description |
Destination Bank Identifier | String | Mandatory | |
Destination Bank Account Number | String | Mandatory | |
Destination Bank Account Holder Name | String | Optional | May be send by the Alias Conversion or the Destination Bank in the account validation response |
Destination Bank Fees | String | Mandatory | Fees levied by Destination Bank on Recipient, in case Source Bank wants to offer Sender the option to cover these fees |
Destination Bank Account Status | String | Mandatory | |
Errors | Array | Optional | Reasons for account validation failure |
This step is triggered by Nexus as it responds to the Account Validation request above. The Alias Conversion request will follow local standards, as configured by the Destination IPS, as this is a request from the Nexus Gateway to the Destination IPS or Destination Bank (depending on the local alias arrangements). However, as a minimum, the Destination IPS / Bank must return the following information to the Nexus Gateway:
Response – Minimum Fields
Field | Condition |
Destination Bank Account Holder Name | Optional |
Destination Bank Account Number | Mandatory |
Destination Bank Identifier | Mandatory |
This step is triggered by Nexus as it responds to the Account Validation request above. The Account Validation request towards the Destination Bank will follow local standards, as configured by the Destination IPS, as this is a request from the Nexus Gateway to the Destination Bank. However, as a minimum, the Destination Bank must return the following information to the Nexus Gateway:
Response – Minimum Fields
Field | Condition |
Destination Bank Account Holder Name | Optional |
Destination Bank Account Status | Mandatory |
Destination Bank Fees | Mandatory |
This step is triggered by Nexus as it responds to the Account Validation request above. The Check Availability request will follow local standards, as configured by the Destination IPS, as this is a request from the Nexus Gateway to the local IPS. However, as a minimum, the Destination IPS or Destination Bank must return the following information to the Nexus Gateway:
Response – Minimum Fields
Field | Condition |
Destination Bank Status | Mandatory |
Destination Bank Planned Unavailability | Optional |