Skip to main content
Use this endpoint to look up a payment using the merchant reference ID you assigned when creating it — for example, an order number. Unlike the Retrieve a Payment endpoint, which requires Accelebit’s internal payment UUID, this endpoint lets you query by your own identifier. The merchantRef query parameter is required; omitting it returns a 400 error. Payments are scoped to your merchant account — you can only retrieve payments created with your API key.
This endpoint requires the merchantRef query parameter. Requests without it will return a 400 INVALID_REQUEST error.

Query parameters

merchantRef
string
required
Your merchant reference ID to search for. This is the value you passed as merchantRef when creating the payment.

Headers

X-API-Key
string
required
Your secret API key. Starts with smtgw_sk_.

Response

This endpoint returns the matching payment with the same fields as Retrieve a Payment.
data
object
curl "https://api.gateway.accelebit.com/v1/payments?merchantRef=order_98765" \
  -H "X-API-Key: smtgw_sk_test_your_secret_key"
{
  "data": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "merchantId": "merchant_abc123",
    "customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "providerId": "everest",
    "status": "captured",
    "amount": "55.00",
    "currency": "EUR",
    "paymentMethod": "card",
    "merchantRef": "order_98765",
    "errorCode": null,
    "errorMessage": null,
    "createdAt": "2026-04-09T12:01:00.000Z",
    "updatedAt": "2026-04-09T12:01:02.000Z"
  },
  "meta": {
    "timestamp": "2026-04-09T12:05:00.000Z"
  }
}