The Rapyd Client Portal Developer Hub

Welcome to the Rapyd Client Portal developer hub. You'll find comprehensive guides and documentation to help you start working with Rapyd Client Portal as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Merchant Settlement Report

šŸš§

New version coming up!

The next version of the Merchant Monthly Settlement Report will released on March 1st, 2022.

During period until March 1st, 2022 both the current and new beta version of the merchant settlement report (both monthly and daily) will be published simultaneously, providing the necessary time to learn and adapt existing processes and systems.

Starting February 1st, a monthly settlement report will be published both in the old and the new beta format.

The new Merchant Settlement report was adapted to fit the exact structure of the beta daily settlement report, and will simply reflect the daily settlements on a monthly basis. Hence, consolidating the specifications of the settlement report into this one, single source.

The beta report specifications can be found on the Merchant Settlement Report Beta page.

Main changes:

  1. Unused columns have been removed
  2. Indication on Reserve amounts held on each settlement record
  3. Breakdown on the monthly settlements performed throughout a calendar month from Rapyd

Please reach out to our supportt team if you have any questions and/or feedback on the new 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.

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.

File Version

Current file format version is 1.3

Reporting Frequency

Depending on the merchant activity, the report is generated on a daily basis at 2:00 AM GMT.

File Structure

Header Format

Line 1 of the CSV file contains the following information:

šŸ“˜

Timestamps Format

All timestamps should be in UTC.

FieldValue
Report TitleRapyd Merchant Settlement Report
VersionReport version number
MerchantAlias of the merchant
Fromthe string "From"
Start datePeriod start date
Tothe string "To"
End datePeriod 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:00AM UTC).

FieldValue
Account IDAlias of the merchant's account on the Rapyd platform.
Account NumberThe merchant's account number at the merchant's bank. Relevant to collections.
BankThe name of the merchant's bank where the settlement is managed. Relevant to collections.
eWallet IDā— Collections - The wallet the funds are collected to and settled from.
ā— Disbursements - The wallet the fees are collected from. Relevant when fees are collected from a wallet and not invoiced.
TypeType of transaction. One of the following:
ā— Collection - Payments and refunds.
ā— Disbursement - Payouts.
Settlement DateThe date the payments are settled. Format: YYYY-MM-DD. Relevant to collections.
Settlement CurrencyThe currency of the transactions, as settled with the merchant. Three-letter ISO 4217 code. Relevant to collections.
Fee CurrencyThe currency for the client to pay Rapyd's fees. Three-letter ISO 4217 code.
Settlement AmountThe total amount settled with the merchant for all transactions that settled on the settlement date, minus the amount of negative settlements from previous days.
ā— Collection: Settlement = Net Credit - Net Debit - Prev Negative Settlement
ā— Disbursement: Settlement = (-1 * Debit Fee)
Settlement eWallet Account Currencyā— Collections - The currency of the funds collected.
ā— Disbursements - The currency of the funds received by the beneficiary.

Three-letter ISO 4217 code.
Settlement Amount in eWallet Account CurrencyThe client wallet currency equivalent of the amount settled with the merchant.
Prev Negative SettlementThe total amount that the merchant owes to Rapyd from previous days. Relevant when there is a past negative remittance.
Gross DebitIndicates the aggregate debit.

ā— Collection - Gross amount of all refunds, including fees.
ā— Disbursement - Amount of all payouts, excluding fees.
Debit FeeSum of all fees paid to Rapyd for debit transactions (refund or payout).
Net Debitā— Payment: Net Debit = Gross Debit
ā— Disbursement: Net Debit = 0
Gross CreditThe amount paid to the merchant (payments), including fees. Relevant to collections.
Credit FeeSum of all fees paid to Rapyd for credit transactions (payments). Relevant to collections.
Net CreditNet Credit = Gross Credit - Credit Fee
Relevant to collections (payments).

Example Report File

Rapyd Merchant Settlement Report,v1.3,21/04/2020 6:05,MERCHANT_NAME,,,,,,,,,,,,,,
Account ID,Account Number,Bank,eWallet ID,Type,Settlement Date,Settlement Currency,Fee Currency,Settlement Amount,Settlement eWallet Account Currency,Settlement Amount in eWallet Account Currency,Prev Negative Settlement,Gross Debit,Debit Fee,Net Debit,Gross Credit,Credit Fee,Net Credit
US Dollar Account,123-456789-123,Barclays,ewallet_9b102808ff77880d212e11eaa06754ec,Collection,21/04/2020,USD,USD,20,AUD,30.56,0,0,0,0,21.2,1.2,20
EUR Account,123-123455-123,HSBC,ewallet_9b102808ff77880d212e11eaa06754ec,Collection,21/04/2020,EUR,EUR,289.1,MYR,1293.46,1,10,1,10,315.12,15.11,300.1
N/A,N/A,N/A,,Disbursement,21/04/2020,USD,USD,0,TWD,0,0,3,2.24,0,0,0,0

Updated 10 months ago


Merchant Settlement Report


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.