Onramp Transfer
Initiate a new 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"
}
'import requests
url = "https://api.carbnconnect.com/payment/api/v1/transfers/onramp"
payload = {
"user_id": "0abad22b-53d3-4473-b1ee-283f4b32e3ad",
"wallet_id": "34e9819d-2f1c-40a5-9404-a1be8fe34227"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_id: '0abad22b-53d3-4473-b1ee-283f4b32e3ad',
wallet_id: '34e9819d-2f1c-40a5-9404-a1be8fe34227'
})
};
fetch('https://api.carbnconnect.com/payment/api/v1/transfers/onramp', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.carbnconnect.com/payment/api/v1/transfers/onramp",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_id' => '0abad22b-53d3-4473-b1ee-283f4b32e3ad',
'wallet_id' => '34e9819d-2f1c-40a5-9404-a1be8fe34227'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.carbnconnect.com/payment/api/v1/transfers/onramp"
payload := strings.NewReader("{\n \"user_id\": \"0abad22b-53d3-4473-b1ee-283f4b32e3ad\",\n \"wallet_id\": \"34e9819d-2f1c-40a5-9404-a1be8fe34227\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.carbnconnect.com/payment/api/v1/transfers/onramp")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"0abad22b-53d3-4473-b1ee-283f4b32e3ad\",\n \"wallet_id\": \"34e9819d-2f1c-40a5-9404-a1be8fe34227\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.carbnconnect.com/payment/api/v1/transfers/onramp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"0abad22b-53d3-4473-b1ee-283f4b32e3ad\",\n \"wallet_id\": \"34e9819d-2f1c-40a5-9404-a1be8fe34227\"\n}"
response = http.request(request)
puts response.read_body{
"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
API key for authentication. Must be included in the x-api-key header.
Body
The unique identifier of the user
"0abad22b-53d3-4473-b1ee-283f4b32e3ad"
The unique identifier of the wallet
"34e9819d-2f1c-40a5-9404-a1be8fe34227"
Open Banking payment options. When provided, the transfer uses the hosted Open Banking flow. Available for US, EU, and UK.
Show child attributes
Show child attributes
QR Payin payment options. Available exclusively for PHP (Philippine Peso) transactions. Generates a QR code that users can scan with their mobile banking app.
Show child attributes
Show child attributes
Response
Onramp transfer initiated successfully
The unique identifier of the transaction
"76e12d55-1a25-457e-9e97-0495162de555"
Source currency code (ISO 4217)
"PHP"
Open Banking response data
Show child attributes
Show child attributes
QR Payin response data (PHP only)
Show child attributes
Show child attributes
Virtual bank account details
Show child attributes
Show child attributes
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"
}
'import requests
url = "https://api.carbnconnect.com/payment/api/v1/transfers/onramp"
payload = {
"user_id": "0abad22b-53d3-4473-b1ee-283f4b32e3ad",
"wallet_id": "34e9819d-2f1c-40a5-9404-a1be8fe34227"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_id: '0abad22b-53d3-4473-b1ee-283f4b32e3ad',
wallet_id: '34e9819d-2f1c-40a5-9404-a1be8fe34227'
})
};
fetch('https://api.carbnconnect.com/payment/api/v1/transfers/onramp', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.carbnconnect.com/payment/api/v1/transfers/onramp",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_id' => '0abad22b-53d3-4473-b1ee-283f4b32e3ad',
'wallet_id' => '34e9819d-2f1c-40a5-9404-a1be8fe34227'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.carbnconnect.com/payment/api/v1/transfers/onramp"
payload := strings.NewReader("{\n \"user_id\": \"0abad22b-53d3-4473-b1ee-283f4b32e3ad\",\n \"wallet_id\": \"34e9819d-2f1c-40a5-9404-a1be8fe34227\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.carbnconnect.com/payment/api/v1/transfers/onramp")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"0abad22b-53d3-4473-b1ee-283f4b32e3ad\",\n \"wallet_id\": \"34e9819d-2f1c-40a5-9404-a1be8fe34227\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.carbnconnect.com/payment/api/v1/transfers/onramp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"0abad22b-53d3-4473-b1ee-283f4b32e3ad\",\n \"wallet_id\": \"34e9819d-2f1c-40a5-9404-a1be8fe34227\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}