POST Sale/ProspectPayment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ServiceUsername	string	Required
ServicePassword	string	Required
ProspectCode	integer	Required
CustomerReference	string	None.
OrderPayment	OrderPayment	None.
OrderItems	Collection of OrderItem	None.

Request Formats

application/json, text/json

Sample:

{
  "ProspectCode": 3,
  "OrderPayment": {
    "Amount": 4,
    "PaymentDate": "2025-06-16T02:59:10.4548612Z",
    "ReceiptNo": "sample string 6",
    "PaymentChannel": "sample string 5",
    "PaymentLogId": "sample string 3",
    "PaymentReference": "sample string 2",
    "PaymentMethod": "sample string 1"
  },
  "OrderItems": [
    {
      "ItemAmount": 4,
      "PassportUploadMinor": "sample string 9",
      "ThumbUploadJoint": "sample string 8",
      "SignatureUploadJoint": "sample string 7",
      "JointOtherNames": "sample string 6",
      "JointSurname": "sample string 5",
      "ItemCode": "sample string 3",
      "ItemName": "sample string 2",
      "AccountType": "sample string 1"
    },
    {
      "ItemAmount": 4,
      "PassportUploadMinor": "sample string 9",
      "ThumbUploadJoint": "sample string 8",
      "SignatureUploadJoint": "sample string 7",
      "JointOtherNames": "sample string 6",
      "JointSurname": "sample string 5",
      "ItemCode": "sample string 3",
      "ItemName": "sample string 2",
      "AccountType": "sample string 1"
    }
  ],
  "CustomerReference": "sample string 4",
  "ServicePassword": "sample string 2",
  "ServiceUsername": "sample string 1"
}

application/xml, text/xml

Sample:

<ProspectPaymentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceUsername>sample string 1</ServiceUsername>
  <ServicePassword>sample string 2</ServicePassword>
  <ProspectCode>3</ProspectCode>
  <CustomerReference>sample string 4</CustomerReference>
  <OrderPayment>
    <PaymentMethod>sample string 1</PaymentMethod>
    <PaymentReference>sample string 2</PaymentReference>
    <PaymentLogId>sample string 3</PaymentLogId>
    <Amount>4</Amount>
    <PaymentChannel>sample string 5</PaymentChannel>
    <PaymentDate>2025-06-16T03:59:10.4548612+01:00</PaymentDate>
    <ReceiptNo>sample string 6</ReceiptNo>
  </OrderPayment>
  <OrderItems>
    <OrderItem>
      <AccountType>sample string 1</AccountType>
      <ItemName>sample string 2</ItemName>
      <ItemCode>sample string 3</ItemCode>
      <ItemAmount>4</ItemAmount>
      <JointSurname>sample string 5</JointSurname>
      <JointOtherNames>sample string 6</JointOtherNames>
      <SignatureUploadJoint>sample string 7</SignatureUploadJoint>
      <ThumbUploadJoint>sample string 8</ThumbUploadJoint>
      <PassportUploadMinor>sample string 9</PassportUploadMinor>
    </OrderItem>
    <OrderItem>
      <AccountType>sample string 1</AccountType>
      <ItemName>sample string 2</ItemName>
      <ItemCode>sample string 3</ItemCode>
      <ItemAmount>4</ItemAmount>
      <JointSurname>sample string 5</JointSurname>
      <JointOtherNames>sample string 6</JointOtherNames>
      <SignatureUploadJoint>sample string 7</SignatureUploadJoint>
      <ThumbUploadJoint>sample string 8</ThumbUploadJoint>
      <PassportUploadMinor>sample string 9</PassportUploadMinor>
    </OrderItem>
  </OrderItems>
</ProspectPaymentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProspectPaymentResponse

Name	Type	Additional information
PaymentLogId	string	None.
Status	integer	None.
StatusMessage	string	None.
MembershipNumber	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "MembershipNumber": 4,
  "Status": 2,
  "StatusMessage": "sample string 3",
  "PaymentLogId": "sample string 1"
}

application/xml, text/xml

Sample:

<ProspectPaymentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentLogId>sample string 1</PaymentLogId>
  <Status>2</Status>
  <StatusMessage>sample string 3</StatusMessage>
  <MembershipNumber>4</MembershipNumber>
</ProspectPaymentResponse>