Send on-chain
Sends BTC, USDT or USDC to an address on a chain. `amount_minor` is in the asset's minor units.
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
Header Parameters
Idempotency-Key*string
Unique per payment. Retrying with the same key returns the same order.
Length
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
asset*string
chain*Chain
A chain that can hold a receive address. Lightning uses invoices instead.
Value in
- "bitcoin"
- "tron"
- "ethereum"
- "polygon"
- "solana"
- "base"
- "bsc"
amount_minor*integer
address*string
memo?string
customer_id?string
Optional. The customer this payment is for.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/transfers" \ -H "Idempotency-Key: 9f1c2f7e-3a55-4a1f-9d3f-6f6a0f4e51b2" \ -H "Content-Type: application/json" \ -d '{ "asset": "USDC", "chain": "bitcoin", "amount_minor": 10500000, "address": "string" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "reference": "string", "status": "successful", "currency": "string", "amount": "string", "amount_minor": "string", "fee": "string", "fee_minor": "string", "created_at": "2019-08-24T14:15:22Z" }}