GET /v1/payments — Look Up Payment by Reference

curl "https://api.gateway.accelebit.com/v1/payments?merchantRef=order_98765" \
  -H "X-API-Key: smtgw_sk_test_your_secret_key"

const response = await fetch(
  'https://api.gateway.accelebit.com/v1/payments?merchantRef=order_98765',
  {
    headers: {
      'X-API-Key': process.env.ACCELEBIT_SECRET_KEY!,
    },
  }
);

const result = await response.json();

import requests

response = requests.get(
    'https://api.gateway.accelebit.com/v1/payments',
    params={'merchantRef': 'order_98765'},
    headers={'X-API-Key': ACCELEBIT_SECRET_KEY},
)

result = response.json()

{
  "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"
  }
}

{
  "data": null,
  "error": {
    "status": 400,
    "name": "INVALID_REQUEST",
    "message": "Query parameter merchantRef is required"
  }
}

{
  "data": null,
  "error": {
    "status": 404,
    "name": "NOT_FOUND",
    "message": "Transaction order_98765 not found"
  }
}

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

string

required

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

Headers

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.

object

Show data properties

string

UUID of the transaction.

string

Your merchant account ID.

string

UUID of the Accelebit customer record associated with this payment.

string

The upstream provider that processed the payment. null if the payment has not yet been submitted to a provider.

string

Current transaction status. One of: created, captured, authorized, pending_3ds, pending_consent, failed.

string

Payment amount as a decimal string. For example: "55.00".

string

Three-letter ISO 4217 currency code.

string

"card" or "stored_card".

string

Your merchant reference, as provided when the payment was created.

string

Error code if the payment failed. null on success.

string

Human-readable error message if the payment failed. null on success.

string

ISO 8601 timestamp of when the payment was created.

string

ISO 8601 timestamp of the last status update.

curl "https://api.gateway.accelebit.com/v1/payments?merchantRef=order_98765" \
  -H "X-API-Key: smtgw_sk_test_your_secret_key"

const response = await fetch(
  'https://api.gateway.accelebit.com/v1/payments?merchantRef=order_98765',
  {
    headers: {
      'X-API-Key': process.env.ACCELEBIT_SECRET_KEY!,
    },
  }
);

const result = await response.json();

import requests

response = requests.get(
    'https://api.gateway.accelebit.com/v1/payments',
    params={'merchantRef': 'order_98765'},
    headers={'X-API-Key': ACCELEBIT_SECRET_KEY},
)

result = response.json()

{
  "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"
  }
}

{
  "data": null,
  "error": {
    "status": 400,
    "name": "INVALID_REQUEST",
    "message": "Query parameter merchantRef is required"
  }
}

{
  "data": null,
  "error": {
    "status": 404,
    "name": "NOT_FOUND",
    "message": "Transaction order_98765 not found"
  }
}

curl "https://api.gateway.accelebit.com/v1/payments?merchantRef=order_98765" \
  -H "X-API-Key: smtgw_sk_test_your_secret_key"

const response = await fetch(
  'https://api.gateway.accelebit.com/v1/payments?merchantRef=order_98765',
  {
    headers: {
      'X-API-Key': process.env.ACCELEBIT_SECRET_KEY!,
    },
  }
);

const result = await response.json();

import requests

response = requests.get(
    'https://api.gateway.accelebit.com/v1/payments',
    params={'merchantRef': 'order_98765'},
    headers={'X-API-Key': ACCELEBIT_SECRET_KEY},
)

result = response.json()

{
  "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"
  }
}

{
  "data": null,
  "error": {
    "status": 400,
    "name": "INVALID_REQUEST",
    "message": "Query parameter merchantRef is required"
  }
}

{
  "data": null,
  "error": {
    "status": 404,
    "name": "NOT_FOUND",
    "message": "Transaction order_98765 not found"
  }
}

Payments

Refunds

Customers

GET /v1/payments — Look Up Payment by Reference

Query parameters

Headers

Response

​Query parameters

​Headers

​Response

Query parameters

Headers

Response