Guides

Session Details Enquiry

Suggest Edits

You can use our GET Session Details API at any time to retrieve the latest Checkout Session, Payment Session, and Instrument Session details and corresponding status information.

  1. sessionType indicates the type of session, including:
    1. Checkout Session,
    2. Payment Session,
    3. or Instrument Session.
  2. sessionStatus see table below for details:
StatusIndicates that
CreatedOur platform successfully created a session record, and we responded to you with the redirect URL. You will receive this status when calling the Create Session API.
LaunchedThe buyer has been successfully redirected to us, and our relevant PayTo experience has started.
CompletedThe objective of the session was successfully achieved. For Checkout Session and Payment Session, this mean the payment is complete. For Instrument Session, this means the instrument is created and saved.
CancelledThe objective of the session was NOT met. For Checkout Session and Payment Session, this means the payment has failed. For Instrument Session, this means the instrument was not created.
ExpiredThe session was not Completed on time and has now expired. This typically indicates that the buyer has closed the browser midway and abandoned this session, or has left things too late.
  1. instrumentStatus is applicable to Checkout and Instrument sessions only. See table below for details:
StatusIndicates that
NotStartedThe buyer is yet to provide their bank account details to us, and we are yet to attempt the creation of the PayTo agreement in the NPP infrastructure.
PendingWe have successfully created the PayTo agreement in the NPP infrastructure, and are waiting the buyers authorisation.
CreatedThe buyer has authorised the PayTo agreement, and the PayTo instrument now can be used to make payments.
DeclinedThe buyer or their bank have declined this PayTo agreement request, therefore PayTo instrument creation has failed.
  1. paymentStatus is applicable to Checkout and Payment sessions only. See table below for details:
StatusIndicates that
NotStartedWe are yet to initiate the PayTo payment in the NPP infrastructure.
ProcessingThe payment is inflight and is being processed by the NPP infrastructure.
CompletedThe payment has successfully settled and funds transfer is complete.
RejectedThe payment has failed and no funds have been transferred. A detailed reason for failure is also provided.

📘

Timestamps

Session created, expiry and latest status updated timestamps are also provided.

Updated 4 months ago