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.
curl --request GET \
--url https://api-sandbox.payabli.com/api/TokenStorage/{methodId} \
--header 'requestToken: <api-key>'
{
"responseText": "Success",
"isSuccess": true,
"responseData": {
"customers": [
{
"customerId": 1456,
"customerNumber": "CS789",
"customerUsername": "Marcus",
"customerStatus": 1,
"company": "Bluesky Tech Inc",
"firstname": "Marcus",
"lastname": "Chen",
"phone": "+14156789012",
"email": "marcus@blueskytech.com",
"address": "742 Innovation Ave",
"address1": "Suite 500",
"city": "San Francisco",
"state": "CA",
"zip": "94105",
"country": "US",
"shippingAddress": "742 Innovation Ave",
"shippingAddress1": "Suite 500",
"shippingCity": "San Francisco",
"shippingState": "CA",
"shippingZip": "94105",
"shippingCountry": "US",
"balance": 250,
"timeZone": -8,
"mfa": true,
"mfaMode": 1,
"snProvider": null,
"snIdentifier": null,
"snData": null,
"lastUpdated": "2024-12-15T09:45:32.123",
"created": "2023-06-01T14:30:00",
"additionalFields": {
"clientId": "901555",
"invoiceScheduled": "true",
"invoiceFrequency": "monthly",
"invoiceStartDate": "Mon Jan 15 2024 00:00:00 GMT-0800 (Pacific Standard Time)",
"additionalProp1": "enterpriseClient"
},
"identifierFields": [
"firstname",
"email"
],
"subscriptions": null,
"storedMethods": null,
"customerSummary": null,
"paypointLegalname": "Bluesky Technologies LLC",
"paypointDbaname": "Bluesky Tech",
"parentOrgName": "TechCorp",
"parentOrgId": 5,
"paypointEntryname": "45782932fcc",
"pageindentifier": null,
"externalPaypointID": null,
"customerConsent": null
}
],
"idPmethod": "81f7fde1-dd8b-4892-b2e1-cd60dd91f6b4-XXXC",
"method": "card",
"descriptor": "visa",
"maskedAccount": "4XXXXXXX2345",
"expDate": "0926",
"holderName": "Marcus Chen",
"bin": "401288",
"binData": {
"binMatchedLength": "6",
"binCardBrand": "VISA",
"binCardType": "CREDIT",
"binCardCategory": "CLASSIC",
"binCardIssuer": "CHASE",
"binCardIssuerCountry": "UNITED STATES",
"binCardIssuerCountryCodeA2": "US",
"binCardIssuerCountryNumber": "840"
},
"aba": "",
"postalCode": "94105",
"methodType": "Single Merchant",
"lastUpdated": "2025-01-15T16:30:22.45502"
}
}
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
1
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.
false
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
The object containing the response data.
Customer information. May be required, depending on the paypoint's settings. Required for subscriptions. See PayorData object Model for a complete reference.
The Payabli-generated unique ID for the customer.
4440
Customer/Payor first name.
250
"John"
Customer/Payor last name.
250
"Doe"
Customer's company name.
250
"Sunshine LLC"
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250
"3456-7645A"
Customer's billing address.
250
"123 Walnut Street"
Additional line for Customer's billing address.
100
"STE 900"
Customer's billing city.
250
"Johnson City"
Customer's billing state. Must be 2-letter state code for address in US.
250
"Johnson City"
Customer's billing ZIP code.
50
"37615"
Customer's billing country.
100
"US"
Customer's phone number.
50
"5555555555"
Customer's email address.
320
"example@email.com"
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
100
"US"
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"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
["email"]
Username of the customer
Status code for the customer
Customer's current balance
Customer's timezone
Multi-factor authentication status
MFA mode setting
Social network provider
Social network identifier
Social network data
Last update timestamp
Creation timestamp
Parent organization ID
Customer consent information
List of subscriptions associated to the customer
The subscription's ID.
396
The subscription's payment method.
"card"
The paypoint's ID. Note that this is different than the entryname.
255
The subscription amount, including any fees.
103
The subscription amount, minus any fees.
3762.87
Fee applied to the subscription.
3
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
"4XXXXXXXX1111"
Bank account type or card brand.
"visa"
Expiration date of card used in transaction.
"11/29"
ZIP code for card used in transaction.
"90210"
Account holder name for the method.
"Chad Mercia"
Text description of the transaction.
250
"Depost for materials for 123 Walnut St"
Identifier of stored payment method used in transaction.
"1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440"
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.
"payor"
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.
"subscription"
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.
"subsequent"
Custom identifier for payment connector.
250
null
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 subscription start date.
"2025-10-19T00:00:00"
The subscription's end date.
"2025-10-19T00:00:00"
The next date the subscription will be processed.
"2025-10-19T00:00:00"
The subscription's frequency.
"monthly"
The total number of cycles the subscription is set to run.
24
The number of cycles the subscription has left.
15
The last time the subscription was processed.
"2025-10-19T00:00:00"
The subscription's status.
- 0: Paused
- 1: Active
1
If applicable, the internal reference ID to the payment page capturing the payment.
0
Payment plan ID.
0
When true
, the subscription has no explicit end date and will run until canceled.
true
Events associated with the subscription.
Event description.
"TransferCreated"
Event timestamp, in UTC.
"2023-07-05T22:31:06.8317486+00:00"
Reference data.
Extra data.
The event source.
100
"api"
The last date and time the subscription was updated.
"2022-07-01 15:00:01"
The Payabli-generated unique ID for the customer.
4440
Customer/Payor first name.
"John"
Customer/Payor last name.
"Doe"
Customer's company name.
"Sunshine LLC"
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250
"3456-7645A"
Customer's billing address.
"1111 West 1st Street"
Additional line for Customer's billing address.
"Suite 200"
Customer's billing city.
"Miami"
Customer's billing state. Must be 2-letter state code for address in US.
"FL"
Customer's billing ZIP code.
"45567"
Customer's billing country.
"US"
Customer's phone number.
"5555555555"
Customer's email address.
320
"example@email.com"
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
"US"
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"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
The Payabli-generated unique ID for the customer.
4440
Customer Status. Possible values:
-99
Deleted0
Inactive1
Active85
Locked (typically due to multiple failed login attempts)
1
Array of field names to be used as identifiers.
[
"\\\"firstname\\\"",
"\\\"lastname\\\"",
"\\\"email\\\"",
"\\\"customId\\\""
]
Invoice number. Identifies the invoice under a paypoint.
250
"INV-2345"
Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
"2024-07-01"
Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
"2024-07-01"
Type of invoice. Only 0
for one-time invoices is currently supported.
0
Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
"2024-07-01"
Status for invoice.
The accepted status values are:
- 0 draft
- 1 active
- 2 partially paid
- 4 paid/complete
- 99 cancelled
0
, 1
, 2
, 4
, 99
1
Frequency of scheduled invoice.
one-time
, weekly
, every2weeks
, every6months
, monthly
, every3months
, annually
"monthly"
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
"PIA"
Custom terms and conditions included in the invoice.
"Must be paid before work scheduled."
Notes included in the invoice.
"Example notes."
Tax rate in percent applied to the invoice.
2.05
Discount applied to the invoice.
10
Invoice total amount.
105
Freight/shipping amount.
10
Duty amount.
0
Purchase order number.
"PO-345"
First name of the recipient of the invoice.
"Chad"
Last name of the recipient of the invoice.
"Mercia"
Company name of the recipient of the invoice.
"ACME, INC"
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
"US"
Shipping recipient's contact email address.
320
"example@email.com"
Recipient phone number.
"5555555555"
Sender shipping ZIP code.
"30040"
Commodity code.
"501718"
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"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
The paypoint's legal name.
"Sunshine Services, LLC"
The paypoint's DBA name.
"Sunshine Gutters"
The paypoint's entryname.
50
"d193cf9a46"
The name of the parent organization.
"PropertyManager Pro"
Timestamp of when the subscription ws created, in UTC.
"2022-07-01 15:00:01"
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.
"Paypoint-100"
Custom identifier to indicate the transaction or request source.
100
"api"
List of payment methods associated to the customer
Method internal ID
"6edcbb56-9c0e-4003-b3d1-99abf149ba0e"
Type of payment vehicle: ach or card
"card"
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).
"visa"
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
"4XXXXXXXX1111"
Expiration date associated to the method (only for card) in format MMYY.
"1227"
Account holder name for the method.
"Chad Mercia"
The bank identification number (BIN). Null when method is ACH.
"411111"
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 number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table.
6
The card brand. For example, Visa, MasterCard, American Express, Discover.
"Visa"
The type of card: Credit or Debit.
"Credit"
The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID
.
"PLATINUM"
The name of the financial institution that issued the card.
"Bank of Example"
The issuing financial institution's country name.
"United States"
The issuing financial institution's two-character ISO country code. See this resource for a list of codes.
"US"
The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.
840
Date of last update
"2022-07-01 15:00:01"
Number total of transactions or payments
30
Total amount in transactions
1500
Total net amount in transactions
1500
List of more recent 5 transactions belonging to the customer
The name of the parent organization.
"PropertyManager Pro"
Paypoint's DBA name.
"Sunshine Gutters"
Paypoint's legal name.
"Sunshine Services, LLC"
Paypoint's entryname.
50
"d193cf9a46"
Unique Transaction ID.
"226-fe55ec0348e34702bd91b4be198ce7ec"
Connector used for transaction.
"gp"
Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.
"[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]"
Internal identifier used for processing.
"TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0"
Custom identifier for the transaction.
250
"O-5140"
Payment method used: card, ach, or wallet.
"ach"
Batch number.
"batch_226_ach_12-30-2023"
Batch amount.
30.22
Unique ID for customer linked to the transaction.
1551
Status of transaction. See the docs for a full reference.
1
InternalId for paypoint.
226
Transaction total amount (including service fee or sub-charge)
30.22
Net amount paid.
3762.87
Service fee or sub-charge applied.
1
Settlement status for transaction. See the docs for a full reference.
2
The transaction's operation.
"Sale"
The transaction's response data.
Custom identifier to indicate the transaction or request source.
100
"api"
Reference to the subscription that originated the transaction.
0
ID of immediate parent organization.
123
Identifier of refund transaction linked to this payment.
0
Identifier of return/chargeback transaction linked to this payment.
0
Not currently in use.
If applicable, the internal reference ID to the payment page capturing the payment.
0
Transaction date and time, in UTC.
"2025-10-19T00:00:00"
Service Fee or sub-charge transaction associated to the main transaction.
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
Events associated with this transaction.
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.
2
Identifier of registered cloud device used in the transaction.
"6c361c7d-674c-44cc-b790-382b75d1xxx"
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.
The bank's accountholder type: personal or business.
personal
, business
Business legal name.
"Sunshine Services, LLC"
The alternate or common name that this business is doing business under usually referred to as a DBA name.
"Sunshine Gutters"
The name of the parent organization.
"PropertyManager Pro"
The paypoint entryname the customer is associated with
Auxiliary validation used internally by payment pages and components.
null
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.
"Paypoint-100"
The stored payment method's identifier in Payabli
Method of payment: 'card' or 'ach'
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).
"visa"
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
"4XXXXXXXX1111"
Expiration date for card in stored method in format MM/YY
Account holder name in stored method
"Chad Mercia"
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.
The bank's accountholder type: personal or business.
personal
, business
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 number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table.
6
The card brand. For example, Visa, MasterCard, American Express, Discover.
"Visa"
The type of card: Credit or Debit.
"Credit"
The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID
.
"PLATINUM"
The name of the financial institution that issued the card.
"Bank of Example"
The issuing financial institution's country name.
"United States"
The issuing financial institution's two-character ISO country code. See this resource for a list of codes.
"US"
The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.
840
Bank routing number
The payment method postal code
The payment method's token type
Timestamp for last update of stored method, in UTC
"2022-07-01 15:00:01"
Was this page helpful?
curl --request GET \
--url https://api-sandbox.payabli.com/api/TokenStorage/{methodId} \
--header 'requestToken: <api-key>'
{
"responseText": "Success",
"isSuccess": true,
"responseData": {
"customers": [
{
"customerId": 1456,
"customerNumber": "CS789",
"customerUsername": "Marcus",
"customerStatus": 1,
"company": "Bluesky Tech Inc",
"firstname": "Marcus",
"lastname": "Chen",
"phone": "+14156789012",
"email": "marcus@blueskytech.com",
"address": "742 Innovation Ave",
"address1": "Suite 500",
"city": "San Francisco",
"state": "CA",
"zip": "94105",
"country": "US",
"shippingAddress": "742 Innovation Ave",
"shippingAddress1": "Suite 500",
"shippingCity": "San Francisco",
"shippingState": "CA",
"shippingZip": "94105",
"shippingCountry": "US",
"balance": 250,
"timeZone": -8,
"mfa": true,
"mfaMode": 1,
"snProvider": null,
"snIdentifier": null,
"snData": null,
"lastUpdated": "2024-12-15T09:45:32.123",
"created": "2023-06-01T14:30:00",
"additionalFields": {
"clientId": "901555",
"invoiceScheduled": "true",
"invoiceFrequency": "monthly",
"invoiceStartDate": "Mon Jan 15 2024 00:00:00 GMT-0800 (Pacific Standard Time)",
"additionalProp1": "enterpriseClient"
},
"identifierFields": [
"firstname",
"email"
],
"subscriptions": null,
"storedMethods": null,
"customerSummary": null,
"paypointLegalname": "Bluesky Technologies LLC",
"paypointDbaname": "Bluesky Tech",
"parentOrgName": "TechCorp",
"parentOrgId": 5,
"paypointEntryname": "45782932fcc",
"pageindentifier": null,
"externalPaypointID": null,
"customerConsent": null
}
],
"idPmethod": "81f7fde1-dd8b-4892-b2e1-cd60dd91f6b4-XXXC",
"method": "card",
"descriptor": "visa",
"maskedAccount": "4XXXXXXX2345",
"expDate": "0926",
"holderName": "Marcus Chen",
"bin": "401288",
"binData": {
"binMatchedLength": "6",
"binCardBrand": "VISA",
"binCardType": "CREDIT",
"binCardCategory": "CLASSIC",
"binCardIssuer": "CHASE",
"binCardIssuerCountry": "UNITED STATES",
"binCardIssuerCountryCodeA2": "US",
"binCardIssuerCountryNumber": "840"
},
"aba": "",
"postalCode": "94105",
"methodType": "Single Merchant",
"lastUpdated": "2025-01-15T16:30:22.45502"
}
}