Purchase
success callbacks and webhooks.
Purchase
success callbacks are defined by providing a target URL in the success_callback
field on Purchase
creation (see POST /purchases/). The system will generate a callback when:
Purchase
with skip_capture=false
is successfully paidPurchase
with skip_capture=true
is successfully captured (see POST /purchases/{id}/capture/)Purchase
is successfully paid using a recurring token (see POST /purchases/{id}/charge/)Purchase
as their payload. The payload represents a snapshot of the state of the Purchase
when the event was created. The payload will include an event_type
field to indicate which specific event (see Event schema) triggered the callback.
The payload is signed using a company-wide key pair. You can obtain the public key with GET /public_key/
. See the Authentication
section below for more details.
Webhook
callback payloads are signed using a dedicated key pair. You can obtain the public key from Webhook.public_key
. See the Authentication section below for more details.
purchase.created
and purchase.paid
events, there will be no purchase.paid
callbacks for this Purchase
until all purchase.created
callbacks for this Purchase
are successfully delivered.