Skip to main content
POST
payments.transactions.search

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
startDate
string<date-time>
required

Inclusive start of the search window.

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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
endDate
string<date-time>
required

End of the search window, at most 31 days after start.

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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
transactionId
string

Filter by one transaction in your connected account.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
status
enum<string>

Filter by transaction state.

Available options:
pending,
completed,
failed,
reversed
currency
string

Filter by transaction currency.

Required string length: 1 - 3
Pattern: ^[A-Z]{3}$
balanceAffectingOnly
boolean
default:true

Only records that change your account balance; false includes informational records.

limit
number

Page size, 1 to 50; default 10.

Required range: x >= 1
cursor
string

nextCursor from this same search and connected account.

Required string length: 1 - 2048

Response

The result

results
object[]
required

Financial records; no buyer contacts or account identifiers.

nextCursor
string

Opaque cursor for the next page of this search.

lastRefreshedAt
string

Data refresh time, ISO 8601 UTC, when known.