Search Counterparties V2

post

https://api.sandbox.braid.zone/v2/counterparty/search

Query Params

pageNumber

int32

Defaults to 0

pageSize

int32

Defaults to 100

Body Params

associatedEntityType

string

enum

Associated entity type the counterparty belongs to

Allowed:

associatedEntityId

int32

Associated entity id (must be provided together with associatedEntityType)

name

string

Name of the counterparty (case-insensitive LIKE match)

statuses

array of strings

Counterparty statuses to include

statuses

Allowed:

paymentInstrumentDirection

string

enum

Filter payment instruments by direction

Allowed:

paymentInstrumentTypes

array of strings

Filter payment instruments by rail

paymentInstrumentTypes

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Entity

500Internal Server Error

503Service Unavailable