Creating Any-to-Any Currency Payouts via Batch or API
The Payout Data File or API Request is the source of truth for new Payouts. The HEV payout process starts when new payout records are received with the related HEV fields filled out and successfully processed by Latitude.
How it WorksWhen a non-USD payout is created using QBSA, Latitude fetches the historical USD equivalent (interbank/ECB rate) on the original payment date. That USD value becomes the new fixed liability. If the recipient collects in their original currency, Latitude converts the payout to QBRA after processing. More details about the Any-to-Any Currency Option can be found here.
Data File Example
File Naming Convention (Excel)
Example: Acme_ReadyRemit_TransferRequest_Data_20230101110000.xlsx
To enable Historical Equivalent Value, the HEV Date must be included, the currency must be non-USD and the "Send or Receive" field must be set to SEND_AMOUNT.
In the following example, a batch payout has been created in MXN.A data row should be added to the data file for every unique payout. The data elements of the data row are defined in the table below:
| Column | Description | Data type | Required | Example |
|---|---|---|---|---|
| Row identifier | Single character identifier used to determine the type of row: D = data | Text (1) | ✔️ | D |
| Reference Number | Unique ID used by you to reference the payout in within the Latitude product. This value is generated by you. This value is also the ID value used by the end user in the event they need customer support. Note: It is recommended to select a value that is already being used to reference this payment in your system however it must be unique for all payouts. | Text (1-50) | ✔️ | ABC123456 |
| Sender ID | Unique ID provided by the Latitude Integrations team referencing a specific sender configuration and account as the source of funds. | Text(1-50) | ✔️ | d82df35w-4723-3s09-9se7-d23hc3hes5a2 |
| Recipient First Name | Given name of the recipient | Text (1-50) | ✔️ | Josef |
| Recipient Last Name | Surname of the recipient | Text (1-50) | ✔️ | Martinez |
| Recipient Second Last Name | Maternal or second last name of the recipient | Text (1-50) | Jiminez | |
| Recipient Email Address | Email address of the recipient (this will determine where notification emails are sent) | Text (1-50) | ✔️ | [email protected] |
| Recipient Phone Number | Phone number of the recipient (last 4 of this phone number used for verification by user by default) | Text (4-50) | ✔️ | 555812345678 |
| Recipient Mailing Address Line 1 | Address line 1 of the recipient mailing address | Text (1-50) | PRIVADA UNIÓN 10 | |
| Recipient Mailing Address Line 2 | Address line 2 of the recipient mailing address | Text (1-50) | COL. AGRÍCOLA PANTITLÁN | |
| Recipient Mailing Address City | City of the recipient mailing address | Text (1-50) | CIUDAD DE MÉXICO | |
| Recipient Mailing Address State | State/Province of the recipient mailing address | Text (1-50) | IZTACALCO | |
| Recipient Mailing Address Postal Code | Zip/Postal code of the recipient mailing address | Text (1-10) | 30339 or 30339-0081 | |
| Recipient Mailing Address Country | Country of the recipient mailing address | ISO-3 | ✔️ | MXN |
| Payout amount | Total amount of the payout in a decimal format (minimum amount = $1.00) | Decimal (1-9999999) | ✔️ | 150.99 |
| Payout Amount Currency |
| ISO-3 | ✔️ | AUD |
| Send or Receive | SEND_AMOUNT must be specified in order to trigger the Any-to-Any Currency option. | Text (1-50) | ✔️ | SEND_AMOUNT |
| Supplemental Information 1 | Additional field for notes for cross reference | Text (1-50) | This is an example | |
| Supplemental Information 2 | Additional field for notes for cross reference | Text (1-50) | This is an example | |
| Verification Code | Alternate verification method to the default last 4 digits of their phone number. This value should be a unique, private, and hard to guess string that only the end user recipient will know. Supplying a value in this field will disable the default verification method of using the last 4 of the phone number. | Text (4-50) | 3098sfDSi8e9a8 | |
| Supplemental Information 3 | Additional field for notes for cross reference | Text (1-50) | This is an example | |
| Supplemental Information 4 | Additional field for notes for cross reference | Text (1-50) | This is an example | |
| User ID | Indicator that can associate multiple payouts to a single user through a unique ID. | Text (1-50) | XYZ789 | |
| Recipient Type | Whether the payout is being sent to a person (B2C) or a business (B2B) entity. | "PERSON" or "BUSINESS" | PERSON | |
| HEV Date | Date of the original payment date. This is required for all Any-to-Any Currency payouts. | MM-DD-YYYY | ✔️ | 06-05-2025 |
Creating Any-to-Any Payouts via API
In the Create Payout API, ensure you add a hev_date field to any request that creates a non-USD SEND_AMOUNT payout. The value should be structured as "YYYY-MM-DD" - see below for an example:
"hev_date": "2025-06-05"
Any-to-Any Currency Limitations
At this time, Any-to-Any is only supported for certain non-USD currencies. If a payout is sent with a non-USD currency that is not eligible for HEV, the system will return an error.
Supported HEV currencies: EUR, USD, AUD, INR, NOK, BRL, BGN, CAD, CNY, NZD, HRK, CZK, DKK, GBP, HKD, HUF, ISK, IDR, ILS, JPY, KRW, ZAR, CHF, MYR, MXN, PHP, PLN, RON, RUB, SGD, SEK, THB, TRY