CollectionsHosted PaymentsPayments

List Hosted Payments

GET
/v1/hosted-payments

Authorization

authorization
AuthorizationBearer <token>

Set Your Secret API Key

In: header

Query Parameters

after?string

An object ID used as a cursor in pagination. If a list request returns 100 objects ending with obj_0KSEVXZ2ZF0AV, a subsequent call can include after=obj_0KSEVXZ2ZF0AV to fetch the next page of the list.

limit?integer

A limit on the number of objects to be returned, between 1 and 100.

Formatint32
order?string

Sort list objects in either ascending or descending order.

Value in

  • "ASC"
  • "DESC"
status?string

Filter by hosted payment status.

Value in

  • "REQUIRES_ACTION"
  • "PENDING"
  • "SUCCEEDED"
  • "FAILED"

Response Body

*/*

application/json

application/json

curl -X GET "https://example.com/v1/hosted-payments"

One page of hosted payments across methods.

{
  "data": [
    {
      "id": "hpymt_0J7Q9A2M8V5X1",
      "status": "SUCCEEDED",
      "resultCode": null,
      "underlyingErrorCode": null,
      "underlyingErrorMessage": null,
      "transactionReference": "20260909DBSSSGSGBRT7728204",
      "amount": 4242,
      "currency": "SGD",
      "channel": "WEB_BROWSER_DESKTOP",
      "method": "PAYNOW",
      "returnUrl": "https://example.com/return",
      "redirectUrl": "https://api.tryacme.com/redirection/hosted-payments/hpymt_0J7Q9A2M8V5X1/submit",
      "referenceId": "ORDER-10042",
      "tokenization": false,
      "hostedPaymentMethodId": null,
      "customerProxy": null,
      "payer": null,
      "paymentInformation": null,
      "createdAt": "2026-09-09T04:00:27.967830Z",
      "updatedAt": "2026-09-09T04:01:03.800309Z",
      "expiredAt": null
    },
    {
      "id": "hpymt_0J7Q9G8W6N2Z7",
      "status": "SUCCEEDED",
      "resultCode": null,
      "underlyingErrorCode": null,
      "underlyingErrorMessage": null,
      "transactionReference": "2609091234567890",
      "amount": 12500,
      "currency": "MYR",
      "channel": null,
      "method": "FPX_ONLINEBANKING",
      "returnUrl": "https://example.com/return",
      "redirectUrl": "https://api.tryacme.com/redirection/hosted-payments/hpymt_0J7Q9G8W6N2Z7/submit",
      "referenceId": "ORDER-MY-7781",
      "tokenization": null,
      "hostedPaymentMethodId": null,
      "customerProxy": null,
      "payer": {
        "returnedName": "AHMAD BIN ALI",
        "payerBank": "Malayan Banking Berhad (M2U)",
        "firstName": "Ahmad",
        "lastName": "bin Ali",
        "email": "ahmad@example.com",
        "phone": "+60123456789"
      },
      "paymentInformation": [
        {
          "itemName": "DEPOSIT",
          "itemReference": "ID-1",
          "unitAmount": 12500,
          "numberOfUnits": 1,
          "totalTaxAmount": 0
        }
      ],
      "createdAt": "2026-09-09T04:12:44.093352Z",
      "updatedAt": "2026-09-09T04:15:20.615870Z",
      "expiredAt": "2026-09-09T04:27:44.093352Z"
    }
  ],
  "hasMore": false
}