Skip to main content
POST
/
payment
/
api
/
v1
/
transfers
/
fx
Transfer
curl --request POST \
  --url https://api.carbnconnect.com/payment/api/v1/transfers/fx \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "user_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "destination_account_id": "9ae6fe4g-b798-545g-c1c6-b69ege7c280d",
  "amount": 100.5,
  "source_currency": "EUR",
  "target_currency": "USD",
  "exchange_rate": 1.085,
  "open_banking": true
}'

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"

​
destination_account_id
string<uuid>
required

The unique identifier of the destination account

Example:

"9ae6fe4g-b798-545g-c1c6-b69ege7c280d"

​
amount
number
required

The amount to transfer

Example:

100.5

​
source_currency
string
required

Source currency code (ISO 4217)

Example:

"EUR"

​
target_currency
string
required

Target currency code (ISO 4217)

Example:

"USD"

​
exchange_rate
number

Exchange rate from source to target currency (optional, will use current rate if not provided)

Example:

1.085

​
open_banking
boolean

Whether to use open banking for the transfer

Example:

true

Response

Transfer initiated successfully