API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Get a Payment Method Token by ID
Retrieves details for a saved payment method.
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
The saved payment method ID.
Query Parameters
Format for card expiration dates in the response.
Accepted values:
-
0: default, no formatting. Expiration dates are returned in the format they're saved in.
-
1: MMYY
-
2: MM/YY
When true, the request will include temporary tokens in the search and return details for a matching temporary token. The default behavior searches only for permanent tokens.
Response
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
The object containing the response data.
Bank routing number.
The bank identification number (BIN).
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.
The card brand. For example, Visa, MasterCard, American Express, Discover.
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.
The type of card: Credit or Debit.
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.
Customer information. May be required, depending on the paypoint's settings. Required for subscriptions. See PayorData object Model for a complete reference.
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Example usage:
{
"additionalData": {
"CustomIdentifier": "value",
"key2": "value2",
"key3": "value3"
}
}
Customer's billing address.
250Additional line for Customer's billing address.
100Customer's billing city.
250Customer's billing country.
100Customer's email address.
250Customer's phone number.
50Customer's billing state. Must be 2-letter state code for address in US.
250Customer's billing ZIP code.
50Customer's company name.
250The Payabli-generated unique ID for the customer.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250Customer/Payor first name.
250List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Customer/Payor last name.
250The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
100Shipping state or province.
Shipping ZIP code.
50Number total of transactions or payments
List of more recent 5 transactions belonging to the customer
Batch amount.
Batch number.
Service Fee or sub-charge transaction associated to the main transaction.
Connector used for transaction.
Identifier of registered cloud device used in the transaction.
If applicable, the internal reference ID to the payment page capturing the payment.
Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.
Service fee or sub-charge applied.
Internal identifier used for processing.
Payment method used: card, ach, or wallet.
Net amount paid.
The transaction's operation.
Custom identifier for the transaction.
250ID of immediate parent organization.
The name of the parent organization.
Unique Transaction ID.
Unique ID for customer linked to the transaction.
Paypoint's DBA name.
Paypoint's entryname.
50InternalId for paypoint.
Paypoint's legal name.
The difference between the configured pass-through fee and the fee amount sent in the request. When transfering funds, Payabli uses this field to deduct the fee difference and transfer the correct amount to the merchant.
When a paypoint is set up to absorb fees, and the pass-through fee sent with the request is less than the configured amount, the difference must be covered by the merchant. See Fee Configuration to learn more about pass-through fee settings.
Identifier of refund transaction linked to this payment.
The transaction's response data.
Identifier of return/chargeback transaction linked to this payment.
Reference to the subscription that originated the transaction.
Settlement status for transaction. See the docs for a full reference.
Custom identifier to indicate the transaction or request source.
100Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
Transaction total amount (including service fee or sub-charge)
Events associated with this transaction.
Transaction date and time, in UTC.
Not currently in use.
Total amount in transactions
Total net amount in transactions
A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.
Auxiliary validation used internally by payment pages and components.
The name of the parent organization.
The alternate or common name that this business is doing business under usually referred to as a DBA name.
The paypoint entryname the customer is associated with.
Business legal name.
List of payment methods associated to the customer.
The bank identification number (BIN). Null when method is ACH.
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.
The card brand. For example, Visa, MasterCard, American Express, Discover.
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.
The type of card: Credit or Debit.
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.
When the method is a card, this field displays card brand. When the method is ACH, this field displays the account type for ACH (checking or savings).
Expiration date associated to the method (only for card) in format MMYY.
Account holder name for the method.
Method internal ID
Date of last update
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
Type of payment vehicle: ach or card
List of subscriptions associated to the customer.
Timestamp of when the subscription ws created, in UTC.
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"
}
}
Customer's billing address.
Additional line for Customer's billing address.
Customer's billing city.
Customer's billing country.
Customer's email address.
Customer's phone number.
Customer's billing state. Must be 2-letter state code for address in US.
Customer's billing ZIP code.
Customer's company name.
Timestamp of when record was created, in UTC.
The Payabli-generated unique ID for the customer.
The Payabli-generated unique ID for the customer.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250Customer Status. Possible values:
-99Deleted0Inactive1Active85Locked (typically due to multiple failed login attempts)
Customer/Payor first name.
Array of field names to be used as identifiers.
Customer/Payor last name.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping state or province.
Shipping ZIP code.
50The subscription's end date.
If applicable, the internal reference ID to the payment page capturing the payment.
A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.
Fee applied to the subscription.
The subscription's frequency.
The subscription's ID.
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"
}
}
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Company name of the recipient of the invoice.
Discount applied to the invoice.
Duty amount.
First name of the recipient of the invoice.
Freight/shipping amount.
Frequency of scheduled invoice.
one-time, weekly, every2weeks, every6months, monthly, every3months, annually Invoice total amount.
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.
Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Invoice number. Identifies the invoice under a paypoint.
250Status for invoice.
The accepted status values are:
- 0 draft
- 1 active
- 2 partially paid
- 4 paid/complete
- 99 cancelled
0, 1, 2, 4, 99 Type of invoice. Only 0 for one-time invoices is currently supported.
Array of line items included in the invoice.
Last name of the recipient of the invoice.
Notes included in the invoice.
Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.
PIA, CIA, UR, NET10, NET20, NET30, NET45, NET60, NET90, EOM, MFI, 5MFI, 10MFI, 15MFI, 20MFI, 2/10NET30, UF, 10UF, 20UF, 25UF, 50UF Purchase order number.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping recipient's contact email address.
Sender shipping ZIP code.
Recipient phone number.
Shipping state or province.
Shipping ZIP code.
50Commodity code.
Tax rate in percent applied to the invoice.
Custom terms and conditions included in the invoice.
The last time the subscription was processed.
The last date and time the subscription was updated.
The number of cycles the subscription has left.
The subscription's payment method.
The subscription amount, minus any fees.
The next date the subscription will be processed.
The name of the parent organization.
Expiration date of card used in transaction.
Custom identifier for payment connector.
250Bank account type or card brand.
ZIP code for card used in transaction.
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.
Account holder name for the method.
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 transactionsmerchant: For merchant-initiated transactions
See Understanding CIT and MIT Indicators for more information.
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
Text description of the transaction.
250Details about the payment.
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.
Identifier of stored payment method used in transaction.
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 paypoint's DBA name.
The paypoint's entryname.
50The paypoint's ID. Note that this is different than the entryname.
The paypoint's legal name.
Payment plan ID.
Custom identifier to indicate the transaction or request source.
100The subscription start date.
Events associated with the subscription.
Event description.
Event timestamp, in UTC.
Extra data.
Reference data.
The event source.
100The subscription's status.
- 0: Paused
- 1: Active
The subscription amount, including any fees.
The total number of cycles the subscription is set to run.
When true, the subscription has no explicit end date and will run until canceled.
When the method is a card, this field displays card brand. When the method is ACH, this field displays the account type for ACH (checking or savings).
Expiration date for card in stored method in format MM/YY.
Account holder name in stored method.
The stored payment method's identifier in Payabli.
Timestamp for last update of stored method, in UTC.
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
Method of payment: 'card' or 'ach'.
The payment method's token type.
The payment method postal code.
Response text for operation: 'Success' or 'Declined'.
Was this page helpful?