Create a payment

post

https://secure.breeze.cash/v1/gateway/payments

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Server-to-server payment details

amount

integer

required

≥ 1

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

currency

string

enum

required

ISO 4217 currency code.

clientReferenceId

string

required

length ≤ 100

^[\w-]+$

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

customer

required

Customer identification. Provide one of the three variants below.

paymentMethod

required

Payment credentials. Pick the variant that matches your integration.

transactionContext

object

Required for Merchant-Initiated Transactions (MIT). Optional for standard Customer-Initiated Transactions (CIT).

threeDs

3DS authentication results. Required for customer-initiated transactions on RAW_PAN, NETWORK_TOKEN, and DECRYPTED_GOOGLE_PAY PAN_ONLY; optional otherwise. Merchant-initiated (MIT) transactions skip 3DS.

risk

object

Risk signals used for fraud scoring. sessionId is required for CIT and omitted for MIT.

taxDetails

object

Merchant-supplied tax carried within the tax-inclusive amount. S2S accepts merchant_calculated only.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad request

401Unauthorized