# Get tokenized method details GET https://api-sandbox.payabli.com/api/TokenStorage/{methodId} Retrieves details for a saved payment method. Reference: https://docs.payabli.com/developers/api-reference/tokenstorage/get-a-payment-method ## OpenAPI Specification ```yaml openapi: 3.1.1 info: title: Get payment method version: endpoint_tokenStorage.GetMethod paths: /TokenStorage/{methodId}: get: operationId: get-method summary: Get payment method description: Retrieves details for a saved payment method. tags: - - subpackage_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: requestToken in: header required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/type_tokenStorage:GetMethodResponse' '400': description: Bad request/ invalid data content: {} '401': description: Unauthorized request. content: {} '500': description: Internal API Error content: {} '503': description: Database connection error content: {} components: schemas: type_:IsSuccess: type: boolean type_:AchHolderType: type: string enum: - value: personal - value: business default: personal type_:AchSecCode: type: string type_: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.' 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. type_:AdditionalData: type: object additionalProperties: type: object additionalProperties: description: Any type type_:BillingAddressNullable: type: string type_:BillingAddressAddtlNullable: type: string type_:BillingCityNullable: type: string type_:BillingCountryNullable: type: string type_:Email: type: string format: email type_:PhoneNumber: type: string type_:BillingStateNullable: type: string type_:BillingZip: type: string type_:CustomerId: type: integer format: int64 type_:CustomerNumberNullable: type: string type_:Identifierfields: type: array items: type: string type_:Shippingaddress: type: string type_:Shippingaddressadditional: type: string type_:Shippingcity: type: string type_:Shippingcountry: type: string type_:Shippingstate: type: string type_:Shippingzip: type: string type_:BatchNumber: type: string type_:TransactionTime: type: string format: date-time type_:QueryCFeeTransaction: type: object properties: cFeeTransid: type: string feeAmount: type: number format: double operation: type: string refundId: type: integer format: int64 responseData: type: object additionalProperties: description: Any type settlementStatus: type: integer transactionTime: $ref: '#/components/schemas/type_:TransactionTime' transStatus: type: integer type_:CustomerStatus: type: integer type_:AdditionalDataMap: type: object additionalProperties: type: string type_: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/type_: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/type_:Email' description: Customer's email address. CustomerNumber: $ref: '#/components/schemas/type_:CustomerNumberNullable' ShippingAddress1: $ref: '#/components/schemas/type_:Shippingaddress' ShippingAddress2: $ref: '#/components/schemas/type_:Shippingaddressadditional' ShippingCity: $ref: '#/components/schemas/type_:Shippingcity' ShippingState: $ref: '#/components/schemas/type_:Shippingstate' ShippingZip: $ref: '#/components/schemas/type_:Shippingzip' ShippingCountry: $ref: '#/components/schemas/type_:Shippingcountry' customerId: $ref: '#/components/schemas/type_:CustomerId' customerStatus: $ref: '#/components/schemas/type_:CustomerStatus' AdditionalData: $ref: '#/components/schemas/type_:AdditionalDataMap' type_:Device: type: string type_:EntrypageId: type: integer format: int64 type_:ExternalProcessorInformation: type: string type_:FeeAmount: type: number format: double type_:FileContentFtype: type: string enum: - value: pdf - value: doc - value: docx - value: jpg - value: jpeg - value: png - value: gif - value: txt type_: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/type_:FileContentFtype' description: The MIME type of the file (if content is provided) furl: type: string description: Optional URL provided to show or download the file remotely type_:Attachments: type: array items: $ref: '#/components/schemas/type_:FileContent' type_:Discount: type: number format: double type_:DutyAmount: type: number format: double type_:FreightAmount: type: number format: double type_:Frequency: type: string enum: - value: onetime - value: weekly - value: every2weeks - value: every6months - value: monthly - value: every3months - value: annually type_:InvoiceAmount: type: number format: double type_:Datenullable: type: string format: date type_:InvoiceNumber: type: string type_:Invoicestatus: type: integer type_:InvoiceType: type: integer type_:ItemCommodityCode: type: string type_:ItemDescription: type: string type_:ItemProductCode: type: string type_:ItemProductName: type: string type_:ItemUnitofMeasure: type: string type_:BillItem: type: object properties: itemCategories: type: array items: type: string description: Array of tags classifying item or product. itemCommodityCode: $ref: '#/components/schemas/type_:ItemCommodityCode' itemCost: type: number format: double description: Item or product price per unit. itemDescription: $ref: '#/components/schemas/type_:ItemDescription' itemMode: type: integer description: >- Internal class of item or product: value '0' is only for invoices , '1' for bills and, '2' common for both. itemProductCode: $ref: '#/components/schemas/type_:ItemProductCode' itemProductName: $ref: '#/components/schemas/type_: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: Total amount in item or product. itemUnitOfMeasure: $ref: '#/components/schemas/type_:ItemUnitofMeasure' required: - itemCost type_:BillDataPaymentTerms: type: string enum: - value: PIA - value: CIA - value: UR - value: NET10 - value: NET20 - value: NET30 - value: NET45 - value: NET60 - value: NET90 - value: EOM - value: MFI - value: 5MFI - value: 10MFI - value: 15MFI - value: 20MFI - value: 2/10NET30 - value: UF - value: 10UF - value: 20UF - value: 25UF - value: 50UF type_:PurchaseOrder: type: string type_:ShippingFromZip: type: string type_:SummaryCommodityCode: type: string type_:Tax: type: number format: double type_:TermsConditions: type: string type_:BillData: type: object properties: AdditionalData: $ref: '#/components/schemas/type_:AdditionalDataMap' attachments: $ref: '#/components/schemas/type_:Attachments' company: type: string description: Company name of the recipient of the invoice. discount: $ref: '#/components/schemas/type_:Discount' dutyAmount: $ref: '#/components/schemas/type_:DutyAmount' firstName: type: string description: First name of the recipient of the invoice. freightAmount: $ref: '#/components/schemas/type_:FreightAmount' frequency: $ref: '#/components/schemas/type_:Frequency' description: Frequency of scheduled invoice. invoiceAmount: $ref: '#/components/schemas/type_:InvoiceAmount' invoiceDate: $ref: '#/components/schemas/type_:Datenullable' description: 'Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.' invoiceDueDate: $ref: '#/components/schemas/type_:Datenullable' description: >- Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. invoiceEndDate: $ref: '#/components/schemas/type_:Datenullable' description: >- Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. invoiceNumber: $ref: '#/components/schemas/type_:InvoiceNumber' description: Invoice number. Identifies the invoice under a paypoint. invoiceStatus: $ref: '#/components/schemas/type_:Invoicestatus' invoiceType: $ref: '#/components/schemas/type_:InvoiceType' items: type: array items: $ref: '#/components/schemas/type_:BillItem' description: Array of line items included in the invoice. lastName: type: string description: Last name of the recipient of the invoice. notes: type: string description: Notes included in the invoice. paymentTerms: $ref: '#/components/schemas/type_:BillDataPaymentTerms' purchaseOrder: $ref: '#/components/schemas/type_:PurchaseOrder' shippingAddress1: $ref: '#/components/schemas/type_:Shippingaddress' shippingAddress2: $ref: '#/components/schemas/type_:Shippingaddressadditional' shippingCity: $ref: '#/components/schemas/type_:Shippingcity' shippingCountry: $ref: '#/components/schemas/type_:Shippingcountry' shippingEmail: $ref: '#/components/schemas/type_:Email' description: Shipping recipient's contact email address. shippingFromZip: $ref: '#/components/schemas/type_:ShippingFromZip' shippingPhone: type: string description: Recipient phone number. shippingState: $ref: '#/components/schemas/type_:Shippingstate' shippingZip: $ref: '#/components/schemas/type_:Shippingzip' summaryCommodityCode: $ref: '#/components/schemas/type_:SummaryCommodityCode' tax: $ref: '#/components/schemas/type_:Tax' termsConditions: $ref: '#/components/schemas/type_:TermsConditions' type_:Netamountnullable: type: number format: double type_:Operation: type: string type_:OrderId: type: string type_:Orgid: type: integer format: int64 type_:OrgParentName: type: string type_:Accountexp: type: string type_:Accountid: type: string type_:Accounttype: type: string type_:Accountzip: type: string type_:Holdername: type: string type_:Initiator: type: string type_:Maskedaccount: type: string type_:Orderdescription: type: string type_:PaymentCategories: type: object properties: amount: type: number format: double description: Price/cost per unit of item or category. description: type: string description: Description of item or category label: type: string description: Name of item or category. qty: type: integer default: 1 description: Quantity of item or category required: - amount - label type_:SplitFundingContent: type: object properties: accountId: type: string description: The accountId for the account the split should be sent to. amount: type: number format: double description: Amount from the transaction to sent to this recipient. description: type: string description: A description for the split. recipientEntryPoint: type: string description: The entrypoint the split should be sent to. type_:SplitFunding: type: array items: $ref: '#/components/schemas/type_:SplitFundingContent' type_:PaymentDetail: type: object properties: categories: type: array items: $ref: '#/components/schemas/type_:PaymentCategories' description: >- Array of payment categories/line items describing the amount to be paid. **Note**: These categories are for information only and aren't validated against the total amount provided. checkImage: type: object additionalProperties: description: Any type description: Object containing image of paper check. checkNumber: type: string description: >- A check number to be used in the ach transaction. **Required** for payment method = 'check'. currency: type: string description: >- The currency for the transaction, `USD` or `CAD`. If your paypoint is configured for CAD, you must send the `CAD` value in this field, otherwise it defaults to USD, which will cause the transaction to fail. serviceFee: type: number format: double description: >- Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually. splitFunding: $ref: '#/components/schemas/type_:SplitFunding' description: >- Split funding instructions for the transaction. See [Split a Transaction](/developers/developer-guides/money-in-split-funding) for more. totalAmount: type: number format: double description: >- Total amount to be charged. If a service fee is sent, then this amount should include the service fee." required: - totalAmount type_:Sequence: type: string type_:Signaturedata: type: string type_:Storedmethodid: type: string type_:StoredMethodUsageType: type: string type_:QueryPaymentData: type: object properties: AccountExp: $ref: '#/components/schemas/type_:Accountexp' accountId: $ref: '#/components/schemas/type_:Accountid' AccountType: $ref: '#/components/schemas/type_:Accounttype' AccountZip: $ref: '#/components/schemas/type_:Accountzip' binData: $ref: '#/components/schemas/type_:BinData' HolderName: $ref: '#/components/schemas/type_:Holdername' Initiator: $ref: '#/components/schemas/type_:Initiator' MaskedAccount: $ref: '#/components/schemas/type_:Maskedaccount' orderDescription: $ref: '#/components/schemas/type_:Orderdescription' paymentDetails: $ref: '#/components/schemas/type_:PaymentDetail' Sequence: $ref: '#/components/schemas/type_:Sequence' SignatureData: $ref: '#/components/schemas/type_:Signaturedata' StoredId: $ref: '#/components/schemas/type_:Storedmethodid' description: Identifier of stored payment method used in transaction. StoredMethodUsageType: $ref: '#/components/schemas/type_:StoredMethodUsageType' type_:PayorId: type: integer format: int64 type_:Dbaname: type: string type_:Entrypointfield: type: string type_:Legalname: type: string type_:PendingFeeAmount: type: number format: double type_:RefundId: type: integer format: int64 type_:Authcode: type: string type_:AvsResponse: type: string type_:AvsResponseText: type: string type_:CvvResponse: type: string type_:CvvResponseText: type: string type_:EmvAuthResponseData: type: string type_:ResultCodev2: type: string type_:ResultCodeText: type: string type_:QueryResponseData: type: object properties: authcode: $ref: '#/components/schemas/type_:Authcode' avsresponse: $ref: '#/components/schemas/type_:AvsResponse' avsresponse_text: $ref: '#/components/schemas/type_:AvsResponseText' cvvresponse: $ref: '#/components/schemas/type_:CvvResponse' cvvresponse_text: $ref: '#/components/schemas/type_:CvvResponseText' emv_auth_response_data: $ref: '#/components/schemas/type_:EmvAuthResponseData' orderid: $ref: '#/components/schemas/type_:OrderId' response: type: string description: 'Response text for operation: ''Success'' or ''Declined''.' response_code: type: string description: >- Internal result code processing the transaction. Value 1 indicates successful operation, values 2 and 3 indicate errors. response_code_text: type: string description: >- 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 decline. responsetext: type: string description: >- 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 decline. resultCode: $ref: '#/components/schemas/type_:ResultCodev2' resultCodeText: $ref: '#/components/schemas/type_:ResultCodeText' transactionid: type: string description: The transaction identifier in Payabli. type: type: string description: Type of transaction or operation. type_:ReturnedId: type: integer format: int64 type_:Source: type: string type_:QueryTransactionEventsEventData: oneOf: - type: object additionalProperties: description: Any type - type: string type_:QueryTransactionEvents: type: object properties: EventData: $ref: '#/components/schemas/type_:QueryTransactionEventsEventData' description: >- Any data associated to the event received from processor. Contents vary by event type. EventTime: type: string format: date-time description: Date and time of event. TransEvent: type: string description: >- Event descriptor. See [TransEvent Reference](/guides/pay-in-transevents-reference) for more details. type_:DatetimeNullable: type: string format: date-time type_:TransactionQueryRecords: type: object properties: AchHolderType: $ref: '#/components/schemas/type_:AchHolderType' AchSecCode: $ref: '#/components/schemas/type_:AchSecCode' BatchAmount: type: number format: double description: Batch amount. BatchNumber: $ref: '#/components/schemas/type_:BatchNumber' CfeeTransactions: type: array items: $ref: '#/components/schemas/type_: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/type_:QueryTransactionPayorData' DeviceId: $ref: '#/components/schemas/type_:Device' EntrypageId: $ref: '#/components/schemas/type_:EntrypageId' ExternalProcessorInformation: $ref: '#/components/schemas/type_:ExternalProcessorInformation' FeeAmount: $ref: '#/components/schemas/type_:FeeAmount' GatewayTransId: type: string description: Internal identifier used for processing. InvoiceData: $ref: '#/components/schemas/type_:BillData' Method: type: string description: 'Payment method used: card, ach, or wallet.' NetAmount: $ref: '#/components/schemas/type_:Netamountnullable' description: Net amount paid. Operation: $ref: '#/components/schemas/type_:Operation' OrderId: $ref: '#/components/schemas/type_:OrderId' OrgId: $ref: '#/components/schemas/type_:Orgid' description: ID of immediate parent organization. ParentOrgName: $ref: '#/components/schemas/type_:OrgParentName' PaymentData: $ref: '#/components/schemas/type_:QueryPaymentData' PaymentTransId: type: string description: Unique Transaction ID. PayorId: $ref: '#/components/schemas/type_:PayorId' PaypointDbaname: $ref: '#/components/schemas/type_:Dbaname' description: Paypoint's DBA name. PaypointEntryname: $ref: '#/components/schemas/type_:Entrypointfield' description: Paypoint's entryname. PaypointId: type: integer format: int64 description: InternalId for paypoint. PaypointLegalname: $ref: '#/components/schemas/type_:Legalname' description: Paypoint's legal name. PendingFeeAmount: $ref: '#/components/schemas/type_:PendingFeeAmount' RefundId: $ref: '#/components/schemas/type_:RefundId' ResponseData: $ref: '#/components/schemas/type_:QueryResponseData' ReturnedId: $ref: '#/components/schemas/type_: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/type_:Source' splitFundingInstructions: $ref: '#/components/schemas/type_:SplitFunding' TotalAmount: type: number format: double description: Transaction total amount (including service fee or sub-charge) TransactionEvents: type: array items: $ref: '#/components/schemas/type_:QueryTransactionEvents' description: Events associated with this transaction. TransactionTime: $ref: '#/components/schemas/type_:DatetimeNullable' description: Transaction date and time, in UTC. TransAdditionalData: description: Any type TransStatus: type: integer description: >- Status of transaction. See [the docs](/developers/references/money-in-statuses#money-in-transaction-status) for a full reference. type_:CustomerSummaryRecord: type: object properties: numberofTransactions: type: integer description: Number total of transactions or payments recentTransactions: type: array items: $ref: '#/components/schemas/type_:TransactionQueryRecords' description: List of more recent 5 transactions belonging to the customer totalAmountTransactions: type: number format: double description: Total amount in transactions totalNetAmountTransactions: type: number format: double description: Total net amount in transactions type_:ExternalPaypointId: type: string type_:PageIdentifier: type: string type_:Descriptor: type: string type_:LastModified: type: string format: date-time type_:MethodQueryRecords: type: object properties: bin: type: string description: The bank identification number (BIN). Null when method is ACH. binData: $ref: '#/components/schemas/type_:BinData' descriptor: $ref: '#/components/schemas/type_:Descriptor' expDate: type: string description: >- Expiration date associated to the method (only for card) in format MMYY. holderName: $ref: '#/components/schemas/type_:Holdername' idPmethod: type: string description: Method internal ID lastUpdated: $ref: '#/components/schemas/type_:LastModified' description: Date of last update maskedAccount: $ref: '#/components/schemas/type_:Maskedaccount' method: type: string description: 'Type of payment vehicle: **ach** or **card**' type_:CreatedAt: type: string format: date-time type_:PaypointId: type: integer format: int64 type_:GeneralEvents: type: object properties: description: type: string description: Event description. eventTime: type: string format: date-time description: Event timestamp, in UTC. extraData: type: object additionalProperties: description: Any type description: Extra data. refData: type: string description: Reference data. source: $ref: '#/components/schemas/type_:Source' description: The event source. type_:SubscriptionQueryRecords: type: object properties: CreatedAt: $ref: '#/components/schemas/type_:CreatedAt' description: Timestamp of when the subscription ws created, in UTC. Customer: $ref: '#/components/schemas/type_:QueryTransactionPayorData' EndDate: $ref: '#/components/schemas/type_:DatetimeNullable' description: The subscription's end date. EntrypageId: $ref: '#/components/schemas/type_:EntrypageId' ExternalPaypointID: $ref: '#/components/schemas/type_:ExternalPaypointId' FeeAmount: type: number format: double description: Fee applied to the subscription. Frequency: type: string description: The subscription's frequency. IdSub: type: integer format: int64 description: The subscription's ID. InvoiceData: $ref: '#/components/schemas/type_:BillData' LastRun: $ref: '#/components/schemas/type_:DatetimeNullable' description: The last time the subscription was processed. LastUpdated: $ref: '#/components/schemas/type_:LastModified' description: The last date and time the subscription was updated. LeftCycles: type: integer description: The number of cycles the subscription has left. Method: type: string description: The subscription's payment method. NetAmount: $ref: '#/components/schemas/type_:Netamountnullable' description: The subscription amount, minus any fees. NextDate: $ref: '#/components/schemas/type_:DatetimeNullable' description: The next date the subscription will be processed. ParentOrgName: $ref: '#/components/schemas/type_:OrgParentName' PaymentData: $ref: '#/components/schemas/type_:QueryPaymentData' PaypointDbaname: $ref: '#/components/schemas/type_:Dbaname' description: The paypoint's DBA name. PaypointEntryname: $ref: '#/components/schemas/type_:Entrypointfield' description: The paypoint's entryname. PaypointId: $ref: '#/components/schemas/type_:PaypointId' PaypointLegalname: $ref: '#/components/schemas/type_:Legalname' description: The paypoint's legal name. PlanId: type: integer description: Payment plan ID. Source: $ref: '#/components/schemas/type_:Source' StartDate: $ref: '#/components/schemas/type_:DatetimeNullable' description: The subscription start date. SubEvents: type: array items: $ref: '#/components/schemas/type_:GeneralEvents' description: Events associated with the subscription. SubStatus: type: integer description: |- The subscription's status. - 0: Paused - 1: Active TotalAmount: type: number format: double description: The subscription amount, including any fees. TotalCycles: type: integer description: The total number of cycles the subscription is set to run. UntilCancelled: type: boolean description: >- When `true`, the subscription has no explicit end date and will run until canceled. type_tokenStorage:GetMethodResponseResponseDataCustomersItem: type: object properties: additionalData: $ref: '#/components/schemas/type_:AdditionalData' billingAddress1: $ref: '#/components/schemas/type_:BillingAddressNullable' billingAddress2: $ref: '#/components/schemas/type_:BillingAddressAddtlNullable' billingCity: $ref: '#/components/schemas/type_:BillingCityNullable' billingCountry: $ref: '#/components/schemas/type_:BillingCountryNullable' billingEmail: $ref: '#/components/schemas/type_:Email' billingPhone: $ref: '#/components/schemas/type_:PhoneNumber' billingState: $ref: '#/components/schemas/type_:BillingStateNullable' billingZip: $ref: '#/components/schemas/type_:BillingZip' description: >- Customer's billing 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". company: type: string description: Customer's company name. customerId: $ref: '#/components/schemas/type_:CustomerId' customerNumber: $ref: '#/components/schemas/type_:CustomerNumberNullable' firstName: type: string description: Customer/Payor first name. identifierFields: $ref: '#/components/schemas/type_:Identifierfields' lastName: type: string description: Customer/Payor last name. shippingAddress1: $ref: '#/components/schemas/type_:Shippingaddress' shippingAddress2: $ref: '#/components/schemas/type_:Shippingaddressadditional' shippingCity: $ref: '#/components/schemas/type_:Shippingcity' shippingCountry: $ref: '#/components/schemas/type_:Shippingcountry' shippingState: $ref: '#/components/schemas/type_:Shippingstate' shippingZip: $ref: '#/components/schemas/type_:Shippingzip' balance: type: number format: double description: Customer's current balance created: type: string format: date-time description: Creation timestamp customerConsent: type: object additionalProperties: description: Any type description: Customer consent information customerStatus: type: integer description: Status code for the customer customerSummary: $ref: '#/components/schemas/type_:CustomerSummaryRecord' customerUsername: type: string description: Username of the customer externalPaypointID: $ref: '#/components/schemas/type_:ExternalPaypointId' lastUpdated: type: string format: date-time description: Last update timestamp mfa: type: boolean description: Multi-factor authentication status mfaMode: type: integer description: MFA mode setting pageindentifier: $ref: '#/components/schemas/type_:PageIdentifier' parentOrgId: type: integer description: Parent organization ID parentOrgName: $ref: '#/components/schemas/type_:OrgParentName' paypointDbaname: $ref: '#/components/schemas/type_:Dbaname' paypointEntryname: type: string description: The paypoint entryname the customer is associated with paypointLegalname: $ref: '#/components/schemas/type_:Legalname' snData: type: object additionalProperties: description: Any type description: Social network data snIdentifier: type: string description: Social network identifier snProvider: type: string description: Social network provider storedMethods: type: array items: $ref: '#/components/schemas/type_:MethodQueryRecords' description: List of payment methods associated to the customer subscriptions: type: array items: $ref: '#/components/schemas/type_:SubscriptionQueryRecords' description: List of subscriptions associated to the customer timeZone: type: integer description: Customer's timezone type_:VendorResponseBillingData: type: object properties: id: type: integer accountId: type: string nickname: type: string bankName: type: string routingAccount: type: string accountNumber: type: string typeAccount: type: string bankAccountHolderName: type: string bankAccountHolderType: type: string bankAccountFunction: type: integer verified: type: boolean status: type: integer services: type: array items: description: Any type default: type: boolean type_:AdditionalDataString: type: string type_:Contacts: type: object properties: contactEmail: $ref: '#/components/schemas/type_:Email' description: Contact email address. contactName: type: string description: Contact name. contactPhone: type: string description: Contact phone number. contactTitle: type: string description: Contact title. additionalData: $ref: '#/components/schemas/type_:AdditionalDataString' type_:InternalReferenceId: type: integer format: int64 type_:LocationCode: type: string type_:Mcc: type: string type_:PayeeName: type: string type_:Remitaddress1: type: string type_:Remitaddress2: type: string type_:Remitcity: type: string type_:Remitcountry: type: string type_:Remitstate: type: string type_:Remitzip: type: string type_:VendorResponseStoredMethod: type: object properties: IdPmethod: type: - string - 'null' Method: type: - string - 'null' Descriptor: type: - string - 'null' MaskedAccount: type: - string - 'null' ExpDate: type: - string - 'null' HolderName: type: - string - 'null' AchSecCode: type: - string - 'null' AchHolderType: type: - string - 'null' IsValidatedACH: type: - boolean - 'null' BIN: type: - string - 'null' binData: type: - string - 'null' ABA: type: - string - 'null' PostalCode: type: - string - 'null' MethodType: type: - string - 'null' LastUpdated: type: - string - 'null' format: date-time CardUpdatedOn: type: - string - 'null' format: date-time required: - IdPmethod - Method - Descriptor - MaskedAccount - ExpDate - HolderName - AchSecCode - AchHolderType - IsValidatedACH - BIN - binData - ABA - PostalCode - MethodType - LastUpdated - CardUpdatedOn type_:VendorResponseSummary: type: object properties: ActiveBills: type: integer PendingBills: type: integer InTransitBills: type: integer PaidBills: type: integer OverdueBills: type: integer ApprovedBills: type: integer DisapprovedBills: type: integer TotalBills: type: integer ActiveBillsAmount: type: number format: double PendingBillsAmount: type: number format: double InTransitBillsAmount: type: number format: double PaidBillsAmount: type: number format: double OverdueBillsAmount: type: number format: double ApprovedBillsAmount: type: number format: double DisapprovedBillsAmount: type: number format: double TotalBillsAmount: type: number format: double type_:Vendorid: type: integer type_:VendorNumber: type: string type_:Vendorstatus: type: integer type_tokenStorage:GetMethodResponseResponseDataVendorsItem: type: object properties: additionalData: $ref: '#/components/schemas/type_:AdditionalDataMap' description: Additional data for vendor address1: type: string description: Vendor's address address2: type: string description: Additional line for vendor's address billingData: $ref: '#/components/schemas/type_:VendorResponseBillingData' description: Object containing vendor's bank information city: type: string description: Vendor's city contacts: type: array items: $ref: '#/components/schemas/type_:Contacts' description: Array of objects describing the vendor's contacts country: type: string description: Vendor's country createdDate: type: string format: date-time description: Date when vendor was created customField1: type: string description: Custom field 1 for vendor customField2: type: string description: Custom field 2 for vendor customerVendorAccount: type: string description: Account number of paypoint in the vendor's side ein: type: string description: EIN/Tax ID for vendor. In responses, this field is masked. email: $ref: '#/components/schemas/type_:Email' description: Vendor's email address enrollmentStatus: type: string description: Vendor enrollment status externalPaypointID: type: string description: External paypoint identifier internalReferenceId: $ref: '#/components/schemas/type_:InternalReferenceId' description: Internal reference ID for vendor lastUpdated: type: string format: date-time description: Date when vendor was last updated locationCode: $ref: '#/components/schemas/type_:LocationCode' description: Location code for vendor mcc: $ref: '#/components/schemas/type_:Mcc' description: Merchant category code name1: type: string description: Primary name for vendor name2: type: string description: Secondary name for vendor parentOrgId: type: integer description: ID of the parent organization parentOrgName: type: string description: Name of the parent organization payeeName1: $ref: '#/components/schemas/type_:PayeeName' description: Primary payee name payeeName2: $ref: '#/components/schemas/type_:PayeeName' description: Secondary payee name paymentMethod: type: string description: Preferred payment method for vendor paypointDbaname: type: string description: DBA name of the paypoint paypointEntryname: type: string description: Entry name of the paypoint paypointId: type: string description: Paypoint ID paypointLegalname: type: string description: Legal name of the paypoint phone: type: string description: Vendor's phone number remitAddress1: $ref: '#/components/schemas/type_:Remitaddress1' description: Remittance address line 1 remitAddress2: $ref: '#/components/schemas/type_:Remitaddress2' description: Remittance address line 2 remitCity: $ref: '#/components/schemas/type_:Remitcity' description: Remittance city remitCountry: $ref: '#/components/schemas/type_:Remitcountry' description: Remittance country remitEmail: type: string description: Email address for remittance remitState: $ref: '#/components/schemas/type_:Remitstate' description: Remittance state remitZip: $ref: '#/components/schemas/type_:Remitzip' description: Remittance ZIP code state: type: string description: Vendor's state storedMethods: type: array items: $ref: '#/components/schemas/type_:VendorResponseStoredMethod' description: Array of stored payment methods for vendor summary: $ref: '#/components/schemas/type_:VendorResponseSummary' description: Vendor bill summary statistics vendorId: $ref: '#/components/schemas/type_:Vendorid' description: The unique numeric ID assigned to the vendor in Payabli vendorNumber: $ref: '#/components/schemas/type_:VendorNumber' description: Custom vendor number assigned by the business vendorStatus: $ref: '#/components/schemas/type_:Vendorstatus' description: Status code for the vendor zip: type: string description: Vendor's ZIP code type_tokenStorage:GetMethodResponseResponseData: type: object properties: aba: type: string description: Bank routing number achHolderType: $ref: '#/components/schemas/type_:AchHolderType' achSecCode: $ref: '#/components/schemas/type_:AchSecCode' bin: type: string description: The bank identification number (BIN) binData: $ref: '#/components/schemas/type_:BinData' cardUpdatedOn: type: string format: date-time description: Timestamp for when card was last updated customers: type: array items: $ref: >- #/components/schemas/type_tokenStorage:GetMethodResponseResponseDataCustomersItem descriptor: $ref: '#/components/schemas/type_:Descriptor' expDate: type: string description: Expiration date for card in stored method in format MM/YY holderName: $ref: '#/components/schemas/type_: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/type_: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/type_tokenStorage:GetMethodResponseResponseDataVendorsItem type_:ResponseText: type: string type_tokenStorage:GetMethodResponse: type: object properties: isSuccess: $ref: '#/components/schemas/type_:IsSuccess' responseData: $ref: '#/components/schemas/type_tokenStorage:GetMethodResponseResponseData' responseText: $ref: '#/components/schemas/type_:ResponseText' required: - responseText ``` ## SDK Code Examples ```python Example tokenstorage GET with card payment method from payabli import payabli client = payabli( api_key="YOUR_API_KEY", ) client.token_storage.get_method( method_id="32-8877drt00045632-678", card_expiration_format=1, include_temporary=False, ) ``` ```typescript Example tokenstorage GET with card payment method import { PayabliClient } from "@payabli/sdk-node"; const client = new PayabliClient({ apiKey: "YOUR_API_KEY" }); await client.tokenStorage.getMethod("32-8877drt00045632-678", { cardExpirationFormat: 1, includeTemporary: false }); ``` ```go Example tokenstorage GET with card payment method import ( context "context" option "github.com/payabli/sdk-go/option" sdkgo "github.com/payabli/sdk-go" sdkgoclient "github.com/payabli/sdk-go/client" ) client := sdkgoclient.NewClient( option.WithApiKey( "", ), ) response, err := client.TokenStorage.GetMethod( context.TODO(), "32-8877drt00045632-678", &sdkgo.GetMethodRequest{ CardExpirationFormat: sdkgo.Int( 1, ), IncludeTemporary: sdkgo.Bool( false, ), }, ) ``` ```csharp Example tokenstorage GET with card payment method using PayabliApi; var client = new PayabliApiClient("API_KEY"); await client.TokenStorage.GetMethodAsync( "32-8877drt00045632-678", new GetMethodRequest { CardExpirationFormat = 1, IncludeTemporary = false } ); ``` ```ruby Example tokenstorage GET with card payment method require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/TokenStorage/32-8877drt00045632-678?cardExpirationFormat=1&includeTemporary=false") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java Example tokenstorage GET with card payment method HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/TokenStorage/32-8877drt00045632-678?cardExpirationFormat=1&includeTemporary=false") .header("requestToken", "") .asString(); ``` ```php Example tokenstorage GET with card payment method request('GET', 'https://api-sandbox.payabli.com/api/TokenStorage/32-8877drt00045632-678?cardExpirationFormat=1&includeTemporary=false', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```swift Example tokenstorage GET with card payment method import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/TokenStorage/32-8877drt00045632-678?cardExpirationFormat=1&includeTemporary=false")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ```python Example tokenstorage GET with ACH payment method from payabli import payabli client = payabli( api_key="YOUR_API_KEY", ) client.token_storage.get_method( method_id="32-8877drt00045632-678", card_expiration_format=1, include_temporary=False, ) ``` ```typescript Example tokenstorage GET with ACH payment method import { PayabliClient } from "@payabli/sdk-node"; const client = new PayabliClient({ apiKey: "YOUR_API_KEY" }); await client.tokenStorage.getMethod("32-8877drt00045632-678", { cardExpirationFormat: 1, includeTemporary: false }); ``` ```go Example tokenstorage GET with ACH payment method import ( context "context" option "github.com/payabli/sdk-go/option" sdkgo "github.com/payabli/sdk-go" sdkgoclient "github.com/payabli/sdk-go/client" ) client := sdkgoclient.NewClient( option.WithApiKey( "", ), ) response, err := client.TokenStorage.GetMethod( context.TODO(), "32-8877drt00045632-678", &sdkgo.GetMethodRequest{ CardExpirationFormat: sdkgo.Int( 1, ), IncludeTemporary: sdkgo.Bool( false, ), }, ) ``` ```csharp Example tokenstorage GET with ACH payment method using PayabliApi; var client = new PayabliApiClient("API_KEY"); await client.TokenStorage.GetMethodAsync( "32-8877drt00045632-678", new GetMethodRequest { CardExpirationFormat = 1, IncludeTemporary = false } ); ``` ```ruby Example tokenstorage GET with ACH payment method require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/TokenStorage/32-8877drt00045632-678?cardExpirationFormat=1&includeTemporary=false") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java Example tokenstorage GET with ACH payment method HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/TokenStorage/32-8877drt00045632-678?cardExpirationFormat=1&includeTemporary=false") .header("requestToken", "") .asString(); ``` ```php Example tokenstorage GET with ACH payment method request('GET', 'https://api-sandbox.payabli.com/api/TokenStorage/32-8877drt00045632-678?cardExpirationFormat=1&includeTemporary=false', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```swift Example tokenstorage GET with ACH payment method import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/TokenStorage/32-8877drt00045632-678?cardExpirationFormat=1&includeTemporary=false")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ```python Example tokenstorage GET with vendor ACH payment method from payabli import payabli client = payabli( api_key="YOUR_API_KEY", ) client.token_storage.get_method( method_id="749e236c-59a3-49c7-ab47-73e06f9e94aa-199689", card_expiration_format=1, include_temporary=False, ) ``` ```typescript Example tokenstorage GET with vendor ACH payment method import { PayabliClient } from "@payabli/sdk-node"; const client = new PayabliClient({ apiKey: "YOUR_API_KEY" }); await client.tokenStorage.getMethod("749e236c-59a3-49c7-ab47-73e06f9e94aa-199689", { cardExpirationFormat: 1, includeTemporary: false }); ``` ```go Example tokenstorage GET with vendor ACH payment method import ( context "context" option "github.com/payabli/sdk-go/option" sdkgo "github.com/payabli/sdk-go" sdkgoclient "github.com/payabli/sdk-go/client" ) client := sdkgoclient.NewClient( option.WithApiKey( "", ), ) response, err := client.TokenStorage.GetMethod( context.TODO(), "32-8877drt00045632-678", &sdkgo.GetMethodRequest{ CardExpirationFormat: sdkgo.Int( 1, ), IncludeTemporary: sdkgo.Bool( false, ), }, ) ``` ```csharp Example tokenstorage GET with vendor ACH payment method using PayabliApi; var client = new PayabliApiClient("API_KEY"); await client.TokenStorage.GetMethodAsync( "749e236c-59a3-49c7-ab47-73e06f9e94aa-199689", new GetMethodRequest { CardExpirationFormat = 1, IncludeTemporary = false } ); ``` ```ruby Example tokenstorage GET with vendor ACH payment method require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/TokenStorage/749e236c-59a3-49c7-ab47-73e06f9e94aa-199689?cardExpirationFormat=1&includeTemporary=false") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java Example tokenstorage GET with vendor ACH payment method HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/TokenStorage/749e236c-59a3-49c7-ab47-73e06f9e94aa-199689?cardExpirationFormat=1&includeTemporary=false") .header("requestToken", "") .asString(); ``` ```php Example tokenstorage GET with vendor ACH payment method request('GET', 'https://api-sandbox.payabli.com/api/TokenStorage/749e236c-59a3-49c7-ab47-73e06f9e94aa-199689?cardExpirationFormat=1&includeTemporary=false', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```swift Example tokenstorage GET with vendor ACH payment method import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/TokenStorage/749e236c-59a3-49c7-ab47-73e06f9e94aa-199689?cardExpirationFormat=1&includeTemporary=false")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```