Payabli Token Storage API
The tokenStorage API from Payabli — 2 operation(s) for tokenstorage.
Payabli Token Storage API is one of 34 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 4 operations across 2 paths, and defines 163 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.
4 operations
2 paths
163 schemas
1 DELETE1 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Payabli Token Storage API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
An API key is passed in the header as requestToken (APIKeyAuth).
BearerAuth— OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).APIKeyAuth— Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
tokenStorage 4
POST
/TokenStorage/add
Save a payment method (tokenize)
GET
/TokenStorage/{methodId}
Get payment method
PUT
/TokenStorage/{methodId}
Update a payment method
DELETE
/TokenStorage/{methodId}
Remove a payment method
Schemas 163
The contract defines 163 schemas that model the data the API accepts and returns. The most detailed are GetMethodResponseResponseDataVendorsItem (45 properties), GetMethodResponseResponseDataCustomersItem (43 properties), TransactionQueryRecords (40 properties), BillData (32 properties). Each schema is shown below with its type and property counts.
ResultCode
integer
Result code for the operation. Value 1 indicates a successful operation, values 2 and 3 indicate errors. A value of 10 indicates that an operation has been ini…
QueryPaymentData
object
14 properties
VendorResponseStoredMethod
object
Stored payment method information
17 properties
17 required
AccountId
string
Custom identifier for payment connector.
ReturnedId
integer
Identifier of return/chargeback transaction linked to this payment.
Netamountnullable
number
Net amount.
QueryTransactionEventsEventData
Any data associated to the event received from processor. Contents vary by event type.
Email
string
Email address.
GetMethodResponse
object
3 properties
1 required
CustomerStatus
integer
Customer Status. Possible values: - -99 Deleted - 0 Inactive - 1 Active - 85 Locked (typically due to multiple failed login attempts)
PaymentCategories
object
4 properties
2 required
Cardholder
string
Cardholder name.
GetMethodResponseResponseData
object
18 properties
CvvResponseText
string
Text code describing the result for CVV validation (applies only for card transactions).
SplitCount
integer
Number of split funding instructions associated with the transaction. Returns 0 when the transaction has no splits.
PayabliApiResponsePaymethodDeleteResponseData
object
3 properties
GeneralEvents
object
5 properties
Cardzip
string
ZIP or postal code for the billing address of cardholder. We strongly recommend that you include this field when using card as a method.
AchValidation
boolean
When true, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.
VendorDataRequest
object
Object describing the vendor owner of payment method. Required when saving an ACH payment method on behalf of a vendor (for Pay Out transactions).
2 properties
LocationCode
string
A location code used to identify the vendor's location.
MethodQueryRecords
object
17 properties
Accountexp
string
Expiration date of card used in transaction.
Remitstate
string
Remittance address state or province. Used for mailing paper checks. Required if any remittance address field is provided. Must be a valid US state or Canadian…
Vendorstatus
integer
Vendor's status. Allowed values: - 0 Inactive - 1 Active - -99 Deleted
BillingCityNullable
string
Billing city.
Remitcountry
string
Remittance address country. Used for mailing paper checks. Must be US or CA. Defaults to US if not provided.
BillItem
object
12 properties
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
PayeeName
string
Alternative name used to receive paper check.
EntrypageId
integer
If applicable, the internal reference ID to the payment page associated with the transaction.
Legalname
string
Business legal name.
ResultCodeText
string
Description of the result code. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information.
TokenizeACH
object
7 properties
5 required
Cardexp
string
Card expiration date in format MMYY or MM/YY. Required for card transactions.
ItemCommodityCode
string
Item or product commodity code. Max length of 250 characters.
TransactionQueryRecords
object
40 properties
2 required
CvvResponse
string
Text code describing the result for CVV validation (applies only for card transactions).
AddMethodResponseResponseData
object
5 properties
Shippingstate
string
Shipping state or province.
CreatedAt
string
Timestamp of when record was created, in UTC.
PurchaseOrder
string
Purchase order number.
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
SubscriptionType
string
Subscription type or category. Can't be changed after the subscription is created; if sent to the update endpoint, it's ignored. - Regular: A standard recurrin…
InvoiceNumber
string
Invoice number. Identifies the invoice under a paypoint.
Orgid
integer
Organization ID. Unique identifier assigned to an org by Payabli.
Accountzip
string
ZIP code for card used in transaction.
PayorId
integer
Unique ID for the customer linked to the transaction. This is the same value as the customerId used when creating or referencing a customer.
ItemProductName
string
Item or product name. Max length of 250 characters.
Operation
string
The transaction's operation.
Device
string
Identifier of registered cloud device used in the transaction.
Entrypointfield
string
The entrypoint identifier.
BatchNumber
string
A unique identifier for the batch. This is generated by Payabli when the batch is created, and follows this format: paypointId + "" + serviceName + "" + batchD…
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
Descriptor
string
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).
StoredMethodUsageType
string
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 u…
QueryTransactionPayorData
object
22 properties
Remitzip
string
Remittance address ZIP or postal code. Used for mailing paper checks. Required if any remittance address field is provided. For US addresses, use five digits o…
Frequency
string
Frequency for operation. The firstofmonth, fifteenthofmonth, and endofmonth values are only valid on subscriptions — they aren't accepted by other endpoints (s…
Holdername
string
The cardholder name.
PayorDataRequest
object
Customer information. May be required, depending on the paypoint's settings. Required for subscriptions.
21 properties
CustomerSummaryRecord
object
4 properties
Attachments
array
Array of fileContent objects with attached documents. Max upload size is 30 MB.
PhoneNumber
string
Phone number.
IdempotencyKey
string
Optional but recommended. A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. Th…
AdditionalDataMap
object
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](…
PaymentDetail
object
Details about the payment.
8 properties
1 required
AvsResponseText
string
Text code describing the result for address validation (applies only for card transactions).
RequestTokenStoragePaymentMethod
Information about the payment method for the transaction.
Storedmethodid
string
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…
SplitFundingContent
object
4 properties
BillData
object
32 properties
Remitaddress1
string
Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided.
Shippingcity
string
Shipping city.
BillDataPaymentTerms
string
Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30. Mirrors the values in [Terms](schema-terms).
Mcc
string
Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcccodes.csv) lists MCC codes.
ExternalProcessorInformation
string
Information from the external processor about the transaction.
AchSecCode
string
Standard Entry Class (SEC) code is a three letter code that describes how an ACH payment was authorized. Supported values are: - PPD (Prearranged Payment and D…
Remitcity
string
Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
SplitFunding
array
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
Tax
number
Tax rate in percent applied to the invoice.
Vendorid
integer
Payabli identifier for vendor record.
BillingStateNullable
string
Billing state. Must be a 2-letter state code for addresses in the US.
AdditionalData
object
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](…
VendorResponseSummary
object
Vendor bill summary statistics
16 properties
ItemProductCode
string
Item or product code. Max length of 250 characters.
ItemUnitofMeasure
string
Unit of measurement. Max length of 100 characters.
ShippingFromZip
string
Sender shipping ZIP code.
Contacts
object
5 properties
Resulttext
string
Text describing the result. If ResultCode = 1, will return Approved or a general success message. If ResultCode = 2 or 3, will contain the cause of the error o…
RequestTokenStorage
object
9 properties
BillingAddressNullable
string
Billing address.
BinData
object
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…
11 properties
Accounttype
string
Bank account type or card brand.
Orderdescription
string
Text description of the transaction.
QueryTransactionEvents
object
3 properties
PayabliApiResponsePaymethodDelete
object
Response body for payment method deletion.
3 properties
1 required
Shippingzip
string
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 3…
DutyAmount
number
Duty amount.
Authcode
string
Authorization code for the transaction.
GetMethodResponseResponseDataVendorsItem
object
45 properties
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Shippingaddress
string
The shipping address.
AddMethodResponse
object
Minimal response wrapper used by approval-style endpoints that don't carry the standard response envelope.
3 properties
1 required
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
Achrouting
string
ABA/routing number of Bank account.
Achaccount
string
Bank account number.
FreightAmount
number
Freight/shipping amount.
PaypointId
integer
The paypoint's ID. Note that this is different than the entryname.
FeeAmount
number
Service fee or sub-charge applied.
Subdomain
string
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
Cardnumber
string
The card number. Required when method is card and a storedMethodId isn't included.
Shippingcountry
string
Shipping address country.
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
TermsConditions
string
Custom terms and conditions included in the invoice.
InvoiceAmount
number
The invoice amount.
EmvAuthResponseData
string
EMV authorization response data, applicable for card transactions.
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
OrgParentName
string
The name of the parent organization.
Source
string
Custom identifier to indicate the transaction or request source.
QueryResponseData
object
The transaction's response data.
15 properties
BillingAddressAddtlNullable
string
Additional line for the billing address.
BillingCountryNullable
string
Billing address country.
Initiator
string
The transaction's initiator. Indicates who initiated the transaction.
SubscriptionQueryRecords
object
31 properties
5 required
TransactionTime
string
Timestamp when transaction was submitted, in UTC.
VendorNumber
string
Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.
RefundId
integer
Identifier of refund transaction linked to this payment.
Identifierfields
array
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
PendingFeeAmount
number
The difference between the configured pass-through fee and the fee amount sent in the request. When transferring funds, Payabli uses this field to deduct the f…
InvoiceType
integer
Invoice type. Value 0 is for single/one-time invoices, 1 for scheduled invoices.
AvsResponse
string
Text code describing the result for address validation (applies only for card transactions).
Invoicestatus
integer
Invoice status code.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
Sequence
string
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected…
Discount
number
Discount applied to the invoice.
SummaryCommodityCode
string
Commodity code.
VendorResponseBillingData
object
Object containing vendor's bank information
14 properties
CustomerId
integer
The Payabli-generated unique ID for the customer.
FileContentFtype
string
The MIME type of the file (if content is provided).
ForceCustomerCreation
boolean
When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to false.
Shippingaddressadditional
string
Additional line for shipping address.
InternalReferenceId
integer
An internal reference ID.
GetMethodResponseResponseDataCustomersItem
object
Customer information. May be required, depending on the paypoint's settings. Required for subscriptions.
43 properties
CustomerNumberNullable
string
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
AchHolderType
string
The bank's accountholder type: personal or business.
TokenizeCard
object
7 properties
4 required
AdditionalDataString
string
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: json { "additionalData"…
MethodReferenceId
string
The stored method's identifier (sometimes referred to as 'token') in Payabli. When null, the method wasn't created, or doesn't exist, depending on the operatio…
BillingZip
string
Billing address ZIP code.
Signaturedata
string
Achaccounttype
string
Bank account type: Checking or Savings.
Maskedaccount
string
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
ItemDescription
string
Item or product description. Max length of 250 characters.
ResultCodev2
string
Unified result code for the transaction. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information.
LastModified
string
Timestamp of when record was last updated, in UTC.
CreateAnonymous
boolean
When true, creates a saved method with no associated customer information. The token will be associated with customer information the first time it's used to m…
Cardcvv
string
Card Verification Value (CVV) associated with the card number. We strongly recommend that you include this field when using card as a method.
OrderId
string
Custom identifier for the transaction.
QueryCFeeTransaction
object
8 properties
Remitaddress2
string
Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.
ConvertToken
object
Object containing the information needed to convert a temporary token to a permanent token.
2 properties
2 required
Temporary
boolean
Creates a temporary, one-time-use token for the payment method that expires in 12 hours. Defaults to false.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Payabli 12
Other APIs Payabli publishes across the network.
Payabli Bill API
Payabli Boarding API
Payabli Charge Backs API
Payabli Check Capture API
Payabli Cloud API
Payabli Customer API
Payabli Export API
Payabli Funding API
Payabli Ghost Card API
Payabli Import API
Payabli Invoice API
Payabli Management API
Where this information came from
This is an independent, third-party profile of Payabli Token Storage API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.