Skip to main content

User Interface Initialisation

POST 
/ipframe/request/V2

Initialise a payment or card validation to be executed via the IPFrame UI and request its status.

info

This endpoint is multi purpose and its behaviour varies depending on the request type.

There are 3 request types:

  • initialisationRequest (Initialisation Request)
  • cardValidationInitialisationRequest (Card Validation Initialisation Request)
  • statusRequest (Status Request)

The UI can be initialised to make a payment for a specified amount using the Initialisation Request. Alternatively it can be initialised to validate a card, allowing a PCI secure token to be created, using the Card Validation Initialisation Request. These will both receive an Initialisation Response.

When the UI has closed, the status of the transaction can be queried by using the Status Request. This will receive a Payment Response.

Request​

Responses​

User Interface Initialisation Responses