Response File
The Payout Response file is provided back to you from Latitude in response to every Payout Data File received. The Response file will contain information about the status of each Payout as well as the link that will allow a recipient user to complete the Payout.
Naming convention
<YOUR_COMPANY_NAME>_ReadyRemit_TransferRequest_Response_YYYYMMDDhhmmss.txt
Examples:
| Company name | Date | Response File name |
|---|---|---|
| Acme | 01 Jan 2023 6:00:00 AM EST | Acme_ReadyRemit_TransferRequest_Response_20230101110000.txt |
| Acme Tech | 01 Jan 2023 6:30:00 PM EST | Acme_Tech_ReadyRemit_TransferRequest_Response_20230101233000.txt |
Note
The timestamp on the file is ISO-8601 compliant and always converted to UTC (GMT-0) time.
Specification
H|58a2ab39-a7be-45db-acc7-2a268c118241|2024-02-15T10:00:00.000Z|3|3|PROCESSED||
D|Jane|Doe|[email protected]|Latitude01|PROCESSED||https://YOURCOMPANY.pay.brightwell.com/6fdf879f-30c1-4702-b4c8-ffd38d3721b9|2024-02-15T16:00:00.000Z|25.00|USD|resnum12843|confirmnum123487
D|John|Doe|[email protected]|Latitude02|PROCESSED||https://YOURCOMPANY.pay.brightwell.com/5ddf879f-30c1-4702-b4c8-ffd38d37d83s|2024-02-15T16:00:00.000Z|5472.23|MXN|refund21837432|confirmnum373263
D|Jim|Smith|[email protected]|Latitude03|PROCESSED||https://YOURCOMPANY.pay.brightwell.com/5ddf879f-30c1-4702-b4c8-ffd38d3738d4|2024-02-15T16:00:00.000Z|100.70|USD|Jim Smith|37832464583
The Response File is a pipe-delimited file consisting of two types of rows: header and data.
Header Row
Every Response File will contain one (1) header row. The data elements of the header row are defined in the table below:
| Element | Description | Data type | Required | Example |
|---|---|---|---|---|
| Row identifier | Single character identifier used to determine the type of row: H = header | Text (1) | ✔️ | H |
| Customer ID | ID of the customer provided by the Latitude Integrations team. | Text (1-50) | ✔️ | 58a2ab39-a7be-45db-acc7-2a268c118241 |
| Date | Date that the Response File was received in UTC time (GMT-0). | ISO-8601 | ✔️ | 2022-02-15T16:00:00.000Z |
| Total Row Count | Number of total data rows received in the originating Data File. | Integer | ✔️ | 2 |
| Processed Row Count | Number of data rows that were successfully processed. | Integer | ✔️ | 2 |
| Status | The overall status of the Transfer Request batch. | Text (1-50) | ✔️ | PROCESSED FAILED INVALID |
| Error message | Human readable description of the error if applicable. If the batch processed successfully, this value will be blank. | Text(1-100) | File could not be processed: missing header row |
Header Row Statuses
PROCESSED:
The file was valid and processed successfully.
NOTE: This status indicates the file as a whole was processed successfully. This status applies even in the event that some individual data records were not processed successfully.
FAILED:
The file failed to process for an unknown or unexpected reason. Details of the specific error can be found in the "Error message" field.
INVALID:
The Data File was received in an invalid format.
Errors
If all data rows were invalid, the response file will be renamed with a prefix of ERROR_ to signify a full file failure. Ex: ERROR_Acme_ReadyRemit_TransferRequest_Response_YYYYMMDDhhmmss.txt
Data Row
A data row will be present in the Response File for every record received in the corresponding Data File. The data elements of the header row are defined in the table below:
| Column | Description | Data type | Example |
|---|---|---|---|
| Row identifier | Single character identifier used to determine the type of row: D = data | Text (1) | D |
| Recipient First Name | Given name of the recipient | Text (1-50) | Jane |
| Recipient Last Name | Surname of the recipient | Text (1-50) | Doe |
| Recipient Email Address | Email address of the recipient | Text (1-50) | [email protected] |
| Reference Number | Unique ID referencing the reference number sent in the Data File | Text (1-50) | ABC123456 |
| Status | Status of the Payout | Text (1-50) | PROCESSING INVALID |
| Error message | Description of the error if applicable. If the Transfer Request processed successfully, this value will be blank | Text (1-100) | Record failed to parse: invalid character at position 68 |
| Recipient Portal Link | Link to the Latitude Recipient Portal. This link can be provided to your recipients so they can complete the Transfer. If the Transfer Request failed to process, this value will be blank. | Text (1-150) | https://latitude.pay.brightwell.com/6fdf879f-30c1-4702-b4c8-ffd38d3721b9 |
| Recipient Portal Link Expiration Date | Date the Portal link will no longer be valid (GMT-0) | ISO-8601 | 2022-02-15T16:00:00.000Z |
| Amount | Amount of the Payout | Decimal (1-9999999) | 100.70 |
| Currency | Currency of the Payout | ISO-3 | USD |
| 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 |
Data Row Statuses
PROCESSING
The row passed validation and is currently in a processing state. Future updates will be provided in the Status Report.
INVALID
The row failed to validate. Use the error message provided to determine the cause of the issue. A new data file will need to be created which includes any data rows with all relevant errors corrected prior to re-submission.
FAQ
Q: Do I need to do anything with this file?
A: The Response File should be used to collect the Recipient Portal Link so it can be provided to recipients. This file could also be used to trigger notifications in case of file ingestion failures.
Q: How long will it take to get a Response File?
A: A response file should be expected within 5 minutes of receipt of a Data File. If more time has passed, please reach out to support.
Q: Will Response files be returned in the same order that Request files were sent?
A: No, there is no guarantee that Data files will be processed in series.
Q: What if my data contains the delimiter character(|)?
A: The pipe bar character is not supported in any data fields and will never be returned in the response file. If your data contains a pipe bar, please consider replacing it with a different character.
Updated 5 months ago