Skip to main content
POST
/
v1
/
settlements
/
process
Process settlement
curl --request POST \
  --url https://api.plexospay.com/v1/settlements/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
import requests

url = "https://api.plexospay.com/v1/settlements/process"

payload = {}
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({})
};

fetch('https://api.plexospay.com/v1/settlements/process', 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.plexospay.com/v1/settlements/process",
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([

]),
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.plexospay.com/v1/settlements/process"

payload := strings.NewReader("{}")

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.plexospay.com/v1/settlements/process")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.plexospay.com/v1/settlements/process")

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 = "{}"

response = http.request(request)
puts response.read_body
{
  "id": "se_abc123",
  "merchantId": "<string>",
  "amount": "<string>",
  "feeTotal": "<string>",
  "netAmount": "<string>",
  "amountFormatted": "<string>",
  "netAmountFormatted": "<string>",
  "periodStart": "2023-11-07T05:31:56Z",
  "periodEnd": "2023-11-07T05:31:56Z",
  "payoutRef": "<string>",
  "itemCount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "processedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}
Returns 204 No Content if there are no payments to settle.

Authorizations

Authorization
string
header
required

API key starting with sk_live_ or sk_test_

Body

application/json
currency
enum<string>

ISO currency code

Available options:
CVE,
AOA

Response

Settlement processed

id
string
Example:

"se_abc123"

merchantId
string
amount
string
feeTotal
string
netAmount
string
currency
enum<string>

ISO currency code

Available options:
CVE,
AOA
amountFormatted
string
netAmountFormatted
string
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
periodStart
string<date-time>
periodEnd
string<date-time>
payoutRef
string | null
itemCount
integer
createdAt
string<date-time>
processedAt
string<date-time> | null
completedAt
string<date-time> | null