Merchant Settlement Report
The Merchant Settlement Report summarizes all settlements performed to the merchant during the period for which the report applies to. The report is generated only when settlement events occur.
There are a few different types of Settlement reports:
Merchant Settlement Report - Summarizes all settlements performed to the merchant during the period for which the report applies to. The report is generated only when settlement events occur.
Merchant Settlement Report Beta - The same report as Merchant Settlement Report, but temporarily released when new fields are released (beta) before they are merged into the main Merchant Settlement Report.
Merchant Monthly Settlement Report - Monthly overview of the Merchant Settlement Report as described.
You can download the Merchant Settlement Report. See Downloading a Financial Report.
The report is provided in the form of a CSV file. To read it, open it in a spreadsheet.
The current file format version is 1.4
Depending on the merchant activity, the report is generated on a daily basis at 2:00 AM GMT.
Header Format
Line 1 of the CSV file contains the following information:
Timestamps Format
All timestamps should be in UTC.
Field | Value |
|---|---|
Report Title | Rapyd Merchant Settlement Report |
Version | Report version number |
Merchant | Alias of the merchant |
From | the string "From" |
Start date | Period start date |
To | the string "To" |
End date | Period end date |
Data Format
Headers - Described in the following table.
Collections - Transactions created by Create Payment or Create Refund. If the merchant has two or more accounts for collections, each account appears on a separate line.
Disbursements - Transactions created by Create Payout.
Transaction Settlement Timeframe
Transactions closed within a day (UTC time) will be considered for settlement starting that day (i.e. the system's cutoff time is 12:00 AM UTC).
Field | Value |
|---|---|
Account ID | Alias of the merchant's account on the Rapyd platform. |
Account Number | The account number of the bank account to which the settlement was remitted to. |
Bank | The name of the merchant's bank where the settlement is managed. Relevant to collections. |
Wallet ID |
|
Type | Type of transaction. One of the following:
|
Settlement Date | The date the settlement was processed and remitted by Rapyd. Format: YYYY-MM-DD |
Original Settlement Date | The date the funds are designated to be settled according to the settlement cycle. |
Settlement Currency | The currency of the transactions, as settled with the merchant. Three-letter ISO 4217 code. Relevant to collections. |
Reserve Amount in Settlement Currency | The total reserve amount denominated in the settlement currency. |
Reserve Currency | The currency of the reserve funds. |
Reserve Amount in Reserve Currency | The total reserve amount denominated in the reserve currency. |
Settlement Amount | The amount settled with the merchant for transactions that settled on the settlement date. |
Settlement ID | The identifier of the settlement generated by Rapyd. |
Settlement Reference ID | The identifier of the settlement completed by Rapyd on the settlement configuration. |
Settlement Wallet Account Currency |
Three-letter ISO 4217 code. |
Settlement Amount in Wallet Account Currency | The client wallet currency equivalent of the amount settled with the merchant. |
Prev Negative Settlement | The total amount that the merchant owes to Rapyd from previous days. Relevant when there is a past negative remittance. |
Static Reference ID | The identifier generated from the settlement configuration. |
Initiator | Indicates whether the settlement is requested by Rapyd or the client. The settlement is requested by the client for settlement on demand transactions. Possible values:
|
Client Reference | The Settlement Reference ID for settlement on demand transactions. Other possible values: null. |
Wallet Address | The wallet address value as entered by the merchant. |
Sample Report
Merchant Settlement Report
Merchant Settlement Report,v1.4,Awesome Merchant LTD,From,2024/04/29,To,2024/04/30,,,,,,,,,,,,, Account ID,Account Number,Bank,Wallet ID,Type,Settlement Date,Settlement Currency,Settlement Amount,Settlement Wallet Account Currency,Settlement Amount in Wallet Account Currency,Prev Negative Settlement,Settlement Reference ID,Static Reference Id,Reserve Currency,Reserve Amount in Reserve Currency,Reserve Amount in Settlement Currency,Initiator,Client Reference,Settlement ID,Original Settlement Date Awesome Merchant LTD,123456789,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-04-30,USD,62005.645,USD,62005.645,,ds321fds5sdf,,USD,"4,758.96","4,758.96",Rapyd,,SDFG5DFG321DFG6548UKJ3K321HJM3,2024-04-22 Awesome Merchant LTD,123456790,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-04-30,USD,61972.025,USD,61972.025,,dfg321df3dfg1,,USD,"4,757.66","4,757.66",Rapyd,,DFHF856GHJ231DF32GFH8YUJ321G3FGH1,2024-04-22 Awesome Merchant LTD,123456791,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,reserve_return,2024-04-30,USD,6040.95,USD,6040.95,,dfg231311323d,,,,,Rapyd,,DFG231SDF685DF64T32H1B321DSF8DH,2024-04-22 Awesome Merchant LTD,123456792,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,reserve_return,2024-04-30,USD,6041.86,USD,6041.86,,dfg21f3fg13212,,,,,Rapyd,,DFG21FHGJK89YU32HM1CB1SDFG654H,2024-04-22 Awesome Merchant LTD,123456793,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-04-30,USD,46079.805,USD,46079.805,,dfg213gd1se1,,USD,"3,539.41","3,539.41",Rapyd,,SDFG231GJ8YU3M21BVN8DFG321FGH13,2024-04-30 Awesome Merchant LTD,123456794,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-04-30,USD,4056.075,USD,4056.075,,df3sd3213215,,USD,314.1,314.1,Rapyd,,DFG21SE8FDGFH32G1K5YU321GH3DD,2024-04-30 Awesome Merchant LTD,123456795,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-04-30,USD,46243.065,USD,46243.065,,dfs123ds1332,,USD,"3,551.88","3,551.88",Rapyd,,DFG21YTJ8GH32VBM1F8SD321DFGH8,2024-04-30 Awesome Merchant LTD,123456796,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,reserve_return,2024-04-30,USD,800.12,USD,800.12,,werty3841000,,,,,Rapyd,,SDFG3218YJ36FGH1DF32DFR8J321FNH,2024-04-30 Awesome Merchant LTD,123456797,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,reserve_return,2024-04-30,USD,8658.34,USD,8658.34,,eyy32165486,,,,,Rapyd,,SDFG1TH8321SD8SD32DFH1Y8651GN3SA,2024-04-30 Awesome Merchant LTD,123456798,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,reserve_return,2024-04-30,USD,8728.435,USD,8728.435,,iuj2103165658,,,,,Rapyd,,DFG1YJ8FGN321X58SE3GFH1GHJ8FH,2024-04-30
The current file format version is 1.5
Header Format
Line 1 of the CSV file contains the following information:
Timestamps Format
All timestamps are in UTC.
Field | Value |
|---|---|
Report Title | Rapyd Merchant Settlement Report Beta |
Version | Report version number |
Merchant | The name of the organization as registered with Rapyd |
From | the string "From" |
Start date | Period start date |
To | the string "To" |
End date | Period end date |
Data Format
The Merchant Settlement Beta report includes all the fields in the current report as well as the newly included fields.
Starting from Line 2 of the CSV file, the information contained follows the below guideline:
Field | Value |
|---|---|
Beneficiary Name | The beneficiary name of the account owner, as registered with Rapyd |
Account Number | The account number of the bank account to which the settlement was remitted to |
Bank Code | The bank code of the bank account to which the settlement was remitted to The code may state SWIFT BIC, ABA, sort code, etc., depending on your bank's location. |
Wallet ID | The wallet ID funds were settled from |
Settlement Date | The date the settlement was processed and remitted by Rapyd. Format: YYYY-MM-DD |
Settlement Currency | The currency of the transactions, as settled with the merchant. Format: Three-letter ISO 4217 code. Relevant to collections. |
Settlement Amount | The amount settled with the merchant for transactions that settled on the settlement date. |
Settlement Reference ID | The identifier of the settlement completed by Rapyd on the settlement configuration. |
Reserve Currency | The currency of the reserve funds. |
Reserve Amount in Reserve Currency | The total reserve amount denominated in the reserve currency. |
Reserve Amount in Settlement Currency | The total reserve amount denominated in the settlement currency. |
Initiator | Indicates whether the settlement is requested by Rapyd or the client. The settlement is requested by the client for settlement on demand transactions. Possible Values:
|
Client Reference | The Settlement Reference ID for settlement on demand transactions. Other possible values: null. |
Settlement ID | The identifier of the settlement generated by Rapyd. |
Header Format
Line 1 of the CSV file contains the following information:
Timestamps Format
All timestamps should be in UTC.
Field | Value |
|---|---|
Report Title | Merchant Monthly Settlement Report |
Version | Version number. |
Merchant | Alias of the merchant. |
From | Start of the report. |
YYYY-MM-DD hh:mm:ss | Timestamp at start. |
To | End of the report. |
YYYY-MM-DD hh:mm:ss | Timestamp at end. |
Data Format
Transactions
Transactions closed within a day (again, UTC time) will be considered for settlement starting that day, i.e. the system's cutoff time is 12:00 AM UTC.
Field | Value |
|---|---|
Account ID | Alias of the merchant's account on the Rapyd platform. Relevant to collections. |
Account Number | The merchant's account number at the merchant's bank. Relevant to collections. |
Bank | The name of the merchant's bank where the settlement is managed. Relevant to collections. |
Wallet ID | The wallet token from which the funds were settled. |
Type |
|
Settlement Date | The date when the funds were settled. |
Settlement Currency | The currency of the transactions, as settled with the merchant. Format: Three-letter ISO 4217 code. Relevant to collections. |
Settlement Amount | The amount settled with the merchant for transactions that settled on the settlement date. |
Settlement Wallet Account Currency |
Three-letter ISO 4217 code. |
Settlement Amount in Wallet Account Currency | The client wallet currency equivalent of the amount settled with the merchant. |
Prev Negative Settlement | The total amount that the merchant owes to Rapyd from previous days. Relevant when there is a past negative remittance. |
Settlement Reference ID | The identifier of the settlement completed by Rapyd on the settlement configuration. |
Reserve Currency | The currency of the reserve funds. |
Reserve Amount in Reserve Currency | The total reserve amount denominated in the reserve currency. |
Reserve Amount in Settlement Currency | The total reserve amount denominated in the settlement currency. |
Settlement ID | The identifier of the settlement generated by Rapyd. |
Sample Report
Merchant Monthly Settlement Report
Merchant Monthly Settlement Report Beta,v1.5,Awesome Merchant LTD,From,2024/03/01,To,2024/04/01,,,,,,,,, Account ID,Account Number,Bank,Wallet ID,Type,Settlement Date,Settlement Currency,Settlement Amount,Settlement Wallet Account Currency,Settlement Amount in Wallet Account Currency,Prev Negative Settlement,Settlement Reference ID,Reserve Currency,Reserve Amount in Reserve Currency,Reserve Amount in Settlement Currency,Settlement ID Awesome Merchant LTD,123456789,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-03-01,USD,62005.645,USD,62005.645,,ds321fds5sdf,USD,"4,758.96","4,758.96",SDFG5DFG321DFG6548UKJ3K321HJM3 Awesome Merchant LTD,123456790,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-03-01,USD,61972.025,USD,61972.025,,dfg321df3dfg1,USD,"4,757.66","4,757.66",DFHF856GHJ231DF32GFH8YUJ321G3FGH1 Awesome Merchant LTD,123456791,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-03-01,USD,6040.95,USD,6040.95,,dfg231311323d,USD,,,DFG231SDF685DF64T32H1B321DSF8DH Awesome Merchant LTD,123456792,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,reserve_return,2024-03-01,USD,6041.86,USD,6041.86,,dfg21f3fg13212,,,,DFG21FHGJK89YU32HM1CB1SDFG654H Awesome Merchant LTD,123456793,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,reserve_return,2024-03-01,USD,46079.805,USD,46079.805,,dfg213gd1se1,,"3,539.41","3,539.41",SDFG231GJ8YU3M21BVN8DFG321FGH13 Awesome Merchant LTD,123456794,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,reserve_return,2024-03-01,USD,4056.075,USD,4056.075,,df3sd3213215,,314.1,314.1,DFG21SE8FDGFH32G1K5YU321GH3DD Awesome Merchant LTD,123456795,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-03-02,USD,46243.065,USD,46243.065,,dfs123ds1332,USD,"3,551.88","3,551.88",DFG21YTJ8GH32VBM1F8SD321DFGH8 Awesome Merchant LTD,123456796,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-03-02,USD,800.12,USD,800.12,,werty3841000,USD,333.45,333.45,SDFG3218YJ36FGH1DF32DFR8J321FNH Awesome Merchant LTD,123456797,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,Collections,2024-03-02,USD,8658.34,USD,8658.34,,eyy32165486,USD,321.22,321.22,SDFG1TH8321SD8SD32DFH1Y8651GN3SA Awesome Merchant LTD,123456798,Bank of America,ewallet_fdfg321dfg54dfg321dfg3215dfg321df,reserve_return,2024-03-02,USD,8728.435,USD,8728.435,,iuj2103165658,,,,DFG1YJ8FGN321X58SE3GFH1GHJ8FH