Crypto-to-fiat Payments
A Guide to Crypto-to-fiat Payments, Compliance, and Webhooks with the Request Network API (V2)
Last updated
Was this helpful?
A Guide to Crypto-to-fiat Payments, Compliance, and Webhooks with the Request Network API (V2)
Last updated
Was this helpful?
Crypto-to-fiat payments let a payer pay a Request in cryptocurrency, while the payee receives fiat directly in their bank account. This is achieved by combining compliance (KYC/Agreement) and bank account registration (payment detail) flows, and combining the Request Network crypto payment with offramp infrastructure.
includes a reference implementation for this flow.
clientUserId
Many /payer
endpoints in the Request Network API require a clientUserId
as a path parameter. This value is an arbitrary identifier chosen by your platform to represent a user (the payer) in your own system.
You control the format: The clientUserId
can be any unique string that makes sense for your application. It can be a UUID, email address, database ID, or anything unique per user on your platform.
EasyInvoice Example: In the EasyInvoice demo app, clientUserId
is set to the user's email address.
Why is this useful? This approach allows you to integrate the Request Network API without having to change your existing user management logic. You simply pass your own identifier to the API, and all payer-related compliance, agreement, and payment detail records will be associated with that value.
Example usage:
In each case, replace {clientUserId}
with your chosen identifier for the user.
Before a payer can use crypto-to-fiat, they must complete compliance steps:
KYC: The payer must submit a KYC application.
Agreement: The payer must sign a compliance agreement (via an iframe flow).
Bank Account: The payee's bank account must be associated with a payer for compliance reasons, even though the payee owns the account.
Submit KYC: The platform collects KYC information from the payer and submits it to the API.
KYC Review: The platform receives webhook updates as the KYC is processed (compliance.updated
with kycStatus
).
Agreement Signature: The platform displays an iframe for the payer to sign the compliance agreement. Once signed, the platform calls the API to update the agreement status.
Agreement Confirmation: The platform receives a webhook update when the agreement is completed (compliance.updated
with agreementStatus
).
POST /payer
: Submit KYC application.
GET /payer/{clientUserId}
: Get compliance status for a payer.
PATCH /payer/{clientUserId}
: Update agreement status after signature.
Before a payer can pay in crypto and the payee can receive fiat, the platform must:
Submit the payee’s bank account details (associated with a payer for compliance).
Wait for approval of those payment details (usually less than 60 seconds, confirmed via webhook).
Create a new request with isCryptoToFiatAllowed = true
.
Submit Bank Account: The platform submits the payee’s bank account details, associating them with a payer. The Request Network API forwards these details to the offramp provider (Request Tech).
Approval: The platform receives a webhook (payment_detail.updated
) indicating if the payment details are approved, failed, or pending.
Create Request: Once approved, the platform creates a new request as usual, but with the isCryptoToFiatAllowed
flag set to true
. This signals that the request is eligible for crypto-to-fiat payment.
POST /payer/{clientUserId}/payment-details
: Create payment details (register bank account) for a payee.
GET /payer/{clientUserId}/payment-details
: Get payment details (bank accounts) for a payee.
POST /v2/request
with isCryptoToFiatAllowed = true
: Create a new crypto-to-fiat request
The payer pays in crypto; Request Tech handles offramping and fiat payout.
Flow Explanation
Get Payment Calldata: The platform fetches payment calldata for the request.
User Pays: The payer signs and submits the transaction, sending crypto to Request Tech.
Offramp Processing: Request Tech receives the crypto and begins the offramp process.
Event
Description
subStatus values (if any)
compliance.updated
KYC/Agreement status updates
kycStatus
: initiated
, pending
, approved
, rejected
, failed
agreementStatus
: not_started
, pending
, completed
, rejected
, failed
payment_detail.updated
Payment detail (bank account) status
approved
, failed
, pending
payment.processing
Offramp in progress
initiated
, pending_internal_assessment
, ongoing_checks
, sending_fiat
, fiat_sent
, bounced
, retry_required
payment.failed
Offramp or payment failed
failed
, bounced
payment.confirmed
Payment fully settled (fiat delivered)
Status Updates: The platform receives webhook events as the offramp progresses (, ), with indicating the current offramp stage.
Fiat Delivered: When the offramp is complete, the platform receives a final webhook ( with ), and then a event.
Retrieves the comprehensive compliance status for a specific user, including KYC and agreement status.
The client user ID to check compliance status for
user-123
API key for authentication
Retrieves the registered bank account details for a user. Optionally filter by payment details ID.
The client user ID to get payment details for
user-123
Optional ID of specific payment details to retrieve
fa898aec-519c-46be-9b4c-e76ef4ff99d9
API key for authentication
Checks compliance status and returns necessary URLs for completing compliance.
API key for authentication
Client User ID
First Name
Last Name
Company Name
Date of birth in YYYY-MM-DD format
^\d{4}-\d{2}-\d{2}$
Address Line 1
Address Line 2
City
State
Postcode
Country
Nationality
Phone in E.164 format
^\+?[1-9]\d{1,14}$
Social Security Number
Source of Funds
Business Activity
Update the agreement completion status for a user.
The client user ID to update
user-123
API key for authentication
Create payment details for a user
The client user ID
user-123
API key for authentication
Name of the bank
Name of the account holder
Bank account number
Bank routing number (US)
Type of beneficiary
Three-letter currency code (ISO 4217)
Primary address line
Secondary address line
City name
State or province code
Two-letter country code (ISO 3166-1 alpha-2)
Date of birth in YYYY-MM-DD format
^\d{4}-\d{2}-\d{2}$
Postal or ZIP code
Payment rail type
local
Possible values: UK bank sort code
Government-issued ID number
Type of government-issued ID (e.g., passport, driver's license)
Type of bank account
French RIB number
New Zealand NCC number
Bank branch code
Bank code
Create a new payment request
API key for authentication
The wallet address of the payer
The wallet address of the payee
The payable amount of the invoice, in human readable format
Invoice Currency ID, from the Request Network Token List e.g: USD
Payment currency ID, from the Request Network Token List e.g: ETH-sepolia-sepolia
Whether crypto-to-fiat payment is available for this request