Gyvar docs
API reference v1Transactions

List transactions

Inbound and outbound together, newest first. `next_cursor` is returned only on a full page.

GET
/transactions

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

direction?string

Narrow to one direction.

Value in

  • "in"
  • "out"
currency?string

Asset code, e.g. USDT.

kind?string

Narrow to one kind of movement.

Value in

  • "payout"
  • "transfer"
  • "lightning"
  • "deposit"
status?string

Narrow to one status. Deposits are always successful.

Value in

  • "pending"
  • "successful"
  • "failed"
from?string

RFC3339. Inclusive lower bound on created_at.

Formatdate-time
to?string

RFC3339. Inclusive upper bound on created_at.

Formatdate-time
limit?integer

1-100, default 50. Larger values are treated as 100.

Range1 <= value <= 100
Default50
cursor?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/transactions"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "direction": "in",      "status": "successful",      "currency": "USDC",      "amount": "20.000000",      "amount_minor": "20000000",      "fee": "0.600000",      "fee_minor": "600000",      "created_at": "2019-08-24T14:15:22Z",      "reference": "WDR_TBJWZFYIYTM3KPF5",      "chain": "ethereum",      "network": "onchain",      "address": "string",      "hash": "string",      "invoice": "string",      "address_reference": "string",      "address_label": "string",      "completed_at": "2019-08-24T14:15:22Z",      "failure_code": "transfer_failed",      "failure_message": "string",      "settlement_currency": "GHS",      "settlement_decimals": 0,      "settlement_amount": "string",      "settlement_amount_minor": "string",      "rate": "string",      "destination": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "string",        "country": "string",        "network": "string",        "account_masked": "string",        "rail": "momo"      }    }  ],  "next_cursor": "string"}

Fetch a transaction by reference

Look up a transaction by its reference - `DEP_…` for a deposit, `WDR_…` for a payment - as shown in webhooks and receipts. Older `CTX_` and `LNX_` references also work. Direct on-chain receives have no reference; look those up by `id`.

Transfers

Send BTC, USDT or USDC to an on-chain address.