Skip to main content

ACH/eCheck account approved for autopay

Webhook 

This event occurs when an ACH payment method is opted into autopay.

Note these fields:

  • context_str = ach
  • context_id = ... (this will be the ach_id of the ACH account that has been approved for autopay)

  • event = autopay

Request

Body

    context_str string
    context_id integer
    event string

    data

    object

    ach

    object

    ach_id integer
    customer_id integer
    external_key string
    type string
    type_name string
    token string
    number string
    mask_number string
    routing string
    mask_routing string
    name string
    bank string
    mask_bank string
    url_verifylink string
    write_datetime string
    mod_datetime string

    customer

    object

    customer_id integer
    parent_customer_id integer
    token string
    superuser_id integer
    external_key string
    display_as string
    company string
    language_id integer
    currency_id integer
    currency_iso4217 string
    currency_symbol string
    class_id integer
    admin_id integer
    campaign_id integer
    campaign_details string
    superuser_username string
    superuser_email string
    superuser_name string
    superuser_first_name string
    superuser_last_name string
    superuser_phone string
    superuser_token string
    superuser_title string
    bill_addr1 string
    bill_addr2 string
    bill_addr3 string
    bill_city string
    bill_state string
    bill_postcode string
    bill_country string
    bill_block string
    ship_addr1 string
    ship_addr2 string
    ship_addr3 string
    ship_city string
    ship_state string
    ship_postcode string
    ship_country string
    ship_block string
    custom_1 string
    custom_2 string
    custom_3 string
    custom_4 string
    custom_5 string
    custom_6 string
    custom_7 string
    custom_8 string
    custom_9 string
    custom_10 string
    custom_11 string
    custom_12 string
    custom_13 string
    custom_14 string
    custom_15 string
    custom_16 string
    custom_17 string
    custom_18 string
    custom_19 string
    custom_20 string
    write_datetime string
    write_ipaddr string
    mod_datetime string
    mod_ipaddr string
    brand_id integer
    class_name string
    terms_id integer
    terms_name string
    terms_days integer
    url_statementlink string
    url_paymethodlink string
    url_self string
    admin_name string
    admin_email string
    customer_status_id integer
    customer_status_name string
    customer_status_str string
    customer_status_state string
    default_paymethod string
    default_creditcard_id integer
    default_ach_id integer
    no_taxes boolean
    no_dunning boolean
    no_latefees boolean
    no_procfees boolean
    invoice_delivery string

    Possible values: [print, email]

    dunning_delivery string

    Possible values: [print, email]

    tax_ident string
    total float
    balance float
    paid float
    mrr float
    arr float
    tags string[]

    user

    object

    user_id integer
    external_key string
    token string
    username string
    password string
    name string
    first_name string
    middle_name_glob string
    last_name string
    name_suffix string
    display_as string
    title string
    email string
    phone string
    mobile string
    user_type_id integer
    user_type_name string
    customer_id integer
    custom_1 string
    custom_2 string
    custom_3 string
    custom_4 string
    custom_5 string
    custom_6 string
    custom_7 string
    custom_8 string
    custom_9 string
    custom_10 string
    custom_11 string
    custom_12 string
    custom_13 string
    custom_14 string
    custom_15 string
    custom_16 string
    custom_17 string
    custom_18 string
    custom_19 string
    custom_20 string
    write_datetime string
    mod_datetime string
    url_self string
    security_token string

Responses

Return a 200 status to indicate that the data was received successfully

Loading...