curl --request POST \
--url https://api.useroutr.com/v1/funding_intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"destination": {
"rail": "stellar",
"asset": "crypto:USDC",
"target": {
"kind": "chain_address",
"address": "<string>",
"memo": "<string>"
}
},
"presentment_currency": "fiat:USD",
"customer_id": "<string>",
"reference": "<string>",
"metadata": {},
"policy": {
"optimize": "cost",
"max_slippage_bps": 1,
"allow_destination_call": true
}
}
'import requests
url = "https://api.useroutr.com/v1/funding_intents"
payload = {
"destination": {
"rail": "stellar",
"asset": "crypto:USDC",
"target": {
"kind": "chain_address",
"address": "<string>",
"memo": "<string>"
}
},
"presentment_currency": "fiat:USD",
"customer_id": "<string>",
"reference": "<string>",
"metadata": {},
"policy": {
"optimize": "cost",
"max_slippage_bps": 1,
"allow_destination_call": True
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
destination: {
rail: 'stellar',
asset: 'crypto:USDC',
target: {kind: 'chain_address', address: '<string>', memo: '<string>'}
},
presentment_currency: 'fiat:USD',
customer_id: '<string>',
reference: '<string>',
metadata: {},
policy: {optimize: 'cost', max_slippage_bps: 1, allow_destination_call: true}
})
};
fetch('https://api.useroutr.com/v1/funding_intents', 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.useroutr.com/v1/funding_intents",
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([
'destination' => [
'rail' => 'stellar',
'asset' => 'crypto:USDC',
'target' => [
'kind' => 'chain_address',
'address' => '<string>',
'memo' => '<string>'
]
],
'presentment_currency' => 'fiat:USD',
'customer_id' => '<string>',
'reference' => '<string>',
'metadata' => [
],
'policy' => [
'optimize' => 'cost',
'max_slippage_bps' => 1,
'allow_destination_call' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.useroutr.com/v1/funding_intents"
payload := strings.NewReader("{\n \"destination\": {\n \"rail\": \"stellar\",\n \"asset\": \"crypto:USDC\",\n \"target\": {\n \"kind\": \"chain_address\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\"\n }\n },\n \"presentment_currency\": \"fiat:USD\",\n \"customer_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"metadata\": {},\n \"policy\": {\n \"optimize\": \"cost\",\n \"max_slippage_bps\": 1,\n \"allow_destination_call\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.useroutr.com/v1/funding_intents")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": {\n \"rail\": \"stellar\",\n \"asset\": \"crypto:USDC\",\n \"target\": {\n \"kind\": \"chain_address\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\"\n }\n },\n \"presentment_currency\": \"fiat:USD\",\n \"customer_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"metadata\": {},\n \"policy\": {\n \"optimize\": \"cost\",\n \"max_slippage_bps\": 1,\n \"allow_destination_call\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useroutr.com/v1/funding_intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": {\n \"rail\": \"stellar\",\n \"asset\": \"crypto:USDC\",\n \"target\": {\n \"kind\": \"chain_address\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\"\n }\n },\n \"presentment_currency\": \"fiat:USD\",\n \"customer_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"metadata\": {},\n \"policy\": {\n \"optimize\": \"cost\",\n \"max_slippage_bps\": 1,\n \"allow_destination_call\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "fi_...",
"status": "created",
"destination": {
"rail": "stellar",
"asset": "crypto:USDC",
"target": {
"kind": "chain_address",
"address": "<string>",
"memo": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"amount": {
"amount": "100.00",
"asset": "crypto:USDC"
},
"pay_to": [
{
"rail": "stellar",
"asset": "crypto:USDC",
"address": "<string>",
"memo": "<string>"
}
],
"reference": "<string>",
"metadata": {},
"checkout_url": "<string>",
"failure": {
"code": "amount_below_minimum",
"message": "<string>",
"retryable": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "validation_error",
"request_id": "<string>",
"param": "<string>",
"retryable": true,
"retry_after_seconds": 123,
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "validation_error",
"request_id": "<string>",
"param": "<string>",
"retryable": true,
"retry_after_seconds": 123,
"docs_url": "<string>"
}
}Create a funding intent
curl --request POST \
--url https://api.useroutr.com/v1/funding_intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"destination": {
"rail": "stellar",
"asset": "crypto:USDC",
"target": {
"kind": "chain_address",
"address": "<string>",
"memo": "<string>"
}
},
"presentment_currency": "fiat:USD",
"customer_id": "<string>",
"reference": "<string>",
"metadata": {},
"policy": {
"optimize": "cost",
"max_slippage_bps": 1,
"allow_destination_call": true
}
}
'import requests
url = "https://api.useroutr.com/v1/funding_intents"
payload = {
"destination": {
"rail": "stellar",
"asset": "crypto:USDC",
"target": {
"kind": "chain_address",
"address": "<string>",
"memo": "<string>"
}
},
"presentment_currency": "fiat:USD",
"customer_id": "<string>",
"reference": "<string>",
"metadata": {},
"policy": {
"optimize": "cost",
"max_slippage_bps": 1,
"allow_destination_call": True
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
destination: {
rail: 'stellar',
asset: 'crypto:USDC',
target: {kind: 'chain_address', address: '<string>', memo: '<string>'}
},
presentment_currency: 'fiat:USD',
customer_id: '<string>',
reference: '<string>',
metadata: {},
policy: {optimize: 'cost', max_slippage_bps: 1, allow_destination_call: true}
})
};
fetch('https://api.useroutr.com/v1/funding_intents', 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.useroutr.com/v1/funding_intents",
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([
'destination' => [
'rail' => 'stellar',
'asset' => 'crypto:USDC',
'target' => [
'kind' => 'chain_address',
'address' => '<string>',
'memo' => '<string>'
]
],
'presentment_currency' => 'fiat:USD',
'customer_id' => '<string>',
'reference' => '<string>',
'metadata' => [
],
'policy' => [
'optimize' => 'cost',
'max_slippage_bps' => 1,
'allow_destination_call' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.useroutr.com/v1/funding_intents"
payload := strings.NewReader("{\n \"destination\": {\n \"rail\": \"stellar\",\n \"asset\": \"crypto:USDC\",\n \"target\": {\n \"kind\": \"chain_address\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\"\n }\n },\n \"presentment_currency\": \"fiat:USD\",\n \"customer_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"metadata\": {},\n \"policy\": {\n \"optimize\": \"cost\",\n \"max_slippage_bps\": 1,\n \"allow_destination_call\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.useroutr.com/v1/funding_intents")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": {\n \"rail\": \"stellar\",\n \"asset\": \"crypto:USDC\",\n \"target\": {\n \"kind\": \"chain_address\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\"\n }\n },\n \"presentment_currency\": \"fiat:USD\",\n \"customer_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"metadata\": {},\n \"policy\": {\n \"optimize\": \"cost\",\n \"max_slippage_bps\": 1,\n \"allow_destination_call\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useroutr.com/v1/funding_intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": {\n \"rail\": \"stellar\",\n \"asset\": \"crypto:USDC\",\n \"target\": {\n \"kind\": \"chain_address\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\"\n }\n },\n \"presentment_currency\": \"fiat:USD\",\n \"customer_id\": \"<string>\",\n \"reference\": \"<string>\",\n \"metadata\": {},\n \"policy\": {\n \"optimize\": \"cost\",\n \"max_slippage_bps\": 1,\n \"allow_destination_call\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "fi_...",
"status": "created",
"destination": {
"rail": "stellar",
"asset": "crypto:USDC",
"target": {
"kind": "chain_address",
"address": "<string>",
"memo": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"amount": {
"amount": "100.00",
"asset": "crypto:USDC"
},
"pay_to": [
{
"rail": "stellar",
"asset": "crypto:USDC",
"address": "<string>",
"memo": "<string>"
}
],
"reference": "<string>",
"metadata": {},
"checkout_url": "<string>",
"failure": {
"code": "amount_below_minimum",
"message": "<string>",
"retryable": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "validation_error",
"request_id": "<string>",
"param": "<string>",
"retryable": true,
"retry_after_seconds": 123,
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "validation_error",
"request_id": "<string>",
"param": "<string>",
"retryable": true,
"retry_after_seconds": 123,
"docs_url": "<string>"
}
}Authorizations
Server-side only. Never ships to a browser.
Headers
Required on every mutating request. Absent is a 400.
8 - 200Body
One shape for a bank account, a blockchain address, a card, and an internal balance. Used for both sources and destinations: direction is a property of the transfer, never of the type.
Show child attributes
Show child attributes
Omit for open-amount funding.
Show child attributes
Show child attributes
"fiat:USD"
Your own order id. Unique per application. Not a substitute for the idempotency header.
Show child attributes
Show child attributes
Response
Created
"fi_..."
Route shape never appears here. Values may be added in a minor version, so every client switch must carry a default.
created, quoted, awaiting_payment, payment_received, in_review, settling, settled, partially_settled, undeliverable, failed, refund_pending, refunded, refund_failed, expired, canceled One shape for a bank account, a blockchain address, a card, and an internal balance. Used for both sources and destinations: direction is a property of the transfer, never of the type.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Where the payer should send. One entry per rail that can receive.
Show child attributes
Show child attributes
Show child attributes
Show child attributes

