Payments
Create Direct Payment
Creates a new direct payment that is immediately sent to the specified receiver if they have a valid registered wallet. Direct payments bypass the disbursement workflow and are processed instantly.
Create Direct Payment
curl --request POST \
--url https://api.example.com/payments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "<string>",
"asset": {
"id": "<string>",
"code": "<string>",
"issuer": "<string>",
"contract_id": "<string>"
},
"receiver": {
"id": "<string>",
"email": "<string>",
"phone_number": "<string>",
"wallet_address": "<string>"
},
"wallet": {
"id": "<string>",
"address": "<string>"
},
"external_payment_id": "<string>"
}
'import requests
url = "https://api.example.com/payments"
payload = {
"amount": "<string>",
"asset": {
"id": "<string>",
"code": "<string>",
"issuer": "<string>",
"contract_id": "<string>"
},
"receiver": {
"id": "<string>",
"email": "<string>",
"phone_number": "<string>",
"wallet_address": "<string>"
},
"wallet": {
"id": "<string>",
"address": "<string>"
},
"external_payment_id": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
asset: {id: '<string>', code: '<string>', issuer: '<string>', contract_id: '<string>'},
receiver: {
id: '<string>',
email: '<string>',
phone_number: '<string>',
wallet_address: '<string>'
},
wallet: {id: '<string>', address: '<string>'},
external_payment_id: '<string>'
})
};
fetch('https://api.example.com/payments', 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.example.com/payments",
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([
'amount' => '<string>',
'asset' => [
'id' => '<string>',
'code' => '<string>',
'issuer' => '<string>',
'contract_id' => '<string>'
],
'receiver' => [
'id' => '<string>',
'email' => '<string>',
'phone_number' => '<string>',
'wallet_address' => '<string>'
],
'wallet' => [
'id' => '<string>',
'address' => '<string>'
],
'external_payment_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.example.com/payments"
payload := strings.NewReader("{\n \"amount\": \"<string>\",\n \"asset\": {\n \"id\": \"<string>\",\n \"code\": \"<string>\",\n \"issuer\": \"<string>\",\n \"contract_id\": \"<string>\"\n },\n \"receiver\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"wallet_address\": \"<string>\"\n },\n \"wallet\": {\n \"id\": \"<string>\",\n \"address\": \"<string>\"\n },\n \"external_payment_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.example.com/payments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"asset\": {\n \"id\": \"<string>\",\n \"code\": \"<string>\",\n \"issuer\": \"<string>\",\n \"contract_id\": \"<string>\"\n },\n \"receiver\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"wallet_address\": \"<string>\"\n },\n \"wallet\": {\n \"id\": \"<string>\",\n \"address\": \"<string>\"\n },\n \"external_payment_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"asset\": {\n \"id\": \"<string>\",\n \"code\": \"<string>\",\n \"issuer\": \"<string>\",\n \"contract_id\": \"<string>\"\n },\n \"receiver\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"wallet_address\": \"<string>\"\n },\n \"wallet\": {\n \"id\": \"<string>\",\n \"address\": \"<string>\"\n },\n \"external_payment_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "ddf22f55-3259-4822-a4e2-ce01334997f4",
"amount": "100.00",
"stellar_transaction_id": "0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b",
"circle_transaction_id": "74a68b6a-3f67-424b-b8b0-e593a19d7463",
"circle_transaction_type": "TRANSFER",
"stellar_operation_id": "<string>",
"source_wallet_id": "4c379f5e-09b5-4472-a286-b84e249a1512",
"status": "DRAFT",
"status_history": [
{
"status": "DRAFT",
"status_message": "<string>",
"timestamp": "2023-02-03T10:45:51Z"
}
],
"type": "DISBURSEMENT",
"disbursement": {
"id": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43",
"name": "disbursement-june-29",
"receiver_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
"registration_contact_type": "EMAIL",
"status": "DRAFT",
"verification_field": "DATE_OF_BIRTH",
"status_history": [
{
"user_id": "3f351b9e-ed0f-40fa-a314-14757b42dab1",
"status": "DRAFT",
"timestamp": "2023-02-03T10:45:51Z"
}
],
"file_name": "disbursement-feb-03-2023.csv",
"created_at": "2023-06-30T01:22:57.831975Z",
"updated_at": "2023-06-30T01:22:58.316511Z"
},
"asset": {
"id": "ffaec4b3-46b0-4db4-a4c4-6c3508057705",
"code": "USDC",
"issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
"created_at": "2023-02-03T10:45:51Z",
"updated_at": "2023-02-03T10:45:51Z",
"deleted_at": "2023-06-03T10:55:51Z"
},
"receiver_wallet": {
"id": "803031d4-1d04-4879-b6d9-dc5641f9988e",
"receiver": {
"id": "029e2ed0-feb6-4c40-8b47-0836a85741a2"
},
"wallet": {
"id": "5ada9ed5-455a-4782-a0ee-160767e0deb1",
"name": "Vibrant Assist",
"homepage": "https://vibrantapp.com",
"sep_10_client_domain": "api-dev.vibrantapp.com",
"deep_link_schema": "https://vibrantapp.com/sdp-dev",
"enabled": true,
"user_managed": false
},
"stellar_address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
"stellar_memo": "<string>",
"stellar_memo_type": "<string>",
"sep24_transaction_id": "<string>",
"created_at": "2023-02-03T10:45:51.000Z",
"updated_at": "2023-02-03T10:45:51.000Z",
"invitation_sent_at": "2023-02-09T10:45:51.000Z",
"status": "DRAFT",
"status_history": [
{
"status": "DRAFT",
"timestamp": "2023-02-10T10:45:51Z"
}
],
"otp_confirmed_at": "2023-02-10T10:45:51Z",
"otp_confirmed_with": "<string>"
},
"external_payment_id": "payment-001",
"created_at": "2023-02-03T10:45:51Z",
"updated_at": "2023-02-03T10:45:51Z"
}{
"error": "<string>",
"extras": {}
}{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}{
"error": "Forbidden"
}{
"error": "Not found",
"extras": {
"status": 404,
"message": "Resource not found"
}
}Authorizations
Headers
Body
application/json
Response
Direct payment created successfully
The ID of the transaction in the Stellar network. It can be used to track the payment in the Stellar network using Stellar Laboratory, or StellarExpert.
Example:
"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"
Create Direct Payment
curl --request POST \
--url https://api.example.com/payments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "<string>",
"asset": {
"id": "<string>",
"code": "<string>",
"issuer": "<string>",
"contract_id": "<string>"
},
"receiver": {
"id": "<string>",
"email": "<string>",
"phone_number": "<string>",
"wallet_address": "<string>"
},
"wallet": {
"id": "<string>",
"address": "<string>"
},
"external_payment_id": "<string>"
}
'import requests
url = "https://api.example.com/payments"
payload = {
"amount": "<string>",
"asset": {
"id": "<string>",
"code": "<string>",
"issuer": "<string>",
"contract_id": "<string>"
},
"receiver": {
"id": "<string>",
"email": "<string>",
"phone_number": "<string>",
"wallet_address": "<string>"
},
"wallet": {
"id": "<string>",
"address": "<string>"
},
"external_payment_id": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
asset: {id: '<string>', code: '<string>', issuer: '<string>', contract_id: '<string>'},
receiver: {
id: '<string>',
email: '<string>',
phone_number: '<string>',
wallet_address: '<string>'
},
wallet: {id: '<string>', address: '<string>'},
external_payment_id: '<string>'
})
};
fetch('https://api.example.com/payments', 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.example.com/payments",
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([
'amount' => '<string>',
'asset' => [
'id' => '<string>',
'code' => '<string>',
'issuer' => '<string>',
'contract_id' => '<string>'
],
'receiver' => [
'id' => '<string>',
'email' => '<string>',
'phone_number' => '<string>',
'wallet_address' => '<string>'
],
'wallet' => [
'id' => '<string>',
'address' => '<string>'
],
'external_payment_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.example.com/payments"
payload := strings.NewReader("{\n \"amount\": \"<string>\",\n \"asset\": {\n \"id\": \"<string>\",\n \"code\": \"<string>\",\n \"issuer\": \"<string>\",\n \"contract_id\": \"<string>\"\n },\n \"receiver\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"wallet_address\": \"<string>\"\n },\n \"wallet\": {\n \"id\": \"<string>\",\n \"address\": \"<string>\"\n },\n \"external_payment_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.example.com/payments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"asset\": {\n \"id\": \"<string>\",\n \"code\": \"<string>\",\n \"issuer\": \"<string>\",\n \"contract_id\": \"<string>\"\n },\n \"receiver\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"wallet_address\": \"<string>\"\n },\n \"wallet\": {\n \"id\": \"<string>\",\n \"address\": \"<string>\"\n },\n \"external_payment_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"asset\": {\n \"id\": \"<string>\",\n \"code\": \"<string>\",\n \"issuer\": \"<string>\",\n \"contract_id\": \"<string>\"\n },\n \"receiver\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"wallet_address\": \"<string>\"\n },\n \"wallet\": {\n \"id\": \"<string>\",\n \"address\": \"<string>\"\n },\n \"external_payment_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "ddf22f55-3259-4822-a4e2-ce01334997f4",
"amount": "100.00",
"stellar_transaction_id": "0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b",
"circle_transaction_id": "74a68b6a-3f67-424b-b8b0-e593a19d7463",
"circle_transaction_type": "TRANSFER",
"stellar_operation_id": "<string>",
"source_wallet_id": "4c379f5e-09b5-4472-a286-b84e249a1512",
"status": "DRAFT",
"status_history": [
{
"status": "DRAFT",
"status_message": "<string>",
"timestamp": "2023-02-03T10:45:51Z"
}
],
"type": "DISBURSEMENT",
"disbursement": {
"id": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43",
"name": "disbursement-june-29",
"receiver_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
"registration_contact_type": "EMAIL",
"status": "DRAFT",
"verification_field": "DATE_OF_BIRTH",
"status_history": [
{
"user_id": "3f351b9e-ed0f-40fa-a314-14757b42dab1",
"status": "DRAFT",
"timestamp": "2023-02-03T10:45:51Z"
}
],
"file_name": "disbursement-feb-03-2023.csv",
"created_at": "2023-06-30T01:22:57.831975Z",
"updated_at": "2023-06-30T01:22:58.316511Z"
},
"asset": {
"id": "ffaec4b3-46b0-4db4-a4c4-6c3508057705",
"code": "USDC",
"issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
"created_at": "2023-02-03T10:45:51Z",
"updated_at": "2023-02-03T10:45:51Z",
"deleted_at": "2023-06-03T10:55:51Z"
},
"receiver_wallet": {
"id": "803031d4-1d04-4879-b6d9-dc5641f9988e",
"receiver": {
"id": "029e2ed0-feb6-4c40-8b47-0836a85741a2"
},
"wallet": {
"id": "5ada9ed5-455a-4782-a0ee-160767e0deb1",
"name": "Vibrant Assist",
"homepage": "https://vibrantapp.com",
"sep_10_client_domain": "api-dev.vibrantapp.com",
"deep_link_schema": "https://vibrantapp.com/sdp-dev",
"enabled": true,
"user_managed": false
},
"stellar_address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
"stellar_memo": "<string>",
"stellar_memo_type": "<string>",
"sep24_transaction_id": "<string>",
"created_at": "2023-02-03T10:45:51.000Z",
"updated_at": "2023-02-03T10:45:51.000Z",
"invitation_sent_at": "2023-02-09T10:45:51.000Z",
"status": "DRAFT",
"status_history": [
{
"status": "DRAFT",
"timestamp": "2023-02-10T10:45:51Z"
}
],
"otp_confirmed_at": "2023-02-10T10:45:51Z",
"otp_confirmed_with": "<string>"
},
"external_payment_id": "payment-001",
"created_at": "2023-02-03T10:45:51Z",
"updated_at": "2023-02-03T10:45:51Z"
}{
"error": "<string>",
"extras": {}
}{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}{
"error": "Forbidden"
}{
"error": "Not found",
"extras": {
"status": 404,
"message": "Resource not found"
}
}