Create a single payout (mock)
curl --request POST \
--url https://api.example.com/v1/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 1,
"currency": "<string>",
"country": "<string>",
"external_id": "<string>",
"beneficiary": {
"name": "<string>",
"document_type": "<string>",
"document_id": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"zip_code": "<string>",
"street": "<string>"
},
"bank_account": {}
},
"description": "<string>",
"payment_method_id": "<string>",
"payroll_ref": {
"calculation_id": "<string>",
"country": "<string>",
"scheme": "<string>",
"year": 2000,
"concept": "<string>"
},
"notification_url": "<string>",
"metadata": {},
"processing": {
"step_seconds": 30
}
}
'import requests
url = "https://api.example.com/v1/payouts"
payload = {
"amount": 1,
"currency": "<string>",
"country": "<string>",
"external_id": "<string>",
"beneficiary": {
"name": "<string>",
"document_type": "<string>",
"document_id": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"zip_code": "<string>",
"street": "<string>"
},
"bank_account": {}
},
"description": "<string>",
"payment_method_id": "<string>",
"payroll_ref": {
"calculation_id": "<string>",
"country": "<string>",
"scheme": "<string>",
"year": 2000,
"concept": "<string>"
},
"notification_url": "<string>",
"metadata": {},
"processing": { "step_seconds": 30 }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 1,
currency: '<string>',
country: '<string>',
external_id: '<string>',
beneficiary: {
name: '<string>',
document_type: '<string>',
document_id: '<string>',
email: '<string>',
phone: '<string>',
address: {
country: '<string>',
state: '<string>',
city: '<string>',
zip_code: '<string>',
street: '<string>'
},
bank_account: {}
},
description: '<string>',
payment_method_id: '<string>',
payroll_ref: {
calculation_id: '<string>',
country: '<string>',
scheme: '<string>',
year: 2000,
concept: '<string>'
},
notification_url: '<string>',
metadata: {},
processing: {step_seconds: 30}
})
};
fetch('https://api.example.com/v1/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.example.com/v1/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([
'amount' => 1,
'currency' => '<string>',
'country' => '<string>',
'external_id' => '<string>',
'beneficiary' => [
'name' => '<string>',
'document_type' => '<string>',
'document_id' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'address' => [
'country' => '<string>',
'state' => '<string>',
'city' => '<string>',
'zip_code' => '<string>',
'street' => '<string>'
],
'bank_account' => [
]
],
'description' => '<string>',
'payment_method_id' => '<string>',
'payroll_ref' => [
'calculation_id' => '<string>',
'country' => '<string>',
'scheme' => '<string>',
'year' => 2000,
'concept' => '<string>'
],
'notification_url' => '<string>',
'metadata' => [
],
'processing' => [
'step_seconds' => 30
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/v1/payouts"
payload := strings.NewReader("{\n \"amount\": 1,\n \"currency\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"beneficiary\": {\n \"name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"street\": \"<string>\"\n },\n \"bank_account\": {}\n },\n \"description\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"payroll_ref\": {\n \"calculation_id\": \"<string>\",\n \"country\": \"<string>\",\n \"scheme\": \"<string>\",\n \"year\": 2000,\n \"concept\": \"<string>\"\n },\n \"notification_url\": \"<string>\",\n \"metadata\": {},\n \"processing\": {\n \"step_seconds\": 30\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1,\n \"currency\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"beneficiary\": {\n \"name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"street\": \"<string>\"\n },\n \"bank_account\": {}\n },\n \"description\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"payroll_ref\": {\n \"calculation_id\": \"<string>\",\n \"country\": \"<string>\",\n \"scheme\": \"<string>\",\n \"year\": 2000,\n \"concept\": \"<string>\"\n },\n \"notification_url\": \"<string>\",\n \"metadata\": {},\n \"processing\": {\n \"step_seconds\": 30\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1,\n \"currency\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"beneficiary\": {\n \"name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"street\": \"<string>\"\n },\n \"bank_account\": {}\n },\n \"description\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"payroll_ref\": {\n \"calculation_id\": \"<string>\",\n \"country\": \"<string>\",\n \"scheme\": \"<string>\",\n \"year\": 2000,\n \"concept\": \"<string>\"\n },\n \"notification_url\": \"<string>\",\n \"metadata\": {},\n \"processing\": {\n \"step_seconds\": 30\n }\n}"
response = http.request(request)
puts response.read_bodyPayouts
Create a single payout (mock)
Create a single-beneficiary payout. The mock provider returns the Payout resource and either transitions it through PENDING → PROCESSING → PAID asynchronously, or to a deterministic outcome if magic triggers are used. Moves no real money.
POST
/
v1
/
payouts
Create a single payout (mock)
curl --request POST \
--url https://api.example.com/v1/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 1,
"currency": "<string>",
"country": "<string>",
"external_id": "<string>",
"beneficiary": {
"name": "<string>",
"document_type": "<string>",
"document_id": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"zip_code": "<string>",
"street": "<string>"
},
"bank_account": {}
},
"description": "<string>",
"payment_method_id": "<string>",
"payroll_ref": {
"calculation_id": "<string>",
"country": "<string>",
"scheme": "<string>",
"year": 2000,
"concept": "<string>"
},
"notification_url": "<string>",
"metadata": {},
"processing": {
"step_seconds": 30
}
}
'import requests
url = "https://api.example.com/v1/payouts"
payload = {
"amount": 1,
"currency": "<string>",
"country": "<string>",
"external_id": "<string>",
"beneficiary": {
"name": "<string>",
"document_type": "<string>",
"document_id": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"zip_code": "<string>",
"street": "<string>"
},
"bank_account": {}
},
"description": "<string>",
"payment_method_id": "<string>",
"payroll_ref": {
"calculation_id": "<string>",
"country": "<string>",
"scheme": "<string>",
"year": 2000,
"concept": "<string>"
},
"notification_url": "<string>",
"metadata": {},
"processing": { "step_seconds": 30 }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 1,
currency: '<string>',
country: '<string>',
external_id: '<string>',
beneficiary: {
name: '<string>',
document_type: '<string>',
document_id: '<string>',
email: '<string>',
phone: '<string>',
address: {
country: '<string>',
state: '<string>',
city: '<string>',
zip_code: '<string>',
street: '<string>'
},
bank_account: {}
},
description: '<string>',
payment_method_id: '<string>',
payroll_ref: {
calculation_id: '<string>',
country: '<string>',
scheme: '<string>',
year: 2000,
concept: '<string>'
},
notification_url: '<string>',
metadata: {},
processing: {step_seconds: 30}
})
};
fetch('https://api.example.com/v1/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.example.com/v1/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([
'amount' => 1,
'currency' => '<string>',
'country' => '<string>',
'external_id' => '<string>',
'beneficiary' => [
'name' => '<string>',
'document_type' => '<string>',
'document_id' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'address' => [
'country' => '<string>',
'state' => '<string>',
'city' => '<string>',
'zip_code' => '<string>',
'street' => '<string>'
],
'bank_account' => [
]
],
'description' => '<string>',
'payment_method_id' => '<string>',
'payroll_ref' => [
'calculation_id' => '<string>',
'country' => '<string>',
'scheme' => '<string>',
'year' => 2000,
'concept' => '<string>'
],
'notification_url' => '<string>',
'metadata' => [
],
'processing' => [
'step_seconds' => 30
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/v1/payouts"
payload := strings.NewReader("{\n \"amount\": 1,\n \"currency\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"beneficiary\": {\n \"name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"street\": \"<string>\"\n },\n \"bank_account\": {}\n },\n \"description\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"payroll_ref\": {\n \"calculation_id\": \"<string>\",\n \"country\": \"<string>\",\n \"scheme\": \"<string>\",\n \"year\": 2000,\n \"concept\": \"<string>\"\n },\n \"notification_url\": \"<string>\",\n \"metadata\": {},\n \"processing\": {\n \"step_seconds\": 30\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1,\n \"currency\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"beneficiary\": {\n \"name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"street\": \"<string>\"\n },\n \"bank_account\": {}\n },\n \"description\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"payroll_ref\": {\n \"calculation_id\": \"<string>\",\n \"country\": \"<string>\",\n \"scheme\": \"<string>\",\n \"year\": 2000,\n \"concept\": \"<string>\"\n },\n \"notification_url\": \"<string>\",\n \"metadata\": {},\n \"processing\": {\n \"step_seconds\": 30\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1,\n \"currency\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"beneficiary\": {\n \"name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_id\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"street\": \"<string>\"\n },\n \"bank_account\": {}\n },\n \"description\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"payroll_ref\": {\n \"calculation_id\": \"<string>\",\n \"country\": \"<string>\",\n \"scheme\": \"<string>\",\n \"year\": 2000,\n \"concept\": \"<string>\"\n },\n \"notification_url\": \"<string>\",\n \"metadata\": {},\n \"processing\": {\n \"step_seconds\": 30\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API key authentication. Send your API key as: Authorization: Bearer <your_api_key>
Body
application/json
Request body for POST /v1/payouts.
Positive decimal amount.
Required range:
x > 0ISO 4217 code, uppercase.
Required string length:
3ISO 3166-1 alpha-2.
Required string length:
2Required string length:
1 - 80Beneficiary fields. Per-country shape is enforced by CreatePayoutRequest.
We keep bank_account typed as a generic dict here and do the per-country
discrimination on the parent (where country is available). This avoids
Pydantic's discriminator gotchas and produces cleaner error messages.
Show child attributes
Show child attributes
Maximum string length:
200Defaults to the country's default method if omitted.
Free traceability block linking a payout back to a payroll calculation.
Engine is stateless in v1, so calculation_id is informational only.
Show child attributes
Show child attributes
HTTPS only. Receives signed webhook events on every status change.
Required string length:
1 - 2083≤20 keys, string values ≤500 chars.
Mock-only request knobs that control transition timing.
Show child attributes
Show child attributes
Response
Idempotent replay — existing payout returned.