Update Payment method

put

https://api.sb.moneris.io/payment-methods/{payment-method-id}

Update payment method referenced by its Id.
Certain details may not be updated if the payment method was used in a transaction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payment-method-id

string

required

length between 30 and 30

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

Payment Method ID

Body Params

Payment Method details.

Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API.

card

object

required

Card details

cardholderInformation

object | null

Information about the holder of the card.

contactDetails

object | null

Contact details

billingAddress

object | null

The postal address including street, town/city, province, and postal code.
Optionally an unit number can be provided.

paymentMethodSource

string

enum

required

The source of Payment Method being used. It can be:

The Id of a Payment Method already created.
Permanent Token.
Temporary Token.
Card.
E-Wallet.

Allowed:

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

200Payment Method Updated Successfully.

400Bad Request.

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.

404Payment method not found.

409Request could not be completed due to a concurrent access issue.

422The API cannot complete the requested action due to semantic or business validation errors.

429Too Many Requests

500Unexpected error.

503Service Temporarily Unavailable