Multiple Completions

Multiple Completions enables merchants to perform transactions requiring multiple shipments.

1. Getting Started with Multiple Completions

Moneris Sales Support

Phone: 1-855-465-4980

To begin processing Multiple Completions transactions on your store, you will need to call Moneris Sales Support to activate this feature on your store.

2. Create Payment With Multiple Completions

Pre-Authorizations that require Multiple Completions can be performed using the Create Payment API call (POST request on /payments). Some key things to note about this include:

  • automaticCapture (Boolean)

This must be set to FALSE for Multiple Completions transactions.

3. Complete Payment with Multiple Completions

The Complete Payment API call can be used to complete a Multiple Completions transaction . This can be performed by a POST request on /payments/{payment-id}/complete. Some key things to note about the Complete Payment API request include:

  • amount (Object):

This specifies the amount to be completed.

  • amount: Integer value in cents (e.g., $10.59 → 1059)

  • currency: ISO currency code (e.g., CAD, USD)  

  • finalCompletion (Boolean):

Indicates whether this is the last Completion request for a Payment.

  • To indicate that additional Completions will be performed, please pass finalCompletion as false.

  • To indicate that this is the last Completion, please pass finalCompletion as true.

In the response of a Complete Payment API call with Multiple Completions, Moneris will return an array of the Multiple Completions associated with a Payment. Such information includes:

  • amount (Object):

This specifies the amount that was completed.

  • processedAt (date-time):

This specifies the time that the Completion was processed.

  • finalCompletion (Boolean):

Indicates whether a given Completion was the last in a Multiple Completions series.

4. Follow-On Transactions for Multiple Completions

Similarly to conventional Pre-Authorizations and Completions, you can perform follow-on transactions for Multiple Completions. Such follow-on transactions include:

  1. Cancel Payment: Void a Multiple Completion.

  2. Create Refund: Perform a Matching Refund on a Multiple Completion.

To perform such actions, you will need to pass the multipleCompletion object. Such parameters included in this object include:

  • amount (Object):

This specifies the amount that was completed.

  • processedAt (date-time):

This specifies the time that the Completion was processed.

  • finalCompletion (Boolean):

Indicates whether a given Completion was the last in a Multiple Completions series.

Additional Information

Learn more with the API Definitions

Peruse the endpoints, request/response formats, and authentication methods covered in this scenario.

API References