/
Ready to pay requested

Ready to pay requested
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json

Payload of ready to pay-related webhook event.

eventTypestring

Type of event that triggered the webhook.

Value:"ready-to-pay-requested"
websiteIdstring, <= 50 characters(WebsiteId)

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
currencystring

Currency of the ready to pay request.

amountnumber, (double)

Amount of the ready to pay request.

itemsArray of objects
billingAddressContactObject (object) or null
One of:

Contact's information.

riskMetadataobject(Risk metadata)

Risk metadata used for 3D Secure and risk scoring.

customerIdstring, <= 50 characters(CustomerId)

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
transactionIdstring, <= 50 characters(TransactionId)

ID of the transaction.

Example:"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"
checkoutFormIdstring, <= 50 characters(CheckoutFormId)read-only

ID of the checkout form.

Example:"chkt_frm_0YV8XZ6174C2MBS5011SAZNMBP"
_embeddedobject

Embedded objects related to the ready to pay event.

Payload
{
  "eventType": "ready-to-pay-requested",
  "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "currency": "string",
  "amount": 0.1,
  "items": [
    { … }
  ],
  "billingAddress": {
    "firstName": "Benjamin",
    "lastName": "Franklin",
    "organization": "Rebilly",
    "address": "36 Craven St",
    "address2": "string",
    "city": "Austin",
    "region": "Texas",
    "country": "GB",
    "postalCode": "WC2N 5NF",
    "phoneNumbers": [ … ],
    "emails": [ … ],
    "dob": "1980-04-01",
    "jobTitle": "CEO",
    "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
  },
  "riskMetadata": {
    "ipAddress": "93.92.91.90",
    "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
    "httpHeaders": { … },
    "browserData": { … },
    "extraData": { … },
    "isProxy": true,
    "isVpn": true,
    "isTor": true,
    "isHosting": true,
    "hostingName": "string",
    "isp": "string",
    "country": "US",
    "region": "NY",
    "city": "New York",
    "latitude": 0.1,
    "longitude": 0,
    "postalCode": "string",
    "timeZone": "America/New_York",
    "accuracyRadius": 0,
    "distance": 0,
    "hasMismatchedBillingAddressCountry": true,
    "hasMismatchedBankCountry": true,
    "hasMismatchedTimeZone": true,
    "hasMismatchedHolderName": true,
    "hasFakeName": true,
    "isHighRiskCountry": true,
    "paymentInstrumentVelocity": 0,
    "declinedPaymentInstrumentVelocity": 0,
    "deviceVelocity": 0,
    "ipVelocity": 0,
    "emailVelocity": 0,
    "billingAddressVelocity": 0,
    "paymentInstrumentApprovedTransactionCount": 0,
    "score": 0
  },
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
  "checkoutFormId": "chkt_frm_0YV8XZ6174C2MBS5011SAZNMBP",
  "_embedded": {
    "checkoutForm": { … },
    "customer": { … },
    "transaction": { … },
    "website": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

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