Remitflex Documentation

POST

/

swaps

curl

curl -X POST https://api.remitflex.io/v1/swaps \
  -H "Authorization: Bearer $REMITFLEX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"from":"USDC","to":"EURC","amount":100,"tradeType":"exact_input","destinationAddress":"2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB","refundTo":"2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB"}'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    from: 'USDC',
    to: 'EURC',
    amount: 100,
    destinationAddress: '2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB',
    refundTo: '2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB'
  })
};

fetch('http://localhost:4000/v1/swaps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:4000/v1/swaps"

payload = {
    "from": "USDC",
    "to": "EURC",
    "amount": 100,
    "destinationAddress": "2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB",
    "refundTo": "2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "status": "error",
  "message": "Idempotency-Key header is required for API key requests"
}

{
  "status": "error",
  "message": "Unsupported currency pair"
}

Authorizations

Authorization

string

header

required

API key created in the Remitflex Dashboard at dashboard.remitflex.io (rmf_live_... or rmf_test_...). Key management endpoints require a dashboard JWT and are not part of this reference.

Headers

Idempotency-Key

string

required

Unique key for safe retries on mutating API-key requests. Cached for 24 hours per org, method, and path.

Maximum string length: 255

Example:

"7f3c2a1b-4e5d-6c7b-8a9f-0e1d2c3b4a5f"

Body

application/json

from

enum<string>

required

Source currency on Solana.

Available options:

USDC,

EURC

Example:

"USDC"

to

enum<string>

required

Destination currency on Solana.

Available options:

USDC,

EURC

Example:

"EURC"

amount

number

required

Human-readable amount. For exact_input, amount to send. For exact_output, amount to receive.

Required range: x <= 1000000000

Example:

100

destinationAddress

string

required

Solana address to receive swapped tokens.

Required string length: 32 - 64

Example:

"2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB"

refundTo

string

required

Solana address for Relay refunds (always required).

Required string length: 32 - 64

Example:

"2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB"

tradeType

enum<string>

default:exact_input

Whether amount is the send side or receive side.

Available options:

exact_input,

exact_output

customerId

string

Customer under your org. Defaults to the org primary customer.

Required string length: 1 - 128

Response

Swap created

status

string

Example:

"success"

message

string

data

object

Show child attributes

curl

curl -X POST https://api.remitflex.io/v1/swaps \
  -H "Authorization: Bearer $REMITFLEX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"from":"USDC","to":"EURC","amount":100,"tradeType":"exact_input","destinationAddress":"2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB","refundTo":"2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB"}'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    from: 'USDC',
    to: 'EURC',
    amount: 100,
    destinationAddress: '2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB',
    refundTo: '2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB'
  })
};

fetch('http://localhost:4000/v1/swaps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:4000/v1/swaps"

payload = {
    "from": "USDC",
    "to": "EURC",
    "amount": 100,
    "destinationAddress": "2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB",
    "refundTo": "2dudFU32c5wsRpfRZDXBAJFirHC4hindqpKSCwwtDaAB"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "status": "error",
  "message": "Idempotency-Key header is required for API key requests"
}

{
  "status": "error",
  "message": "Unsupported currency pair"
}