Skip to content
Last updated

Settlements

Availability

Settlements are made available whenever it reaches us. This happens at different times, depending on the PSP. For some it can be multiple times per day, while others more rare, like once a week. This usually is according to when money is paid out to the merchant account.

Endpoint for fetching CSV reports

curl -i -X GET \
  https://api.spensepay.com/partner/settlements/generate_csv \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Organization-Id: string' \
  -d '{
    "from_date": "2025-01-01",
    "to_date": "2025-01-31",
    "format": "transactions"
  }'

Description of Machine Readable CSV format

Header (A)

Column NumberTitleDescription
1TypeAlways A for header entries.
2Total PayoutsThe total number of payouts in the report.
3Total TransactionsThe total number of transactions in the report.
4Transaction AmountThe transaction amount.
5Fee AmountThe fee amount.
6Amount paid outThe total amount paid out to the merchant.
7Amount for invoicing laterThe total amount to invoice the merchant.

Provider Summary (R)

Column NumberTitleDescription
1TypeAlways R for provider summary entries.
2Payment ProviderThe name of the payment provider. Example: WORLDLINE
3Total PayoutsThe total number of payouts for the payment provider.
4Total TransactionsThe total number of transactions for the payment provider.
5Transaction AmountThe total transaction amount for the payment provider.
6Fee AmountThe total fee amount for the payment provider.
7Amount paid outThe total amount paid out to the merchant for the provider.
8Amount for invoicing laterThe total amount to invoice the merchant for the provider.

Payout Entries (P)

Column NumberTitleDescription
1TypeAlways P for payout entries.
2Payment ProviderThe name of the payment provider. Example: WORLDLINE
3DateThe date the payout was made. Format: YYYY-MM-DD
4ReferenceA reference to the payout. Example: 123456
5Report IDThe ID of the report. Example: 123456
6Transaction CountThe number of transactions in the payout. Example: 10
7Purchase AmountThe total amount of the transactions

Transaction Entries (T)

Column NumberTitleDescription
1TypeAlways T for transaction entries.
2Payment IDUnique Spense Payment ID.
3Order Number (if available)
4Payout Reference
5Paid out date
6Payout type (NET or GROSS)
7Transaction Reference
8Parent Transaction ReferenceNo longer in use, will always be blank.
9Transaction Amount
10Transaction Fee
11Transaction Amount Paid Out
12Transaction StateThis field indicates transaction type: SETTLED, REFUNDED, or FEE, based on provider agreements or refunds.
13Currency
14Transaction Date