Skip to main content

On-Ramp Payins (Fiat to Crypto)

Accept fiat payments from Payers and settle funds as crypto into a custodial Web3 wallet managed by Yugo.

For request/response schemas and field-level details, see the API Reference.


When to Use This Flow

Use On-Ramp Payins when you want to:

  • Receive fiat payments and settle as crypto in a Yugo-managed wallet
  • Let Payers pay via open banking, cards, Apple Pay, or Google Pay
  • Offload checkout, compliance, and authorization to Yugo

Prerequisites

Before using this flow, you must be onboarded as a Merchant with Yugo and have a merchant account opened.

During onboarding, Yugo configures:

  • Supported fiat currencies
  • Supported crypto assets
  • Blockchain networks
  • A custodial Web3 wallet managed by Yugo
  • Your API credentials for accessing the API

These settings are configured once during onboarding and are not provided dynamically in each API request.


Integration Flow

Step 1: Create a Payin Intent

Create a Payin Intent specifying the amount, Payer details, payment method, settlement method, and callback URLs.

API Reference: POST /payins View Create Payin API

Minimal Payin Intent Request
{
"amount": {
"value": "100.00",
"currency": "EUR"
},
"payer": {
"email": "payer@example.com",
"first_name": "John",
"last_name": "Doe",
"country": "DE"
},
"reference": "order_123",
"return_url": "https://merchant.com/checkout/complete",
"webhook_url": "https://merchant.com/api/webhooks/payins",
"payment": {
"method": "bank_account"
},
"settlement": {
"method": "yugo_balance"
}
}

Key fields:

  • payment.method = bank_account — triggers the open banking authorization flow
  • settlement.method = yugo_balance — funds are converted to crypto and delivered to the Merchant's custodial wallet

For payment-method-specific behavior, see Open Banking.


Step 2: Redirect the Payer

The Payin response contains a redirect_url. Redirect the Payer to this URL to continue the payment.

At this point:

  • Yugo hosts the checkout experience (in some cases this step is skipped)
  • The Payer completes the authorization flow for their chosen payment method
  • After completion, the Payer is redirected back to the Merchant's return_url
tip

The more payment details the Merchant supplies when creating the Payin Intent, the less friction for the Payer after redirect. In some cases, the Payer may be redirected directly back to the Merchant.

  • The Payer selects their bank (or is redirected directly if pre-selected)
  • The Payer authorizes the payment via their bank's authentication flow

For details, see Open Banking — Authorization Flow.


Step 3: Track Payin Status

Option A: Webhooks

Yugo sends a webhook every time the Payin status changes.

When you receive a webhook, we recommend verifying the updated status via the API (Option B).

API Reference: View Webhook Reference

Option B: Polling

You can retrieve the current Payin status at any time.

API Reference: GET /payins/{id} View Get Payin API

Status Lifecycle

See the Payin Status Lifecycle for the full state diagram and status definitions per payment and settlement method combination.

Status lifecycle for this flow:

StatusMeaning
INTENTPayin Intent created by Merchant
INITIATEDAuthorization process initiated (redirect link generated)
AUTHORIZEDPayment authorized by Payer's bank
RECEIVEDYugo received the fiat funds
SETTLEDCrypto transferred to Merchant's custodial wallet
COMPLETEDTransaction finalized.
FAILEDAuthorization failed or rejected by bank
EXPIREDPayin session expired

For the full state diagram, see Status Lifecycle.


Settlement

  • Bank authorization is real-time
  • Fiat transfer and conversion are asynchronous
  • Crypto is sent to the Merchant's custodial wallet after fiat Settlement completes

For full settlement details, see Yugo Balance Settlement.


Managing On-Ramp Funds

After Settlement, crypto funds are available in the Merchant Portal, where you can:

  • View wallet balances and transaction history
  • Manage received funds and Payouts
  • Configure API keys and users