PaymentMethod Object Model

Information about the payment method for the transaction.

method

enum<string>

required

Method to use for the transaction. For transactions with a credit or debit card, or a tokenized card, use card.

Available options:

card

Example:

"card"

cardnumber

string

required

The card number. Required when method is card and a storedMethodId isn't included.

Maximum length: 20

Example:

"4111111111111111"

cardexp

string | null

required

Card expiration date in format MMYY or MM/YY. This field is required when using the card method.

Maximum length: 5

Example:

"02/25"

cardcvv

string | null

Card Verification Value (CVV) associated with the card number. We strongly recommend that you include this field when using card as a method.

Maximum length: 4

Example:

"123"

cardzip

string | null

ZIP code for the billing address of cardholder. We strongly recommend that you include this field when using card as a method.

Maximum length: 50

Example:

"12345"

cardHolder

string | null

Cardholder name.

Maximum length: 250

Example:

"John Cassian"

initiator

string | null

default:merchant

Strongly recommended The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to merchant.

Available values:

payor: For cardholder-initiated transactions
merchant: For merchant-initiated transactions

See Understanding CIT and MIT Indicators for more information.

Example:

"payor"

saveIfSuccess

boolean | null

When true, Payabli saves the payment method if the transaction is successful. The payment method ID is returned in the response as methodReferenceId. Defaults to false.

Information about the payment method for the transaction.

method

enum<string>

required

Method to use for the transaction. For transactions with a credit or debit card, or a tokenized card, use card.

Available options:

card

Example:

"card"

cardnumber

string

required

The card number. Required when method is card and a storedMethodId isn't included.

Maximum length: 20

Example:

"4111111111111111"

cardexp

string | null

required

Card expiration date in format MMYY or MM/YY. This field is required when using the card method.

Maximum length: 5

Example:

"02/25"

cardcvv

string | null

Card Verification Value (CVV) associated with the card number. We strongly recommend that you include this field when using card as a method.

Maximum length: 4

Example:

"123"

cardzip

string | null

ZIP code for the billing address of cardholder. We strongly recommend that you include this field when using card as a method.

Maximum length: 50

Example:

"12345"

cardHolder

string | null

Cardholder name.

Maximum length: 250

Example:

"John Cassian"

initiator

string | null

default:merchant

Available values:

payor: For cardholder-initiated transactions
merchant: For merchant-initiated transactions

See Understanding CIT and MIT Indicators for more information.

Example:

"payor"

saveIfSuccess

boolean | null

When true, Payabli saves the payment method if the transaction is successful. The payment method ID is returned in the response as methodReferenceId. Defaults to false.

Information about the payment method for the transaction.

method

enum<string>

required

Method to use for the transaction. For ACH transactions or using a tokenized bank account, use ach.

Available options:

ach

Example:

"ach"

achHolder

string | null

required

The checking accountholder's name.

Maximum length: 250

Example:

"John Doe"

achRouting

string | null

required

ABA/routing number of Bank account. This field is required when method = 'ach'.

Required string length: 9

Example:

"123123123"

achAccount

string | null

required

Bank account number. This field is required when method = 'ach'.

Required string length: 4 - 17

Example:

"123123123"

achAccountType

enum<string> | null

required

Bank account type: Checking or Savings.

Available options:

Checking,

Savings

achHolderType

enum<string> | null

default:personal

The bank's accountholder type: personal or business.

Available options:

personal,

business

achCode

string

Standard Entry Class (SEC) code is a a three letter code that describes how an ACH payment was authorized. Supported values are:

PPD (Prearranged Payment and Deposit) - Used for credits or debits where an accountholder authorizes a company to initiate either a single or recurring transaction to their personal bank account. Common examples include direct deposit of payroll, mortgage payments, or utility bills. This is the default value for subscription payments.
WEB (Internet-Initiated/Mobile Entry) - Used for debit entries when authorization is obtained from an accountholder via the internet or a wireless network. Common examples are online bill payments, ecommerce purchases, and mobile app payments where the consumer enters their banking information online.
TEL (Telephone-Initiated Entry) - Used for one-time debit entries where authorization is obtained from a consumer via telephone. Common examples are phone-based purchases or bill payments where the consumer provides their banking information over the phone.
CCD (Corporate Credit or Debit) - Used for fund transfers between business accounts. This code is specifically for business-to-business transactions. Common examples include vendor payments and other business-to-business payments.

saveIfSuccess

boolean | null

When true, Payabli saves the payment method if the transaction is successful. The payment method ID is returned in the response as methodReferenceId. Defaults to false.

Information about the payment method for the transaction.

method

enum<string>

required

Method to use for the transaction. Use either card or ach, depending on what kind of method was tokenized to use a saved payment method for this transaction.

Available options:

card,

ach

Example:

"card"

storedMethodId

string | null

required

Payabli identifier of a tokenized payment method.

Example:

"1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440"

storedMethodUsageType

string | null

default:unscheduled

Strongly recommended The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to unscheduled.

Available values:

unscheduled: This type is used for transactions that are one-time or otherwise not pre-scheduled.
subscription: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions.
recurring: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments.

See Understanding CIT and MIT Indicators for more information.

Example:

"subscription"

initiator

string | null

default:merchant

Available values:

payor: For cardholder-initiated transactions
merchant: For merchant-initiated transactions

See Understanding CIT and MIT Indicators for more information.

Example:

"payor"

Information about the payment method for the transaction.

method

enum<string>

required

Method to use for the transaction. For cloud device transactions, the method is cloud.

Available options:

cloud

Example:

"cloud"

device

string | null

required

Identifier of registered cloud device used in the transaction.

Example:

"6c361c7d-674c-44cc-b790-382b75d1xxx"

saveIfSuccess

boolean | null

When true, Payabli saves the payment method if the transaction is successful. The payment method ID is returned in the response as methodReferenceId. Defaults to false.

Information about the payment method for the transaction.

method

enum<string>

required

Method to use for the transaction. Use check for a paper check transaction. When the method is check, then paymentDetails.checkNumber is required.

Available options:

check

Example:

"check"

achHolder

string | null

required

The checking accountholder's name.

Maximum length: 250

Example:

"John Doe"

Information about the payment method for the transaction.

method

enum<string>

required

Method to use for the transaction. For cash transactions, use cash.

Available options:

cash

Example:

"cash"

Information about the payment method for the transaction.

method

enum<string> | null

required

Method to use for the transaction.

Available options:

card,

ach,

cloud,

check,

cash

cardnumber

string

The card number. Required when method is card and a storedMethodId isn't included.

Maximum length: 20

Example:

"4111111111111111"

cardexp

string | null

Card expiration date in format MMYY or MM/YY. This field is required when using the card method.

Maximum length: 5

Example:

"02/25"

cardcvv

string | null

Card Verification Value (CVV) associated with the card number. We strongly recommend that you include this field when using card as a method.

Maximum length: 4

Example:

"123"

cardzip

string | null

ZIP code for the billing address of cardholder. We strongly recommend that you include this field when using card as a method.

Maximum length: 50

Example:

"12345"

cardHolder

string | null

Cardholder name.

Maximum length: 250

Example:

"John Cassian"

achHolder

string | null

Bank account holder. This field is required for method = 'ach' and method = 'check'.

Maximum length: 250

Example:

"John Doe"

achRouting

string | null

ABA/routing number of Bank account. This field is required when method = 'ach'.

Required string length: 9

Example:

"123123123"

achAccount

string | null

Bank account number. This field is required when method = 'ach'.

Required string length: 4 - 17

Example:

"123123123"

achAccountType

enum<string> | null

Bank account type: Checking or Savings.

Available options:

Checking,

Savings

achCode

string

Standard Entry Class (SEC) code is a a three letter code that describes how an ACH payment was authorized. Supported values are:

PPD (Prearranged Payment and Deposit) - Used for credits or debits where an accountholder authorizes a company to initiate either a single or recurring transaction to their personal bank account. Common examples include direct deposit of payroll, mortgage payments, or utility bills. This is the default value for subscription payments.
WEB (Internet-Initiated/Mobile Entry) - Used for debit entries when authorization is obtained from an accountholder via the internet or a wireless network. Common examples are online bill payments, ecommerce purchases, and mobile app payments where the consumer enters their banking information online.
TEL (Telephone-Initiated Entry) - Used for one-time debit entries where authorization is obtained from a consumer via telephone. Common examples are phone-based purchases or bill payments where the consumer provides their banking information over the phone.
CCD (Corporate Credit or Debit) - Used for fund transfers between business accounts. This code is specifically for business-to-business transactions. Common examples include vendor payments and other business-to-business payments.

storedMethodId

string | null

Payabli identifier of a tokenized payment method. If this field is used in a request, the method field is overridden and the payment is made using the payment token.

Example:

"1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440"

initator

string | null

default:merchant

Available values:

payor: For cardholder-initiated transactions
merchant: For merchant-initiated transactions

See Understanding CIT and MIT Indicators for more information.

Example:

"payor"

storedMethodUsageType

string | null

default:unscheduled

Strongly recommended The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to unscheduled.

Available values:

unscheduled: This type is used for transactions that are one-time or otherwise not pre-scheduled.
subscription: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions.
recurring: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments.

See Understanding CIT and MIT Indicators for more information.

Example:

"subscription"

device

string | null

Identifier of registered cloud device used in the transaction.

Example:

"6c361c7d-674c-44cc-b790-382b75d1xxx"

saveIfSuccess

boolean | null

When true, Payabli saves the payment method if the transaction is successful. The payment method ID is returned in the response as methodReferenceId. Defaults to false.

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

PaymentMethod Object Model