Gyvar docs

The Beneficiary object

The shape of a beneficiary wherever the API returns one.

Every endpoint that returns a beneficiary returns this shape, wrapped in a data envelope.

Attributes

id

uuid · always present

What you pay this destination by.

type

enum · always present

— One of: bank, mobile_money, paybill, paytill, swift, ach, wire.

country

string · always present

—

currency

string · always present

—

account_masked

string · always present

Last four digits of the account.

label

string · optional

Your note for this destination.

bank_code

string · optional

Bank code, or the network for mobile money.

business_code

string · optional

The second identifier where needed - the M-Pesa paybill number.

name_verified

boolean · always present

Whether the account holder's name was confirmed by lookup.

usable

boolean · always present

Whether this destination can be paid now. A new destination waits out a short cooling-off period.

usable_at

timestamp · optional

When the cooling-off period ends. Present only while usable is false.

created_at

timestamp · always present

—

The Beneficiary object
{
  "id": "0d6c2f3a-1b4e-4c9a-9f2d-7a1e5c8b3d60",
  "type": "bank",
  "country": "GH",
  "currency": "GHS",
  "account_masked": "**** 3456",
  "label": "<label>",
  "bank_code": "MTN",
  "business_code": "<business_code>",
  "name_verified": "<name_verified>",
  "usable": "<usable>",
  "usable_at": "2026-09-01T10:04:11Z",
  "created_at": "2026-09-01T10:04:11Z"
}

On this page