Create a batch secure payment for multiple outgoing payouts

curl --request POST \
  --url https://api.request.network/v2/secure-payments/batch-payouts \
  --header 'Content-Type: application/json' \
  --data '
{
  "tokens": [
    "<string>"
  ],
  "redirectUrl": "<string>",
  "redirectLabel": "<string>"
}
'

import requests

url = "https://api.request.network/v2/secure-payments/batch-payouts"

payload = {
    "tokens": ["<string>"],
    "redirectUrl": "<string>",
    "redirectLabel": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({tokens: ['<string>'], redirectUrl: '<string>', redirectLabel: '<string>'})
};

fetch('https://api.request.network/v2/secure-payments/batch-payouts', 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.request.network/v2/secure-payments/batch-payouts",
  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([
    'tokens' => [
        '<string>'
    ],
    'redirectUrl' => '<string>',
    'redirectLabel' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.request.network/v2/secure-payments/batch-payouts"

	payload := strings.NewReader("{\n  \"tokens\": [\n    \"<string>\"\n  ],\n  \"redirectUrl\": \"<string>\",\n  \"redirectLabel\": \"<string>\"\n}")

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

	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.request.network/v2/secure-payments/batch-payouts")
  .header("Content-Type", "application/json")
  .body("{\n  \"tokens\": [\n    \"<string>\"\n  ],\n  \"redirectUrl\": \"<string>\",\n  \"redirectLabel\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.request.network/v2/secure-payments/batch-payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tokens\": [\n    \"<string>\"\n  ],\n  \"redirectUrl\": \"<string>\",\n  \"redirectLabel\": \"<string>\"\n}"

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

{
  "requestIds": [
    "<string>"
  ],
  "securePaymentUrl": "<string>",
  "token": "<string>",
  "feePlan": {
    "version": 1,
    "grossAmountUsd": "<string>",
    "netRecipientAmountUsd": "<string>",
    "payerTotalAmountUsd": "<string>",
    "totalFeesUsd": "<string>",
    "payeeBorneFeesUsd": "<string>",
    "payerBorneFeesUsd": "<string>",
    "fees": [
      {
        "type": "<string>",
        "label": "<string>",
        "percentageBps": 123,
        "capUsd": "<string>",
        "calculatedAmountUsd": "<string>",
        "destinationResolver": "<string>",
        "destinationRef": {
          "evmAddress": "<string>",
          "tronAddress": "<string>"
        },
        "configSource": "<string>",
        "fixedAmountUsd": "<string>"
      }
    ]
  }
}

POST

secure-payments

batch-payouts

Create a batch secure payment for multiple outgoing payouts

curl --request POST \
  --url https://api.request.network/v2/secure-payments/batch-payouts \
  --header 'Content-Type: application/json' \
  --data '
{
  "tokens": [
    "<string>"
  ],
  "redirectUrl": "<string>",
  "redirectLabel": "<string>"
}
'

import requests

url = "https://api.request.network/v2/secure-payments/batch-payouts"

payload = {
    "tokens": ["<string>"],
    "redirectUrl": "<string>",
    "redirectLabel": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({tokens: ['<string>'], redirectUrl: '<string>', redirectLabel: '<string>'})
};

fetch('https://api.request.network/v2/secure-payments/batch-payouts', 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.request.network/v2/secure-payments/batch-payouts",
  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([
    'tokens' => [
        '<string>'
    ],
    'redirectUrl' => '<string>',
    'redirectLabel' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.request.network/v2/secure-payments/batch-payouts"

	payload := strings.NewReader("{\n  \"tokens\": [\n    \"<string>\"\n  ],\n  \"redirectUrl\": \"<string>\",\n  \"redirectLabel\": \"<string>\"\n}")

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

	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.request.network/v2/secure-payments/batch-payouts")
  .header("Content-Type", "application/json")
  .body("{\n  \"tokens\": [\n    \"<string>\"\n  ],\n  \"redirectUrl\": \"<string>\",\n  \"redirectLabel\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.request.network/v2/secure-payments/batch-payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tokens\": [\n    \"<string>\"\n  ],\n  \"redirectUrl\": \"<string>\",\n  \"redirectLabel\": \"<string>\"\n}"

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

{
  "requestIds": [
    "<string>"
  ],
  "securePaymentUrl": "<string>",
  "token": "<string>",
  "feePlan": {
    "version": 1,
    "grossAmountUsd": "<string>",
    "netRecipientAmountUsd": "<string>",
    "payerTotalAmountUsd": "<string>",
    "totalFeesUsd": "<string>",
    "payeeBorneFeesUsd": "<string>",
    "payerBorneFeesUsd": "<string>",
    "fees": [
      {
        "type": "<string>",
        "label": "<string>",
        "percentageBps": 123,
        "capUsd": "<string>",
        "calculatedAmountUsd": "<string>",
        "destinationResolver": "<string>",
        "destinationRef": {
          "evmAddress": "<string>",
          "tronAddress": "<string>"
        },
        "configSource": "<string>",
        "fixedAmountUsd": "<string>"
      }
    ]
  }
}

Headers

x-api-key

string

API key for authentication (optional if using Client ID or session)

x-client-id

string

Client ID for frontend authentication (optional if using API key or session)

Authorization

string

Bearer token for session authentication (or use the session_token cookie). Only consulted when no x-orchestrator-key, x-api-key, or x-client-id header is present.

Origin

string

Origin header (required for Client ID auth, automatically set by browser)

Body

application/json

tokens

string[]

required

Tokens of existing pending single payout secure payments to combine into one batch payment link

Minimum array length: 2

Minimum string length: 1

redirectUrl

string

URL the payer is redirected to after a successful payment

redirectLabel

string

Optional label describing the redirect destination

Required string length: 1 - 255

Pattern: ^[^<>&"'`]*$

Response

Batch payout secure payment created successfully

requestIds

string[]

required

Array of request IDs created for this secure payment

securePaymentUrl

string<uri>

required

URL to the secure payment page

token

string

required

Secure payment token

feePlan

object | null

required

Resolved fee plan snapshot. Null when fees don't apply — e.g. non-stablecoin currency, or a batch that spans multiple currencies (not yet supported).

Show child attributes

Preview the fee plan for a payment

Get secure payment data by token

⌘I

🔑 API Setup

⚙️ API Features

📚 API Reference

Create a batch secure payment for multiple outgoing payouts

Headers

Body

Response