Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Lookups

Get Payment Methods

Retrieves a list of payment methods, optionally filtered by PaymentMethodID.

get/v1/paymentMethods

Query parameters

PaymentMethodIDinteger

The unique identifier of the payment method to filter the results.

Response

A list of payment methods matching the specified criteria.

PaymentMethodIDinteger nullable

The unique identifier of the payment method.

PaymentMethodDescriptionstring nullable

A brief description of the payment method.

LastUpdatedstring date-time nullable

The date and time when the payment method information was last updated.

PrepaidPaymentBitboolean nullable

Indicates whether the payment method supports prepaid payments.

PreselectionSupportBitinteger nullable

Indicates whether the payment method supports pre-selection during transactions.

TransactionBlockDurationinteger nullable

The duration (in seconds) for which a transaction is blocked or held.

AutomaticVoidBitboolean nullable

Indicates whether the payment method supports automatic voids of transactions.

CKeystring nullable

A unique key associated with the payment method for additional identification or reference.

ExternalPrepaidBitboolean nullable

Indicates whether the payment method supports external prepaid transactions.

MobileApplicationBitboolean nullable

Indicates whether the payment method is supported by mobile applications.

QRPaymentSupportBitboolean nullable

Indicates whether the payment method supports QR code payments.

ForceSettlementSupportBitboolean nullable

Indicates whether the payment method supports forced settlements.