> ## Documentation Index > Fetch the complete documentation index at: https://docs.amber.ai/llms.txt > Use this file to discover all available pages before exploring further. # List Payments ## OpenAPI ````yaml https://app.amber.ai/api/public/v1/openapi.json get /brands/{brand}/payments openapi: 3.1.0 info: title: Amber Public API version: 1.3.0 description: >- Read-only access to brand business data. Products are Parent Products; Product Options and SKUs are distinct resources. Follow reference IDs and collection cursors for complete graphs. API keys never impersonate their creator. New source monetary values are decimal strings; deployed summary numbers remain unchanged. JSON specifications retain all nested fields. Archived rows remain visible unless soft-deleted; supplier-private quote drafts are excluded. servers: - url: https://app.amber.ai/api/public/v1 security: [] tags: - name: Brand - name: Parent Products - name: Product Options - name: SKUs - name: Product Versions - name: Boms - name: Bom Components - name: Bom Skus - name: Measurement Tables - name: Measurement Table Skus - name: Product Relations - name: Product Option Values - name: Product Option Dimension Values - name: Product Option Prices - name: Product Option Collections - name: Sku Dimension Values - name: Product Collections - name: Product Tags - name: Product Launch Windows - name: Suppliers - name: Quotes - name: Quote Revisions - name: Quote Items - name: Quote Price Bands - name: Quote Notes - name: Samples - name: Sample Rounds - name: Sample Checklist Results - name: Orders - name: Order Items - name: Order Amendments - name: Production Runs - name: Production Run Items - name: Production Run Item Revisions - name: Shipments - name: Shipment Items - name: Shipment Cartons - name: Shipment Carton Items - name: Shipment Charges - name: Order Shipments - name: Legs - name: Leg Items - name: Bookings - name: Booking Items - name: Shipment Bookings - name: Shipment Item Lineages - name: Packing Lists - name: Packing List Lines - name: Goods Receipts - name: Goods Receipt Lines - name: Inventory - name: Invoices - name: Invoice Lines - name: Payment Agreements - name: Payment Milestones - name: Payments - name: Payment Settlements - name: Payment Receipts - name: Partners - name: Contacts - name: Locations - name: Brand Locations - name: Partner Locations - name: Documents - name: Document Types - name: Images - name: Notes - name: Materials - name: Material Variants - name: Bom Sections - name: Categories - name: Collections - name: Launch Windows - name: Tags - name: Colors - name: Options - name: Option Values - name: Dimensions - name: Dimension Values - name: Dimension Groups - name: Dimension Group Dimensions - name: Dimension Curves - name: Dimension Curve Axes - name: Dimension Curve Axis Values - name: Dimension Curve Cells - name: Checklists - name: Packing Templates - name: Carton Sizes - name: Couriers - name: Payment Terms - name: Units Of Measure - name: Countries - name: Custom Field Definitions paths: /brands/{brand}/payments: get: tags: - Payments summary: List Payments operationId: listPayments parameters: - name: brand in: path required: true description: Brand slug authorized by this API key. schema: type: string example: acme - name: cursor in: query required: false description: >- Opaque nextCursor from the same collection and filters. Omit on the first request. schema: type: string - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 25 - name: code in: query required: false description: Exact, case-sensitive match. Spaces and punctuation are literal. schema: type: string minLength: 1 maxLength: 255 description: Exact, case-sensitive match. Spaces and punctuation are literal. - name: sourceKind in: query required: false description: Exact, case-sensitive match. Spaces and punctuation are literal. schema: type: string minLength: 1 maxLength: 255 description: Exact, case-sensitive match. Spaces and punctuation are literal. - name: sourceKey in: query required: false description: Exact, case-sensitive match. Spaces and punctuation are literal. schema: type: string minLength: 1 maxLength: 255 description: Exact, case-sensitive match. Spaces and punctuation are literal. - name: scopeKey in: query required: false description: Exact, case-sensitive match. Spaces and punctuation are literal. schema: type: string minLength: 1 maxLength: 255 description: Exact, case-sensitive match. Spaces and punctuation are literal. - name: groupRef in: query required: false description: Exact, case-sensitive match. Spaces and punctuation are literal. schema: type: string minLength: 1 maxLength: 255 description: Exact, case-sensitive match. Spaces and punctuation are literal. - name: currency in: query required: false description: Exact, case-sensitive match. Spaces and punctuation are literal. schema: type: string minLength: 1 maxLength: 255 description: Exact, case-sensitive match. Spaces and punctuation are literal. - name: onHold in: query required: false description: Exact Boolean match. Use true or false. schema: type: string enum: - 'true' - 'false' description: Exact Boolean match. Use true or false. - name: orderId in: query required: false schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - name: payeeSupplierId in: query required: false schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ responses: '200': description: >- One page. totalItems counts the full filtered set; nextCursor null means exhausted. content: application/json: schema: $ref: '#/components/schemas/PaymentsList' headers: Link: description: >- Origin-relative URL for the next page, with rel="next". Resolve against this response URL. Preserves filters and page size; omitted when nextCursor is null. schema: type: string '400': description: >- Invalid parameter, unsupported include, or cursor used with different filters. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing, invalid, expired, or out-of-scope API key. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Entity or related subject is not visible in this brand. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limit exceeded. Retry after the indicated delay. content: application/json: schema: $ref: '#/components/schemas/Error' headers: Retry-After: description: Seconds before retrying. schema: type: integer minimum: 0 '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKeyAuth: [] components: schemas: PaymentsList: type: object properties: items: type: array items: type: object properties: id: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ code: type: - string - 'null' sourceKind: type: string sourceKey: type: string scopeKey: type: string groupRef: type: - string - 'null' orderId: anyOf: - type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: 'null' payeeSupplierId: anyOf: - type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: 'null' label: type: string amount: type: string currency: type: string exchangeRate: type: - string - 'null' dueDate: type: - string - 'null' estimatedDueDate: type: - string - 'null' waitingOn: type: - string - 'null' onHold: type: boolean cancelledAt: type: - string - 'null' cancelledReason: type: - string - 'null' cancelledByUserId: anyOf: - type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: 'null' brandOwnerId: anyOf: - type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: 'null' createdAt: type: string updatedAt: type: string deletedAt: type: - string - 'null' required: - id - code - sourceKind - sourceKey - scopeKey - groupRef - orderId - payeeSupplierId - label - amount - currency - exchangeRate - dueDate - estimatedDueDate - waitingOn - onHold - cancelledAt - cancelledReason - cancelledByUserId - brandOwnerId - createdAt - updatedAt - deletedAt additionalProperties: false nextCursor: type: - string - 'null' totalItems: type: integer minimum: 0 maximum: 9007199254740991 required: - items - nextCursor - totalItems additionalProperties: false Error: type: object properties: error: type: string errorCode: type: string details: $ref: e288252a-1a5c-4f61-a45d-43bb0ec01ab5 description: Parameter validation issues, when available. required: - error - errorCode additionalProperties: false $defs: __schema0: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/Error/$defs/__schema0' - type: object propertyNames: type: string additionalProperties: $ref: '#/components/schemas/Error/$defs/__schema0' securitySchemes: ApiKeyAuth: type: http scheme: bearer description: A brand-scoped or global amb_sk_... API key. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.