Skip to main content
GET
/
beneficiaries
List beneficiaries
curl --request GET \
  --url https://api.prod.payana.cloud/public/api/v1/beneficiaries \
  --header 'api-key: <api-key>'
{
  "items": [
    {
      "reference": "be07b610-c6f6-465c-8c43-c6469d3a585f",
      "name": "Acme Inc.",
      "type": "supplier",
      "email": "[email protected]",
      "phone_number": null,
      "identifier_type": "NIT",
      "identifier_number": "112233449",
      "payment_terms": null,
      "fiscal_address": null,
      "contact_information": [
        {
          "type": "email",
          "value": "[email protected]"
        },
        {
          "type": "phone",
          "value": "+5725706683"
        }
      ],
      "bank_accounts": [
        {
          "reference": "35034bf9-babf-45c1-b9d1-c7267e2e02f0",
          "bank_reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
          "bank_name": "Banco de Bogotá",
          "account_number": "999999999"
        }
      ],
      "created_at": "2025-06-01T18:00:35.194+00:00",
      "updated_at": "2025-06-01T18:00:35.194+00:00"
    }
  ],
  "total": 1,
  "current_page": 1,
  "page_size": 25,
  "total_pages": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.payana.la/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api-key
string
header
required

API key provista por Payana.

Query Parameters

Texto para buscar por nombre.

page
integer
default:1

Página (1-indexed).

Required range: x >= 1
per_page
integer
default:25

Cantidad de ítems por página.

Required range: 1 <= x <= 100

Response

Beneficiaries list response

items
object[]
required
total
integer
required
current_page
integer
required
page_size
integer
required
total_pages
integer
required