9.7 - Settlements Report

---

Contains relevant information on settlements for a partner. One file is generated per day with the filename as follows: Settlements_YYYY_MM_DD.json

Delivery time of the settlement files may vary due to dependency on our settlement runs. Settlement files can be exptected to be on the Rapyd SFTP folder between 06:30-06:00 GMT.

Information

Please note that this page is only relevant to Payment Facilitators

9.7.1 - Settlement

Field name	Length/type	Description
AgreementNumber	6	The agreement number for the merchant
SettlementId	DateTime	Primary key for the settlement
SettlementNumber	int	Uniquely represents the settlement
MerchantName	50	The name of the merchant
CurrencyCode	3	The currency for the settlement
PaymentAmount	decimal	The paid amount for the settlement
GrossAmount	decimal	The gross amount processed
PaymentDate	DateTime	Date of settlement
Fees	Set	Fees applied to the settlement
Batches	Set	Batches that make up the settlement
Exceptions	Set	Any exceptions related to the settlement

9.7.2 - Sub Type Fees

Field name	Length/type	Description
FeeAmount	decimal	The collected amount
FeeDescription	60	The description of the fee
FeeType	10	The type of fee

9.7.3 - Sub Type Batches

Field name	Length/type	Description
BatchId	DateTime	Primary key for the batch
BatchNumber	string	Uniquely represents the batch
Transactions	Set	The Transactions in the batch

9.7.4 - Sub Type Transaction

Field name	Length/type	Description
ARN	23	Acquirer Reference Number (ARN). Unique ID in Rapyd system
TransactionId	12	Transaction reference
TransactionLifeCycleId	15	Schema life cycle reference
ReferenceData	50	Reference data from the transaction

9.7.5 - Sub Type SettlementException

Field name	Length/type	Description
ExceptionId	DateTime	Unique reference to the exception
ARN	23	Acquirer Reference Number (ARN). Unique ID in Rapyd system
TransactionType	6	Type of transaction

9.7.6 - Example

[
  {
    "AgreementNumber": "230990",
    "SettlementNumber": 32862247,
    "MerchantName": "Pet Store",
    "CurrencyCode": "EUR",
    "PaymentAmount": 35346.56,
    "GrossAmount": 39787.94,
    "PaymentDate": "2024-04-26T00:00:00",
    "Fees": [
      {
        "FeeAmount": 6989.04,
        "FeeDescription": "Merchant Service Charges",
        "FeeType": "BUMERC"
      },
      {
        "FeeAmount": 5.00,
        "FeeDescription": "Chargeback Fee",
        "FeeType": "CHBFAG"
      }
    ],
    "Batches": [
      {
        "BatchNumber": "0423JKOdWB",
        "Transactions": [
          {
            "ARN": "74648934114133385496453",
            "TransactionId": "411323869782",
            "TransactionLifeCycleId": "384113845803664",
            "ReferenceData": "payment_x4YsjiCqjB                                     "
          }
        ]
      },
      {
        "BatchNumber": "04235CM01n",
        "Transactions": [
          {
            "ARN": "74648934114133385496560",
            "TransactionId": "411323869810",
            "TransactionLifeCycleId": "484113851691824",
            "ReferenceData": "payment_hzKre74tqo                                     "
          }
        ]
      },
      {
        "BatchNumber": "0423QcYrGJ",
        "Transactions": [
          {
            "ARN": "74648934114133385496586",
            "TransactionId": "411323869719",
            "TransactionLifeCycleId": "384113833841602",
            "ReferenceData": "payment_q4yPZ7qje2                                "
          },
          {
            "ARN": "74648934114133385496594",
            "TransactionId": "411323869848",
            "TransactionLifeCycleId": "464113856171052",
            "ReferenceData": "payment_mxmh8B5Ker                                "
          }
        ]
      }
    ],
    "Exceptions": [
      {
        "ExceptionId": "2024-04-23T07:01:30.864396",
        "ARN": "74648934081133070107332",
        "TransactionType": "CHABAC"
      },
      {
        "ExceptionId": "2024-04-23T12:03:29.478060",
        "ARN": "74507444045132735024796",
        "TransactionType": "CHABAC"
      },
      {
        "ExceptionId": "2024-04-23T08:02:16.529327",
        "ARN": "75282524085133114194802",
        "TransactionType": "CHABAC"
      }
    ]
  },
  {
    "AgreementNumber": "368140",
    "SettlementNumber": 32872164,
    "MerchantName": "Central Car Rental",
    "CurrencyCode": "EUR",
    "PaymentAmount": 2105.66,
    "GrossAmount": 2389.44,
    "PaymentDate": "2024-04-24T00:00:00",
    "Fees": [
      {
        "FeeAmount": 25.06,
        "FeeDescription": "Merchant Service Charges",
        "FeeType": "BUMERC"
      },
      {
        "FeeAmount": 3.79,
        "FeeDescription": "Swift Fee",
        "FeeType": "SWIFTF"
      }
    ],
    "Batches": [
      {
        "BatchNumber": "0424sM0kIu",
        "Transactions": [
          {
            "ARN": "74507444115133395689477",
            "TransactionId": "411411000333",
            "TransactionLifeCycleId": "484114398302422",
            "ReferenceData": "payment_xm1vra                                      "
          },
          {
            "ARN": "74507444115133395689485",
            "TransactionId": "411412000335",
            "TransactionLifeCycleId": "484114439795012",
            "ReferenceData": "payment_d1f45                                       "
          },
          {
            "ARN": "74507444115133395689493",
            "TransactionId": "411415000336",
            "TransactionLifeCycleId": "484114569608957",
            "ReferenceData": "payment_q6clpv                                      "
          },
          {
            "ARN": "75290454115133395689508",
            "TransactionId": "411409000332",
            "TransactionLifeCycleId": "MPB2GJBAX0422  ",
            "ReferenceData": "payment_eif8za                                      "
          },
          {
            "ARN": "74507444115133395689519",
            "TransactionId": "411411000334",
            "TransactionLifeCycleId": "484114428044089",
            "ReferenceData": "payment_6kta4o                                      "
          }
        ]
      }
    ],
    "Exceptions": []
  }
]

Download settlements file