Skip to main content
POST
Onramp Transfer

Authorizations

x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
user_id
string<uuid>
required

The unique identifier of the user

Example:

"0abad22b-53d3-4473-b1ee-283f4b32e3ad"

wallet_id
string<uuid>
required

The unique identifier of the wallet

Example:

"34e9819d-2f1c-40a5-9404-a1be8fe34227"

open_banking
object

Open Banking payment options. When provided, the transfer uses the hosted Open Banking flow. Available for US, EU, and UK.

qr_payin
object

QR Payin payment options. Available exclusively for PHP (Philippine Peso) transactions. Generates a QR code that users can scan with their mobile banking app.

Response

Onramp transfer initiated successfully

transaction_id
string<uuid> | null

The unique identifier of the transaction

Example:

"76e12d55-1a25-457e-9e97-0495162de555"

source_currency
string

Source currency code (ISO 4217)

Example:

"PHP"

open_banking
object | null

Open Banking response data

qr_payin
object | null

QR Payin response data (PHP only)

v_bank
object | null

Virtual bank account details