Increment Payment

post

https://api.sb.moneris.io/payments/{payment-id}/increment

Increases the locked amount of funds in an existing pre-authorization (Payment with automaticCapture = false) for later settle by a single pre-authorization completion. There is no limit to the number of Increment Payment API calls on the original estimated authorization and each new Increment Payment increases the hold on the customer's credit card.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payment-id

string

required

length between 30 and 30

^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

The unique identifier of the payment

Body Params

idempotencyKey

string

required

length between 1 and 36

A Unique Identifier that is required for handling idempotent requests.

Note: Moneris encourages the use of UUID Version 4 in APIs as an idempotency key."

invoiceNumber

string | null

Submits a unique value to identify a transaction that is logged by Moneris Solutions.

amount

object

required

This amount excludes surcharge, application and converience fee.

customData

object | null

Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

Headers

Api-Version

string

required

Defaults to 2025-08-14

The endpoint's API Version.

Must be provided through the headers section.

X-Correlation-Id

string

Correlates a series of requests within the same flow.

Note: This ID is generated by Moneris with every request or response, if it doesn't exist.
Merchants are to echo back the value with every request that is part of the call flow."

X-Merchant-Id

string

required

length between 13 and 13

Thirteen character identification code.

Note: This code is provided by Moneris and is required to identify the Merchant executing the transaction."

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Incremental Authorization successfully created. Authorized Payment amount incremented successfully.

400Failed to complete purchase

401Not authorized. The user does not have a valid API Key or Access Token.

403Forbidden. The user does not have permission to access the requested resource.

404Not Found.

409Request could not be completed due to a conflict with resource state or existing idempotency key.

422Failed Payment operation result response

429Too Many Requests

500Unexpected error.

503Service Temporarily Unavailable