Create Payout
curl --request POST \
--url https://api.monime.io/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'Monime-Space-Id: <monime-space-id>' \
--data '
{
"amount": {
"currency": "<string>",
"value": 123
},
"destination": {
"providerCode": "m17",
"accountId": "+23278000000"
},
"source": {
"financialAccountId": "<string>"
},
"metadata": {}
}
'import requests
url = "https://api.monime.io/payouts"
payload = {
"amount": {
"currency": "<string>",
"value": 123
},
"destination": {
"providerCode": "m17",
"accountId": "+23278000000"
},
"source": { "financialAccountId": "<string>" },
"metadata": {}
}
headers = {
"Monime-Space-Id": "<monime-space-id>",
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Monime-Space-Id': '<monime-space-id>',
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: {currency: '<string>', value: 123},
destination: {providerCode: 'm17', accountId: '+23278000000'},
source: {financialAccountId: '<string>'},
metadata: {}
})
};
fetch('https://api.monime.io/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.monime.io/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' => [
'currency' => '<string>',
'value' => 123
],
'destination' => [
'providerCode' => 'm17',
'accountId' => '+23278000000'
],
'source' => [
'financialAccountId' => '<string>'
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"Monime-Space-Id: <monime-space-id>"
],
]);
$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.monime.io/payouts"
payload := strings.NewReader("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": 123\n },\n \"destination\": {\n \"providerCode\": \"m17\",\n \"accountId\": \"+23278000000\"\n },\n \"source\": {\n \"financialAccountId\": \"<string>\"\n },\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Monime-Space-Id", "<monime-space-id>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.monime.io/payouts")
.header("Monime-Space-Id", "<monime-space-id>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": 123\n },\n \"destination\": {\n \"providerCode\": \"m17\",\n \"accountId\": \"+23278000000\"\n },\n \"source\": {\n \"financialAccountId\": \"<string>\"\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.monime.io/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Monime-Space-Id"] = '<monime-space-id>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": 123\n },\n \"destination\": {\n \"providerCode\": \"m17\",\n \"accountId\": \"+23278000000\"\n },\n \"source\": {\n \"financialAccountId\": \"<string>\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"messages": [
"<unknown>"
],
"result": {
"id": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"source": {
"financialAccountId": "<string>",
"transactionReference": "<string>"
},
"destination": {
"providerCode": "<string>",
"accountId": "<string>",
"transactionReference": "<string>"
},
"charges": [
{
"name": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"metadata": {}
}
],
"delayedReason": "<string>",
"failureDetail": {
"explanation": "<string>"
},
"createTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
}Authorizations
Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>
Headers
The value is the tenancy parameter that Monime used to determine which space the request is intended for.
100^spc-.*$This header is used to uniquely identify a request, ensuring that the operation is not performed more than once during retries.
64Body
The monetary amount to pay out to the destination.
Show child attributes
Show child attributes
The destination for the fund of the payout object.
Show child attributes
Show child attributes
The source of fund for the payout object.
Show child attributes
Show child attributes
This holds key-value pairs, where both the keys and values are strings not exceeding 64 and 100 characters respectively. This allows for flexible and descriptive tagging or additional information to be associated with the object.
Response
OK
Was this page helpful?
curl --request POST \
--url https://api.monime.io/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'Monime-Space-Id: <monime-space-id>' \
--data '
{
"amount": {
"currency": "<string>",
"value": 123
},
"destination": {
"providerCode": "m17",
"accountId": "+23278000000"
},
"source": {
"financialAccountId": "<string>"
},
"metadata": {}
}
'import requests
url = "https://api.monime.io/payouts"
payload = {
"amount": {
"currency": "<string>",
"value": 123
},
"destination": {
"providerCode": "m17",
"accountId": "+23278000000"
},
"source": { "financialAccountId": "<string>" },
"metadata": {}
}
headers = {
"Monime-Space-Id": "<monime-space-id>",
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Monime-Space-Id': '<monime-space-id>',
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: {currency: '<string>', value: 123},
destination: {providerCode: 'm17', accountId: '+23278000000'},
source: {financialAccountId: '<string>'},
metadata: {}
})
};
fetch('https://api.monime.io/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.monime.io/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' => [
'currency' => '<string>',
'value' => 123
],
'destination' => [
'providerCode' => 'm17',
'accountId' => '+23278000000'
],
'source' => [
'financialAccountId' => '<string>'
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"Monime-Space-Id: <monime-space-id>"
],
]);
$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.monime.io/payouts"
payload := strings.NewReader("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": 123\n },\n \"destination\": {\n \"providerCode\": \"m17\",\n \"accountId\": \"+23278000000\"\n },\n \"source\": {\n \"financialAccountId\": \"<string>\"\n },\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Monime-Space-Id", "<monime-space-id>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.monime.io/payouts")
.header("Monime-Space-Id", "<monime-space-id>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": 123\n },\n \"destination\": {\n \"providerCode\": \"m17\",\n \"accountId\": \"+23278000000\"\n },\n \"source\": {\n \"financialAccountId\": \"<string>\"\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.monime.io/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Monime-Space-Id"] = '<monime-space-id>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": {\n \"currency\": \"<string>\",\n \"value\": 123\n },\n \"destination\": {\n \"providerCode\": \"m17\",\n \"accountId\": \"+23278000000\"\n },\n \"source\": {\n \"financialAccountId\": \"<string>\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"messages": [
"<unknown>"
],
"result": {
"id": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"source": {
"financialAccountId": "<string>",
"transactionReference": "<string>"
},
"destination": {
"providerCode": "<string>",
"accountId": "<string>",
"transactionReference": "<string>"
},
"charges": [
{
"name": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"metadata": {}
}
],
"delayedReason": "<string>",
"failureDetail": {
"explanation": "<string>"
},
"createTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
}