Card Entry Form Webhook

Hosted Card Entry Form Guide

API session approach for embedded card capture

When you create a session-based card entry form with a CallBackURL, PCI Booking sends a POST request to that URL each time the session status changes. Your endpoint must accept the following payload.

Webhook Payload

{
  "CaptureCardRequestID": "uC1efRTOpU4p3hmhH7fbY3J6A9LYL3j5",
  "CaptureCardRequestStatus": "OK",
  "CardUri": "https://service.pcibooking.net/api/payments/paycard/G54Cvv0GZddE4TTr44mHj12DssAzb5Dp"
}

CaptureCardRequestID

string

The ID of the card entry form session. Matches the RequestID returned by Create Card Entry Form Session.

CaptureCardRequestStatus

string

The current status of the session. Possible values:

Status	Value	Description
Card stored	`OK`	Card was tokenized successfully. The `CardUri` field contains the token URL.
Store failed	`Failure`	Card storage failed due to a general error.
Bad data	`BadData`	Card storage failed because the cardholder entered invalid data (e.g. a card type not in the supported list).
Expired	`Expired`	The session exceeded its `TTL` without a successful submission.

CardUri

string

The PCI Booking token URL for the stored card. Only present when CaptureCardRequestStatus is OK.

Expected Response

Your callback endpoint must return 200 OK to acknowledge receipt. If PCI Booking does not receive a 200 response, the notification is not retried.

Delete Card Entry Form Send Card Capture Link

Start Here

Authentication & General

Capture Cards

Manage Tokens

Use Tokens

Additional Functions

Payments Library

Card Entry Form Webhook

Hosted Card Entry Form Guide

Webhook Payload

Expected Response

Hosted Card Entry Form Guide

​Webhook Payload

​Expected Response

Webhook Payload

Expected Response