Skip to main content
Hosted Pages is available as a Beta version. Please contact your Customer Success Manager if you would like to access it.

​
Introduction

Hosted payment statuses and phases are used to track the progress of a payment made using Yapily Hosted Pages. We explain the differences among status fields and the phases field in the get hosted payment request response below. Given below is an example from a response of the get hosted payment request endpoint. For brevity, only the phases, paymentStatus, and statusDetails fields are included. Note: statusDetails will get populated after the payment gets accepted by the institution and it will also contain the iso status and states of the payment. 
{
  ...
  "data":{
    ...
    "payments": [
      {
        ...
        "phases": [
          {
            "phaseName": "INITIATED",
            "phaseCreatedAt": "2021-06-10T11:26:54.887Z"
          },
          {
            "phaseName": "INSTITUTION_SUBMITTED",
            "phaseCreatedAt": "2021-06-10T11:26:55.123Z"
          },
          {
            "phaseName": "AUTHORISATION_INITIATED",
            "phaseCreatedAt": "2021-06-10T11:27:05.123Z"
          },
          {
            "phaseName": "VALIDATION_COMPLETED",
            "phaseCreatedAt": "2021-06-10T11:27:05.223Z"
          },
          {
            "phaseName": "AUTHORISATION_CREATED",
            "phaseCreatedAt": "2021-06-10T11:27:06.637Z"
          },
          {
            "phaseName": "AUTHORISED",
            "phaseCreatedAt": "2021-06-10T11:27:10.637Z"
          },
          {
            "phaseName": "SUBMITTED",
            "phaseCreatedAt": "2021-06-10T11:27:10.654Z"
          },
          {
            "phaseName": "ACCEPTED",
            "phaseCreatedAt": "2021-06-10T11:27:11.867Z"
          },
          {
            "phaseName": "SETTLEMENT_COMPLETED",
            "phaseCreatedAt": "2021-06-10T11:27:13.887Z"
          }
        ],
        "paymentStatus": "COMPLETED",
        "statusDetails": [
          {
            "status": "PENDING",
            "statusUpdateDate": "2021-06-10T11:27:11.867Z",
            "isoStatus": {
              "code": "PDNG",
              "name": "Pending"
            }
          },
          {
            "status": "COMPLETED",
            "statusUpdateDate": "2021-06-10T11:27:13.887Z",
            "isoStatus": {
              "code": "ACSC",
              "name": "AcceptedSettlementCompleted"
            }
          }
        ]
        ...
The phases is an array that records the chronological sequence of phases that the payment has gone through; the paymentStatus field indicates the current status of the payment request and the statusDetails field is an array that provides the statuses the payment has gone through, including each status’s specific details such as corresponding ISO status code and name.

​
Mapping between status and phases

As phases are recorded by every step that a payment goes through, it provides a more detailed view of the payment’s progress. Therefore, multiple phases can map to a single status. We provide a mapping of the phases to the payment statuses below.
Phase NamePhase DescriptionStatus
INITIATEDPayment process initiatedPENDING
DECLINEDPayment process failed and will not proceed furtherFAILED
INSTITUTION_SUBMITTEDPayment institution submittedPENDING
AUTHORISATION_INITIATEDAuthorisation of payment initiatedPENDING
VALIDATION_COMPLETEDPayer successfully validatedPENDING
VALIDATION_FAILEDFailed to validate additional input attributesFAILED
EMBEDDED_CREDENTIAL_REQUESTEDPayment Institution submitted and embedded credentials are requested for further processingPENDING
EMBEDDED_TYPE_REQUESTEDSCA method requested for embedded payment authorisationPENDING
EMBEDDED_TYPE_SELECTEDSCA method selected for embedded payment authorisationPENDING
EMBEDDED_CODE_COLLECTEDSCA code collected from psuPENDING
DECOUPLED_AUTHORISATIONAuthorisation for payment that is known to follow the decoupled flowPENDING
EMBEDDED_CODE_REQUESTEDExpecting user to provide a codePENDING
AUTHORISATION_CREATEDPayment authorisation request created with Institution, awaiting authorisation completionPENDING
PRE_AUTHORISEDPayment pre authorisation request created with Institution, awaiting pre authorisation completionPENDING
AUTHORISEDPayment authorisation completedPENDING
AUTHORISATION_FAILEDPayment authorisation failed and will not proceed furtherFAILED
AUTHORISATION_REJECTEDPayment authorisation rejected and will not proceed furtherFAILED
SUBMITTEDPayment execution created and submitted to InstitutionPENDING
SUBMITTED_AUTOPayment execution created and submitted to Institution automatically after polling consent status successPENDING
ACCEPTEDPayment execution accepted by Institution and awaiting settlementPENDING
REJECTEDPayment or Authorisation request rejected by Institution and will not proceed furtherFAILED
SETTLEMENT_COMPLETEDPayment settlement completedCOMPLETED
STATUS_POLLING_STARTEDPayment status polling startedPENDING
STATUS_POLLING_ENDEDPayment status polling endedPENDING
MERCHANT_ACKNOWLEDGEDPayment acknowledgement received from merchantCOMPLETED
FINISHEDPayment process completed-

​
Hosted Pages Resources

​
Implementation Resources