Recipients-Get-v6

From Barion Documentation
Jump to navigation Jump to search

Barion API: List my recipients

GET /v6/recipients

The /v6/recipients API endpoint can be used to list or search the recipients of a wallet with all of its payout methods. The number of recipients in the response can be limited. Paging is supported with a cursor. The order of the results is according to the alphabetical order of the "last name + first name" and "company name" fields.

Prerequisites before use:


v6 This API endpoint is available in API v6.

Authentication

Barion Wallet Authentication

Input properties

The input properties should be defined in the query string.

Property name Property type Limitations and constraints Description
limit int
  • Optional
  • Accepted range: 1–200
  • Default value: 100
Number of recipients to return.
cursor string
  • Optional
Opaque string used for paging. Returns limit recipients after the given cursor position. If not specified, the first limit items are returned.
Note: If the cursor is specified, all other filtering and ordering parameters are ignored — everything is already encoded in the cursor.
search string
  • Optional
  • Maximum length: 100 characters
Returns only those recipients whose display name contains this value (case-insensitive).
afterModifiedDate DateTime
  • Optional
  • ISO 8601 format, e.g. 2014-12-06T08:35:46Z
  • Universal Time Coordinated (UTC)
Returns all items that were created, modified, or deleted after the given date.
showDeleted bool
  • Optional
If true, deleted recipients and payout methods are included in the response. Deleted items will have the isDeleted field set to true.

Output properties

The response is an object of the following structure:

Property name Property type Description
<root> Object
hasMore bool Indicates whether there are more items available beyond the current page.
nextCursor string Cursor to be used in the next request to retrieve the following page of results.
data Object Array Array of recipient objects.
data.id string Unique identifier of the recipient. Format: rcp_<ordered-base64-ulid>
data.recipientType string Type of the recipient. Accepted values: individual or business.
data.companyName string Name of the company. Only present if data.recipientType is business.
data.firstName string First name of the recipient. Only present if data.recipientType is individual.
data.lastName string Last name of the recipient. Only present if data.recipientType is individual.
data.isDeleted bool Indicates whether the recipient has been deleted. Only present in the response if showDeleted is true in the request.
data.payoutMethods Object Array List of payout methods associated with the recipient. See the object.

To find out which errors this endpoint can produce, visit the Calling the API – Handling the response page. Note that this endpoint uses camelCase field names in error responses.

Possible error messages

Condition ErrorCode HTTP status code
Authentication fails 401