BRbreeze
Direct Payment

Create a payment

Changed on

Create and authorize a payment.

For merchant-calculated tax, first call Get tax rate with the pre-tax amount and customer location. Then set amount to the all-in total charged to the customer (pre-tax amount + tax), and pass the calculated tax in taxDetails.amount with the same location. For example, for a $1.00 subtotal and $0.08 tax, send amount: 108 and taxDetails.amount: 8. Breeze remains the Merchant of Record and remits and files the tax.

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

Request body

amountinteger required

All-in total charged to the customer, in minor units (e.g. 1000 = $10.00). Includes taxDetails.amount when tax is supplied.

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.

descriptionstring

Description of what the customer purchased. Direct Payment has no line items, so this is how product information reaches the receipt and the Breeze dashboard.

metadataobject

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

Example request

{
  "taxDetails": {
    "location": {
      "country": "US",
      "postalCode": "23242"
    }
  }
}

Response

Success

status'SUCCEEDED' required

Changes

  • 4af083d182a6Revision changes
    • breaking

      removed the enum value AMEX of the request property ///

    • breaking

      removed the enum value CARTES_BANCAIRES of the request property ///

    • breaking

      removed the enum value DINERS of the request property ///

    • breaking

      removed the enum value DISCOVER of the request property ///

    • breaking

      removed the enum value JCB of the request property ///

    • breaking

      removed the enum value MASTERCARD of the request property ///

    • breaking

      removed the enum value VISA of the request property ///

    • breaking

      the response property /// became optional for the status

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      the request property // became optional

    • info

      added subschema #1 subschema #2 to the /// request property oneOf list

    • info

      added the optional property / to the response with the status