# Embat Payments API

**Canonical:** https://apis.io/apis/embat/embat-payments-api/  
**Provider:** Embat — https://apis.io/providers/embat/  
**Base URL:** https://api.embat.io  
**Documentation:** https://api.embat.io/docs

Embat Payments API is one of 22 APIs that [Embat](https://apis.io/providers/embat/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

`Payment` represents money moving between a bank transaction and the operations (invoices, bills) or accounting entries it settles. `customId` is the unique identifier of a payment: set your own value to use as your ERP payment ID, or let Embat auto-generate one. A payment links the bank world and the accounting world in Embat: it can represent the relationship between a `Transaction` (the bank movement) and one or more `Operations` (the invoices/bills being paid), a cash movement posted directly to an accounting account, or a movement involving a `Contact` (client or supplier). Payments can also reference a `Product` to resolve the accounting code used for classification, and a `Category` for reporting. **Typical flow:** payments synchronize accounting in both directions between your ERP and Embat. 1. **Notify Embat of payments posted in your ERP.** When a payment is recorded in your ERP, create it in Embat with the operations it settles — each settled amount reduces the pending amount of the corresponding operation (invoice/bill) in Embat: ```json POST /payments/{companyId} { "customId": "erp-payment-001", "date": "2024-01-15T00:00:00Z", "amount": 1250.50, "currency": "EUR", "operations": [ { "customId": "invoice-2024-001", "amount": 1250.50 } ] } ``` 2. **Read payments created from Embat.** Periodically pull the payments generated in Embat that are pending on your side, using `GET /payments/{companyId}` with the `sync` filter (payments not yet synchronized) and `startUpdatedAt`/`endUpdatedAt` for incremental reads since your last poll. This endpoint never returns payments you created through `POST /payments/{companyId}` — retrieve those by `customId` with `GET /payments/{companyId}/{customId}`. 3. **Confirm them back.** Once those payments are posted in your ERP, mark them as synchronized and registered (or record an `error`) with `PATCH /payments/{companyId}/{customId}` (or the bulk variant `PATCH /payments/{companyId}`).

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/embat/refs/heads/main/openapi/embat-payments-api-openapi.yml
- **Documentation** — https://api.embat.io/docs
- **APIReference** — https://api.embat.io/docs

## Other Embat APIs (12)

- [Embat AccountingAccounts API](https://apis.io/apis/embat/embat-accountingaccounts-api/)
- [Embat AccountingEntries API](https://apis.io/apis/embat/embat-accountingentries-api/)
- [Embat Attributes API](https://apis.io/apis/embat/embat-attributes-api/)
- [Embat Authentication API](https://apis.io/apis/embat/embat-authentication-api/)
- [Embat Balances API](https://apis.io/apis/embat/embat-balances-api/)
- [Embat Banks API](https://apis.io/apis/embat/embat-banks-api/)
- [Embat Categories API](https://apis.io/apis/embat/embat-categories-api/)
- [Embat Companies API](https://apis.io/apis/embat/embat-companies-api/)
- [Embat Contacts API](https://apis.io/apis/embat/embat-contacts-api/)
- [Embat DebtScheduleConfigs API](https://apis.io/apis/embat/embat-debtscheduleconfigs-api/)
- [Embat Files API](https://apis.io/apis/embat/embat-files-api/)
- [Embat Forecasts API](https://apis.io/apis/embat/embat-forecasts-api/)

## Tags

Payments

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/embat/embat-payments-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/embat/.