Skip to main content
POST
payments.settlement.lines.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
ref
string
required

The ref returned by payments.settlements.list or payments.order.settlements.get.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
limit
integer
default:50

Maximum lines per page; default 50.

Required range: 1 <= x <= 100
cursor
string

Opaque nextCursor from the previous page.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9+/=_-]+$

Response

The result

items
object[]
required

Payments, refunds, disputes and adjustments counted in this settlement.

Maximum array length: 100
nextCursor
string

Next page cursor, when present.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9+/=_-]+$