Payment

This operation enables the applicant to receive the payment URL to make the payment.

path Parameters
CaseID
required
string

A fully qualified application number

header Parameters
OrganisationID
required
string

The relevant organisation name to indicate where the request is originated from.

IdempotencyID
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json

body

updatedByEmail
string <= 250 characters

Registered user mail address who performing the action.

Responses

Request samples

Content type
application/json
{
  • "updatedByEmail": "johnsmith@yopmail.com"
}

Response samples

Content type
application/json
{
  • "PaymentURL": "https://gpp-digital-ui-preprod.apps.pcf-ext.testservicensw.net?paymentReference= GPP-DIG-7LmKhNViSICwuH9GHdyoZg"
}