v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

payments

Create a new Payment

Create a new payment.

post/payments/payment/

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Idempotency-Keystring

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Request body

erp_vendor_idstring

The vendor's unique identifier in your ERP system.

location_idinteger

The Ottimate location (restaurant) ID for this payment.

scheduled_datestring

The ISO 8601 date and time when the payment is scheduled to be sent.

customer_account_numberstring

Your account number with the vendor.

memostring

A memo or note to include with the payment.

payment_numberstring

Your internal identifier for this payment.

ottimate_company_idinteger

The Ottimate company ID associated with this payment.

Response

Successfully created

idstring

The unique identifier of the newly created payment.