Class PaymentMethodsApi

PaymentMethodsApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • PaymentMethodsApi

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Attaches a Payment Method to a Customer, converting it from single-use to reusable. Before attaching a card_present Payment Method to a Customer, the Payment Method must have been successfully used on a Terminal Reader. Payment Methods expire 15 minutes after creation. After 15 minutes, the Payment Method can no longer be attached to a Customer.

    Summary

    Attach a Payment Method to a Customer

    Throws

    Memberof

    PaymentMethodsApi

    Parameters

    Returns Promise<AxiosResponse<PaymentMethod, any>>

  • Creates a Payment Method. To use this endpoint, you must first submit your PCI Attestation of Compliance (AOC). Please contact integrations@tilled.com for information on how to submit your documentation.

    Summary

    Create a Payment Method

    Throws

    Memberof

    PaymentMethodsApi

    Parameters

    Returns Promise<AxiosResponse<PaymentMethod, any>>

  • Detaches a Payment Method from a Customer. Once detached, the Payment Method can no longer be used to confirm a Payment Intent.

    Summary

    Detach a Payment Method from a Customer

    Throws

    Memberof

    PaymentMethodsApi

    Parameters

    Returns Promise<AxiosResponse<PaymentMethod, any>>

  • Updates a Payment Method by setting the values of the provided parameters. Any parameters not provided will be left unchanged. The Payment Method must be attached to a Customer to be updated.

    Summary

    Update a Payment Method

    Throws

    Memberof

    PaymentMethodsApi

    Parameters

    Returns Promise<AxiosResponse<PaymentMethod, any>>

Generated using TypeDoc