Embat PaymentOrders API
⚠️ Warning: This API section is in BETA. It might undergo significant changes and may not be stable.A PaymentOrder represents a payment executed through Embat, such as a wire transfer or SEPA payment sent to a bank on behalf of a company. It can reference a `documentId` identifying the invoice or operation it settles, a Product used to fund it, and the Bank it was executed through.**Typical flow:** poll `GET /paymentorders/{companyId}` to track the payment orders created in Embat and their execution `status` (`IN_PROGRESS`, `COMPLETED`, `REJECTED`, `ON_HOLD`). Once a payment order is executed, download its signed receipt with `GET /paymentorders/{id}/receipt`.
Embat PaymentOrders API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include PaymentOrders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 2.120.3.
Requests are made against the base URL https://api.embat.io.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Embat PaymentOrders API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (HTTPBearer).
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
⚠️ Warning: This API section is in BETA. It might undergo significant changes and may not be stable. A PaymentOrder represents a payment executed through Embat, such as a wire tra…
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PaymentOrderSchema (13 properties), ValidationError (5 properties), ListPaymentOrdersResponseSchema (2 properties), BankSchema (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Embat 12
Other APIs Embat publishes across the network.