Get a Payment Method Token by ID

Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).

Bank account type or card brand.

Expiration date of card used in transaction.

ZIP code for card used in transaction.

Account holder name for the method.

Text description of the transaction.

Identifier of stored payment method used in transaction.

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.

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.

The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli.

Available values:

• first: The first use of the payment method. This is almost always a cardholder-initiated transaction.
• subsequent: For merchant-initiated transactions after the first use of the payment method.

See Understanding CIT and MIT Indicators for more information.

Custom identifier for payment connector.

Object containing information related to the card. This object is null unless the payment method is card. If the payment method is Apple Pay, the binData will be related to the DPAN (device primary account number), not the card connected to Apple Pay.

Details about the payment.

The Payabli-generated unique ID for the customer.

Customer/Payor first name.

Customer/Payor last name.

Customer's company name.

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Customer's billing address.

Additional line for Customer's billing address.

Customer's billing city.

Customer's billing state. Must be 2-letter state code for address in US.

Customer's billing ZIP code.

Customer's billing country.

Customer's phone number.

Customer's email address.

The shipping address.

Additional line for shipping address.

Shipping city.

Shipping state or province.

Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: "37615-1234" or "37615".

Shipping address country.

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Timestamp of when record was created, in UTC.

The Payabli-generated unique ID for the customer.

Customer Status. Possible values:

• -99 Deleted
• 0 Inactive
• 1 Active
• 85 Locked (typically due to multiple failed login attempts)

Array of field names to be used as identifiers.

Invoice number. Identifies the invoice under a paypoint.

Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Type of invoice. Only 0 for one-time invoices is currently supported.

Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Status for invoice.

The accepted status values are:

• 0 draft
• 1 active
• 2 partially paid
• 4 paid/complete
• 99 cancelled

Frequency of scheduled invoice.

Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.

Custom terms and conditions included in the invoice.

Notes included in the invoice.

Tax rate in percent applied to the invoice.

Discount applied to the invoice.

Invoice total amount.

Freight/shipping amount.

Duty amount.

Purchase order number.

First name of the recipient of the invoice.

Last name of the recipient of the invoice.

Company name of the recipient of the invoice.

The shipping address.

Additional line for shipping address.

Shipping city.

Shipping state or province.

Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: "37615-1234" or "37615".

Shipping address country.

Shipping recipient's contact email address.

Recipient phone number.

Sender shipping ZIP code.

Commodity code.

Array of line items included in the invoice.

Array of fileContent objects with attached documents. Max upload size is 30 MB.

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table.

The card brand. For example, Visa, Mastercard, American Express, Discover.

The type of card: Credit or Debit.

The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID.

The name of the financial institution that issued the card.

The issuing financial institution's country name.

The issuing financial institution's two-character ISO country code. See this resource for a list of codes.

The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.