API Reference
GuidesAPI Reference

List Payments

get
https://sandbox-api.getbrass.co/banking/payments

List and optionally search payment records

Query Params
string

Optional comma-separated list of relationships to include

string

Optional query to filter the list of payments

int32
Defaults to 1

The page of results to retrieve

int32
Defaults to 10

The maximum number of records to fetch

string
enum

Comma-separated list of payment statuses to filter for

string

Filter for payments that were set to debit a particular source account using its resource id

string

Comma-separated list of tags to filter the payments for

string

Filter for payments that were created as a result of a particular recurring mandate using its resource id

boolean

Only provide this parameter when you want to retrieve only scheduled payments (this includes payments resulting from a recurring mandate)

Headers
string
required
Defaults to Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJhdXRoLmdldGJyYXNzLmNvIiwiZXhwIjoxNjA4OTg4NTI0LCJpYXQiOjE2MDg5ODQ5MjQsIm5iZiI6MTYwODk4NDkyNCwiYXBpX2NsaWVudCI6ImFwcF82OEQ0eTJ3d1V0aENNV3BrTXZ5WjRZIiwiY3VzdG9tZXIiOiJjdXNfN0x0NWpIeXFmd3pXc1M1dVM5aFA1MiIsInVzZXIiOiJ1c3JfNE0xNTJVTWlMR05DYTE1cFlUQXZDcCJ9.spCnJ6iokwFMyt8MPZZ7CyFpLKW01EXHYLOYLb5URt55OS91-66xEl4ktySKgZwitXlf5W2WHrQmb8_lQx_F7S7uAIkv4gcmYC-Bu45IsADtQVQXyGJAyu-4-tGV5pxEKOxW5lr-XhtujSxTMM-OPkaz2lJFG9wX61uR0hnErcY

An auth level 2 token to authorize the call

Response

Updated about 5 years ago

Language
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 5 years ago