curl --request POST \
--url https://vibe-api.liquidramp.com/v1/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient": {
"address": "0x34DF48981ce4d1899a2b1139CC0fDDb6951C4053"
},
"customer": {
"reference": "cust-001",
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+2348012345678"
}
}
'{
"status": true,
"message": "<string>",
"data": {
"reference": "<string>",
"merchant_reference": "<string>",
"customer_reference": "<string>",
"type": "onramp",
"from": {
"currency": "<string>",
"network": "<string>",
"amount": 123
},
"to": {
"currency": "<string>",
"network": "<string>",
"amount": 123
},
"pricing": {
"base_currency": "<string>",
"quote_currency": "<string>",
"exchange_rate": 123
},
"fee": {
"currency": "<string>",
"network_fee": 123,
"protocol_fee": 123,
"partner_fee": 123,
"vat": 123,
"total": 123,
"fee_in_rate": true
},
"metadata": {},
"amount_paid": 123,
"amount_settled": 123,
"amount_refunded": 123,
"percentage_settled": 123,
"status": "initiated",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"recipient": {
"institution_code": "<string>",
"account_number": "<string>",
"account_name": "<string>",
"memo": "<string>"
},
"payin": {
"currency": "<string>",
"account_name": "<string>",
"account_number": "<string>",
"institution_code": "<string>",
"amount": 123,
"tx_reference": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"paid_at": "2023-11-07T05:31:56Z"
},
"payout": [
{
"currency": "<string>",
"account_name": "<string>",
"account_number": "<string>",
"institution_code": "<string>",
"amount": 123,
"percentage": 123,
"tx_reference": "<string>",
"paid_at": "2023-11-07T05:31:56Z"
}
],
"refund": {
"currency": "<string>",
"account_name": "<string>",
"account_number": "<string>",
"institution_code": "<string>",
"amount": 123,
"tx_reference": "<string>",
"refunded_at": "2023-11-07T05:31:56Z"
},
"timeline": [
{
"group": "<string>",
"event": "<string>",
"details": "<unknown>",
"created_at": "2023-11-07T05:31:56Z"
}
]
},
"meta": {
"total": 123,
"per_page": 123,
"current_page": 123,
"last_page": 123
}
}{
"status": false,
"code": "E_VALIDATION_ERROR",
"message": "recipient: recipient is required"
}Orders
Create order
Unified order creation for onramp, offramp, and swap. Provide quote_id from a reserved quote, or from/to legs directly.
Recipient rules:
- Offramp:
institution_code,account_number,account_name - Onramp and swap:
address(optional on-chainmemo)
Auth: Secret key + HMAC. Account must be KYB-approved.
Best practice: Pass quote_id to lock pricing. Use a unique merchant_reference so you can correlate retries on your side.
POST
/
v1
/
orders
curl --request POST \
--url https://vibe-api.liquidramp.com/v1/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient": {
"address": "0x34DF48981ce4d1899a2b1139CC0fDDb6951C4053"
},
"customer": {
"reference": "cust-001",
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+2348012345678"
}
}
'{
"status": true,
"message": "<string>",
"data": {
"reference": "<string>",
"merchant_reference": "<string>",
"customer_reference": "<string>",
"type": "onramp",
"from": {
"currency": "<string>",
"network": "<string>",
"amount": 123
},
"to": {
"currency": "<string>",
"network": "<string>",
"amount": 123
},
"pricing": {
"base_currency": "<string>",
"quote_currency": "<string>",
"exchange_rate": 123
},
"fee": {
"currency": "<string>",
"network_fee": 123,
"protocol_fee": 123,
"partner_fee": 123,
"vat": 123,
"total": 123,
"fee_in_rate": true
},
"metadata": {},
"amount_paid": 123,
"amount_settled": 123,
"amount_refunded": 123,
"percentage_settled": 123,
"status": "initiated",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"recipient": {
"institution_code": "<string>",
"account_number": "<string>",
"account_name": "<string>",
"memo": "<string>"
},
"payin": {
"currency": "<string>",
"account_name": "<string>",
"account_number": "<string>",
"institution_code": "<string>",
"amount": 123,
"tx_reference": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"paid_at": "2023-11-07T05:31:56Z"
},
"payout": [
{
"currency": "<string>",
"account_name": "<string>",
"account_number": "<string>",
"institution_code": "<string>",
"amount": 123,
"percentage": 123,
"tx_reference": "<string>",
"paid_at": "2023-11-07T05:31:56Z"
}
],
"refund": {
"currency": "<string>",
"account_name": "<string>",
"account_number": "<string>",
"institution_code": "<string>",
"amount": 123,
"tx_reference": "<string>",
"refunded_at": "2023-11-07T05:31:56Z"
},
"timeline": [
{
"group": "<string>",
"event": "<string>",
"details": "<unknown>",
"created_at": "2023-11-07T05:31:56Z"
}
]
},
"meta": {
"total": 123,
"per_page": 123,
"current_page": 123,
"last_page": 123
}
}{
"status": false,
"code": "E_VALIDATION_ERROR",
"message": "recipient: recipient is required"
}Authorizations
Bearer sk_* plus required headers:
- liquidramp-client-id
- liquidramp-timestamp (unix ms)
- liquidramp-signature (sha256=...)
Body
application/json
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
⌘I