Skip to main content
POST
/
payment
/
api
/
v1
/
transfers
/
onramp
Onramp Transfer
curl --request POST \
  --url https://api.carbnconnect.com/payment/api/v1/transfers/onramp \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "0abad22b-53d3-4473-b1ee-283f4b32e3ad",
  "wallet_id": "34e9819d-2f1c-40a5-9404-a1be8fe34227",
  "open_banking": {
    "amount": 3,
    "redirect_url": "https://www.google.com",
    "is_mobile_app": false,
    "country_codes": [
      "SWE"
    ]
  },
  "qr_payin": {
    "amount": 400
  }
}
'
{
  "transaction_id": "76e12d55-1a25-457e-9e97-0495162de555",
  "source_currency": "PHP",
  "open_banking": {
    "deposit_link": "https://secure.plaid.com/hl/lpps56nr6p98sn9r89341n78s8834q672q",
    "payment_id": "payment-id-production-2308307c-0d61-46d3-9225-50d48f607e36",
    "link_token": "link-production-cf01ae1c-43fa-4e34-896a-23f3389d127d"
  },
  "qr_payin": {
    "qr_code": "00020101021228600011ph.ppmi.p2m0111DCPHPHM1XXX03192147235668383093866050301152044814530360854034005802PH5904test6015MAHAGUN MORPHEU62380011ph.ppmi.p2m0519198581120859644569663048038",
    "expiry_time": "2026-02-10T07:13:58.621Z"
  },
  "v_bank": {
    "bic": "MODRIE22XXX",
    "iban": "IE44MODR99035511728566",
    "bank_name": "Modulr Finance, Ireland Branch",
    "payment_rail": "sepa"
  }
}

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

Open Banking response data

​
qr_payin
object

QR Payin response data (PHP only)

​
v_bank
object

Virtual bank account details