File spec

Column	Description	Data Type	Format	Constraints	Examples
Customer name	Name of customer	String	Alphanumeric	Mandatory, Max length: 50 characters	Payment Bank
Transfer ID	Unique ID of the transfer defined by ReadyRemit	String	UUID	Mandatory, Valid UUID format	f592edb9-f094-49cc-8f00-7c4168b80ed8
Confirmation number	Unique ID of the transfer defined by the remittance service provider	String	Alphanumeric	Mandatory, Max length: 50 characters	33TF030740448
Transfer date time	Date and time the transfer was originally submitted (in UTC)	DateTime	MM/dd/yyyy hh:mm:ss tt	Mandatory, Eastern Time (EST/EDT)	10/03/2022 11:19:31 AM
Sender name	Full name of the sender	String	Text	Mandatory, Max length: 200	John Doe
Recipient name	Full name of the recipient	String	Text	Mandatory, Max length: 200	Jane Doe
Send amount	Total amount sent by the user	Decimal	Numeric	Mandatory, 2 decimal places, no thousands separator	150.00
Transfer fee	Total fee amount	Decimal	Numeric	Mandatory, 2 decimal places, no thousands separator	3.00
Total credit amount	Total cost amount (send amount + fee)	Decimal	Numeric	Mandatory, 2 decimal places, no thousands separator	153.00
Cancelation reason	Reason for cancellation is defined during the cancellation.	String	Text	Mandatory, Max length: 100	ACCOUNT DOES NOT SUPPORT PAYMENT
Proxy number	Card proxy number (available if ingested during transfer)	String	Alphanumeric	Optional, Max length: 30 characters	ABC123XYZ
RSP Name	The remittance service provider that was used for the original transfer of funds	String	Text	Mandatory, Max length: 50	Transpay

The file will use the following naming convention: Customer_ReadyRemit_Daily_Cancelled_Transfers_MMDDYY.csv
The file will have a header row
The file will be generated whether there are cancellations or not. If there are no cancellations in the applicable time period, the report will have no data rows (the header row will still be present)
The file will be sent daily at 6:15 AM ET (adjusts with daylight savings time)
The last row of the cancelations file will be a summary row with totals for Send amount, Transfer fee, and Total credit amount.

🚧
Summary row
The last row of the file will be a summary row with totals for Send amount, Transfer fee, and Total credit amount. This row will not contain ID information for any specific transfer and should not be processed as a cancelation.

Sample

Customer name,Transfer ID,Confirmation number,Transaction date time,Sender name,Recipient name,Send amount,Transfer fee,Total credit amount,Cancelation reason,Proxy number
PrePaid Technologies,f592edb9-f094-49cc-8f00-7c4168b80ed8,33TF030740448,10/03/2022 11:19:31 AM,Kyle Fix,Jennifer Fix,100.00,2.99,102.99,ACCOUNT DOES NOT SUPPORT PAYMENT,ABC123XYZ
PrePaid Technologies,eu3719c3-l000-4ix2-4u77-3hc28skn3bd5,33TF001912288,10/02/2022 4:08:38 AM,Daniel Chimento,Dana John,558.00,3.99,561.99,ACCOUNT DOES NOT SUPPORT PAYMENT,DEF456GHI

Report Delivery

The cancelations report can be delivered one of three ways:

1. Email

The quickest solution to receiving the cancelations report is through email. An email address will be provided to the ReadyRemit integrations team and the report will be delivered daily as an attachment.

2. SFTP (pull)

If a more automated process is desired the cancelations report can be delivered via SFTP. In the "pull" model, the ReadyRemit integrations team will provide you with SFTP credentials and you will provide ReadyRemit with a public key for encryption. Files will be dropped in the determined SFTP directory on a daily basis.

3. SFTP (push)

Similar to the pull model, in the SFTP push model a file is generated and dropped in an agreed upon SFTP directory. In this model you will provide the ReadyRemit team with SFTP credentials along with the public encryption key.

Next steps

To get started with the process of receiving the cancelations report, please reach out to the ReadyRemit integrations team at [email protected].