Get Merchant Settlement

GET 
/api/partner/v1/merchants/:ref/settlements/:id

Returns one settlement of a merchant together with the transactions it covers: header, totals for the whole settlement and one page of positions. Requires scope account:read and an active merchant delegation covering that scope.

All monetary values - header, summary and positions - are decimal strings with two decimal places; the currency is in settlement.currency.

Pagination: page-based (page, per_page), unlike the settlements list which is cursor-based. per_page above the maximum is capped, not rejected. summary always covers the whole settlement, and a page beyond the last one returns an empty transactions array.

Settlements of merchants that do not belong to your partner account are indistinguishable from settlements that do not exist (HTTP 404).

Request

Responses

200

Settlement with its positions.

401

Missing or invalid partner key.

403

The partner key lacks the account:read scope, the merchant has not authorized this operation, or dpay Connect is currently unavailable.

404

No such settlement for this merchant, or no merchant with this ref belongs to your partner account.