Gyvar docs
API reference v1Payouts

Look up an account

Returns the name on a bank or mobile-money account, so you can confirm who you are paying before you pay. Available where the corridor's `name_enquiry` is true. Needs a key with the `money` capability.

POST
/accounts/lookup

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

country*string
currency?string

Needed where the country has more than one corridor.

type*string

Value in

  • "bank"
  • "mobile_money"
bank_code?string

Bank code, or the network for mobile money.

account_number*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/accounts/lookup" \  -H "Content-Type: application/json" \  -d '{    "country": "GH",    "type": "bank",    "account_number": "0241234567"  }'
{  "data": {    "verified": true,    "account_name": "AMA MENSAH",    "bank_name": "string"  }}

Pay a beneficiary in local currency

Converts from your Bitcoin or stablecoin balance and pays out in local currency, in one call. `amount_minor` is what leaves your wallet. Set `min_settlement_amount_minor` to have the payout refused, with nothing debited, if the recipient would get less (`slippage_exceeded`). Pay a saved `beneficiary_id`, or a new `destination`. Some corridors also need a `sender`.

Transactions

Every movement on the business's balance, inbound and outbound, newest first.