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"
}
'
{
  "status": "SUCCESS",
  "terminal_id": "10362517",
  "payment_method": "QRIS",
  "transaction_date": "2025-06-20T16:59:59.000Z"
}

Authorizations

​
X-API-KEY
string
header
required

API key for authentication

Headers

​
provider
enum<string>
required

Provider name.

Available options:
BRI,
NTT
​
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"