--- updatedAt: 2026-06-18T06:12:47.000Z agentTools: projectIndex: https://developer.hellozai.com/llms.txt --- # List Items OK # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Assembly API", "description": "Assembly (formely PromisePay) is a powerful payments engine custom-built for platforms and marketplaces.", "version": "2.4", "contact": { "email": "support@assemblypayments.com", "url": "http://docs.assemblypayments.com/" } }, "servers": [ { "url": "https://test.api.promisepay.com", "description": "Pre-live environment" }, { "url": "https://secure.api.promisepay.com", "description": "Production environment" }, { "url": "https://au-0000.sandbox.auth.assemblypay.com", "description": "Pre-Live (Sandbox) Auth issuing server and API" }, { "url": "https://au-0000.auth.assemblypay.com", "description": "Production Auth issuing server and API" }, { "description": "SwaggerHub API Auto Mocking", "url": "https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.1" } ], "x-explorer-enabled": false, "x-samples-languages": [ "curl", "ruby", "php", "javascript", "csharp", "go" ], "paths": { "/items": { "get": { "tags": [ "Items" ], "summary": "List Items", "description": "OK", "operationId": "listItems", "parameters": [ { "$ref": "#/components/parameters/offsetParam" }, { "$ref": "#/components/parameters/limitParam" }, { "name": "search", "in": "query", "description": "A text value to be used for searching within the item description", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "" }, { "name": "created_before", "in": "query", "description": "Date and time in ISO 8601 format the item(s) were created before (e.g. 2020-02-27T23:54:59Z)", "style": "form", "explode": true, "schema": { "type": "string" }, "example": "" }, { "name": "created_after", "in": "query", "description": "Date and time in ISO 8601 format the item(s) were created after (e.g. 2020-02-27T23:54:59Z)", "style": "form", "explode": true, "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/items" }, "examples": { "response": { "value": { "items": [ { "id": "7172300-1-8447", "name": "Item 7172300-1-8447", "description": "Test Item 7172300-1-8447", "created_at": "2020-05-09T07:08:24.727Z", "updated_at": "2020-05-09T07:08:49.111Z", "state": "completed", "payment_type_id": 2, "status": 22500, "amount": 173, "deposit_reference": "100014012518964", "buyer_name": "Buyer Last Name", "buyer_country": "AUS", "buyer_email": "assemblybuyer71718542@assemblypayments.com", "seller_name": "Assembly seller71718579", "seller_country": "AUS", "seller_email": "neol_seller71718579@assemblypayments.com", "tds_check_state": "NA", "currency": "AUD", "links": { "self": "/items/7172300-1-8447", "buyers": "/items/7172300-1-8447/buyers", "sellers": "/items/7172300-1-8447/sellers", "status": "/items/7172300-1-8447/status", "fees": "/items/7172300-1-8447/fees", "transactions": "/items/7172300-1-8447/transactions", "batch_transactions": "/items/7172300-1-8447/batch_transactions", "wire_details": "/items/7172300-1-8447/wire_details", "bpay_details": "/items/7172300-1-8447/bpay_details" } }, { "id": "7172240-1-1578", "name": "Item 7172240-1-1578 Escrow", "description": "Test Item 7172240-1-1578", "created_at": "2020-05-09T06:58:21.280Z", "updated_at": "2020-05-09T06:58:57.855Z", "state": "completed", "payment_type_id": 2, "status": 22500, "amount": 110, "deposit_reference": "100014012518900", "buyer_name": "Buyer Last Name", "buyer_country": "AUS", "buyer_email": "assemblybuyer71717945@assemblypayments.com", "seller_name": "Assembly seller71717976", "seller_country": "AUS", "seller_email": "neol_seller71717976@assemblypayments.com", "tds_check_state": "NA", "currency": "AUD", "links": { "self": "/items/7172240-1-1578", "buyers": "/items/7172240-1-1578/buyers", "sellers": "/items/7172240-1-1578/sellers", "status": "/items/7172240-1-1578/status", "fees": "/items/7172240-1-1578/fees", "transactions": "/items/7172240-1-1578/transactions", "batch_transactions": "/items/7172240-1-1578/batch_transactions", "wire_details": "/items/7172240-1-1578/wire_details", "bpay_details": "/items/7172240-1-1578/bpay_details" } } ], "links": { "self": "/items" }, "meta": { "limit": 2, "offset": 0, "total": 55 } } } } } } } } } } }, "components": { "parameters": { "offsetParam": { "name": "offset", "in": "query", "description": "Number of records to offset. Required for pagination.", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, "limitParam": { "name": "limit", "in": "query", "description": "Number of records to retrieve. Up to 200.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 10 } } }, "schemas": { "items": { "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/item" } }, "links": { "type": "object", "properties": { "self": { "type": "string" } } }, "meta": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } } } } }, "item": { "type": "object", "required": [ "id", "name", "amount", "payment_type", "buyer_id", "seller_id" ], "properties": { "id": { "type": "string", "example": "7190770-1-2908" }, "name": { "type": "string", "example": "Item #001" }, "description": { "type": "string", "example": "My first Item." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "state": { "type": "string", "enum": [ "pending", "payment_required", "wire_pending", "payment_pending", "payment_held", "payment_authorized", "void_pending", "voided", "fraud_hold", "payment_deposited", "work_completed", "problem_flagged", "problem_resolve_requested", "problem_escalated", "completed", "cancelled", "refunded", "refund_pending", "refund_flagged", "off_platform_refunded", "partial_completed", "partial_paid", "off_platform_chargedback" ], "example": "pending" }, "status": { "type": "integer", "enum": [ 22000, 22100, 22110, 22150, 22175, 22180, 22185, 22195, 22190, 22200, 22300, 22400, 22410, 22420, 22500, 22575, 22600, 22610, 22650, 22670, 22700, 22800, 22680 ], "example": 22000 }, "amount": { "type": "integer", "example": 20000 }, "payment_type_id": { "type": "integer", "example": 2 }, "currency": { "type": "string", "example": "AUD" }, "buyer_name": { "type": "string", "example": "Sample Buyer" }, "buyer_email": { "type": "string", "format": "email", "example": "sample.buyer@assemblypayments.com" }, "buyer_country": { "type": "string", "example": "AUS" }, "seller_name": { "type": "string", "example": "Sample Seller" }, "seller_email": { "type": "string", "format": "email", "example": "sample.seller@assemblypayments.com" }, "seller_country": { "type": "string", "format": "email", "example": "AUS" }, "tds_check_state": { "type": "string", "format": "email", "example": "NA" }, "batch_state": { "type": "string", "example": null }, "invoice_url": { "type": "string", "example": null }, "payout_descriptor": { "type": "string", "example": null }, "remaining_amount": { "type": "integer", "example": 0 }, "requested_release_amount": { "type": "integer", "example": 0 }, "custom_descriptor": { "type": "string", "example": null }, "net_amount": { "type": "integer", "example": 20000 }, "chargedback_amount": { "type": "integer", "example": 0 }, "refunded_amount": { "type": "integer", "example": 0 }, "released_amount": { "type": "integer", "example": 0 }, "buyer_fees": { "type": "integer", "example": 0 }, "seller_fees": { "type": "integer", "example": 400 }, "credit_card_fee": { "type": "integer", "example": 0 }, "paypal_fee": { "type": "integer", "example": 0 }, "seller_url": { "type": "string" }, "buyer_url": { "type": "string" }, "direct_debit_fee": { "type": "integer", "example": 0 }, "due_date": { "type": "string", "format": "date", "nullable": true }, "pending_release_amount": { "type": "integer", "example": 0 }, "dynamic_descriptor": { "type": "string", "example": null }, "deposit_reference": { "type": "string", "example": 100014013961629 }, "promisepay_fee": { "type": "integer", "example": 350 }, "total_outstanding": { "type": "integer", "example": 20000 }, "total_amount": { "type": "integer", "example": 20000 }, "payment_method": { "type": "string", "example": "pending" }, "payment_credit_card_enabled": { "type": "boolean", "example": true }, "payment_direct_debit_enabled": { "type": "boolean", "example": true }, "related": { "type": "object", "properties": { "buyers": { "type": "string", "example": "064d6800-fff3-11e5-86aa-5e5517507c66" }, "sellers": { "type": "string", "example": "5830def0-ffe8-11e5-86aa-5e5517507c66" } } }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "buyers": { "type": "string" }, "sellers": { "type": "string" }, "status": { "type": "string" }, "fees": { "type": "string" }, "transactions": { "type": "string" }, "batch_transactions": { "type": "string" }, "wire_details": { "type": "string" }, "bpay_details": { "type": "string" }, "tds_checks": { "type": "string" } } } } } }, "securitySchemes": { "oAuth2ClientCredentials": { "type": "oauth2", "description": "Please refer to Authentication section within https://developer.assemblypayments.com/reference#authentication", "flows": { "clientCredentials": { "tokenUrl": "https://au-0000.sandbox.auth.assemblypay.com/tokens", "scopes": {} } } } } }, "security": [ { "oAuth2ClientCredentials": [] } ], "x-proxy-enabled": true, "x-samples-enabled": true } ```