Find transactions by client reference

GET

/transactions/by-client-reference

GET

/transactions/by-client-reference

curl -G https://sandbox.api.thepennyinc.com/transactions/by-client-reference \
     -H "X-Penny-As-Business: business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71" \
     -H "Authorization: Bearer <token>" \
     -d client_reference=client_reference

{
  "items": [
    {
      "transaction_id": "transaction_01937a7d-ad6b-77ca-8046-ad6b7ca046ce",
      "account_id": "account_019372e3-b8dc-7de2-80b6-b8dcde20b6c9",
      "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
      "business_entity_id": "business_entity_01937c9d-3a1e-72b0-8881-3a1e2b088159",
      "program_id": "program_019377de-7f88-7f02-894f-7f88f0294fcb",
      "version": 1,
      "version_time": "2024-01-15T10:30:00Z",
      "stage": 2,
      "stage_time": "2024-01-15T10:30:00Z",
      "status": "approved",
      "direction": "outbound",
      "type": "payment",
      "base_amount": "108.50",
      "base_amount_currency": "USD",
      "channel": {
        "card_id": "card_019375de-a2a0-7f31-884a-a2a0f3184abd",
        "cardholder_id": "cardholder_01937e19-4ebb-75bd-8250-4ebb5bd25085",
        "processing_details": {
          "card_class": "consumer",
          "card_product_id": "card_product_01937f5d-a015-7a55-818b-a015a5518b97",
          "pan_entry_mode": "contactless",
          "type": "point_of_service"
        },
        "scheme_details": {
          "funding_type": "prepaid",
          "network": "visa",
          "product_type": "consumer"
        },
        "type": "card"
      },
      "counterparty": {
        "acquirer": {
          "id": "acq_01j8xyzabc",
          "name": "First National Merchant Services"
        },
        "merchant": {
          "category": "Grocery Stores, Supermarkets",
          "city": "San Francisco",
          "code": "5411",
          "country": "US",
          "merchant_id": "WFM-0481726",
          "name": "Whole Foods Market",
          "subdivision": "US-CA",
          "zip_code": "94105"
        },
        "type": "card"
      },
      "message": "Card payment approved",
      "client_reference": "payroll-run-2026-09-invoice-4471",
      "original_amount": "100.00",
      "original_amount_currency": "EUR"
    }
  ],
  "count": 1,
  "next_page_token": "string"
}

Find transactions with an exact caller reference within your business. References need not be unique.

Required permissions: transaction:list.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

client_referencestringRequired>=1 character

The client_reference you set when creating the transfer.

page_sizeintegerOptional1-3000Defaults to 100

Maximum number of results to return per page. Defaults to 100.

next_page_tokenstring or nullOptional

Pagination key used to retrieve the next page of results.

Response

Successful Response

itemslist of objects

The list of items returned by the API.

countinteger

The total number of items returned in this response.

next_page_tokenstring or nullOptional

A token for retrieving the next page of results, if applicable.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response

Errors