Skip to main content
POST
/
commands
/
settlement
Settlement
curl --request POST \
  --url http://{IP_ADDRESS}:{PORT}/commands/settlement \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'provider: <provider>' \
  --data '
{
  "terminal_id": "10362517",
  "payment_method": "QRIS"
}
'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "http://{IP_ADDRESS}:{PORT}/commands/settlement",
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([
'terminal_id' => '10362517',
'payment_method' => 'QRIS'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>",
"provider: <provider>"
],
]);

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

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
HttpResponse<String> response = Unirest.post("http://{IP_ADDRESS}:{PORT}/commands/settlement")
.header("provider", "<provider>")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"terminal_id\": \"10362517\",\n \"payment_method\": \"QRIS\"\n}")
.asString();
package main

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

func main() {

url := "http://{IP_ADDRESS}:{PORT}/commands/settlement"

payload := strings.NewReader("{\n \"terminal_id\": \"10362517\",\n \"payment_method\": \"QRIS\"\n}")

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

req.Header.Add("provider", "<provider>")
req.Header.Add("X-API-KEY", "<api-key>")
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))

}
import requests

url = "http://{IP_ADDRESS}:{PORT}/commands/settlement"

payload = {
"terminal_id": "10362517",
"payment_method": "QRIS"
}
headers = {
"provider": "<provider>",
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
provider: '<provider>',
'X-API-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({terminal_id: '10362517', payment_method: 'QRIS'})
};

fetch('http://{IP_ADDRESS}:{PORT}/commands/settlement', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
require 'uri'
require 'net/http'

url = URI("http://{IP_ADDRESS}:{PORT}/commands/settlement")

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

request = Net::HTTP::Post.new(url)
request["provider"] = '<provider>'
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"terminal_id\": \"10362517\",\n \"payment_method\": \"QRIS\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "SUCCESS",
  "terminal_id": "10362517",
  "payment_method": "QRIS",
  "transaction_date": "2025-06-20T16:59:59.000Z"
}
{
"error_code": "INVALREQUEST",
"message": "Invalid terminal ID"
}
{
"error_code": "INVALCREDENTIAL",
"message": "Invalid API key"
}
{
"error_code": "TNOT_FOUND",
"message": "Terminal not found"
}
{
"error_code": "NEED_DO_SETTLEMENT",
"message": "No settlement needed"
}
{
"error_code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error"
}
{
"error_code": "INVALREQUEST",
"message": "Transaction Failed"
}

Authorizations

X-API-KEY
string
header
required

API key for authentication

Headers

provider
enum<string>
required

Provider name.

Available options:
BRI,
NTT,
CASHUP,
SHC
simulation
boolean

Simulation/mock response flag.

pretty-print
boolean

Json Pretty Formatter flag.

Body

application/json
terminal_id
string
required

Terminal's ID to perform settlement on.

Required string length: 1 - 50
Example:

"10362517"

payment_method
enum<string>

Available payment methods

Available options:
CARD,
EWALLET,
QRIS
Example:

"QRIS"

Response

Successful settlement response.

status
enum<string>
required

Transaction status values

Available options:
SUCCESS,
FAILED
Example:

"SUCCESS"

payment_method
enum<string>
required

Available payment methods

Available options:
CARD,
EWALLET,
QRIS
Example:

"QRIS"

terminal_id
string
required

Terminal ID where settlement was performed.

Example:

"10362517"

transaction_date
string<date-time>
required

Settlement date and time.

Example:

"2025-06-20T16:59:59.000Z"