Private API reference

Transaction

Private Transaction API endpoints

Endpoints

GET/transactions
GET/transactions/{transaction_id}

Get list of transactions

GET /transactions

An API endpoint to get list of transactions.

Query parameters

pageoptionalinteger

Page

per_pageoptionalinteger

Entities per page

customer_idoptionalinteger

Filter by customer ID

invoice_idoptionalinteger

Filter by invoice ID

statusoptionalstring

Filter transactions by status (e.g., success, failed)

Possible values: success, failed.

external_idsoptionalstring[]

Filter transactions by external (gateway) transaction IDs

Returnsobject

Transactions list response

Error responses

422object

A query parameter failed validation: page below 1, per_page outside 1 to 100, a customer_id or invoice_id that does not belong to the shop, a status other than success or failed, an external_ids[] value that matches no transaction of the shop, or a non-array expand[].

curl https://api.subbly.co/private/v1/transactions \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "external_id": "pi_3Qtw6SJ8pwdPGEaK0nZoMSSE",
      "invoice_id": 1,
      "customer_id": 1,
      "customer": {
        "id": 8435732,
        "user_id": 5512,
        "first_name": "John",
        "last_name": "Smith",
        "email": "test@test.com",
        "marketing_consent": false,
        "tos_consent_at": "2022-04-01T00:00:00.000000Z",
        "external_id": "crm-8842",
        "default_payment_method_id": 1,
        "default_payment_method": {},
        "payment_methods": [
          {}
        ],
        "subscriptions": [
          {}
        ],
        "past_due_invoice_count": 0,
        "balance": 1500,
        "tags": [
          "VIP"
        ],
        "tags_meta": [],
        "notes": [
          {}
        ],
        "addresses": [
          {}
        ],
        "metadata": [
          {}
        ],
        "created_at": "2022-04-01T00:00:00.000000Z"
      },
      "description": "description",
      "payment_method_id": 1,
      "payment_method": {
        "id": 567,
        "type": "card",
        "identifier": "4242",
        "currencies": [
          "USD",
          "EUR"
        ],
        "card": {
          "last_four": "4242",
          "expiry_month": "2",
          "expiry_year": "2099",
          "type": "credit",
          "brand": "visa"
        },
        "ideal": {
          "bank": "ING",
          "bic": "INGBNL2A",
          "email": "test@subbly.co",
          "name": "John Doe"
        },
        "bancontact": {
          "email": "test@subbly.co",
          "name": "John Doe"
        },
        "acss_debit": {
          "email": "test@subbly.co",
          "name": "John Doe",
          "bank_name": "Royal Bank of Canada",
          "transit_number": "12345",
          "institution_number": "123",
          "last_four": "6789"
        },
        "us_bank_account": {
          "email": "test@subbly.co",
          "name": "John Doe",
          "bank_name": "US Bank",
          "last4": "6789",
          "routing_number": "123456789",
          "account_type": "checking",
          "account_holder_type": "individual"
        },
        "sepa_debit": {
          "email": "test@subbly.co",
          "name": "John Doe",
          "iban_last4": "6789",
          "bank_code": "123456",
          "country": "DE",
          "branch_code": "12345"
        },
        "sofort": {
          "email": "test@subbly.co",
          "name": "John Doe",
          "country": "DE"
        },
        "link": {
          "email": "test@subbly.co",
          "name": "John Doe"
        },
        "cashapp": {
          "email": "test@subbly.co",
          "name": "John Doe",
          "buyer_id": "cashapp:123456789",
          "cash_tag": "$subbly"
        },
        "created_at": "2022-04-01T00:00:00.000000Z"
      },
      "type": "charge",
      "status": "success",
      "amount": 1.5,
      "currency_code": "USD",
      "last_payment_error": {
        "error_text": "Your card has insufficient funds.",
        "decline_code": "insufficient_funds",
        "error_code": "card_declined"
      },
      "created_at": "2026-01-15T10:30:00Z"
    }
  ]
}

Get transaction by ID

GET /transactions/{transaction_id}

A detailed description of the charge transaction.

Path parameters

transaction_idRequiredinteger

Transaction ID

Format: integer.

ReturnsTransaction

Transaction object response

Error responses

400object

The transaction exists but belongs to another shop.

404object

No transaction exists with this ID.

422object

The expand[] parameter is not an array.

curl https://api.subbly.co/private/v1/transactions/{transaction_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "external_id": "pi_3Qtw6SJ8pwdPGEaK0nZoMSSE",
  "invoice_id": 1,
  "customer_id": 1,
  "customer": {
    "id": 8435732,
    "user_id": 5512,
    "first_name": "John",
    "last_name": "Smith",
    "email": "test@test.com",
    "marketing_consent": false,
    "tos_consent_at": "2022-04-01T00:00:00.000000Z",
    "external_id": "crm-8842",
    "default_payment_method_id": 1,
    "default_payment_method": {},
    "payment_methods": [
      {}
    ],
    "subscriptions": [
      {}
    ],
    "past_due_invoice_count": 0,
    "balance": 1500,
    "tags": [
      "VIP"
    ],
    "tags_meta": [],
    "notes": [
      {}
    ],
    "addresses": [
      {}
    ],
    "metadata": [
      {}
    ],
    "created_at": "2022-04-01T00:00:00.000000Z"
  },
  "description": "description",
  "payment_method_id": 1,
  "payment_method": {
    "id": 567,
    "type": "card",
    "identifier": "4242",
    "currencies": [
      "USD",
      "EUR"
    ],
    "card": {
      "last_four": "4242",
      "expiry_month": "2",
      "expiry_year": "2099",
      "type": "credit",
      "brand": "visa"
    },
    "ideal": {
      "bank": "ING",
      "bic": "INGBNL2A",
      "email": "test@subbly.co",
      "name": "John Doe"
    },
    "bancontact": {
      "email": "test@subbly.co",
      "name": "John Doe"
    },
    "acss_debit": {
      "email": "test@subbly.co",
      "name": "John Doe",
      "bank_name": "Royal Bank of Canada",
      "transit_number": "12345",
      "institution_number": "123",
      "last_four": "6789"
    },
    "us_bank_account": {
      "email": "test@subbly.co",
      "name": "John Doe",
      "bank_name": "US Bank",
      "last4": "6789",
      "routing_number": "123456789",
      "account_type": "checking",
      "account_holder_type": "individual"
    },
    "sepa_debit": {
      "email": "test@subbly.co",
      "name": "John Doe",
      "iban_last4": "6789",
      "bank_code": "123456",
      "country": "DE",
      "branch_code": "12345"
    },
    "sofort": {
      "email": "test@subbly.co",
      "name": "John Doe",
      "country": "DE"
    },
    "link": {
      "email": "test@subbly.co",
      "name": "John Doe"
    },
    "cashapp": {
      "email": "test@subbly.co",
      "name": "John Doe",
      "buyer_id": "cashapp:123456789",
      "cash_tag": "$subbly"
    },
    "created_at": "2022-04-01T00:00:00.000000Z"
  },
  "type": "charge",
  "status": "success",
  "amount": 1.5,
  "currency_code": "USD",
  "last_payment_error": {
    "error_text": "Your card has insufficient funds.",
    "decline_code": "insufficient_funds",
    "error_code": "card_declined"
  },
  "created_at": "2026-01-15T10:30:00Z"
}