List beneficiaries
Newest first. `next_cursor` is returned only on a full page.
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, default 50. Larger values are treated as 100.
Range
1 <= value <= 100Default
50cursor?string
The next_cursor from the previous page. Treat it as opaque.
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"}