v1

latestOpenAPI 3.1.02026-07-245575200.1 KB

Direct Payment

Create a payment

Create and authorize a payment.

Base URL — to meet PCI requirements, this endpoint must be called against https://secure.breeze.cash (production) or https://secure-sandbox.breeze.cash (sandbox), not the default api.breeze.cash host shown elsewhere in this reference.

post/v1/gateway/payments

Request body

amountinteger required

Payment amount in minor units (e.g. 1000 = $10.00).

currency'USD' | 'AUD' | 'CAD' | 'CHF' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'JPY' | 'NOK' | 'NZD' | 'PLN' | 'SEK' | 'SGD' | 'TWD' | 'KRW' required

ISO 4217 currency code.

clientReferenceIdstring required

Merchant-provided dedup key. Used to safely retry requests without double-charging.

metadataobject

Arbitrary key-value pairs. Max 50 keys, string values only.

Response

Success

status'SUCCEEDED' required