Quickstart

This guide takes you end to end: create a deposit address, receive a stablecoin deposit into your merchant USD balance, then quote and initiate a payout to a whitelisted recipient.

Prerequisites

A Yara account. Sign in to the dashboard to create one.
An API key. See Authentication.

Get started

Get your API key

In the dashboard, open API keys and generate a key. Copy it somewhere safe — the full key is shown only once.

export YARA_API_KEY="your-secret-key"

Create a deposit address

Create a receive address on a supported chain. Store the returned id — it’s the stable identifier for the address.

curl https://api.yara.cash/v1/addresses \
  --request POST \
  --header "x-yara-api-key: $YARA_API_KEY" \
  --header "X-Idempotency-Key: $(uuidgen)" \
  --header "Content-Type: application/json" \
  --data '{ "chain": "BASE" }'

Share the returned address with whoever is funding it.

Receive a deposit

When stablecoins (USDC/USDT) arrive and confirm, Yara credits your merchant USD balance and sends a deposit.confirmed webhook. Check your balance any time:

curl https://api.yara.cash/v1/balance \
  --header "x-yara-api-key: $YARA_API_KEY"

{
  "data": {
    "available": "100.000000",
    "reserved": "0.000000",
    "pending_deposits": "0.000000",
    "currency": "USD"
  }
}

Quote a payout

To pay out, first quote a transfer to a whitelisted recipient. The quote locks in the rate and fee.

curl https://api.yara.cash/v1/transfers/quotes \
  --request POST \
  --header "x-yara-api-key: $YARA_API_KEY" \
  --header "X-Idempotency-Key: $(uuidgen)" \
  --header "Content-Type: application/json" \
  --data '{
    "recipient_id": "3bf24579-a35a-4ba9-a936-5df9c1d809f9",
    "amount": "15000",
    "currency": "NGN"
  }'

Initiate the transfer

Use the quote_id from the previous step to initiate the payout.

curl https://api.yara.cash/v1/transfers \
  --request POST \
  --header "x-yara-api-key: $YARA_API_KEY" \
  --header "X-Idempotency-Key: $(uuidgen)" \
  --header "Content-Type: application/json" \
  --data '{
    "quote_id": "0e0f7b9c-f47b-4f42-b56e-991b8f7a1cb3",
    "reference": "merchant-transfer-001"
  }'

Next steps

Core concepts

How addresses, balance, and transfers fit together.

API reference

Every endpoint, with a “Try it” console.

Need a hand? Email support@yara.cash.

Introduction

Build

Prerequisites

Get started

Next steps

Core concepts

API reference

​Prerequisites

​Get started

​Next steps

Core concepts

API reference

Prerequisites

Get started

Next steps