Counterparts

Get all counterparts

get/counterparts

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/counterparts
  • Auth: HTTP bearer

Query parameters

ibanstring

The IBAN of the counterpart's bank account.

sort_codestring

The bank's sort code.

account_numberstring

The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits.

tax_idstring

The tax ID of the counterpart.

vat_idstring

The VAT ID of the counterpart.

id__instring uuid

A list of counterpart IDs to search through.

order'asc' | 'desc'

Sort order (ascending by default). Typically used together with the sort parameter.

limitinteger

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstring

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

sort'counterpart_name'

The field to sort the results by. Typically used together with the order parameter.

type'individual' | 'organization'
counterpart_namestring
counterpart_name__iexactstring
counterpart_name__containsstring
counterpart_name__icontainsstring
is_vendorboolean
is_customerboolean
emailstring
email__containsstring
email__icontainsstring
created_at__gtstring date-time
created_at__ltstring date-time
created_at__gtestring date-time
created_at__ltestring date-time
address.countrystring
address.citystring
address.postal_codestring
address.statestring
address.line1string
address.line2string
tag_ids__instring uuid

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Response

Successful Response

next_pagination_tokenstring

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you've reached the last page).

prev_pagination_tokenstring

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you've reached the first page).

Changes

No recorded changes to this operation across all 1 revision of this API.