Execute a batch of payouts

POST

api

rfq

execute-batch

curl --request POST \
  --url https://api.example.com/api/rfq/execute-batch \
  --header 'Authorization: <authorization>'

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://api.example.com/api/rfq/execute-batch', 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/api/rfq/execute-batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/rfq/execute-batch"

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

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/rfq/execute-batch")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

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

{
  "success": true,
  "data": {
    "rows": [
      { "idx": 0, "status": "accepted", "transactionId": "8b1a4c1d-…", "quoteId": "4c2b7e8f-…" },
      { "idx": 1, "status": "failed", "errorCode": "RECIPIENT_NOT_FOUND", "retryable": false },
      { "idx": 2, "status": "accepted", "transactionId": "4f9e5f15-…", "quoteId": "1c84203c-…" }
    ]
  }
}

Batched POST /rfq/execute. Rows share fromCurrency. Partial failure is per-row — walk data.rows, retry retryable: true.

Scope payouts:write · rate-limited

Headers

string

required

API key.

string

Optional envelope-level dedup. Per-row dedup uses items[].idempotency_key.

Request body

Batch is exact-output by design. Each row’s targetAmount is what the recipient receives; the engine sizes the source spend. items[].amount is accepted on the wire but informational only — targetAmount drives quoting.

Fiat-to-fiat / Onramp
Stablecoin-to-fiat

string

required

Shared source currency.

string

required

Opaque onramp route token. Pins every row to the same onramp route.

string

required

Shared funding source.

object[]

required

Non-empty array of payouts.

Show items[]

string

required

Destination currency.

number

required

Destination amount the recipient receives. Must be > 0.

string

required

Recipient UUID.

number

Informational source amount. Accepted but not used for sizing — targetAmount drives quoting.

string

Recipient PM UUID.

string

Offramp routing hint.

string

Per-row opaque route token.

string

Per-row classification.

string

Per-row free-text reference.

string

Per-row dedup key — retry just this row.

string

required

Stablecoin ticker (e.g. USDC).

string

required

Required at the top level even for S2F (handler-level constraint).

string

required

Required at the top level even for S2F (handler-level constraint).

object

Per-chain source wallet — {"polygon": "0x…", "arbitrum": "0x…"}.

object[]

required

Non-empty array of payouts. Same items[] shape as the other tab.

Response

Always { "success": true, "data": { "rows": [...], "items": [...] } }. Use rows — items is a deprecation alias.

object[]

One entry per input row, in the same order.

Show rows[]

integer

Zero-based input index.

string

accepted or failed.

string

Present when accepted.

string

Echoed for correlation.

string

Present when failed.

boolean

When true, re-fire just this row with the same idempotencyKey.

object[]

Deprecation alias for rows. Same shape, same order, same contents — kept for one major-version of backward compatibility. New code should read rows.

{
  "success": true,
  "data": {
    "rows": [
      { "idx": 0, "status": "accepted", "transactionId": "8b1a4c1d-…", "quoteId": "4c2b7e8f-…" },
      { "idx": 1, "status": "failed", "errorCode": "RECIPIENT_NOT_FOUND", "retryable": false },
      { "idx": 2, "status": "accepted", "transactionId": "4f9e5f15-…", "quoteId": "1c84203c-…" }
    ]
  }
}

HTTP status is 200 even when some rows fail — data.rows[].status is the source of truth.

Execute a batch of payouts

curl --request POST \
  --url https://api.example.com/api/rfq/execute-batch \
  --header 'Authorization: <authorization>'

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://api.example.com/api/rfq/execute-batch', 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/api/rfq/execute-batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/rfq/execute-batch"

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

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/rfq/execute-batch")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

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

{
  "success": true,
  "data": {
    "rows": [
      { "idx": 0, "status": "accepted", "transactionId": "8b1a4c1d-…", "quoteId": "4c2b7e8f-…" },
      { "idx": 1, "status": "failed", "errorCode": "RECIPIENT_NOT_FOUND", "retryable": false },
      { "idx": 2, "status": "accepted", "transactionId": "4f9e5f15-…", "quoteId": "1c84203c-…" }
    ]
  }
}

Configuration

Recipients

Quotes

Payouts

Webhooks

Execute a batch of payouts

Headers

Request body

Response

​Headers

​Request body

​Response

Headers

Request body

Response