Sign in

v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
PaymentMethods

View payment method

Find a single payment method by ID.

get/v1/PaymentMethods/{id}

Path parameters

idinteger required

Format - int32. ID of the payment method to view.

Response

OK

okboolean
payment_method_idinteger

Primary identifier for this payment method.

descriptionstring

A short description of the payment method.

order_indexinteger

Indicates the order in which the method should be listed relative to others in ascending numerical order.

cc_enabledboolean

Indicates that this method will facilitate an electronic credit card payment.

ach_enabledboolean

Indicates that this method will facilitate an electronic check or ACH payment.

erate_enabledboolean

Indicates that this method supports the eRate feature for government reimbursement.

fee_descriptionstring

A description of the fee applied to any payment by this method. Only applicable if fee_amount is greater than zero.

fee_amountnumber double

The amount of fee to apply to any payment by this method. It can represent a flat fee: 4.00 = $4.00. It can represent a percentage based on the payment amount: 4.00 = 4.00%. Which representation is indicated by the fee_type value.

fee_type'FLAT' | 'PERCENT'

Indicates what the fee_amount value represents.

fee_applied_to_auto_debitboolean

Indicates that the fee should also apply to auto debit payments.

shows_in_customer_portalboolean

Indicates that this method is available to choose in the customer portal.

shows_in_agent_portalboolean

Indicates that this method is available to choose in the agent portal.