Information about the payment method for the transaction.

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
cardnumber
string
required

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

Maximum length: 20
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
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
cardHolder
string | null

Cardholder name.

Maximum length: 250
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
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.

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.

Was this page helpful?