ormuz
Docs/API reference/Payments

Payments

Reconcilable business payment, often aggregated from one or more PSP payments.

Business object

Vue d’ensemble

Payment endpoints create and retrieve business payments. They also let you find the PSP payments that compose or source a payment.

See also the business-model page payment for semantics, relationships, and functional lifecycle.

Contrat JSON

Objet payment

Responses use the prefixed identifier pay_ and the field object to make the type explicit.

buyer_idstring

Identifier of the counterparty company, except for certain PSP sources.

statusenum

`pending`, `matched`, `partially_matched`, or `unmatched`.

amount / currencynumber/string

Received amount and currency.

sourceenum

`open_banking`, `manual`, `psp`, or `psp_with_allocations`.

payment_datedate

Business date of the payment.

source_referencestring

External reference used for business idempotency.

REST

Endpoints

MethodEndpointUsage
POST/v1/paymentsCreate a received business payment.
GET/v1/paymentsList payments, with filters for `merchant_id`, `buyer_id`, `status`, `source`, or `source_reference`.
GET/v1/payments/{id}Retrieve a payment.
GET/v1/payments/{id}/psp-paymentsList attached PSP payments.

Events

Associated events

These events can be consumed through platform webhooks when the account is configured to receive them.

payment.received

Behavior

Points d’attention

  • `payment` represents the reconcilable business payment, while `psp_payment` preserves provider detail.
  • For provider payments, prefer submitting a draft through the intended process rather than directly creating a business object from a provider webhook.