Customer redirected offsite
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json
Payload of customer redirect-related webhook event.
transactionIdstring, <= 50 characters(TransactionId)
ID of the transaction.
Example:"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"
redirectUrlstring, (uri)
URL customer redirected to.
ipAddressstring
Customer's IP address.
httpHeadersobject
Customer's browser HTTP headers.
Example:
{
  "Content-Type": "application/json",
  "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}
eventTypestring
Type of event that triggered the webhook.
Enum:"customer-redirected-offsite""customer-returned"
_embeddedobject
Embedded objects related to the customer redirect event.
_linksArray of objects
Links to related resources.
POST
customer-redirected-offsite
Payload
{
  "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
  "redirectUrl": "http://example.com",
  "ipAddress": "string",
  "httpHeaders": {
    "Content-Type": "application/json",
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
  },
  "eventType": "customer-redirected-offsite",
  "_embedded": {
    "transaction": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

Returns any 2xx status to indicate that data is received.