Payment Methods

The following operations are available for this resource.

Http Verb Operation
Check TXN/PaymentMethods/Check?cardReaderTypeId={cardReaderTypeId} Check PaymentMethod setup for EMV or Hosted Payment charges.
GET Method: Check, URL: TXN/PaymentMethods/Check?cardReaderTypeId={cardReaderTypeId} Test

Check PaymentMethod setup for EMV or Hosted Payment charges.

Get TXN/PaymentMethods/{paymentMethodId} Get details of a payment method.
GET Method: Get, URL: TXN/PaymentMethods/{paymentMethodId} Test

Get details of a payment method.

GetAll TXN/PaymentMethods?paymentTypeIds={paymentTypeIds}&maintenanceMode={maintenanceMode} Get all payment methods. This resource looks similar to referenceData resources, but is functionally different. When maintenanceMode is false, control groups are considered when returning payment methods. The default for maintenanceMode is false. This endpoint should not generally be used for transaction based screens because it does not account for assigned payment methods based on user group security. For cart available payment methods, consider Security/PaymentMethods?amount={amount}.
GET Method: GetAll, URL: TXN/PaymentMethods?paymentTypeIds={paymentTypeIds}&maintenanceMode={maintenanceMode} Test

Get all payment methods. This resource looks similar to referenceData resources, but is functionally different. When maintenanceMode is false, control groups are considered when returning payment methods. The default for maintenanceMode is false. This endpoint should not generally be used for transaction based screens because it does not account for assigned payment methods based on user group security. For cart available payment methods, consider Security/PaymentMethods?amount={amount}.

TranslateMnemonic TXN/PaymentMethods/TranslateMnemonic?cardReaderTypeId={cardReaderTypeId}&mnemonic={mnemonic} Translate a card mnemonic into the matching system PaymentMethod or the default fallback PaymentMethod for that CardReaderType
GET Method: TranslateMnemonic, URL: TXN/PaymentMethods/TranslateMnemonic?cardReaderTypeId={cardReaderTypeId}&mnemonic={mnemonic} Test

Translate a card mnemonic into the matching system PaymentMethod or the default fallback PaymentMethod for that CardReaderType

Create TXN/PaymentMethods Create a new payment method.
POST Method: Create, URL: TXN/PaymentMethods Test

Create a new payment method.

Update TXN/PaymentMethods/{paymentMethodId} Update an existing payment method.
PUT Method: Update, URL: TXN/PaymentMethods/{paymentMethodId} Test

Update an existing payment method.

Delete TXN/PaymentMethods/{paymentMethodId} Delete an existing payment method.
DELETE Method: Delete, URL: TXN/PaymentMethods/{paymentMethodId} Test

Delete an existing payment method.