Settlement files

Settlement files are generated for each payment run and contain all transactions and fees for a transaction. They are provided in the formats CSV and XLSX.

The settlement files can be retrieved through our ORCA interface or SFTP connection and are generated for each payment run.

ORCA

Please login into ORCA and click on the billing icon in the left sidebar:

The button may not be displayed due to missing permissions. Please contact the person in your company who is responsible for the administration of ORCA users.

You should then see a view where you can download the settlement reports, separated by payout dates, in Excel or CSV format:

SFTP

To set up the SFTP connection, please follow these steps: https://ratepay.gitbook.io/sftp/

The settlement files are stored on the SFTP server as a CSV file under the following path: /from_ratepay/settlement_report/ Each settlement file will be removed from this path after 30 days and copied to /archive/settlement_report/

CSV structure

Column

Description

Possible Values

Example Values

Issued by

SHOP_ID

bigint

Identifier of shop

-

99999999

Ratepay

PAYMENTDATE

date

Date when payment was received by Ratepay-FiBu

YYYY-MM-DD

2013-01-05

Ratepay

PAYMENTMONTH

char(10)

Month when payment was received by Ratepay-FiBu

YYYY-MM

2013-01

Ratepay

SHOPNAME

char(50)

Name of shop

-

Testshop

Ratepay

AMOUNT

decimal(14,2)

Amount of position

-

111.99

Ratepay

DESCRIPTOR

char(20)

Ratepay-reference of order

-

DG1234567Z1

Ratepay

SHOPINVOICE_ID

char(50)

Identifier of shop-Invoice

-

abcde

invoice-id

SHOPSORDER_ID

char(50)

Identifier of shop-order

-

12344545abc

order-id

INVOICENUMBER

char(50)

Identifier of Ratepay-Invoice

-

99999999002

Ratepay

DESCRIPTION

char(100)

Description of type of amount

-

RatePAYdisagio

Ratepay

FEETYPE

char(10)

ID of type of amount

1 - Original amount, return, cancellation, credit memo, additional debit 2 - Disagio 3 - Transaction fee 4 - Fees for return, cancellation, credit memo, additional debit 5 - Service charge 6 - VAT 7 - Interest cost

<null> - Other (monthly fee or similar)

1

Ratepay

ORDERDATE

timestamp

Date when request was sent to Ratepay-gateway

YYYY-MM-DD HH:MM:SS.FFFFFF

2013-01-01 12:32:53.123456

Ratepay

SENTDATE

date

Date when operation was sent to Ratepay-gateway

YYYY-MM-DD

2013-01-05

Ratepay

TRANSACTION_ID

char(20)

Ratepay-Identifier of order

-

39-2013050217283

Ratepay

CUSTOMERGROUP

char(10)

Customer Group Identifier

1 - B2B 2 - B2C

2

Ratepay

KNOWNCUSTOMER

char(1)

Customer sent as known regular customer by shop

1 - Known customer 0 - Unknown customer

1

Ratepay

PRODUCT

char(1)

ID describing product

1 - INVOICE 2 - INSTALLMENT 3 - DIRECT DEBIT 4 - PREPAYMENT 5 - INSTALLMENT DIRECT DEBIT

1

Ratepay

REFERENCE_ID_ACCOUNTING

char(255)

Shop internal accounting number (e. g. from ERP-system such as SAP), used to reference payment-changes

-

ABC-123-B

reference-id