Payments
Get payments (PMS)
API Reference Overview
Authentication
Consumers
Connections
Accounting
- Folders
- Book years
- Clients
- Suppliers
- Invoices
- Ledger accounts
- Journals
- Journal entries
- Employees
- Analytic plans
- Analytic accounts
- Miscellaneous operations
- Outstandings
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
Payment
- Payments
- Balances
- Transactions
- Refunds
Banking
- Financial institutions
- Banking accounts
- Transactions
Advanced
- Webhooks
- Syncs
- Issues
- Datastores
Payments
Get payments (PMS)
Returns a list of payments
GET
/
consumers
/
{consumer_id}
/
pms
/
payments
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/pms/payments \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "payment-123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"payment_method_id": "payment-method-123",
"payment_method_name": "Cash",
"total": 11,
"tip": 1,
"status": "Completed",
"currency": "EUR",
"date": "2025-01-01T00:00:00Z",
"partner_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
}
}
],
"total": 1,
"page": 2,
"size": 2
}
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
Required range:
x >= 1
Required range:
1 <= x <= 100
Response
200
application/json
Successful Response
Total amount of the payment
Example:
11
Unique identifier of the payment
Example:
"payment-123"
Unique identifier of the payment method used for the payment
Example:
"payment-method-123"
Chift's name of the payment method used for the payment
Example:
"Cash"
Total amount of the tips of the payment. Tips are not part of the total of the payment
Example:
1
Status of the payment
Available options:
Pending
, Completed
, Canceled
, Failed
, Unknown
, Authorised
Example:
"Completed"
Currency of the payment
Example:
"EUR"
Date of the payment
Example:
"2025-01-01T00:00:00Z"
Reference to the customer related to this payment
Required range:
x >= 0
Required range:
x >= 1
Required range:
x >= 1
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/pms/payments \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "payment-123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"payment_method_id": "payment-method-123",
"payment_method_name": "Cash",
"total": 11,
"tip": 1,
"status": "Completed",
"currency": "EUR",
"date": "2025-01-01T00:00:00Z",
"partner_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
}
}
],
"total": 1,
"page": 2,
"size": 2
}