Create a payout
curl --request POST \
--url https://api.orqex.com/v1/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 50,
"currency": "EUR",
"method": "<string>",
"description": "Supplier settlement",
"instrument": {
"phone_number": "+15550000000",
"account_name": "<string>",
"account_number": "<string>",
"bank_code": "<string>",
"swift_bic": "<string>",
"country": "DE",
"address": "<string>",
"network": "<string>",
"memo_tag": "<string>"
},
"customer": {
"email": "[email protected]",
"first_name": "Ada",
"last_name": "Lovelace",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip": "<string>"
},
"reference": "batch-42-line-7",
"webhook_url": "<string>",
"metadata": {
"order_id": "1042"
},
"gateway_options": {}
}
'import requests
url = "https://api.orqex.com/v1/payouts"
payload = {
"amount": 50,
"currency": "EUR",
"method": "<string>",
"description": "Supplier settlement",
"instrument": {
"phone_number": "+15550000000",
"account_name": "<string>",
"account_number": "<string>",
"bank_code": "<string>",
"swift_bic": "<string>",
"country": "DE",
"address": "<string>",
"network": "<string>",
"memo_tag": "<string>"
},
"customer": {
"email": "[email protected]",
"first_name": "Ada",
"last_name": "Lovelace",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip": "<string>"
},
"reference": "batch-42-line-7",
"webhook_url": "<string>",
"metadata": { "order_id": "1042" },
"gateway_options": {}
}
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: 50,
currency: 'EUR',
method: '<string>',
description: 'Supplier settlement',
instrument: {
phone_number: '+15550000000',
account_name: '<string>',
account_number: '<string>',
bank_code: '<string>',
swift_bic: '<string>',
country: 'DE',
address: '<string>',
network: '<string>',
memo_tag: '<string>'
},
customer: {
email: '[email protected]',
first_name: 'Ada',
last_name: 'Lovelace',
address: '<string>',
city: '<string>',
state: '<string>',
country: 'US',
zip: '<string>'
},
reference: 'batch-42-line-7',
webhook_url: '<string>',
metadata: {order_id: '1042'},
gateway_options: {}
})
};
fetch('https://api.orqex.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.orqex.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' => 50,
'currency' => 'EUR',
'method' => '<string>',
'description' => 'Supplier settlement',
'instrument' => [
'phone_number' => '+15550000000',
'account_name' => '<string>',
'account_number' => '<string>',
'bank_code' => '<string>',
'swift_bic' => '<string>',
'country' => 'DE',
'address' => '<string>',
'network' => '<string>',
'memo_tag' => '<string>'
],
'customer' => [
'email' => '[email protected]',
'first_name' => 'Ada',
'last_name' => 'Lovelace',
'address' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => 'US',
'zip' => '<string>'
],
'reference' => 'batch-42-line-7',
'webhook_url' => '<string>',
'metadata' => [
'order_id' => '1042'
],
'gateway_options' => [
]
]),
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.orqex.com/v1/payouts"
payload := strings.NewReader("{\n \"amount\": 50,\n \"currency\": \"EUR\",\n \"method\": \"<string>\",\n \"description\": \"Supplier settlement\",\n \"instrument\": {\n \"phone_number\": \"+15550000000\",\n \"account_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"country\": \"DE\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"memo_tag\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"batch-42-line-7\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"gateway_options\": {}\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.orqex.com/v1/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 50,\n \"currency\": \"EUR\",\n \"method\": \"<string>\",\n \"description\": \"Supplier settlement\",\n \"instrument\": {\n \"phone_number\": \"+15550000000\",\n \"account_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"country\": \"DE\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"memo_tag\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"batch-42-line-7\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"gateway_options\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orqex.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\": 50,\n \"currency\": \"EUR\",\n \"method\": \"<string>\",\n \"description\": \"Supplier settlement\",\n \"instrument\": {\n \"phone_number\": \"+15550000000\",\n \"account_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"country\": \"DE\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"memo_tag\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"batch-42-line-7\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"gateway_options\": {}\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"id": "po_6Cw1Rh",
"amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"settlement_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"exchange_rate": {
"value": "0.92000000",
"from_currency": "USD",
"to_currency": "EUR",
"expression": "$1.00 ≈ €0.92"
},
"method": {
"value": "test",
"label": "<string>",
"description": "<string>",
"icon_url": "<string>",
"category": "<string>",
"requires_phone": true
},
"status": "pending",
"reference": "batch-42-line-7",
"description": "<string>",
"webhook_url": "<string>",
"customer": {
"id": "cus_2f8Kd1",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "[email protected]",
"avatar_url": "<string>"
},
"instrument": {
"id": "pin_5Yt2Wc",
"type": "phone",
"phone_number": "<string>",
"account_name": "<string>",
"account_number": "<string>",
"bank_code": "<string>",
"swift_bic": "<string>",
"country": {
"code": "US",
"name": "United States",
"flag": "<string>"
},
"address": "<string>",
"network": "<string>",
"memo_tag": "<string>"
},
"gateway": {
"transaction": {
"id": "<string>",
"reference": "<string>",
"external_id": "<string>",
"status": "<string>"
}
},
"fee_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"failure": {
"code": {
"value": "<string>",
"category": "CUSTOMER_ERROR",
"message": "<string>"
},
"message": "<string>"
},
"metadata": {},
"initiated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "The given data was invalid.",
"errors": {}
}{
"message": "<string>"
}Payouts
Create a payout
Sends money to a typed instrument. The amount is in major units, the same scale as a payment. The response carries the payout in its current status, which is usually not final yet.
POST
/
payouts
Create a payout
curl --request POST \
--url https://api.orqex.com/v1/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 50,
"currency": "EUR",
"method": "<string>",
"description": "Supplier settlement",
"instrument": {
"phone_number": "+15550000000",
"account_name": "<string>",
"account_number": "<string>",
"bank_code": "<string>",
"swift_bic": "<string>",
"country": "DE",
"address": "<string>",
"network": "<string>",
"memo_tag": "<string>"
},
"customer": {
"email": "[email protected]",
"first_name": "Ada",
"last_name": "Lovelace",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip": "<string>"
},
"reference": "batch-42-line-7",
"webhook_url": "<string>",
"metadata": {
"order_id": "1042"
},
"gateway_options": {}
}
'import requests
url = "https://api.orqex.com/v1/payouts"
payload = {
"amount": 50,
"currency": "EUR",
"method": "<string>",
"description": "Supplier settlement",
"instrument": {
"phone_number": "+15550000000",
"account_name": "<string>",
"account_number": "<string>",
"bank_code": "<string>",
"swift_bic": "<string>",
"country": "DE",
"address": "<string>",
"network": "<string>",
"memo_tag": "<string>"
},
"customer": {
"email": "[email protected]",
"first_name": "Ada",
"last_name": "Lovelace",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip": "<string>"
},
"reference": "batch-42-line-7",
"webhook_url": "<string>",
"metadata": { "order_id": "1042" },
"gateway_options": {}
}
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: 50,
currency: 'EUR',
method: '<string>',
description: 'Supplier settlement',
instrument: {
phone_number: '+15550000000',
account_name: '<string>',
account_number: '<string>',
bank_code: '<string>',
swift_bic: '<string>',
country: 'DE',
address: '<string>',
network: '<string>',
memo_tag: '<string>'
},
customer: {
email: '[email protected]',
first_name: 'Ada',
last_name: 'Lovelace',
address: '<string>',
city: '<string>',
state: '<string>',
country: 'US',
zip: '<string>'
},
reference: 'batch-42-line-7',
webhook_url: '<string>',
metadata: {order_id: '1042'},
gateway_options: {}
})
};
fetch('https://api.orqex.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.orqex.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' => 50,
'currency' => 'EUR',
'method' => '<string>',
'description' => 'Supplier settlement',
'instrument' => [
'phone_number' => '+15550000000',
'account_name' => '<string>',
'account_number' => '<string>',
'bank_code' => '<string>',
'swift_bic' => '<string>',
'country' => 'DE',
'address' => '<string>',
'network' => '<string>',
'memo_tag' => '<string>'
],
'customer' => [
'email' => '[email protected]',
'first_name' => 'Ada',
'last_name' => 'Lovelace',
'address' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => 'US',
'zip' => '<string>'
],
'reference' => 'batch-42-line-7',
'webhook_url' => '<string>',
'metadata' => [
'order_id' => '1042'
],
'gateway_options' => [
]
]),
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.orqex.com/v1/payouts"
payload := strings.NewReader("{\n \"amount\": 50,\n \"currency\": \"EUR\",\n \"method\": \"<string>\",\n \"description\": \"Supplier settlement\",\n \"instrument\": {\n \"phone_number\": \"+15550000000\",\n \"account_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"country\": \"DE\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"memo_tag\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"batch-42-line-7\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"gateway_options\": {}\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.orqex.com/v1/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 50,\n \"currency\": \"EUR\",\n \"method\": \"<string>\",\n \"description\": \"Supplier settlement\",\n \"instrument\": {\n \"phone_number\": \"+15550000000\",\n \"account_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"country\": \"DE\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"memo_tag\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"batch-42-line-7\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"gateway_options\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orqex.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\": 50,\n \"currency\": \"EUR\",\n \"method\": \"<string>\",\n \"description\": \"Supplier settlement\",\n \"instrument\": {\n \"phone_number\": \"+15550000000\",\n \"account_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"country\": \"DE\",\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"memo_tag\": \"<string>\"\n },\n \"customer\": {\n \"email\": \"[email protected]\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"US\",\n \"zip\": \"<string>\"\n },\n \"reference\": \"batch-42-line-7\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {\n \"order_id\": \"1042\"\n },\n \"gateway_options\": {}\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"id": "po_6Cw1Rh",
"amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"settlement_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"exchange_rate": {
"value": "0.92000000",
"from_currency": "USD",
"to_currency": "EUR",
"expression": "$1.00 ≈ €0.92"
},
"method": {
"value": "test",
"label": "<string>",
"description": "<string>",
"icon_url": "<string>",
"category": "<string>",
"requires_phone": true
},
"status": "pending",
"reference": "batch-42-line-7",
"description": "<string>",
"webhook_url": "<string>",
"customer": {
"id": "cus_2f8Kd1",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "[email protected]",
"avatar_url": "<string>"
},
"instrument": {
"id": "pin_5Yt2Wc",
"type": "phone",
"phone_number": "<string>",
"account_name": "<string>",
"account_number": "<string>",
"bank_code": "<string>",
"swift_bic": "<string>",
"country": {
"code": "US",
"name": "United States",
"flag": "<string>"
},
"address": "<string>",
"network": "<string>",
"memo_tag": "<string>"
},
"gateway": {
"transaction": {
"id": "<string>",
"reference": "<string>",
"external_id": "<string>",
"status": "<string>"
}
},
"fee_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"failure": {
"code": {
"value": "<string>",
"category": "CUSTOMER_ERROR",
"message": "<string>"
},
"message": "<string>"
},
"metadata": {},
"initiated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "The given data was invalid.",
"errors": {}
}{
"message": "<string>"
}Authorizations
Your secret key, e.g. sk_live_... or sk_sandbox_....
Headers
Optional key, 8 to 128 characters, that makes this request safe to retry. The first response is stored for 24 hours; a repeat returns it unchanged with X-Idempotent-Replayed: true.
Required string length:
8 - 128Body
application/json
Amount in major units, the same scale as a payment. 50 means 50.00.
Required range:
x >= 1Example:
50
Required string length:
3Example:
"EUR"
Payout method code. The codes available to your project are listed in your dashboard.
Maximum string length:
500Example:
"Supplier settlement"
The typed destination. Required fields depend on type.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Your own identifier. Must be unique within the project; a duplicate returns 409.
Maximum string length:
191Example:
"batch-42-line-7"
URL notified when this payout is created, completes or fails. Deliveries to it are not signed.
Maximum string length:
2048Up to 10 key/value pairs of your own, returned unchanged.
Example:
{ "order_id": "1042" }
Optional processor-specific parameters, keyed by gateway code. Only gateways that declare options accept a section, and each section is validated against that gateway's own schema; an unknown code or an unsupported option is rejected. The codes and options available to your project are listed in your dashboard.
Example:
{}
Was this page helpful?