Browse one page or an exact merchant Customer or fixed Price
Customer Payments · browseMerchantCatalog
GET
/accounts/{accountId}/customer-payments/catalogBase URL: https://api.businessmode.io/v1
Authentication
Developer bearer token
The requirement above comes from this operation's OpenAPI security declaration. See Authentication.
Parameters
| Name | In | Required | Type and constraints |
|---|---|---|---|
accountId | path | Yes | stringFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
kind | query | Yes | stringValues: customers, prices |
id | query | No | stringPattern: ^(cus|price)_[A-Za-z0-9]+$ · Maximum length: 200 |
after | query | No | stringPattern: ^(cus|price)_[A-Za-z0-9]+$ · Maximum length: 200 |
Request body
No request body is defined.
Responses
For status codes, request IDs, and safe retry decisions, see Errors & recovery. Known-code descriptions below are operation-specific, not a complete global error enum.
200 Successful response.
Content type: application/json
object · MerchantCatalogResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
entries | array | Yes | Maximum items: 20View nested schemaarray
Array itemsobject
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
nextCursor | string | null | Yes |
400 Invalid request.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
401 Authentication failed.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
403 The authenticated human is not permitted to perform this operation. Known error codes: customer_payments_forbidden.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
409 The request conflicts with current resource state.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
429 Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
500 An unexpected server error occurred.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
503 A required operation-specific provider or PostgreSQL is unavailable. Known error codes: customer_payments_not_configured, customer_payments_unavailable.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|