Skip to main content
GET
/
v1
/
recipients
List recipients
curl --request GET \
  --url https://api.balampay.com/v1/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Api-Version: <x-api-version>' \
  --header 'x-api-key: <api-key>'
[
  {
    "recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "account_type": "<string>",
    "account_details": {},
    "created_ts": "<string>",
    "updated_ts": "<string>",
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "company_name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "address": "<string>",
    "metadata": {}
  }
]

Authorizations

​
Authorization
string
header
required

Access token from POST /auth (the data.access_token value).

​
x-api-key
string
header
required

API key issued by Kira. Required on every request, including /auth.

Headers

​
X-Api-Version
string
required
Example:

"2026-04-14"

Response

Success.

​
recipient_id
string<uuid>
required
​
type
string
required
​
account_type
string
required
​
account_details
object
required
​
created_ts
string
required
​
updated_ts
string
required
​
first_name
string
​
middle_name
string
​
last_name
string
​
company_name
string
​
phone
string
​
email
string
​
address
​
metadata
object