POST Sale/Goal

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerReference	string	Required
FullName	string	Required
EmailAddress	string	None.
MobileNumber	string	None.
Location	string	None.
NickName	string	None.
MarketingOption	string	None.
OrderPayment	OrderPayment	None.
GoalPaymentItems	Collection of GoalPaymentItem	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderPayment": {
    "Amount": 4,
    "PaymentDate": "2025-04-28T12:11:31.9941541Z",
    "ReceiptNo": "sample string 6",
    "PaymentChannel": "sample string 5",
    "PaymentLogId": "sample string 3",
    "PaymentReference": "sample string 2",
    "PaymentMethod": "sample string 1"
  },
  "GoalPaymentItems": [
    {
      "BeneficiaryDateOfBirth": "2025-04-28T12:11:31.9941541Z",
      "ItemAmount": 3,
      "CertificateId": 10,
      "NameOption": "sample string 12",
      "PersonalMessage": "sample string 11",
      "BeneficiaryMobileNumber": "sample string 9",
      "BeneficiarySex": "sample string 8",
      "BeneficiaryEmailAddress": "sample string 6",
      "BeneficiaryOtherNames": "sample string 5",
      "BeneficiarySurname": "sample string 4",
      "ItemCode": "sample string 2",
      "ItemName": "sample string 1"
    },
    {
      "BeneficiaryDateOfBirth": "2025-04-28T12:11:31.9941541Z",
      "ItemAmount": 3,
      "CertificateId": 10,
      "NameOption": "sample string 12",
      "PersonalMessage": "sample string 11",
      "BeneficiaryMobileNumber": "sample string 9",
      "BeneficiarySex": "sample string 8",
      "BeneficiaryEmailAddress": "sample string 6",
      "BeneficiaryOtherNames": "sample string 5",
      "BeneficiarySurname": "sample string 4",
      "ItemCode": "sample string 2",
      "ItemName": "sample string 1"
    }
  ],
  "MarketingOption": "sample string 7",
  "NickName": "sample string 6",
  "Location": "sample string 5",
  "MobileNumber": "sample string 4",
  "EmailAddress": "sample string 3",
  "FullName": "sample string 2",
  "CustomerReference": "sample string 1"
}

application/xml, text/xml

Sample:

<GoalRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerReference>sample string 1</CustomerReference>
  <FullName>sample string 2</FullName>
  <EmailAddress>sample string 3</EmailAddress>
  <MobileNumber>sample string 4</MobileNumber>
  <Location>sample string 5</Location>
  <NickName>sample string 6</NickName>
  <MarketingOption>sample string 7</MarketingOption>
  <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-04-28T13:11:31.9941541+01:00</PaymentDate>
    <ReceiptNo>sample string 6</ReceiptNo>
  </OrderPayment>
  <GoalPaymentItems>
    <GoalPaymentItem>
      <ItemName>sample string 1</ItemName>
      <ItemCode>sample string 2</ItemCode>
      <ItemAmount>3</ItemAmount>
      <BeneficiarySurname>sample string 4</BeneficiarySurname>
      <BeneficiaryOtherNames>sample string 5</BeneficiaryOtherNames>
      <BeneficiaryEmailAddress>sample string 6</BeneficiaryEmailAddress>
      <BeneficiaryDateOfBirth>2025-04-28T13:11:31.9941541+01:00</BeneficiaryDateOfBirth>
      <BeneficiarySex>sample string 8</BeneficiarySex>
      <BeneficiaryMobileNumber>sample string 9</BeneficiaryMobileNumber>
      <CertificateId>10</CertificateId>
      <PersonalMessage>sample string 11</PersonalMessage>
      <NameOption>sample string 12</NameOption>
    </GoalPaymentItem>
    <GoalPaymentItem>
      <ItemName>sample string 1</ItemName>
      <ItemCode>sample string 2</ItemCode>
      <ItemAmount>3</ItemAmount>
      <BeneficiarySurname>sample string 4</BeneficiarySurname>
      <BeneficiaryOtherNames>sample string 5</BeneficiaryOtherNames>
      <BeneficiaryEmailAddress>sample string 6</BeneficiaryEmailAddress>
      <BeneficiaryDateOfBirth>2025-04-28T13:11:31.9941541+01:00</BeneficiaryDateOfBirth>
      <BeneficiarySex>sample string 8</BeneficiarySex>
      <BeneficiaryMobileNumber>sample string 9</BeneficiaryMobileNumber>
      <CertificateId>10</CertificateId>
      <PersonalMessage>sample string 11</PersonalMessage>
      <NameOption>sample string 12</NameOption>
    </GoalPaymentItem>
  </GoalPaymentItems>
</GoalRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GoalResponse

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

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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