Paymend API documentation

One row per event included in a payout, covering both money movement and fees. The sum of payout_amount across the file is the amount paid to your account on the payout date.

report_settlement_paid_out-{merchant_name}-{payout_date}.csv

The single date in the filename is the payout date, not the period covered. A file named ...-20260912.csv contains events with event_effective_at falling in the settlement period that closed before 12 September.

Columns

Column	Type	Description
`event_id`	string	The event being settled. Matches `event_id` in the transactions or disputes report.
`event_effective_at`	timestamp	When the event is eligible for payout. UTC.
`payout_date`	date	When the event is paid out.
`payment_id`	string	The payment the event relates to.
`merchant_name`	string	Your merchant identifier.
`store_id`	string	Store the payment belongs to.
`merchant_reference`	string	Your own reference from the payment request.
`event_type`	enum	`SALE`, `REFUND`, `ALERT`, `RDR`, `CHARGEBACK`, `FRAUD_REPORT`.
`event_status`	enum	`CAPTURED`, `REFUNDED`, `RESOLVED`, `NO_ACTION_TAKEN`.
`event_amount`	decimal	Signed amount of the event itself.
`event_currency`	string	Currency the event was denominated in, or `NA` where the event carries no amount.
`payout_currency`	string	Currency this row is settled in.
`fx_rate`	decimal	Rate applied to convert `event_amount` into `payout_currency`. Empty where no conversion applies.
`platform_fee`	decimal	Variable processing fee. Negative when funds are deducted from the payout.
`recovery_fee`	decimal	Fixed per-transaction fee. Negative when funds are deducted from the payout.
`dispute_fee`	decimal	Fee charged for a dispute event. Negative when funds are deducted from the payout.
`delayed_settlement_amount`	decimal	Amount to be paid out on longer settlement timeline. Negative.
`payout_amount`	decimal	Net contribution of this row to the payout.

Every row sums

The five component columns add up to payout_amount on every row, with no exceptions:

payout_amount = event_amount
              + platform_fee
              + recovery_fee
              + dispute_fee
              + delayed_settlement_amount

Debits are negative and credits positive, so the total is a plain sum — you never need to know which columns to subtract.

This means signs differ between reports by design. A refund of 97.00 appears as 97.00 in the transactions report, where the amount is unsigned and direction comes from event_type, and as -97.00 here, where the column feeds an arithmetic total.

Summing payout_amount across the whole file gives the amount credited to your bank account on the payout date.

What each event type contributes

`event_type`	`event_amount`	Fees applied
`SALE`	Positive — amount credited	`platform_fee`, `recovery_fee`, `delayed_settlement_amount`
`REFUND`	Negative — amount debited	`platform_fee`, `recovery_fee`
`CHARGEBACK`	Negative — amount debited	`dispute_fee`
`RDR`	Negative — amount debited	`dispute_fee`
`ALERT`	Zero	`dispute_fee`
`FRAUD_REPORT`	Zero	`dispute_fee`

ALERT and FRAUD_REPORT rows carry no amount because the event itself moves no money — they are notifications, and only the fee applies. Where an alert led you to refund the payment, that refund appears separately as its own REFUND row.

Delayed settlement

delayed_settlement_amount is a proportion of each capture withheld rather than paid out. It is a hold, not a fee: the amount is returned on the agreed release schedule and appears as a separate release event in a later settlement report. Do not treat it as a cost when calculating your effective rate.

Example

report_settlement_paid_out-my_merchant-20260912.csv

event_id,event_effective_at,payout_date,payment_id,merchant_name,store_id,merchant_reference,event_type,event_status,event_amount,event_currency,payout_currency,fx_rate,platform_fee,recovery_fee,dispute_fee,delayed_settlement_amount,payout_amount
AUTH_Qw7fRb2Nx4,2026-08-01 09:15:44 UTC,2026-09-01,PAYM_7bQ2xKmR4v,my_merchant,store_abc,ORD-88213,AUTH,AUTHORIZED,0,NA,USD,,0,-1.00,0,0,-1.00
SALE_Kv8dRn2Yx9,2026-08-01 11:49:03 UTC,2026-09-01,PAYM_Nc9wTdLs3E,my_merchant,store_123,ORD-88214,SALE,CAPTURED,129.50,USD,USD,1,-19.43,-1.00,0,-12.95,96.12
CAPT_Hm3yTv8Ld6,2026-08-02 10:04:11 UTC,2026-09-01,PAYM_7bQ2xKmR4v,my_merchant,store_abc,ORD-88213,CAPTURE,CAPTURED,49.00,USD,USD,1,-7.35,0,0,-4.90,36.75
FRAD_9tRm2xQwLe,2026-08-03 02:11:07 UTC,2026-09-01,PAYM_7bQ2xKmR4v,my_merchant,store_abc,ORD-88213,ALERT,REFUNDED,0,NA,USD,,0,0,-20.00,0,-20.00
REFN_Bd9nXq5Vh7,2026-08-03 14:22:10 UTC,2026-09-01,PAYM_7bQ2xKmR4v,my_merchant,store_abc,ORD-88213,REFUND,REFUNDED,-49.00,USD,USD,1,0,0,0,0,-49.00
SALE_Pj6cWz4Mt1,2026-08-07 08:33:52 UTC,2026-09-01,PAYM_Td5xGm9Kc3,my_merchant,store_123,ORD-88224,SALE,CAPTURED,250.00,USD,USD,1,-37.50,-1.00,0,-25.00,186.50
FRAD_Xv2pQs5Bn8,2026-08-11 18:44:22 UTC,2026-09-01,PAYM_Nc9wTdLs3E,my_merchant,store_123,ORD-88214,CHARGEBACK,RESOLVED,-129.50,USD,USD,1,0,0,-25.00,0,-154.50
FRAD_Lm5bNe0kUr,2026-08-22 23:57:14 UTC,2026-09-01,PAYM_Ry6kBnXu2W,my_merchant,store_123,ORD-88219,FRAUD_REPORT,NO_ACTION_TAKEN,0,NA,USD,,0,0,-15.00,0,-15.00

Process payments

Settlement paid out

Columns

Every row sums

What each event type contributes

Delayed settlement

Example

​Columns

​Every row sums

​What each event type contributes

​Delayed settlement

​Example

Columns

Every row sums

What each event type contributes

Delayed settlement

Example