Amberai Payments API
The Payments API from Amberai — 2 operation(s) for payments.
The Payments API from Amberai — 2 operation(s) for payments.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amberai:amberai-payments-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amber Public Payments API
version: 1.3.0
description: Read your brand's catalog, sourcing, orders, shipments, finance, and documents. All business endpoints are read-only and require an API key. Products are Parent Products; Product Options and SKUs are separate resources. Use filters to find records, follow their IDs to related data, and paginate to retrieve every result. See the integration tutorials for complete examples and data conventions for amounts, IDs, and timestamps.
servers:
- url: https://app.amber.ai/api/public/v1
tags:
- name: Payments
paths:
/brands/{brand}/payments:
get:
tags:
- Payments
summary: List Payments
operationId: listPayments
security:
- ApiKeyAuth: []
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: A page of matching records. totalItems counts all matches across pages. When nextCursor is null, you have reached the last page.
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: The record was not found or is not available to your 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'
/brands/{brand}/payments/{id}:
get:
tags:
- Payments
summary: Get Payments
operationId: getPayments
security:
- ApiKeyAuth: []
parameters:
- name: brand
in: path
required: true
description: Brand slug authorized by this API key.
schema:
type: string
example: acme
- name: id
in: path
required: true
description: Stable resource identifier.
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: The requested record.
content:
application/json:
schema:
$ref: '#/components/schemas/Payments'
'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: The record was not found or is not available to your 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'
components:
schemas:
Payments:
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
Error:
type: object
properties:
error:
type: string
errorCode:
type: string
details:
description: Parameter validation issues, when available.
$ref: '#/components/schemas/Error/$defs/__schema0'
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'
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
description: Total number of matching records across all pages.
required:
- items
- nextCursor
- totalItems
additionalProperties: false
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
description: A brand-scoped or global amb_sk_... API key.