POST Policy/GetDetailedCustomerPayment

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SecurityKey		string	None.
DocumentId		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SecurityKey": "sample string 1",
  "DocumentId": 2
}

application/xml, text/xml

Sample:

<SecurityTokenVerifiedDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <DocumentId>2</DocumentId>
  <SecurityKey>sample string 1</SecurityKey>
</SecurityTokenVerifiedDocumentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfCustomerPayment

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Entity	CustomerPayment	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Entity": {
    "DocumentId": 1,
    "FinancialDate": "2025-05-14T00:55:35.0798906+02:00",
    "CustomerAccountId": 3,
    "CustomerAccount": "sample string 4",
    "PaymentMethod": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "Reference": "sample string 5",
    "SettledAmount": 6.0,
    "TotalAmount": 7.0,
    "IsVoided": true,
    "IsRejected": true,
    "RejectionReason": "sample string 10",
    "EBureauTicket": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "CreatedDateTime": "2025-05-14T00:55:35.0798906+02:00",
    "ModifiedDateTime": "2025-05-14T00:55:35.0798906+02:00"
  }
}

application/xml, text/xml

Sample:

<ResponseOfCustomerPaymentlP_S41WJs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
    <d2p1:CreatedDateTime>2025-05-14T00:55:35.0798906+02:00</d2p1:CreatedDateTime>
    <d2p1:CustomerAccount>sample string 4</d2p1:CustomerAccount>
    <d2p1:CustomerAccountId>3</d2p1:CustomerAccountId>
    <d2p1:DocumentId>1</d2p1:DocumentId>
    <d2p1:EBureauTicket>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:EBureauTicket>
    <d2p1:FinancialDate>2025-05-14T00:55:35.0798906+02:00</d2p1:FinancialDate>
    <d2p1:IsRejected>true</d2p1:IsRejected>
    <d2p1:IsVoided>true</d2p1:IsVoided>
    <d2p1:ModifiedDateTime>2025-05-14T00:55:35.0798906+02:00</d2p1:ModifiedDateTime>
    <d2p1:PaymentMethod>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:PaymentMethod>
    <d2p1:Reference>sample string 5</d2p1:Reference>
    <d2p1:RejectionReason>sample string 10</d2p1:RejectionReason>
    <d2p1:SettledAmount>6</d2p1:SettledAmount>
    <d2p1:TotalAmount>7</d2p1:TotalAmount>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfCustomerPaymentlP_S41WJs>