Gyvar docs
API reference v1Beneficiaries

List beneficiaries

Keyset paginated, newest first. `next_cursor` is present only on a full page.

GET
/beneficiaries

Authorization

KeyID Timestamp Nonce Signature
X-Gyvar-Key<token>

Your key id, gyv_k_live_... or gyv_k_sandbox_....

In: header

X-Gyvar-Timestamp<token>

Unix seconds. Must be within 5 minutes of our clock.

In: header

X-Gyvar-Nonce<token>

A unique value per request. Replays are rejected.

In: header

X-Gyvar-Signature<token>

Ed25519 signature over the canonical string. See the Signing guide.

In: header

Query Parameters

limit?integer

1-100. Values above 100 are clamped, not rejected.

Range1 <= value <= 100
Default50
cursor?string

The next_cursor from the previous page. Opaque - do not construct or parse one. A malformed cursor is a 400, never a silent reset to page one.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/beneficiaries"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "bank",      "country": "GH",      "currency": "GHS",      "account_masked": "**** 3456",      "label": "string",      "bank_code": "MTN",      "business_code": "string",      "name_verified": true,      "usable": true,      "usable_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}

Fetch a beneficiary

The other half of the join: a payment row publishes `destination.id`, and this is where that id resolves. A destination that is not yours is a 404, never a 403. A destination you have since REMOVED is also a 404 - the payment itself still carries the masked account, which is the durable record of where the money went.

Corridors

Where Gyvar can pay out to, right now.