Create Payment

Creates a payment. This is where most implementations start.

curl --request POST \
  --url https://api.example.com/payments \
  --header 'Content-Type: application/json' \
  --header 'x-digest-key: <api-key>' \
  --header 'x-digest-signature: <x-digest-signature>' \
  --header 'x-digest-timestamp: <x-digest-timestamp>' \
  --data '
{
  "amount": {
    "currency": "USD",
    "value": 1000
  },
  "description": "Payment for order 12345",
  "redirectUrl": "https://example.com/redirect",
  "name": "Example Store",
  "cancelUrl": "https://example.com/cancel",
  "webhookUrl": "https://example.com/webhook",
  "locale": "en",
  "metadata": {
    "orderId": 12345
  },
  "partnerId": "4cfad08e-1b41-4283-b4cc-f916cd4beba0",
  "escrowPayee": "GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "escrowPlatformFee": 500,
  "expiresInHours": 168,
  "storeId": "store_8821",
  "escrowExpiresAt": "2026-12-31T23:59:59Z"
}
'

import requests

url = "https://api.example.com/payments"

payload = {
    "amount": {
        "currency": "USD",
        "value": 1000
    },
    "description": "Payment for order 12345",
    "redirectUrl": "https://example.com/redirect",
    "name": "Example Store",
    "cancelUrl": "https://example.com/cancel",
    "webhookUrl": "https://example.com/webhook",
    "locale": "en",
    "metadata": { "orderId": 12345 },
    "partnerId": "4cfad08e-1b41-4283-b4cc-f916cd4beba0",
    "escrowPayee": "GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "escrowPlatformFee": 500,
    "expiresInHours": 168,
    "storeId": "store_8821",
    "escrowExpiresAt": "2026-12-31T23:59:59Z"
}
headers = {
    "x-digest-timestamp": "<x-digest-timestamp>",
    "x-digest-key": "<api-key>",
    "x-digest-signature": "<x-digest-signature>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-digest-timestamp': '<x-digest-timestamp>',
    'x-digest-key': '<api-key>',
    'x-digest-signature': '<x-digest-signature>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: {currency: 'USD', value: 1000},
    description: 'Payment for order 12345',
    redirectUrl: 'https://example.com/redirect',
    name: 'Example Store',
    cancelUrl: 'https://example.com/cancel',
    webhookUrl: 'https://example.com/webhook',
    locale: 'en',
    metadata: {orderId: 12345},
    partnerId: '4cfad08e-1b41-4283-b4cc-f916cd4beba0',
    escrowPayee: 'GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
    escrowPlatformFee: 500,
    expiresInHours: 168,
    storeId: 'store_8821',
    escrowExpiresAt: '2026-12-31T23:59:59Z'
  })
};

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' => [
        'currency' => 'USD',
        'value' => 1000
    ],
    'description' => 'Payment for order 12345',
    'redirectUrl' => 'https://example.com/redirect',
    'name' => 'Example Store',
    'cancelUrl' => 'https://example.com/cancel',
    'webhookUrl' => 'https://example.com/webhook',
    'locale' => 'en',
    'metadata' => [
        'orderId' => 12345
    ],
    'partnerId' => '4cfad08e-1b41-4283-b4cc-f916cd4beba0',
    'escrowPayee' => 'GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
    'escrowPlatformFee' => 500,
    'expiresInHours' => 168,
    'storeId' => 'store_8821',
    'escrowExpiresAt' => '2026-12-31T23:59:59Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-digest-key: <api-key>",
    "x-digest-signature: <x-digest-signature>",
    "x-digest-timestamp: <x-digest-timestamp>"
  ],
]);

$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\": {\n    \"currency\": \"USD\",\n    \"value\": 1000\n  },\n  \"description\": \"Payment for order 12345\",\n  \"redirectUrl\": \"https://example.com/redirect\",\n  \"name\": \"Example Store\",\n  \"cancelUrl\": \"https://example.com/cancel\",\n  \"webhookUrl\": \"https://example.com/webhook\",\n  \"locale\": \"en\",\n  \"metadata\": {\n    \"orderId\": 12345\n  },\n  \"partnerId\": \"4cfad08e-1b41-4283-b4cc-f916cd4beba0\",\n  \"escrowPayee\": \"GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n  \"escrowPlatformFee\": 500,\n  \"expiresInHours\": 168,\n  \"storeId\": \"store_8821\",\n  \"escrowExpiresAt\": \"2026-12-31T23:59:59Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-digest-timestamp", "<x-digest-timestamp>")
	req.Header.Add("x-digest-key", "<api-key>")
	req.Header.Add("x-digest-signature", "<x-digest-signature>")
	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("x-digest-timestamp", "<x-digest-timestamp>")
  .header("x-digest-key", "<api-key>")
  .header("x-digest-signature", "<x-digest-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": {\n    \"currency\": \"USD\",\n    \"value\": 1000\n  },\n  \"description\": \"Payment for order 12345\",\n  \"redirectUrl\": \"https://example.com/redirect\",\n  \"name\": \"Example Store\",\n  \"cancelUrl\": \"https://example.com/cancel\",\n  \"webhookUrl\": \"https://example.com/webhook\",\n  \"locale\": \"en\",\n  \"metadata\": {\n    \"orderId\": 12345\n  },\n  \"partnerId\": \"4cfad08e-1b41-4283-b4cc-f916cd4beba0\",\n  \"escrowPayee\": \"GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n  \"escrowPlatformFee\": 500,\n  \"expiresInHours\": 168,\n  \"storeId\": \"store_8821\",\n  \"escrowExpiresAt\": \"2026-12-31T23:59:59Z\"\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["x-digest-timestamp"] = '<x-digest-timestamp>'
request["x-digest-key"] = '<api-key>'
request["x-digest-signature"] = '<x-digest-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": {\n    \"currency\": \"USD\",\n    \"value\": 1000\n  },\n  \"description\": \"Payment for order 12345\",\n  \"redirectUrl\": \"https://example.com/redirect\",\n  \"name\": \"Example Store\",\n  \"cancelUrl\": \"https://example.com/cancel\",\n  \"webhookUrl\": \"https://example.com/webhook\",\n  \"locale\": \"en\",\n  \"metadata\": {\n    \"orderId\": 12345\n  },\n  \"partnerId\": \"4cfad08e-1b41-4283-b4cc-f916cd4beba0\",\n  \"escrowPayee\": \"GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n  \"escrowPlatformFee\": 500,\n  \"expiresInHours\": 168,\n  \"storeId\": \"store_8821\",\n  \"escrowExpiresAt\": \"2026-12-31T23:59:59Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "pt_AEtKAcN9d-",
  "createdAt": "2023-11-18T20:46:15.652Z",
  "updatedAt": "2023-11-18T20:46:15.652Z",
  "expiresAt": "2023-11-18T21:16:15.649Z",
  "mode": "test",
  "amount": {
    "value": 200,
    "currency": "USD"
  },
  "description": "Buying phone",
  "status": "open",
  "settlement_status": "open",
  "redirectUrl": "https://example.com",
  "checkout_id": "pt_AEtKAcN9d-",
  "webhookUrl": "https://example.com/webhook",
  "hostedUrl": "https://sandbox-pay.ebioro.com/payments?paymentId=pt_QKTDINJ662&auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0ZXN0LmViaW9yby5jb20iLCJhdWQiOiJodHRwczovL3Rlc3QtZWJpb3JvLW1lcmNoYW50LXNlcnZpY2UtMzgxNTIyNmU5MmE4Lmhlcm9rdWFwcC5jb20iLCJzdWIiOiJjMzMyZTlkYi1kYjQ1LTQ1ZmQtOTFmMy03NGNiNWU5NTQzYzQiLCJpYXQiOjE3MTQwNjcxOTIsImV4cCI6MTcxNDA3MDc5Mn0.EY5xyWptYzD1HgJPUev6LGMRFFZ8HDZOsE2Vk35OASk&lang=es",
  "shortUrl": "https://sandbox-pay.ebioro.com/iqtRR_42J4TAIFbciUUlV",
  "qrCode": "web+stellar:pay?destination=GAPU7KB2B2USVSWBFJRHGX7AYIWYKF2W44WWDCYEJTEER5D2QYEGD5GM&amount=2.68&asset_code=USDC&asset_issuer=GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5&memo=pt_AEtKAcN9d-&memo_type=text&msg=Buying+phone",
  "merchantName": "Test Store",
  "cancelUrl": "https://example.com/cancel",
  "locale": "es",
  "metadata": {},
  "stellarTxId": "1b680e9577572a0c3e648dcc1686373c87417d9ec17614d0ed5bf0ca397f8fcd",
  "settlement_stellarTxId": "1b680e9577572a0c3e648dcc1686373c87417d9ec17614d0ed5bf0ca397f8fcd",
  "settlement_currency": "USDC",
  "settlement_amount": 2663,
  "settlement_fee": 66.575,
  "amount_paid": 0,
  "history": [
    {
      "time": 1714124827333,
      "status": "success",
      "description": "Payment created"
    }
  ],
  "sender_account": "GDFJ7PTIJGDINCLD7ZWZMYURELPMP6JZ6NMJBDBHKDXBFFWBC4SUFA4F",
  "asset_id": "USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
  "refunded": false,
  "type": "order",
  "partner_id": "4f56c1ff-837c-4a1c-b372-1ddf840f252c"
}

{
  "reason": "Bad Request",
  "statusCode": 400
}

{
  "reason": "Unauthorized",
  "statusCode": 401
}

{
  "reason": "A request with this Idempotency-Key is already being processed",
  "statusCode": 409
}

{
  "reason": "Idempotency-Key reused for a different request",
  "statusCode": 422
}

{
  "reason": "Internal Server Error",
  "statusCode": 500
}

POST

payments

Creates a payment. This is where most implementations start.

curl --request POST \
  --url https://api.example.com/payments \
  --header 'Content-Type: application/json' \
  --header 'x-digest-key: <api-key>' \
  --header 'x-digest-signature: <x-digest-signature>' \
  --header 'x-digest-timestamp: <x-digest-timestamp>' \
  --data '
{
  "amount": {
    "currency": "USD",
    "value": 1000
  },
  "description": "Payment for order 12345",
  "redirectUrl": "https://example.com/redirect",
  "name": "Example Store",
  "cancelUrl": "https://example.com/cancel",
  "webhookUrl": "https://example.com/webhook",
  "locale": "en",
  "metadata": {
    "orderId": 12345
  },
  "partnerId": "4cfad08e-1b41-4283-b4cc-f916cd4beba0",
  "escrowPayee": "GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "escrowPlatformFee": 500,
  "expiresInHours": 168,
  "storeId": "store_8821",
  "escrowExpiresAt": "2026-12-31T23:59:59Z"
}
'

import requests

url = "https://api.example.com/payments"

payload = {
    "amount": {
        "currency": "USD",
        "value": 1000
    },
    "description": "Payment for order 12345",
    "redirectUrl": "https://example.com/redirect",
    "name": "Example Store",
    "cancelUrl": "https://example.com/cancel",
    "webhookUrl": "https://example.com/webhook",
    "locale": "en",
    "metadata": { "orderId": 12345 },
    "partnerId": "4cfad08e-1b41-4283-b4cc-f916cd4beba0",
    "escrowPayee": "GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "escrowPlatformFee": 500,
    "expiresInHours": 168,
    "storeId": "store_8821",
    "escrowExpiresAt": "2026-12-31T23:59:59Z"
}
headers = {
    "x-digest-timestamp": "<x-digest-timestamp>",
    "x-digest-key": "<api-key>",
    "x-digest-signature": "<x-digest-signature>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-digest-timestamp': '<x-digest-timestamp>',
    'x-digest-key': '<api-key>',
    'x-digest-signature': '<x-digest-signature>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: {currency: 'USD', value: 1000},
    description: 'Payment for order 12345',
    redirectUrl: 'https://example.com/redirect',
    name: 'Example Store',
    cancelUrl: 'https://example.com/cancel',
    webhookUrl: 'https://example.com/webhook',
    locale: 'en',
    metadata: {orderId: 12345},
    partnerId: '4cfad08e-1b41-4283-b4cc-f916cd4beba0',
    escrowPayee: 'GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
    escrowPlatformFee: 500,
    expiresInHours: 168,
    storeId: 'store_8821',
    escrowExpiresAt: '2026-12-31T23:59:59Z'
  })
};

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' => [
        'currency' => 'USD',
        'value' => 1000
    ],
    'description' => 'Payment for order 12345',
    'redirectUrl' => 'https://example.com/redirect',
    'name' => 'Example Store',
    'cancelUrl' => 'https://example.com/cancel',
    'webhookUrl' => 'https://example.com/webhook',
    'locale' => 'en',
    'metadata' => [
        'orderId' => 12345
    ],
    'partnerId' => '4cfad08e-1b41-4283-b4cc-f916cd4beba0',
    'escrowPayee' => 'GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
    'escrowPlatformFee' => 500,
    'expiresInHours' => 168,
    'storeId' => 'store_8821',
    'escrowExpiresAt' => '2026-12-31T23:59:59Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-digest-key: <api-key>",
    "x-digest-signature: <x-digest-signature>",
    "x-digest-timestamp: <x-digest-timestamp>"
  ],
]);

$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\": {\n    \"currency\": \"USD\",\n    \"value\": 1000\n  },\n  \"description\": \"Payment for order 12345\",\n  \"redirectUrl\": \"https://example.com/redirect\",\n  \"name\": \"Example Store\",\n  \"cancelUrl\": \"https://example.com/cancel\",\n  \"webhookUrl\": \"https://example.com/webhook\",\n  \"locale\": \"en\",\n  \"metadata\": {\n    \"orderId\": 12345\n  },\n  \"partnerId\": \"4cfad08e-1b41-4283-b4cc-f916cd4beba0\",\n  \"escrowPayee\": \"GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n  \"escrowPlatformFee\": 500,\n  \"expiresInHours\": 168,\n  \"storeId\": \"store_8821\",\n  \"escrowExpiresAt\": \"2026-12-31T23:59:59Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-digest-timestamp", "<x-digest-timestamp>")
	req.Header.Add("x-digest-key", "<api-key>")
	req.Header.Add("x-digest-signature", "<x-digest-signature>")
	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("x-digest-timestamp", "<x-digest-timestamp>")
  .header("x-digest-key", "<api-key>")
  .header("x-digest-signature", "<x-digest-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": {\n    \"currency\": \"USD\",\n    \"value\": 1000\n  },\n  \"description\": \"Payment for order 12345\",\n  \"redirectUrl\": \"https://example.com/redirect\",\n  \"name\": \"Example Store\",\n  \"cancelUrl\": \"https://example.com/cancel\",\n  \"webhookUrl\": \"https://example.com/webhook\",\n  \"locale\": \"en\",\n  \"metadata\": {\n    \"orderId\": 12345\n  },\n  \"partnerId\": \"4cfad08e-1b41-4283-b4cc-f916cd4beba0\",\n  \"escrowPayee\": \"GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n  \"escrowPlatformFee\": 500,\n  \"expiresInHours\": 168,\n  \"storeId\": \"store_8821\",\n  \"escrowExpiresAt\": \"2026-12-31T23:59:59Z\"\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["x-digest-timestamp"] = '<x-digest-timestamp>'
request["x-digest-key"] = '<api-key>'
request["x-digest-signature"] = '<x-digest-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": {\n    \"currency\": \"USD\",\n    \"value\": 1000\n  },\n  \"description\": \"Payment for order 12345\",\n  \"redirectUrl\": \"https://example.com/redirect\",\n  \"name\": \"Example Store\",\n  \"cancelUrl\": \"https://example.com/cancel\",\n  \"webhookUrl\": \"https://example.com/webhook\",\n  \"locale\": \"en\",\n  \"metadata\": {\n    \"orderId\": 12345\n  },\n  \"partnerId\": \"4cfad08e-1b41-4283-b4cc-f916cd4beba0\",\n  \"escrowPayee\": \"GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n  \"escrowPlatformFee\": 500,\n  \"expiresInHours\": 168,\n  \"storeId\": \"store_8821\",\n  \"escrowExpiresAt\": \"2026-12-31T23:59:59Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "pt_AEtKAcN9d-",
  "createdAt": "2023-11-18T20:46:15.652Z",
  "updatedAt": "2023-11-18T20:46:15.652Z",
  "expiresAt": "2023-11-18T21:16:15.649Z",
  "mode": "test",
  "amount": {
    "value": 200,
    "currency": "USD"
  },
  "description": "Buying phone",
  "status": "open",
  "settlement_status": "open",
  "redirectUrl": "https://example.com",
  "checkout_id": "pt_AEtKAcN9d-",
  "webhookUrl": "https://example.com/webhook",
  "hostedUrl": "https://sandbox-pay.ebioro.com/payments?paymentId=pt_QKTDINJ662&auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0ZXN0LmViaW9yby5jb20iLCJhdWQiOiJodHRwczovL3Rlc3QtZWJpb3JvLW1lcmNoYW50LXNlcnZpY2UtMzgxNTIyNmU5MmE4Lmhlcm9rdWFwcC5jb20iLCJzdWIiOiJjMzMyZTlkYi1kYjQ1LTQ1ZmQtOTFmMy03NGNiNWU5NTQzYzQiLCJpYXQiOjE3MTQwNjcxOTIsImV4cCI6MTcxNDA3MDc5Mn0.EY5xyWptYzD1HgJPUev6LGMRFFZ8HDZOsE2Vk35OASk&lang=es",
  "shortUrl": "https://sandbox-pay.ebioro.com/iqtRR_42J4TAIFbciUUlV",
  "qrCode": "web+stellar:pay?destination=GAPU7KB2B2USVSWBFJRHGX7AYIWYKF2W44WWDCYEJTEER5D2QYEGD5GM&amount=2.68&asset_code=USDC&asset_issuer=GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5&memo=pt_AEtKAcN9d-&memo_type=text&msg=Buying+phone",
  "merchantName": "Test Store",
  "cancelUrl": "https://example.com/cancel",
  "locale": "es",
  "metadata": {},
  "stellarTxId": "1b680e9577572a0c3e648dcc1686373c87417d9ec17614d0ed5bf0ca397f8fcd",
  "settlement_stellarTxId": "1b680e9577572a0c3e648dcc1686373c87417d9ec17614d0ed5bf0ca397f8fcd",
  "settlement_currency": "USDC",
  "settlement_amount": 2663,
  "settlement_fee": 66.575,
  "amount_paid": 0,
  "history": [
    {
      "time": 1714124827333,
      "status": "success",
      "description": "Payment created"
    }
  ],
  "sender_account": "GDFJ7PTIJGDINCLD7ZWZMYURELPMP6JZ6NMJBDBHKDXBFFWBC4SUFA4F",
  "asset_id": "USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
  "refunded": false,
  "type": "order",
  "partner_id": "4f56c1ff-837c-4a1c-b372-1ddf840f252c"
}

{
  "reason": "Bad Request",
  "statusCode": 400
}

{
  "reason": "Unauthorized",
  "statusCode": 401
}

{
  "reason": "A request with this Idempotency-Key is already being processed",
  "statusCode": 409
}

{
  "reason": "Idempotency-Key reused for a different request",
  "statusCode": 422
}

{
  "reason": "Internal Server Error",
  "statusCode": 500
}

Authorizations

x-digest-key

string

header

required

Your public API key

Headers

x-digest-timestamp

string

required

Current Unix timestamp

x-digest-key

string

required

Your public api key

x-digest-signature

string

required

Digest Auth Signature

Idempotency-Key

string

Optional. A unique string (max 255 chars) that makes payment creation idempotent: replaying a request with the same key returns the original response instead of creating a duplicate payment.

Maximum string length: 255

Body

application/json

amount

object

required

The amount to be charged, expressed in the smallest unit of the currency (e.g., cents for USD).

Example:

{ "currency": "USD", "value": 1000 }

description

string

required

A description of the payment. This will be displayed to the customer.

Example:

"Payment for order 12345"

redirectUrl

string

URL to redirect the customer after a successful payment. Optional: omit it for a payment link — the customer then sees an Ebioro-hosted confirmation screen.

Example:

"https://example.com/redirect"

name

string

The name of your store, shown to the customer during payment. Defaults to the merchant name if not provided.

Example:

"Example Store"

cancelUrl

string

URL where the customer is redirected if they cancel the payment. Defaults to redirectUrl if not provided.

Example:

"https://example.com/cancel"

webhookUrl

string

Server URL to receive payment status updates via webhook.

Example:

"https://example.com/webhook"

locale

string

Locale setting for the payment page, used to preset the language shown to the customer. Supported locales include [en, es].

Example:

"en"

metadata

object

Custom metadata to be associated with the payment. This can be any structured data relevant to the payment.

Example:

{ "orderId": 12345 }

partnerId

string

For integrations done via an ebioro partner

Example:

"4cfad08e-1b41-4283-b4cc-f916cd4beba0"

escrowPayee

string

Stellar address of the fund recipient for escrow payments. Use this when the payee is a different party from the merchant — i.e., the driver in a ride-hailing app (Uber), the host in a rental platform (Airbnb), or the freelancer in a services marketplace (Upwork). If omitted, defaults to the merchant's Stellar account (common for remittances and POS use cases). Only applicable for merchants with settlement_mode = escrow.

Example:

"GBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

escrowPlatformFee

integer

Platform fee in basis points (1% = 100 bps) to be deducted from the escrowed amount at release time. If omitted, defaults to the merchant's configured platform fee. Only applicable for merchants with settlement_mode = escrow.

Example:

500

expiresInHours

number

Number of hours until this payment expires. If omitted, defaults to 30 minutes (suitable for a checkout). Set a longer window (e.g. 168 = 7 days) for a payment link shared with a payer.

Example:

168

storeId

string

Optional store identifier for merchants operating multiple stores. Returned on the payment and usable as a filter on GET /payments.

Example:

"store_8821"

escrowExpiresAt

string<date-time>

Expiration time for the escrow order (ISO 8601). Defaults to 7 days from payment creation. Only applicable for merchants with settlement_mode = escrow.

Example:

"2026-12-31T23:59:59Z"

Response

On success the endpoint will return a JSON object with detailed payment information.

string

createdAt

string

updatedAt

string

expiresAt

string

mode

string

amount

object

Show child attributes

description

string

status

string

settlement_status

string

redirectUrl

string

checkout_id

string

webhookUrl

string

hostedUrl

string

qrCode

string

merchantName

string

cancelUrl

string

locale

string

metadata

object

stellarTxId

string

settlement_stellarTxId

string

settlement_currency

string

settlement_amount

number

settlement_fee

number

amount_paid

number

history

object[]

Show child attributes

sender_account

string

asset_id

string

refunded

boolean

type

string

partner_id

string

escrow_status

string

Current escrow status. Only present for merchants with settlement_mode = escrow. Possible values: created, funded, failed.

escrow_order_id

string

The on-chain escrow order ID. Only present for merchants with settlement_mode = escrow.

escrow_contract_address

string

The Soroban escrow contract address. Only present for merchants with settlement_mode = escrow.

escrow_platform_fee_bps

integer

Platform fee in basis points (1% = 100 bps) to be deducted at release time. Only present for merchants with settlement_mode = escrow.

API Reference Get Payment

API Reference

Payments

Invoices

Cross-Chain Payments

Refunds

Webhook Logs

Accounts

Merchant

Authorizations

Headers

Body

Response