ALalternativepayments
Webhooks

Subscribe to a webhook

Changed on

Subscribe to a webhook with the provided information

post/webhooks

Request

  • Base URL
    https://public-api.alternativepayments.io
  • URL
    https://public-api.alternativepayments.io/webhooks
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: webhooks:write

Request body

endpoint_urlstring
secret_keystring
topic'payout_paid' | 'payout_failed' | 'payout_processing' | 'payout_scheduled' | 'customer_created' | 'customer_updated' | 'customer_archived' | 'payment_succeeded' | 'payment_chargeback' | 'payment_refunded' | 'invoice_paid' | 'invoice_archived' | 'invoice_created' | 'invoice_updated' | 'payment_failed' | 'payment_method_added' | 'payment_method_deleted' | 'default_payment_method_changed'

Response

Created

created_atstring
endpoint_urlstring
idstring
is_activeboolean
partner_idstring
secret_last_4_digitsstring
topic'payout_paid' | 'payout_failed' | 'payout_processing' | 'payout_scheduled' | 'customer_created' | 'customer_updated' | 'customer_archived' | 'payment_succeeded' | 'payment_chargeback' | 'payment_refunded' | 'invoice_paid' | 'invoice_archived' | 'invoice_created' | 'invoice_updated' | 'payment_failed' | 'payment_method_added' | 'payment_method_deleted' | 'default_payment_method_changed'
updated_atstring

Changes

  • 4e3a31effa3fRevision changes
    • breaking

      removed the enum value bill_created of the request property

    • breaking

      removed the enum value bill_deleted of the request property

    • breaking

      removed the enum value bill_rejected of the request property

    • breaking

      removed the enum value bill_submitted of the request property

    • breaking

      removed the enum value bill_updated of the request property

    • breaking

      removed the enum value vendor_created of the request property

    • breaking

      removed the enum value vendor_data_request_submitted of the request property

    • breaking

      removed the enum value vendor_deactivated of the request property

    • breaking

      removed the enum value vendor_payment_canceled of the request property

    • breaking

      removed the enum value vendor_payment_failed of the request property

    • breaking

      removed the enum value vendor_payment_processing of the request property

    • breaking

      removed the enum value vendor_payment_succeeded of the request property

    • breaking

      removed the enum value vendor_reactivated of the request property

    • breaking

      removed the enum value vendor_updated of the request property

    • info

      removed the bill_created enum value from the response property for the response status

    • info

      removed the bill_deleted enum value from the response property for the response status

    • info

      removed the bill_rejected enum value from the response property for the response status

    • info

      removed the bill_submitted enum value from the response property for the response status

    • info

      removed the bill_updated enum value from the response property for the response status

    • info

      removed the vendor_created enum value from the response property for the response status

    • info

      removed the vendor_data_request_submitted enum value from the response property for the response status

    • info

      removed the vendor_deactivated enum value from the response property for the response status

    • info

      removed the vendor_payment_canceled enum value from the response property for the response status

    • info

      removed the vendor_payment_failed enum value from the response property for the response status

    • info

      removed the vendor_payment_processing enum value from the response property for the response status

    • info

      removed the vendor_payment_succeeded enum value from the response property for the response status

    • info

      removed the vendor_reactivated enum value from the response property for the response status

    • info

      removed the vendor_updated enum value from the response property for the response status