POST
/
api
/
payments
/
transactions
curl --request POST \
  --url 'https://api.atoa.me/api/payments/transactions?page=0&size=20' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fromDate": "2025-01-01",
  "toDate": "2025-12-31",
  "status": ["COMPLETED", "AUTHORIZED"],
  "paymentMethod": ["CARD"]
}'
{
  "data": [
    {
      "paymentIdempotencyId": "ATOA1692417435050",
      "paymentRequestId": "9baa68d8-362a-4127-994d-2ea622ef35ee",
      "customerId": "550e8400-e29b-41d4-a716-446655440000",
      "consumerId": "consumer_123",
      "merchantName": "My Shop",
      "merchantId": "eed6202f-4dfd-42fc-9bc6-48323556b59d",
      "orderId": "ORDER-001",
      "consumerName": "John Doe",
      "paidAmount": 10.50,
      "currency": "GBP",
      "status": "COMPLETED",
      "transactionType": "CARD",
      "notes": "Payment for order #001",
      "storeDetails": {
        "id": "d77e02d5-4e93-46cf-a8be-50da650df562",
        "address": "London",
        "locationName": "London Store"
      },
      "cardPaymentDetails": {
        "cardType": "VISA",
        "transactionSubType": "CARD",
        "captureType": "AUTO_CAPTURE",
        "metadata": {
          "isMitPayment": true
        },
        "paymentMethodId": "card_abc123def456"
      },
      "createdAt": "2025-06-15T10:30:00.000Z",
      "updatedAt": "2025-06-15T10:31:00.000Z"
    }
  ],
  "totalCount": 100,
  "page": 0,
  "size": 20
}

Returns a paginated list of transactions for the authenticated merchant. Use filters to narrow down results by date, status, payment method, customer, or store.

Authorization

Bearer <accessSecret>

Query Parameters

page
number
default: "0"

Page number (0-indexed).

size
number
default: "20"

Number of items per page.

Request Body Schema

All fields are optional. Omit the field to skip filtering.

Array filters must have at least 1 item when provided. Passing an empty array [] will return a validation error.

search
string

Free-text search by consumer name, order ID, payment request ID, or amount.

fromDate
string

Start date in YYYY-MM-DD format. Example: 2025-01-01.

toDate
string

End date in YYYY-MM-DD format. Example: 2025-12-31.

status
string[]

Filter by payment status.

atoaCustomerIds
string[]

Filter by Atoa customer UUIDs (from Create Customer). Each must be a valid UUID.

paymentMethod
string[]

Filter by payment method.

storeIds
string[]

Filter by store UUIDs. Each must be a valid UUID.

Response

data
array
totalCount
number

Total number of transactions matching the filters.

page
number

Current page number.

size
number

Items per page.