Payabli tokenStorage API
The tokenStorage API from Payabli — 2 operation(s) for tokenstorage.
OpenAPI Specification
openapi: 3.1.0
info:
title: API reference Bill tokenStorage API
version: 1.0.0
servers:
- url: https://api-sandbox.payabli.com/api
description: Sandbox
- url: https://api.payabli.com/api
description: Production
tags:
- name: tokenStorage
paths:
/TokenStorage/add:
post:
operationId: AddMethod
summary: Save a payment method (tokenize)
description: Saves a payment method for reuse. This call exchanges sensitive payment information for a token that can be used to process future transactions. The `ReferenceId` value in the response is the `storedMethodId` to use with transactions.
tags:
- tokenStorage
parameters:
- name: achValidation
in: query
description: When `true`, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.
required: false
schema:
$ref: '#/components/schemas/AchValidation'
- name: createAnonymous
in: query
description: 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 make a payment. Defaults to `false`.
required: false
schema:
$ref: '#/components/schemas/CreateAnonymous'
- name: forceCustomerCreation
in: query
description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to `false`.
required: false
schema:
$ref: '#/components/schemas/ForceCustomerCreation'
- name: temporary
in: query
description: Creates a temporary, one-time-use token for the payment method that expires in 12 hours. Defaults to `false`.
required: false
schema:
$ref: '#/components/schemas/Temporary'
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
'
required: true
schema:
type: string
- name: idempotencyKey
in: header
description: _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. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddMethodResponse'
'400':
description: Bad request / invalid data.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'401':
description: Unauthorized request.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'503':
description: Database connection error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTokenStorage'
/TokenStorage/{methodId}:
get:
operationId: GetMethod
summary: Get payment method
description: Retrieves details for a saved payment method.
tags:
- tokenStorage
parameters:
- name: methodId
in: path
description: The saved payment method ID.
required: true
schema:
type: string
- name: cardExpirationFormat
in: query
description: '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'
required: false
schema:
type: integer
default: 0
- name: includeTemporary
in: query
description: 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.
required: false
schema:
type: boolean
default: false
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetMethodResponse'
'400':
description: Bad request / invalid data.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'401':
description: Unauthorized request.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'503':
description: Database connection error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
put:
operationId: UpdateMethod
summary: Update a payment method
description: Updates a saved payment method.
tags:
- tokenStorage
parameters:
- name: methodId
in: path
description: The saved payment method ID.
required: true
schema:
type: string
- name: achValidation
in: query
description: When `true`, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.
required: false
schema:
$ref: '#/components/schemas/AchValidation'
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymethodDelete'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTokenStorage'
delete:
operationId: RemoveMethod
summary: Remove a payment method
description: Deletes a saved payment method.
tags:
- tokenStorage
parameters:
- name: methodId
in: path
description: The saved payment method ID.
required: true
schema:
type: string
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymethodDelete'
'400':
description: Bad request / invalid data.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'401':
description: Unauthorized request.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'503':
description: Database connection error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
components:
schemas:
AccountId:
type: string
description: Custom identifier for payment connector.
title: AccountId
Shippingaddress:
type: string
description: The shipping address.
title: Shippingaddress
AvsResponse:
type: string
description: 'Text code describing the result for address validation (applies only for
card transactions).
'
title: AvsResponse
FreightAmount:
type: number
format: double
description: Freight/shipping amount.
title: FreightAmount
Maskedaccount:
type: string
description: 'Masked card or bank account used in transaction. In the case of Apple
Pay, this is a masked DPAN (device primary account number).
'
title: Maskedaccount
PayabliErrorBodyResponseData:
type: object
properties:
explanation:
type: string
description: Human-readable explanation of what happened.
todoAction:
type: string
description: Suggested resolution.
description: Object with detailed error context.
title: PayabliErrorBodyResponseData
CvvResponseText:
type: string
description: 'Text code describing the result for CVV validation (applies only for card
transactions).
'
title: CvvResponseText
BillDataPaymentTerms:
type: string
enum:
- PIA
- CIA
- UR
- NET10
- NET20
- NET30
- NET45
- NET60
- NET90
- EOM
- MFI
- 5MFI
- 10MFI
- 15MFI
- 20MFI
- 2/10NET30
- UF
- 10UF
- 20UF
- 25UF
- 50UF
description: '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).
'
title: BillDataPaymentTerms
Email:
type: string
format: email
description: Email address.
title: Email
Accountexp:
type: string
description: Expiration date of card used in transaction.
title: Accountexp
BillingStateNullable:
type: string
description: Billing state. Must be a 2-letter state code for addresses in the US.
title: BillingStateNullable
MethodReferenceId:
type: string
description: '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 operation performed.
'
title: MethodReferenceId
AddMethodResponse:
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/AddMethodResponseResponseData'
required:
- responseText
description: 'Minimal response wrapper used by approval-style endpoints that don''t carry
the standard response envelope.
'
title: AddMethodResponse
SplitCount:
type: integer
description: 'Number of split funding instructions associated with the transaction.
Returns `0` when the transaction has no splits.
'
title: SplitCount
CvvResponse:
type: string
description: 'Text code describing the result for CVV validation (applies only for card
transactions).
'
title: CvvResponse
ResultCodeText:
type: string
description: 'Description of the result code. See
[Pay In unified response codes](/guides/pay-in-unified-response-codes-reference)
for more information.
'
title: ResultCodeText
BillingCountryNullable:
type: string
description: Billing address country.
title: BillingCountryNullable
Cardzip:
type: string
description: 'ZIP or postal code for the billing address of cardholder. We **strongly
recommend** that you include this field when using `card` as a method.
'
title: Cardzip
CustomerStatus:
type: integer
description: 'Customer Status. Possible values:
- `-99` Deleted
- `0` Inactive
- `1` Active
- `85` Locked (typically due to multiple failed login attempts)
'
title: CustomerStatus
Discount:
type: number
format: double
description: Discount applied to the invoice.
title: Discount
CreateAnonymous:
type: boolean
description: 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 make a payment. Defaults to `false`.
title: CreateAnonymous
ItemUnitofMeasure:
type: string
description: Unit of measurement. Max length of 100 characters.
title: ItemUnitofMeasure
SummaryCommodityCode:
type: string
description: Commodity code.
title: SummaryCommodityCode
PayeeName:
type: string
description: Alternative name used to receive paper check.
title: PayeeName
TransactionTime:
type: string
format: date-time
description: Timestamp when transaction was submitted, in UTC.
title: TransactionTime
Entrypointfield:
type: string
description: The entrypoint identifier.
title: Entrypointfield
IdempotencyKey:
type: string
description: '_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. This key isn''t generated in Payabli; you must generate it
yourself. The key persists for 2 minutes. After 2 minutes, you can reuse
the key if needed.
'
title: IdempotencyKey
PageIdentifier:
type: string
description: Auxiliary validation used internally by payment pages and components.
title: PageIdentifier
QueryTransactionPayorData:
type: object
properties:
Identifiers:
type: array
items:
description: Any type
description: Array of field names to be used as identifiers.
FirstName:
type: string
description: Customer/Payor first name.
LastName:
type: string
description: Customer/Payor last name.
CompanyName:
type: string
description: Customer's company name.
BillingAddress1:
type: string
description: Customer's billing address.
BillingAddress2:
type: string
description: Additional line for Customer's billing address.
BillingCity:
type: string
description: Customer's billing city.
BillingState:
type: string
description: Customer's billing state. Must be 2-letter state code for address in US.
BillingZip:
$ref: '#/components/schemas/BillingZip'
description: Customer's billing ZIP code.
BillingCountry:
type: string
description: Customer's billing country.
BillingPhone:
type: string
description: Customer's phone number.
BillingEmail:
$ref: '#/components/schemas/Email'
description: Customer's email address.
CustomerNumber:
$ref: '#/components/schemas/CustomerNumberNullable'
ShippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
ShippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
ShippingCity:
$ref: '#/components/schemas/Shippingcity'
ShippingState:
$ref: '#/components/schemas/Shippingstate'
ShippingZip:
$ref: '#/components/schemas/Shippingzip'
ShippingCountry:
$ref: '#/components/schemas/Shippingcountry'
customerId:
$ref: '#/components/schemas/CustomerId'
customerStatus:
$ref: '#/components/schemas/CustomerStatus'
AdditionalData:
$ref: '#/components/schemas/AdditionalDataMap'
title: QueryTransactionPayorData
DutyAmount:
type: number
format: double
description: Duty amount.
title: DutyAmount
Vendorid:
type: integer
description: Payabli identifier for vendor record.
title: Vendorid
Tax:
type: number
format: double
description: Tax rate in percent applied to the invoice.
title: Tax
FileContent:
type: object
properties:
fContent:
type: string
description: 'Content of file, Base64-encoded. Ignored if `furl` is specified. Max
upload size is 30 MB.
'
filename:
type: string
description: The name of the attached file.
ftype:
$ref: '#/components/schemas/FileContentFtype'
furl:
type: string
description: Optional URL provided to show or download the file remotely.
description: Contains details about a file. Max upload size is 30 MB.
title: FileContent
AchSecCode:
type: string
description: "Standard Entry Class (SEC) code is a three letter code that describes\nhow an ACH payment was authorized. Supported values are:\n\n- **PPD** (Prearranged Payment and Deposit) — Used for credits or debits\n where an accountholder authorizes a company to initiate either a single\n or recurring transaction to their personal bank account. Common examples\n include direct deposit of payroll, mortgage payments, or utility bills.\n This is the default value for subscription payments.\n- **WEB** (Internet-Initiated/Mobile Entry) — Used for debit entries when\n authorization is obtained from an accountholder via the internet or a\n wireless network. Common examples are online bill payments, ecommerce\n purchases, and mobile app payments where the consumer enters their\n banking information online.\n- **TEL** (Telephone-Initiated Entry) — Used for one-time debit entries\n where authorization is obtained from a consumer via telephone. Common\n examples are phone-based purchases or bill payments where the consumer\n provides their banking information over the phone.\n- **CCD** (Corporate Credit or Debit) — Used for fund transfers between\n business accounts. This code is specifically for business-to-business\n transactions. Common examples include vendor payments and other\n business-to-business payments.\n- **BOC** (Back Office Conversion) — Used to convert paper checks received\n in-person at a point-of-sale or staffed payment location into electronic\n ACH debits. Required for Remote Deposit Capture (RDC) transactions. Only\n supports consumer checks; business, government, and mailed checks\n aren't eligible.\n"
title: AchSecCode
ItemDescription:
type: string
description: Item or product description. Max length of 250 characters.
title: ItemDescription
CreatedAt:
type: string
format: date-time
description: Timestamp of when record was created, in UTC.
title: CreatedAt
BinData:
type: object
properties:
binMatchedLength:
type: string
description: '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.'
binCardBrand:
type: string
description: 'The card brand. For example, Visa, Mastercard, American Express,
Discover.'
binCardType:
type: string
description: 'The type of card: `Credit` or `Debit`. Case can vary between
processors, so compare this value case-insensitively.'
binCardCategory:
type: string
description: 'The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked `PREPAID`.'
binCardIssuer:
type: string
description: The name of the financial institution that issued the card.
binCardIssuerCountry:
type: string
description: The issuing financial institution's country name.
binCardIssuerCountryCodeA2:
type: string
description: The issuing financial institution's two-character ISO country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes.
binCardIssuerCountryNumber:
type: string
description: The issuing financial institution's ISO standard numeric country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes.
binCardIsRegulated:
type: string
description: Indicates whether the card is regulated.
binCardUseCategory:
type: string
description: The use category classification for the card.
binCardIssuerCountryCodeA3:
type: string
description: 'The issuing financial institution''s three-character ISO country code.
See [this resource](https://www.iso.org/obp/ui/#search) for a list of
codes.'
description: '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.'
title: BinData
Holdername:
type: string
description: The cardholder name.
title: Holdername
ResponseText:
type: string
description: 'Response text for operation: ''Success'' or ''Declined''.
'
title: ResponseText
Temporary:
type: boolean
description: Creates a temporary, one-time-use token for the payment method that expires in 12 hours. Defaults to `false`.
title: Temporary
AchHolderType:
type: string
enum:
- personal
- business
default: personal
description: 'The bank''s accountholder type: personal or business.
'
title: AchHolderType
Cardnumber:
type: string
description: 'The card number. Required when method is `card` and a `storedMethodId`
isn''t included.
'
title: Cardnumber
Shippingstate:
type: string
description: Shipping state or province.
title: Shippingstate
Initiator:
type: string
description: 'The transaction''s initiator. Indicates who initiated the transaction.
'
title: Initiator
Remitcountry:
type: string
description: 'Remittance address country. Used for mailing paper checks. Must be `US`
or `CA`. Defaults to `US` if not provided.
'
title: Remitcountry
FeeAmount:
type: number
format: double
description: Service fee or sub-charge applied.
title: FeeAmount
CustomerId:
type: integer
format: int64
description: The Payabli-generated unique ID for the customer.
title: CustomerId
InternalReferenceId:
type: integer
format: int64
description: An internal reference ID.
title: InternalReferenceId
ExternalProcessorInformation:
type: string
description: Information from the external processor about the transaction.
title: ExternalProcessorInformation
BillingCityNullable:
type: string
description: Billing city.
title: BillingCityNullable
CustomerNumberNullable:
type: string
description: 'User-provided unique identifier for the customer. This is typically the
customer ID from your own system.
'
title: CustomerNumberNullable
GetMethodResponseResponseData:
type: object
properties:
aba:
type: string
description: Bank routing number
achHolderType:
$ref: '#/components/schemas/AchHolderType'
default: personal
achSecCode:
$ref: '#/components/schemas/AchSecCode'
bin:
type: string
description: The bank identification number (BIN)
binData:
$ref: '#/components/schemas/BinData'
cardUpdatedOn:
type: string
format: date-time
description: Timestamp for when card was last updated
customers:
type: array
items:
$ref: '#/components/schemas/GetMethodResponseResponseDataCustomersItem'
descriptor:
$ref: '#/components/schemas/Descriptor'
expDate:
type: string
description: Expiration date for card in stored method in format MM/YY
holderName:
$ref: '#/components/schemas/Holdername'
description: Account holder name in stored method
idPmethod:
type: string
description: The stored payment method's identifier in Payabli
isValidatedACH:
type: boolean
description: Whether the ACH account has been validated
lastUpdated:
type: string
format: date-time
description: Timestamp for last update of stored method, in UTC
maskedAccount:
$ref: '#/components/schemas/Maskedaccount'
method:
type: string
description: 'The saved method''s type: `card` or `ach`.'
methodType:
type: string
description: The payment method's token type
postalCode:
type: string
description: The payment method postal code
vendors:
type: array
items:
$ref: '#/components/schemas/GetMethodResponseResponseDataVendorsItem'
title: GetMethodResponseResponseData
BillItem:
type: object
properties:
itemCategories:
type: array
items:
type: string
description: Array of tags classifying item or product.
itemCommodityCode:
$ref: '#/components/schemas/ItemCommodityCode'
itemCost:
type: number
format: double
description: Item or product price per unit.
itemDescription:
$ref: '#/components/schemas/ItemDescription'
itemMode:
type: integer
description: 'Internal class of item or product: value `0` is only for invoices,
`1` for bills, and `2` is common for both. Required on invoice line
items — invoice creation fails with `Invalid item data` if it''s omitted.
'
itemProductCode:
$ref: '#/components/schemas/ItemProductCode'
itemProductName:
$ref: '#/components/schemas/ItemProductName'
itemQty:
type: integer
description: Quantity of item or product.
itemTaxAmount:
type: number
format: double
description: Tax amount applied to item or product.
itemTaxRate:
type: number
format: double
description: Tax rate applied to item or product.
itemTotalAmount:
type: number
format: double
description: 'Per-line total for this item (unit cost times quantity). Distinct from
the invoice''s overall total, `invoiceAmount`. Required on invoice line items.
'
itemUnitOfMeasure:
$ref: '#/components/schemas/ItemUnitofMeasure'
title: BillItem
BillingAddressAddtlNullable:
type: string
description: Additional line for the billing address.
title: BillingAddressAddtlNullable
ItemProductCode:
type: string
description: Item or product code. Max length of 250 characters.
title: ItemProductCode
TransactionQueryRecords:
type: object
properties:
AchHolderType:
$ref: '#/components/schemas/AchHolderType'
default: personal
AchSecCode:
$ref: '#/components/schemas/AchSecCode'
BatchAmount:
type: number
format: double
description: Batch amount.
BatchNumber:
$ref: '#/components/schemas/BatchNumber'
CfeeTransactions:
type: array
items:
$ref: '#/components/schemas/QueryCFeeTransaction'
description: Service Fee or sub-charge transaction associated to the main transaction.
ConnectorName:
type: string
description: Connector used for transaction.
Customer:
$ref: '#/components/schemas/QueryTransactionPayorData'
DeviceId:
$ref: '#/components/schemas/Device'
EntrypageId:
$ref: '#/components/schemas/EntrypageId'
ExternalProcessorInformation:
$ref: '#/components/schemas/ExternalProcessorInformation'
FeeAmount:
$ref: '#/components/schemas/FeeAmount'
GatewayTransId:
type: string
description: Internal identifier used for processing.
invoiceData:
$ref: '#/components/schemas/BillData'
Method:
type: string
description: 'Payment method used: card, ach, or wallet.'
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
description: Net amount paid.
Operation:
$ref: '#/components/schemas/Operation'
OrderId:
$ref: '#/components/schemas/OrderId'
OrgId:
$ref: '#/components/schemas/Orgid'
description: ID of immediate parent organization.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
PaymentTransId:
type: string
description: Unique Transaction ID.
PayorId:
$ref: '#/components/schemas/PayorId'
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
description: Paypoint's DBA name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
description: Paypoint's entryname.
PaypointId:
type: integer
format: int64
description: InternalId for paypoint.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
description: Paypoint's legal name.
PendingFeeAmount:
$ref: '#/components/schemas/PendingFeeAmount'
RefundId:
$ref: '#/components/schemas/RefundId'
ResponseData:
$ref: '#/components/schemas/QueryResponseData'
ReturnedId:
$ref: '#/components/schemas/ReturnedId'
ScheduleReference:
type: integer
format: int64
description: Reference to the subscription that originated the transaction.
SettlementStatus:
type: integer
description: Settlement status for transaction. See [the docs](/developers/references/money-in-statuses#payment-funding-status) for a full reference.
Source:
$ref: '#/components/schemas/Source'
splitFundingInstructions:
$ref: '#/components/schemas/SplitFunding'
splitCount:
$ref: '#/components/schemas/SplitCount'
TotalAmount:
type: number
format: double
description: Transaction total amount (including service fee or sub-charge)
TransactionEvents:
type: array
items:
$ref: '#/compone
# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/payabli/refs/heads/main/openapi/payabli-tokenstorage-api-openapi.yml