Get All Charges

curl --request GET \
  --url https://api.example.com/v1/charges \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v1/charges"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/charges', 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.example.com/v1/charges",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/v1/charges"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/charges")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/charges")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "page_number": 1,
  "page_size": 100,
  "page_count": 1,
  "total_item_count": 5,
  "items": [
    {
      "fee_amount": 50,
      "net_amount": 950,
      "settlement_status": "UNKNOWN",
      "meta_data": {
        "name": "the value"
      },
      "action_flow": "PAYLOAD",
      "amount": 1000,
      "channel_code": "QR_QRIS",
      "code": "CHG_251095D600C40328C247",
      "currency": "IDR",
      "description": "New description for the Charge.",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "Your Reference Id",
      "status": "PENDING",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T05:17:13.6507292+00:00",
      "updated_by": "drunk@sandbox.dev",
      "updated_on": "2025-10-21T05:49:07.1573109+00:00",
      "id": "019a0533-3632-772a-95d6-00c40328c247"
    },
    {
      "failed_on": "2025-10-21T01:05:40.5145731+00:00",
      "fee_amount": 100,
      "net_amount": 900,
      "settlement_status": "UNKNOWN",
      "meta_data": {},
      "action_flow": "REDIRECTION",
      "amount": 1000,
      "channel_code": "QR_QRIS",
      "code": "CHG_2510A87B019974399F1C",
      "currency": "IDR",
      "description": "hello",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "steven",
      "status": "FAILED",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T00:35:47.9006924+00:00",
      "updated_by": "System",
      "updated_on": "2025-10-21T01:05:40.514819+00:00",
      "id": "019a0431-8e3c-79ee-a87b-019974399f1c"
    },
    {
      "fee_amount": 100,
      "net_amount": 900,
      "paid_on": "2025-10-21T03:06:54.7019641+00:00",
      "settlement_date": "2025-10-23T03:06:54.7019641+00:00",
      "settlement_status": "PENDING",
      "meta_data": {},
      "action_flow": "EMBEDDED",
      "amount": 1000,
      "channel_code": "QR_QRIS",
      "code": "CHG_2510A4A536F6CCD43176",
      "currency": "IDR",
      "description": "",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "",
      "status": "SUCCEEDED",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T03:06:44.4340741+00:00",
      "updated_by": "System",
      "updated_on": "2025-10-21T03:06:54.7023067+00:00",
      "id": "019a04bb-bf52-7aea-a4a5-36f6ccd43176"
    },
    {
      "fee_amount": 100,
      "net_amount": 900,
      "paid_on": "2025-10-21T00:27:58.9597338+00:00",
      "settlement_date": "2025-10-23T00:27:58.9597338+00:00",
      "settlement_status": "PENDING",
      "meta_data": {},
      "action_flow": "REDIRECTION",
      "amount": 1000,
      "channel_code": "QR_QRIS",
      "code": "CHG_2510B55639243FBD761F",
      "currency": "IDR",
      "description": "hello",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "hello",
      "status": "SUCCEEDED",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T00:22:39.3040746+00:00",
      "updated_by": "System",
      "updated_on": "2025-10-21T00:27:58.9651536+00:00",
      "id": "019a0425-85c7-76d2-b556-39243fbd761f"
    },
    {
      "fee_amount": 200,
      "net_amount": 1800,
      "paid_on": "2025-10-21T02:44:22.6329921+00:00",
      "settlement_date": "2025-10-23T02:44:22.6329921+00:00",
      "settlement_status": "PENDING",
      "meta_data": {},
      "action_flow": "PAYLOAD",
      "amount": 2000,
      "channel_code": "QR_QRIS",
      "code": "CHG_2510BEF48B4721EC7E93",
      "currency": "IDR",
      "description": "The payment for Steven",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "Steven",
      "status": "SUCCEEDED",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T02:35:17.8509877+00:00",
      "updated_by": "System",
      "updated_on": "2025-10-21T02:44:22.6400573+00:00",
      "id": "019a049e-f5da-7c68-bef4-8b4721ec7e93"
    }
  ]
}

charges

Get All Charges

Retrieve a paginated list of charges. This endpoint returns all charge objects created under the merchant account, optionally filtered by date range, currency, status, payment method, or search text. Use pagination parameters to navigate through results efficiently.

Key Notes:

Supports flexible filtering and sorting via query parameters.
Results include both succeeded and pending charges.
Useful for reconciliation, reporting, and transaction monitoring dashboards.

GET

charges

Get All Charges

curl --request GET \
  --url https://api.example.com/v1/charges \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v1/charges"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/charges', 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.example.com/v1/charges",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/v1/charges"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/charges")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/charges")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "page_number": 1,
  "page_size": 100,
  "page_count": 1,
  "total_item_count": 5,
  "items": [
    {
      "fee_amount": 50,
      "net_amount": 950,
      "settlement_status": "UNKNOWN",
      "meta_data": {
        "name": "the value"
      },
      "action_flow": "PAYLOAD",
      "amount": 1000,
      "channel_code": "QR_QRIS",
      "code": "CHG_251095D600C40328C247",
      "currency": "IDR",
      "description": "New description for the Charge.",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "Your Reference Id",
      "status": "PENDING",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T05:17:13.6507292+00:00",
      "updated_by": "drunk@sandbox.dev",
      "updated_on": "2025-10-21T05:49:07.1573109+00:00",
      "id": "019a0533-3632-772a-95d6-00c40328c247"
    },
    {
      "failed_on": "2025-10-21T01:05:40.5145731+00:00",
      "fee_amount": 100,
      "net_amount": 900,
      "settlement_status": "UNKNOWN",
      "meta_data": {},
      "action_flow": "REDIRECTION",
      "amount": 1000,
      "channel_code": "QR_QRIS",
      "code": "CHG_2510A87B019974399F1C",
      "currency": "IDR",
      "description": "hello",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "steven",
      "status": "FAILED",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T00:35:47.9006924+00:00",
      "updated_by": "System",
      "updated_on": "2025-10-21T01:05:40.514819+00:00",
      "id": "019a0431-8e3c-79ee-a87b-019974399f1c"
    },
    {
      "fee_amount": 100,
      "net_amount": 900,
      "paid_on": "2025-10-21T03:06:54.7019641+00:00",
      "settlement_date": "2025-10-23T03:06:54.7019641+00:00",
      "settlement_status": "PENDING",
      "meta_data": {},
      "action_flow": "EMBEDDED",
      "amount": 1000,
      "channel_code": "QR_QRIS",
      "code": "CHG_2510A4A536F6CCD43176",
      "currency": "IDR",
      "description": "",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "",
      "status": "SUCCEEDED",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T03:06:44.4340741+00:00",
      "updated_by": "System",
      "updated_on": "2025-10-21T03:06:54.7023067+00:00",
      "id": "019a04bb-bf52-7aea-a4a5-36f6ccd43176"
    },
    {
      "fee_amount": 100,
      "net_amount": 900,
      "paid_on": "2025-10-21T00:27:58.9597338+00:00",
      "settlement_date": "2025-10-23T00:27:58.9597338+00:00",
      "settlement_status": "PENDING",
      "meta_data": {},
      "action_flow": "REDIRECTION",
      "amount": 1000,
      "channel_code": "QR_QRIS",
      "code": "CHG_2510B55639243FBD761F",
      "currency": "IDR",
      "description": "hello",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "hello",
      "status": "SUCCEEDED",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T00:22:39.3040746+00:00",
      "updated_by": "System",
      "updated_on": "2025-10-21T00:27:58.9651536+00:00",
      "id": "019a0425-85c7-76d2-b556-39243fbd761f"
    },
    {
      "fee_amount": 200,
      "net_amount": 1800,
      "paid_on": "2025-10-21T02:44:22.6329921+00:00",
      "settlement_date": "2025-10-23T02:44:22.6329921+00:00",
      "settlement_status": "PENDING",
      "meta_data": {},
      "action_flow": "PAYLOAD",
      "amount": 2000,
      "channel_code": "QR_QRIS",
      "code": "CHG_2510BEF48B4721EC7E93",
      "currency": "IDR",
      "description": "The payment for Steven",
      "merchant_id": "019a0423-2941-735f-9a93-819df469ad39",
      "reference_id": "Steven",
      "status": "SUCCEEDED",
      "created_by": "drunk@sandbox.dev",
      "created_on": "2025-10-21T02:35:17.8509877+00:00",
      "updated_by": "System",
      "updated_on": "2025-10-21T02:44:22.6400573+00:00",
      "id": "019a049e-f5da-7c68-bef4-8b4721ec7e93"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

Currency

string

Filter results by ISO-4217 currency code (e.g., SGD, MYR, THB).

DateFrom

string<date-time>

Start date for filtering charges (inclusive). Example: 2025-10-01T00:00:00Z.

DateTo

string<date-time>

End date for filtering charges (inclusive). Example: 2025-10-21T23:59:59Z.

string<uuid>

Retrieve a specific charge by its unique ID (e.g., chg_01JAB1XYN01P3).

ChannelCode

string

Filter by payment channel (e.g., qr-qris, wallet_dana).

Status

string

Filter by charge status (pending, succeeded, failed, expired, cancelled).

SearchText

string

Keyword search across charge fields such as code, reference_id, or description.

OrderBy

string

Field to sort results by (e.g., created_on, amount, status).

IsDescending

boolean

When true, sorts results in descending order. Default is false.

PageNumber

integer<int32>

Page number for paginated results. Default is 1.

PageSize

integer<int32>

Number of records per page. Maximum allowed is 100.

Response

200 - application/json

page_number

integer

required

Current page number of the paginated result set.

page_size

integer

required

Number of records returned per page.

page_count

integer

required

Total number of pages available.

total_item_count

integer

required

Total number of charge records that match the query filters.

items

object[]

required

List of charge objects. Each object represents one transaction record.

Show child attributes

/v1/merchants/me/web-hook Create a Charge

balances

customers

merchants

charges

payouts

Get All Charges

Authorizations

Query Parameters

Response