> ## Documentation Index > Fetch the complete documentation index at: https://docs.singapay.id/llms.txt > Use this file to discover all available pages before exploring further. # Get List > Retrieve a paginated list of the transactions included in a settlement belonging to the authenticated merchant. The settlement is looked up by its numeric id (`settlements.id`) **or** its reference number (`settlements.reference_no`); it must have status `completed` and belong to the merchant, otherwise the endpoint responds with `404`. Each item summarises one underlying money-in transaction (VA, QRIS, Payment Link, or E-Wallet). Optional filters: `transaction_type` and `is_refunded`. ## OpenAPI ````yaml https://payment-b2b.singapay.id/api/docs/merchant-api.json get /api/v1.0/settlement-transactions/{identifier} openapi: 3.1.0 info: title: Singa Merchant API description: >- OpenAPI specification for the merchant/partner HTTP API. All routes below are additionally protected by `ip.whitelisted.merchant` — the caller IP must be registered for the credential or merchant. Obtain a JWT using `POST /api/v1.0/access-token/b2b` (Basic auth) or `POST /api/v1.1/access-token/b2b` (X-Signature) before calling secured endpoints. version: 1.0.0 servers: - url: https://sandbox-payment-b2b.singapay.id description: >- API host. Paths include `/api` prefix (see `RouteServiceProvider`). Replace scheme/host with your environment. security: [] tags: - name: Security description: >- Merchant authentication (`OauthMerchantTokenController`). **v1.1** B2B token uses `X-CLIENT-ID`, `X-PARTNER-ID`, and `X-Signature` (no Basic auth). Secured routes also require the issued Bearer JWT plus `X-PARTNER-ID`. - name: Accounts description: >- Account management (`routes/merchantApiRoute.php`, `v1.0`). Path parameter `{id}` is always the account ULID. - name: Balance Inquiry description: >- Merchant and per-account balance inquiry (`BalanceController`, `v1.0`). Path `account_id` is the account ULID. - name: Statements description: >- Per-account statement list and detail (`AccountController::accountStatements`, `accountStatementDetail`, prefix `v1.0/statements`). Flugger responses; detail path param `{statement_id}` maps to `statements.transaction_id`. - name: Payment Link description: >- Payment link CRUD and payment-method catalog (`PaymentLinkApiController`, prefix `v1.0/payment-link-manage`). `account_id` is ULID; `payment_link_id` is numeric `payment_links.id`. - name: Payment Link History description: >- Payment link transaction/history listing and detail (`PaymentLinkApiController`, prefix `v1.0/payment-link-histories`). `history_id` is numeric `payment_link_histories.id`. - name: Virtual Account description: >- Native VA CRUD (`VirtualAccountController`, prefix `v1.0/virtual-accounts`). `account_id` and `virtual_account_id` are ULIDs. - name: VA Transaction description: >- VA money-in transaction listing and detail (`VirtualAccountController`, prefix `v1.0/va-transactions`). - name: QRIS (Money In) description: >- MPM dynamic QRIS list, show, and generate (`QrisMpmDynamicApiController`, prefix `v1.0/qris-dynamic`). - name: QRIS (Money Out) description: >- Issuer MPM decode/inquiry, payment credit (money out), and transaction status (`QrisIssuerMpmController`, `QrisApiV2Controller::checkStatus`, prefix `v2.0/qris`). Related list/detail: `GET /api/v2.0/qris/transaction/...`. - name: E-Wallet (Money In) description: >- E-Wallet Native checkout and transactions (`EwalletNativeApiController`, `EwalletNativeTransactionApiController`, `EwalletNativeV2ApiController`). Paths include `v1.0/ewallet-native`, `v1.0/ewallet-native-transactions`, and `v2.0/ewallet-native`. - name: E-Wallet (Money Out) description: >- E-wallet disbursement / top-up to beneficiary wallets (`EWalletTopUpController`, prefix `v2.0/ewallet`). Responses use the custom **`MerchantV2ApiEnvelope`** with **`MerchantV2ResponseCode`** (SP000–SP020). - name: Card (Money In) description: >- One-time card payment, cancel, and inquiry (`CardPaymentMerchantApiController`, prefix `v2.0/card`). - name: Subscription (Recurring) description: >- Credit-card recurring subscription plans (`SubscriptionPlanApiController`, prefix `v2.0/recurring`). Plan `{id}` is UUID (`sub_plans.id`). - name: Direct Debit description: >- Direct Debit — bind a customer bank account once via hosted webview, then charge it host-to-host (`DirectDebitMerchantController`, prefix `v2.0/direct-debit`). Binding `{binding_id}` and transaction `{transaction_id}` are UUIDs. Responses use the **`MerchantV2ApiEnvelope`** with standard Singapay SP000–SP020 dictionary codes and messages. Field-level validation detail is returned in `data.errors` for **SP018**. The `/charge` endpoint is additionally protected by **`X-Signature`** + **`X-Timestamp`** (`verify.signature-internal`); see operation parameters for the signing scheme. Asynchronous outcomes (bind / unbind / charge) are HTTP POST callbacks to `callback_urls.direct_debit_notif_url` — see the Direct Debit **webhooks** (`directDebitBindingNotification`, `directDebitUnbindingNotification`, `directDebitTransactionNotification`). All three share that single URL; discriminate on `event`. - name: Account Transfer description: >- Move funds between sub-accounts within the same merchant (`AnotherAccountApiController`, prefix `v1.0/account-transfer`). The transfer endpoint requires request signature headers (`verify.signature-internal`). Both accounts must belong to the authenticated merchant and be accessible to the credential. - name: Disbursement (Money Out) description: >- Bank disbursement (`DisbursementController` **v1.0**, `DisbursementV2Controller` **v2.0**). **v1.0** list/show/fee/beneficiary/transfer use Flugg envelopes; v1 inquiry-status uses the **custom v2 envelope** (`MerchantV2ApiEnvelope`, codes **SP000–SP020**). **v2.0** check-beneficiary, transfer, and inquiry-status use the same custom envelope — see component schema **`MerchantV2ResponseCode`** for the full response code table. - name: Cardless Withdrawal description: >- Cardless withdrawal API for initiating ATM cash withdrawals without a physical card. Supports creating withdrawals with OTP generation, listing transaction history, viewing transaction details, canceling pending withdrawals, and deleting canceled records. All endpoints use the `v1.0/cardless-withdrawals` route prefix and the standard success/error response envelope. Path parameter `{id}` refers to the `transaction_id` (platform-assigned business identifier). - name: Retail Store description: >- Native Retail Store money-in — generate an Alfamart / Indomaret payment code the customer pays at the cashier, then read its status (`RetailTransactionController`, prefix `v1.0/retail-transactions`). Only two endpoints: create and show. `account_id` is the account ULID; `transaction_id` is the platform-assigned `retail_transactions.transaction_id` string returned by create. Payment confirmation arrives as a POST callback to `callback_urls.transaction_notif_url` with `event = retail-transaction`. - name: Settlement Transaction description: >- Read-only listing of the transactions inside a settlement (`SettlementMerchantApiController`, `GET v1.0/settlement-transactions/{identifier}`). A sub-menu of the merchant Transaction Record APIs. Merchant-scoped — only settlements with status `completed` are exposed. `{identifier}` is the numeric `settlements.id` or the `settlements.reference_no`. Each item mirrors the money-in transaction shape (`account`, `fees`, `amount`, `post_timestamp`, `processed_timestamp`, `has_settle`, `settle_at`). Merchants cannot create, approve, or refund settlements; those actions are BOSS-only. paths: /api/v1.0/settlement-transactions/{identifier}: get: tags: - Settlement Transaction summary: Get List description: >- Retrieve a paginated list of the transactions included in a settlement belonging to the authenticated merchant. The settlement is looked up by its numeric id (`settlements.id`) **or** its reference number (`settlements.reference_no`); it must have status `completed` and belong to the merchant, otherwise the endpoint responds with `404`. Each item summarises one underlying money-in transaction (VA, QRIS, Payment Link, or E-Wallet). Optional filters: `transaction_type` and `is_refunded`. operationId: settlementTransactionsList parameters: - name: identifier in: path description: >- Settlement identifier — numeric `settlements.id` or `settlements.reference_no`. required: true schema: type: string example: SETTLEMENT-1-ABC123 - name: per_page in: query description: Number of items per page. required: false schema: type: integer default: 25 example: 25 - name: transaction_type in: query description: Filter by underlying transaction type. required: false schema: type: string enum: - VA - QRIS - PAYMENT_LINK - EWALLET example: VA - name: is_refunded in: query description: Filter by settlement-level refund state. required: false schema: type: boolean example: false responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/ResponderSuccessSettlementTransactionCollection '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ResponderErrorEnvelope401' '404': description: Settlement not found for this merchant content: application/json: schema: $ref: '#/components/schemas/ResponderErrorEnvelope404' '422': description: Missing `X-PARTNER-ID` content: application/json: schema: $ref: '#/components/schemas/ResponderErrorEnvelope422' security: - BearerAuth: [] PartnerId: [] components: schemas: ResponderSuccessSettlementTransactionCollection: description: >- Standard success envelope wrapping a paginated list of transactions within a settlement. required: - status - success - data properties: status: type: integer example: 200 success: type: boolean example: true data: description: The transactions in this settlement for the current page. type: array items: $ref: '#/components/schemas/SettlementTransactionItem' pagination: description: Pagination metadata (Laravel paginator output). type: object additionalProperties: true type: object ResponderErrorEnvelope401: required: - status - success - error properties: status: type: integer example: 401 success: type: boolean example: false error: $ref: '#/components/schemas/ResponderErrorBody401' type: object ResponderErrorEnvelope404: required: - status - success - error properties: status: type: integer example: 404 success: type: boolean example: false error: $ref: '#/components/schemas/ResponderErrorBody404' type: object ResponderErrorEnvelope422: required: - status - success - error properties: status: type: integer example: 422 success: type: boolean example: false error: $ref: '#/components/schemas/ResponderErrorBody422' data: type: object example: errors: field: - error message additionalProperties: true type: object SettlementTransactionItem: description: A single transaction included in a settlement batch. properties: transaction_id: description: >- Business identifier (VA uses `transaction_id`, other types use `reff_no`). type: - string - 'null' example: VA-20251024-0001H9X8ZK merchant_reff_no: type: - string - 'null' example: INV/2025/10/0001 account: oneOf: - $ref: '#/components/schemas/SettlementTransactionAccount' - type: 'null' fees: $ref: '#/components/schemas/SettlementTransactionFees' amount: $ref: '#/components/schemas/SettlementTransactionMoneyAmount' post_timestamp: description: 13-digit ms epoch string of when the transaction was created. type: - string - 'null' example: '1729748679474' processed_timestamp: description: >- 13-digit ms epoch string of when the transaction was processed/paid. Null for types without a processed timestamp (e.g. QRIS). type: - string - 'null' example: '1729748707000' has_settle: type: boolean example: true settle_at: description: Ms epoch of settlement time. type: - integer - 'null' example: 1729753200000 type: object ResponderErrorBody401: properties: code: type: integer example: 401 message: type: string example: Unauthorized merchant, please sign in type: object ResponderErrorBody404: properties: code: type: integer example: 404 message: type: string example: Account not found. type: object ResponderErrorBody422: properties: code: type: integer example: 422 message: type: string example: Validation error. errors: type: object example: field: - error message type: object SettlementTransactionAccount: description: Sub-account the transaction belongs to. properties: id: description: Account ULID. type: string example: 01H9X8ZK3M7QF4N2VTB6RYJWPC name: type: string example: Toko Sumber Rejeki type: object SettlementTransactionFees: description: Fee charged to the merchant for this transaction. properties: name: description: >- Payment vendor/method name (resolved from the transaction `payment_vendor_code`). type: - string - 'null' example: BRI Virtual Account amount: description: >- Merchant fee amount (IDR). For QRIS this is `vendor_fee + our_margin`. type: - number - 'null' example: 4500 currency: type: string enum: - IDR example: IDR type: object SettlementTransactionMoneyAmount: description: >- Monetary amount with currency. `value` is a string with 2 decimal places. required: - value - currency properties: value: type: string pattern: ^\d+\.\d{2}$ example: '1234.56' currency: type: string enum: - IDR example: IDR type: object securitySchemes: BearerAuth: type: http description: >- JWT issued by `POST /api/v1.1/access-token/b2b`. Send `Authorization: Bearer `. bearerFormat: JWT scheme: bearer PartnerId: type: apiKey description: Merchant API key (`Credential.api_key`). Required on every request. name: X-PARTNER-ID in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.