Retrieve Beneficiary

get

https://api.xpollens.com/api/v2.0/users/{appUserId}/beneficiary

Description

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

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…

Description

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

Prerequiste

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

Path Params

appUserId

string

required

User identifier from the Partner.

Format: min 6 characters, max 30 characters

Accepted characters: 0-9 a-z A-Z _ - . ! § ( )

Regex: ^[a-zA-Z0-9-_.!§)(]*$

Query Params

iban

string

IBAN(International Bank Account Number).

Format: min 15 characters, max 34 characters

Regex: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$

after

uuid

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

Format : UUID - 36 characters

before

uuid

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

Format : UUID - 36 characters

limit

int32

Defaults to 100

Number of beneficiaries per page.The maximum number of beneficiaries per page is limited to 500.

Headers

CorrId

string

Defaults to 55bb9d99-0b4b-4a53-9d8f-c8d9da84b1e5

Correlation Id

Responses

Description

Prerequiste

200OK

206Partial Content

400Bad Request

500Internal Server Error