Skip to main content
POST
payments.financial-actions.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
paymentId
string

Filter by this payment.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
actionId
string

Filter by this action.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
limit
number

Page size, 1 to 50; default 10.

Required range: x >= 1
cursor
string

Opaque next-page value from the previous result.

Required string length: 1 - 4096

Response

The result

results
object[]
required

Financial actions; account identifiers, processor fees and rates are omitted.

Maximum array length: 50
nextCursor
string

Opaque next-page value from the previous result.

Required string length: 1 - 4096