Skip to main content
Endpoint:

Authorization

string
required
Example:Authorization | Bearer Paste-Your-API-Key-Here

Query Parameters

string
Filter the list by transaction status (e.g. settled).
string
Filter transactions by a specific customer ID.
string
Filter by transaction type (e.g. digital_product, event, membership).
Filter transactions by a specific payment link ID.
string
Start of the date range to filter by (Unix timestamp in milliseconds).
string
End of the date range to filter by (Unix timestamp in milliseconds).
string
Comma-separated list of fields to include in each item.
integer
default:"10"
Number of items to return per page. Defaults to 10, with a maximum of 50.
string
Cursor for forward pagination. Pass the nextStartingAfter value from the previous response (a Unix timestamp in milliseconds, as a string) to fetch the next page.

Response

Successful Response

Main Structure (Root)

integer
Status code form API.
string
Status message that describes the status code.
array of object
List of transactions displayed.
boolean
Information on whether there is additional data to be retrieved (true/false).
string | null
Cursor to pass as startingAfter to fetch the next page. null when there is no further data.

data Structure (Array Of Object)

string<uuid>
Unique ID for the balance transaction history.
integer
The amount of credit received from the transaction.
string
The status of the balance transaction (settled = completed/successful).
string
The type of transaction.
string
The payment method.
string<uuid>
The unique ID of the customer who made the transaction.
number (timestamp)
The transaction creation time in epoch format (ms).
The transaction ID associated with the payment link.
array of object
Additional fees applied to the transaction (empty if none).
The ID of the payment link used.
string | null
The subscription ID (if the transaction is a subscription).
string | null
The Xendit transaction ID (if using the Xendit gateway).
object | null
Subscription details (if any).
object | null
Xendit transaction details (if any).
Object that stores transaction details related to the payment link.
object | null
Additional custom fields that can be filled in by the user (if any).
object
Customer data that makes transactions.
Payment link information used for transactions.

fee Structure (Array Of Object)

string <uuid>
Unique ID for the fee entry.
string
The type of fee (e.g. xendit_fee, mayar_fee).
integer
The fee amount deducted.

paymentLinkTransaction Structure (Object)

string <uuid>
Payment link transaction ID.
string | null
Tracking URL data (if any).
boolean | null
Whether the admin fee is borne by the customer.
boolean | null
Whether the channel fee is borne by the customer.

customer Structure (Object)

string <uuid>
Unique customer ID.
string
Customer’s name.
string
Customer’s email address.
string
Customer’s mobile phone number.
string <uuid>
ID payment link.
string
Payment link name.