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": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "wallet_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "open_banking": true,
  "amount": 2
}'

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:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

​
wallet_id
string<uuid>
required

The unique identifier of the wallet

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

​
amount
number
required

The amount to transfer

Example:

2

​
open_banking
boolean

Whether to use open banking for the transfer

Example:

true

Response

Onramp transfer initiated successfully