Get counterparty List

get

https://sb-api.xpollens.com/api/v3.0/counterparty

Description

This endpoint allows to consult the list of outgoing counterparties (associated to a third party / user).

Counterparties with status Rejected or Deleted, as well as incoming counterparties, cannot be retrieved.
If status is omitted, default is Validated.

Prerequisite

To access this endpoint, authentication is required. Credentials are to be provided in the request headers as part of the authentication process.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

UserId

string

User identifier from the Partner.

Iban

string

Counterparty IBAN (International Bank Account Number).

Status

array of strings, unique

Current counterparty status. Possible values: AwaitingBankDetails, UnderReview, Validated (default). Repeatable.

StatusReason

string

enum

Additional context explaining why the counterparty has attained its current status. Possible values: BankDetailsNotRequired (Validated), BankDetailsAccepted (Validated), BankDetailsReview (UnderReview).

Allowed:

Scopes

array of strings, unique

Scope(s) of use of the counterparty. Only counterparties with all the given scopes are retrieved. Possible values: CreditTransferBeneficiary (default), DirectDebitDebtor. Repeatable.

Before

uuid

For pagination purposes, use with the previous field in the response body. Non inclusive cursor (CounterpartyId expected).

After

uuid

For pagination purposes, use with the next field in the response body. Non inclusive cursor (CounterpartyId expected).

Limit

int32

1 to 100

Defaults to 100

Number of counterparties per page.

Headers

CorrId

uuid

Correlation identifier used for request tracing.

Responses

500

Internal Server Error

Language

Credentials

Loading…

Response

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

application/json

200OK

400Bad Request