v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Beneficiaries

List beneficiaries

List registered beneficiaries with query filtering options.

get/v1/beneficiaries

Query parameters

lastEvaluatedCreationDatetimestring

This is the last_evaluated_creation_datetime field from the response. You can use it to get the next page of results on a subsequent call.

perPagestring

Number of items per page, min=1, max=100, default=20.

order'DESC' | 'ASC'

Sort order. Results are ordered on the created_datetime field. Default=DESC.

namestring

Beneficiary name

aliasstring

Beneficiary alias

enabledboolean

Return only active or non-active beneficiaries flag. If not passed, all beneficiares are returned.

Headers

Authorizationstring required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message

Response

Response Body

last_evaluated_creation_datetimestring

Use this field to get next results

per_pageinteger

Items per page.

total_itemsinteger

Total items

Example response

{
  "items": [
    {
      "account_code": "7654321",
      "account_id": 78123456,
      "account_type": "TRAN",
      "alias": "Curveball",
      "bank_code": "1086",
      "beneficiary_id": "123e4567-e89b-12d3-a456-42661417",
      "branch": "5555555",
      "creation_datetime": "2023-04-12T23:20:50.52Z",
      "document_number": "123412341234",
      "enabled": true,
      "name": "Al Freydough",
      "region": "BR",
      "schema": "PIX",
      "updated_datetime": "2023-04-12T23:20:50.52Z"
    }
  ],
  "per_page": 10,
  "total_items": 100
}