> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.sessionboard.com/llms.txt > Use this file to discover all available pages before exploring further. # List payments > The payment records of the event's registration orders, oldest first: card and bank-account charges and refunds made through your organization's own payment gateway (Sessionboard connects to it through Spreedly), and money recorded offline (check, cash, paid elsewhere, comp). A record never carries a card number, a payment or gateway token, or a gateway credential. `card_brand` and `last_four` are filled only when the gateway reported them and Sessionboard stored them; otherwise they are `null`. A failed card attempt is its own record with `status: failed` and a `failure` code, so this list is also the failed-transaction log. A refund names the charge it refunds in `parent_payment_id`. Paginated (`page`, `page_size` up to 200). Requires `read:registrations` (legacy tokens with no scopes pass). ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/event/{eventId}/payments openapi: 3.1.0 info: title: Sessionboard Public API version: '1.0' description: >- REST API for managing sessions, speakers, contacts, sponsors, exhibitors, and event data on the Sessionboard platform. contact: name: Sessionboard Support email: support@sessionboard.com termsOfService: https://www.sessionboard.com/legal/terms-of-service servers: - url: https://public-api.sessionboard.com description: US Region - url: https://public-api-eu.sessionboard.com description: EU Region security: - ApiKey: [] - BearerToken: [] tags: - name: Events description: Manage events on the platform. - name: Sessions description: Search and retrieve sessions within an event. - name: Session Writes description: >- Create, update, delete, and restore sessions. Requires the `write:sessions` scope. - name: Contact Writes description: >- Create, update, delete, and restore contacts. Requires the `write:contacts` scope. - name: Exhibitor Writes description: >- Create, update, delete, and restore exhibitors. Requires the `write:exhibitors` scope. - name: Sponsor Writes description: >- Create, update, delete, and restore sponsors. Requires the `write:sponsors` scope. - name: Field Writes description: >- Create, update, and delete custom fields. Requires the `write:fields` scope. - name: Speakers description: Search and retrieve speakers within an event. - name: Participants description: | Search and retrieve every contact holding a session role on an event — speakers, chairpersons, moderators and custom roles — with the roles each one holds, and list the event's participant roles. - name: Contacts description: Search and retrieve contacts at the organization or event level. - name: Sponsors description: Search and retrieve sponsors within an event. - name: Exhibitors description: Search and retrieve exhibitors within an event. - name: Event Settings description: >- Retrieve event configuration such as fields, tags, tracks, rooms, formats, levels, languages, and session statuses. - name: GDPR description: Manage GDPR data access and erasure requests. - name: Insights description: >- Query event data using SbQL, generate queries with AI, and manage dashboards. - name: Ask description: >- Ask a natural-language question about one event and get a cited answer. Requires the `read:ask` scope, granted explicitly. - name: Metadata Writes description: >- Create, update, and delete session metadata (rooms, tracks, tags, formats, levels, languages, statuses). Requires the `write:metadata` scope. - name: Agenda Planning description: >- Manage agenda drafts, draft sessions, scheduling rules, and evaluation personas. Requires the `write:events` scope. - name: Dashboards & Widgets description: >- Create, read, update, and delete dashboards and widgets at the event or organization level. Requires `write:events` scope for writes. - name: Reports & Queries description: >- Create, read, update, delete, and run saved SbQL queries/reports at the event or organization level. Requires `write:events` scope for writes. - name: Transcriptions description: >- Transcript text on sessions — fragments, summaries, insights, and translations. Requires `read:transcriptions` / `write:transcriptions` scopes. - name: Session Recordings description: >- Session audio files for recording archives (live capture or imported audio). Requires `read:transcriptions` / `write:transcriptions` scopes. - name: Media description: >- Upload video or audio files for automatic transcription. Requires `read:media` / `write:media` scopes. - name: Session Files description: > Documents attached to sessions (PDFs, PowerPoint, Word, images, and similar). Simple upload: `POST .../files/upload` (multipart, max 50 MB). Direct-to-storage: create → PUT → complete (max 500 MB). Requires `read:sessions` / `write:sessions` scopes. See the [Uploading session files](/guides/uploading-session-files) guide. - name: OAuth description: >- OAuth 2.1 endpoints for AI client authorization (Claude, ChatGPT). Mounted at `/oauth/` (not `/v1/`). - name: Log Export description: > Pull your organization's API request, security and audit logs into a SIEM such as Splunk, Microsoft Sentinel or Elastic. Requires a dedicated API token with the `read:audit_logs` scope, which can call nothing else. See the [Exporting logs to a SIEM](/guides/exporting-logs-to-a-siem) guide. - name: Awards description: >- Read and manage Awards programs and their categories, rounds, promo codes, submissions and reviews. Organization-level: paths start at `/v1/organization/{orgId}/awards`. Requires `read:awards` / `write:awards` scopes. - name: Registration description: > Registration inside Sessionboard: registration forms, ticket types, registrations, orders, attendees and check-ins for one event. Requires the preview scopes `read:registrations` / `write:registrations`, which a token or OAuth client gets only when they are named explicitly (not by default, and not listed in `scopes_supported`). The event must have Registration turned on (Early Access); otherwise every endpoint answers `403 FORBIDDEN`. See the [Registration and Expo](/guides/registration-and-expo) guide. - name: Expo description: > Expo floor-map booths and sponsorship inventory for one event. Requires the preview scopes `read:expo` / `write:expo`, which a token or OAuth client gets only when they are named explicitly (not by default, and not listed in `scopes_supported`). The event must have Expo turned on (Early Access); otherwise every endpoint answers `403 FORBIDDEN`. See the [Registration and Expo](/guides/registration-and-expo) guide. paths: /v1/event/{eventId}/payments: get: tags: - Registration summary: List payments description: > The payment records of the event's registration orders, oldest first: card and bank-account charges and refunds made through your organization's own payment gateway (Sessionboard connects to it through Spreedly), and money recorded offline (check, cash, paid elsewhere, comp). A record never carries a card number, a payment or gateway token, or a gateway credential. `card_brand` and `last_four` are filled only when the gateway reported them and Sessionboard stored them; otherwise they are `null`. A failed card attempt is its own record with `status: failed` and a `failure` code, so this list is also the failed-transaction log. A refund names the charge it refunds in `parent_payment_id`. Paginated (`page`, `page_size` up to 200). Requires `read:registrations` (legacy tokens with no scopes pass). operationId: list-payments parameters: - $ref: '#/components/parameters/EventId' - $ref: '#/components/parameters/RegistrationPage' - $ref: '#/components/parameters/RegistrationPageSize' - name: status in: query required: false schema: type: string description: > Only these statuses, comma-separated: `pending`, `processing`, `succeeded`, `failed`, `refunded`, `canceled`. An unknown value is a `400`. - name: type in: query required: false schema: type: string description: > Only these record types, comma-separated: `charge`, `refund`, `authorize`, `capture`, `void`. An unknown value is a `400`. - name: order_id in: query required: false schema: type: string format: uuid description: Only this order's payments. - name: method in: query required: false schema: type: string description: >- Only these methods, comma-separated (e.g. `card`, `check`, `cash`, `external`). - name: updated_since in: query required: false schema: type: string format: date-time description: Only records created or changed at or after this time. responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Payment' pagination: $ref: '#/components/schemas/ListPagination' example: data: - id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f order_id: 9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b order_number: R-1042 type: charge status: succeeded amount_cents: 89500 currency: USD method: card method_type: card processor: spreedly gateway_type: stripe test_mode: false card_brand: visa last_four: '4242' installment: null parent_payment_id: null reference: null failure: null created_at: '2026-10-02T16:21:41.000Z' updated_at: '2026-10-02T16:21:43.000Z' pagination: current_page: 1 page_size: 50 total_pages: 1 total_results: 1 '400': description: >- `VALIDATION_ERROR` — an unknown `status` or `type`, or `order_id` is not a UUID. content: application/json: schema: $ref: '#/components/schemas/RegistrationApiError' '401': $ref: '#/components/responses/RegistrationUnauthorized' '403': $ref: '#/components/responses/RegistrationForbidden' '429': $ref: '#/components/responses/RegistrationTooManyRequests' components: parameters: EventId: name: eventId in: path required: true schema: type: integer description: Event ID RegistrationPage: name: page in: query required: false schema: type: integer minimum: 1 default: 1 description: >- Page number, from 1. A value that is not a positive integer is read as `1`. RegistrationPageSize: name: page_size in: query required: false schema: type: integer minimum: 1 maximum: 200 default: 50 description: >- Results per page. Values above 200 are read as 200; a value that is not a positive integer is read as 50. schemas: Payment: type: object description: > A payment record of a registration order. Never carries a card number, a payment or gateway token, or a gateway credential. properties: id: type: string format: uuid order_id: type: string format: uuid order_number: type: - string - 'null' type: type: string enum: - charge - refund - authorize - capture - void status: type: string enum: - pending - processing - succeeded - failed - refunded - canceled description: >- `pending` with no verdict from the gateway yet (a bank transfer settles days later). amount_cents: type: integer currency: type: string method: type: string description: >- How it was paid as recorded (`card`, `check`, `cash`, `external`, `comp`, `invoice`, …). method_type: type: string enum: - card - bank_account - offline - comp processor: type: - string - 'null' enum: - spreedly - null description: >- `spreedly` for money moved through your payment gateway; `null` for money recorded offline. gateway_type: type: - string - 'null' description: >- The kind of payment gateway (for example `stripe`, `authorize_net`, `test`). test_mode: type: - boolean - 'null' description: Whether the gateway is in test mode. card_brand: type: - string - 'null' last_four: type: - string - 'null' description: Last four digits of the card or bank account, when stored. installment: type: - integer - 'null' description: Which installment of an invoice plan this pays (0-based). parent_payment_id: type: - string - 'null' format: uuid description: For a refund, the charge it refunds. reference: type: - string - 'null' description: Check number or wire reference typed by an admin. failure: type: - object - 'null' description: Why a failed attempt failed. properties: code: type: - string - 'null' message: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time ListPagination: type: object description: >- Pagination metadata returned by the event-settings GET lists (tags, tracks, levels, formats, rooms, languages, statuses). Same numbers as `Pagination`, snake_case keys — these endpoints are served by a different layer, and the casing is longstanding. properties: current_page: type: integer examples: - 1 page_size: type: integer examples: - 25 total_pages: type: integer examples: - 4 total_results: type: integer examples: - 97 RegistrationApiError: type: object description: Error body of the Registration and Expo endpoints. required: - error - message properties: error: type: string enum: - VALIDATION_ERROR - NOT_FOUND - FORBIDDEN - CONFLICT - SCOPE_REQUIRED - EVENT_NOT_ALLOWED - EVENT_ARCHIVED - INTERNAL_ERROR message: type: string details: type: object description: Present when there is a machine-readable reason. properties: reason: type: string description: > Why the request was refused, for example `duplicate`, `sold_out`, `too_many`, `ticket_unavailable`, `not_on_sale`, `registrant_type_unavailable`, `answers_invalid`, `discount_invalid`, `wrong_status`, `account_required` or `booth_not_found`. status: type: string description: >- For `wrong_status` on Check someone in, the registration's current status. errors: type: object additionalProperties: true description: >- More detail for some reasons — the email for `duplicate`, the `ticket_type_id` for `sold_out`, the problems per answer for `answers_invalid`. responses: RegistrationUnauthorized: description: >- Missing, invalid or expired token, or the event does not belong to your organization. RegistrationForbidden: description: > - `SCOPE_REQUIRED` — the token lacks the scope (`read:registrations` for reads, `write:registrations` for writes). A write scope does not grant reads, and legacy tokens with no scopes cannot write. - `EVENT_NOT_ALLOWED` — the event is outside the token's event allow-list. - `EVENT_ARCHIVED` — the event is archived. - `FORBIDDEN` — Registration is not turned on for this event. content: application/json: schema: $ref: '#/components/schemas/RegistrationApiError' examples: feature_off: summary: Registration is off for the event value: error: FORBIDDEN message: Registration is not enabled for this event scope_required: summary: Token lacks the write scope value: error: SCOPE_REQUIRED message: This operation requires the 'write:registrations' scope. RegistrationTooManyRequests: description: | The token's request limit (100 requests per 15 minutes per bucket — see [Rate Limiting](/rate-limiting)). Wait `Retry-After` seconds. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer securitySchemes: ApiKey: type: apiKey in: header name: x-access-token description: >- Organization API token. Generate from Organization Settings → API Tokens. BearerToken: type: http scheme: bearer description: >- OAuth 2.1 access token. Obtained via the OAuth PKCE flow at `/oauth/token`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.