HomeGuideMethod ReferenceAssess YourselfRequest Sandbox Account
Method Reference
Ask For AssistanceLogin

Receive Request Status Via Callback

We recommend that you first review the guide for this method.

PCI Booking offers customers the ability to receive status notifications on card requests sent to a specific URL. The callback API should have the following signature. The callback will be sent each time there is a status change.

  • Parameters
    • RequestID: 9e4fac88bab14e01b5befe540 (string) - The ID of the request in PCI Booking.
    • LastNotifiedStatus: FormViewed (string) The request card status - see table below for full list of statuses and description.
    • LastNotifiedTime: 2017-11-12T14:38:14 (string) The time of the latest update.

Once you have received the callback and the LastNotifiedStatus is CardStored, you should use the Retrieve a card data request method to retrieve the request details including the card token.

Below is an example of the request body that will be sent to your callback application:

{
	"LastNotifiedStatus": "CardStored",
	"RequestID": "uC1efRTOpU4p3hmhH7fbY3J6A9LYL3j5",
	"LastNotifiedTime": "2017-12-19T20:07:32"
}
Method usedStatusValueDescription
Email / SMSMessage queuedMessageQueuedMessage was added to the PCI Booking queue.
SMSMessage sentMessageSentThe message was sent to the recipient.
SMSMessage failedMessageFailedMessage delivery to the recipient failed.
SMSMessage deliveredMessageDeliveredMessage was successfully delivered to the recipient.
Email / SMSForm viewedFormViewedRecipient viewed the capture form.
Email / SMSCard storedCardStoredThe recipient has entered the card in the form and the credit card stored at PCI Booking.
The status response will include a CardUri parameter which will contain the PCI Booking token.
Email / SMSLink expiredLinkExpiredThe link to the capture form has expired.
Email / SMSStore FailedStoreFailedCapture form submission failed.

📘

Card Security Code Requests

As a result of this form submission, the card details of the original token will be duplicated to a new token and the CVV data captured in this form will be added to the new token.
It is your responsibility to clear the original token that was stored in PCI Booking. If this token is not cleared, it will be charged the monthly storage fee.

📘

CVV Retention Policy

Once the status of the card request is CardStored, remember to set the CVV Retention Policy for this token.