Payment Workflow

To process a payment from a user, kindly adhere to the following step-by-step process:

  1. Create Payer: Initiate the process by creating a payer from whom you intend to receive the payment. Utilize the createPayer service to create a new payer.

  2. Generate Payment Order: Create a payment order for the designated payer at createOrder service.

  3. Create Payment Session: Initiate a session to enable payment processing using the card details and CVC. This step ensures the security of your customer's payment information. For more detailed information, please refer to: WorldPay - Create sessions to pay with a card and CVC

  4. Checkout Request: Utilize the card and CVC sessions to execute a checkoutOrder request.

  5. Submit Device Data Collection (DDC) Form: This form is essential for fingerprinting the payer's device. For further details, please refer to: WorldPay - Device Data

  6. Payment Request: Make a payment request using sessionId from the DDC response and the transaction reference number This can be done by making a POST request at the payOrder service

  7. Payment Authentication: Post-payment request, you may encounter one of two scenarios:

    • No challenge: The payment is complete.

    • Challenge: The issuing bank requires identity verification of the payer. In this case, submit a challenge form to Worldpay. For further details, please refer to: WorldPay - Challenge display & Verification

  8. Verify Payment Status: Poll the payment status to confirm if the challenge has been accepted and the payment process is complete. This can be done by utilizing the payOrder service.

    • HTTP Status 200: response will contain outcome as "complete".

    • {
    "status": 0,
    "data": {
        "outcome": "complete"
      }
}

    • HTTP Status 400: response will contain the code and related error message.

      • If you receive an error with code 829, it indicates that the payment is still being processed. In such cases, you can retry the operation. The error response will look like below:

    • {
    "status": -1
    "errorCode": "829",
    "errorMessage": "The payment is still in processing. Please check later"
}

  9. Upload Supporting Documents: Once the payment process is complete, upload the supporting documents.

The flowchart below illustrates the above-mentioned payment process:

PreviousPayment APINextOverview

Last updated