Skip to main content
POST
banking.transactions.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-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by banking.accounts.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
from
string<date>
required

First booking date, inclusive.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
to
string<date>
required

Last booking date, inclusive.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
endUserRef
string

Your identifier for the person; when supplied it must match the consent owner.

Required string length: 1 - 256
limit
integer
default:25

Maximum rows, from 1 to 100.

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

Opaque cursor for the same owner and filters.

Required string length: 1 - 4096
status
enum<string>

Only this settlement state.

Available options:
booked,
pending

Response

The result

transactions
object[]
required

Requested transactions.

Maximum array length: 100
truncated
boolean
required

More transactions exist.

nextCursor
string

Opaque cursor for the same owner and filters.

Required string length: 1 - 4096