Gyvar docs

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.

GET
/beneficiaries/{id}

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

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/beneficiaries/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "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"  }}