GET api/Payment/GetPaymentsForPrimaryMember

GetPayment Invoices For PrimaryMember

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of PaymentInvoices

Name	Type	Additional information
PolicyType	string	None.
PolicyId	integer	None.
PolicyNumber	string	None.
ProductId	integer	None.
ProductName	string	None.
EffectiveDate	date	None.
RenewalDate	date	None.
PaymentGateway	string	None.
PolicylDueAmount	decimal number	None.
CreditAmount	decimal number	None.
PaymentMode	string	None.
PaymentFrequency	string	None.
PolicyStatus	string	None.
ProfitRegion	string	None.
TPA	string	None.
Currency	string	None.
RVFReferenceId	string	None.
CountryOfResidence	string	None.
IsReadyForPayment	boolean	None.
IsPaymentSuccess	boolean	None.
IsRenewalShow	boolean	None.
IsRVFRequiredProduct	boolean	None.
MemberDetails	EntityDetails	None.
Invoices	Collection of InvoiceDetails	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PolicyType": "sample string 1",
    "PolicyId": 2,
    "PolicyNumber": "sample string 3",
    "ProductId": 1,
    "ProductName": "sample string 4",
    "EffectiveDate": "2025-05-02T07:47:10.6374635-07:00",
    "RenewalDate": "2025-05-02T07:47:10.6374635-07:00",
    "PaymentGateway": "sample string 5",
    "PolicylDueAmount": 1.0,
    "CreditAmount": 1.0,
    "PaymentMode": "sample string 6",
    "PaymentFrequency": "sample string 7",
    "PolicyStatus": "sample string 8",
    "ProfitRegion": "sample string 9",
    "TPA": "sample string 10",
    "Currency": "sample string 11",
    "RVFReferenceId": "sample string 12",
    "CountryOfResidence": "sample string 13",
    "IsReadyForPayment": true,
    "IsPaymentSuccess": true,
    "IsRenewalShow": true,
    "IsRVFRequiredProduct": true,
    "MemberDetails": {
      "EntityId": 1,
      "IndividualId": "sample string 2",
      "MembershipNumber": "sample string 3",
      "FirstName": "sample string 4",
      "Surname": "sample string 5",
      "Title": "sample string 6",
      "Initials": "sample string 7",
      "Email": "sample string 8"
    },
    "Invoices": [
      {
        "InvoiceId": 1,
        "InvoiceDate": "2025-05-02T07:47:10.6374635-07:00",
        "DueDate": "2025-05-02T07:47:10.6374635-07:00",
        "InvoicedAmount": 1.0,
        "PaidAmount": 2.0,
        "WriteOffAmount": 3.0,
        "AppliedAmount": 4.0,
        "AmountCancelled": 5.0,
        "InvoiceDueAmount": 1.0,
        "PayStatus": "sample string 6"
      },
      {
        "InvoiceId": 1,
        "InvoiceDate": "2025-05-02T07:47:10.6374635-07:00",
        "DueDate": "2025-05-02T07:47:10.6374635-07:00",
        "InvoicedAmount": 1.0,
        "PaidAmount": 2.0,
        "WriteOffAmount": 3.0,
        "AppliedAmount": 4.0,
        "AmountCancelled": 5.0,
        "InvoiceDueAmount": 1.0,
        "PayStatus": "sample string 6"
      }
    ]
  },
  {
    "PolicyType": "sample string 1",
    "PolicyId": 2,
    "PolicyNumber": "sample string 3",
    "ProductId": 1,
    "ProductName": "sample string 4",
    "EffectiveDate": "2025-05-02T07:47:10.6374635-07:00",
    "RenewalDate": "2025-05-02T07:47:10.6374635-07:00",
    "PaymentGateway": "sample string 5",
    "PolicylDueAmount": 1.0,
    "CreditAmount": 1.0,
    "PaymentMode": "sample string 6",
    "PaymentFrequency": "sample string 7",
    "PolicyStatus": "sample string 8",
    "ProfitRegion": "sample string 9",
    "TPA": "sample string 10",
    "Currency": "sample string 11",
    "RVFReferenceId": "sample string 12",
    "CountryOfResidence": "sample string 13",
    "IsReadyForPayment": true,
    "IsPaymentSuccess": true,
    "IsRenewalShow": true,
    "IsRVFRequiredProduct": true,
    "MemberDetails": {
      "EntityId": 1,
      "IndividualId": "sample string 2",
      "MembershipNumber": "sample string 3",
      "FirstName": "sample string 4",
      "Surname": "sample string 5",
      "Title": "sample string 6",
      "Initials": "sample string 7",
      "Email": "sample string 8"
    },
    "Invoices": [
      {
        "InvoiceId": 1,
        "InvoiceDate": "2025-05-02T07:47:10.6374635-07:00",
        "DueDate": "2025-05-02T07:47:10.6374635-07:00",
        "InvoicedAmount": 1.0,
        "PaidAmount": 2.0,
        "WriteOffAmount": 3.0,
        "AppliedAmount": 4.0,
        "AmountCancelled": 5.0,
        "InvoiceDueAmount": 1.0,
        "PayStatus": "sample string 6"
      },
      {
        "InvoiceId": 1,
        "InvoiceDate": "2025-05-02T07:47:10.6374635-07:00",
        "DueDate": "2025-05-02T07:47:10.6374635-07:00",
        "InvoicedAmount": 1.0,
        "PaidAmount": 2.0,
        "WriteOffAmount": 3.0,
        "AppliedAmount": 4.0,
        "AmountCancelled": 5.0,
        "InvoiceDueAmount": 1.0,
        "PayStatus": "sample string 6"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentInvoices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Data.Models.Payment">
  <PaymentInvoices>
    <CountryOfResidence>sample string 13</CountryOfResidence>
    <CreditAmount>1</CreditAmount>
    <Currency>sample string 11</Currency>
    <EffectiveDate>2025-05-02T07:47:10.6374635-07:00</EffectiveDate>
    <Invoices>
      <InvoiceDetails>
        <AmountCancelled>5</AmountCancelled>
        <AppliedAmount>4</AppliedAmount>
        <DueDate>2025-05-02T07:47:10.6374635-07:00</DueDate>
        <InvoiceDate>2025-05-02T07:47:10.6374635-07:00</InvoiceDate>
        <InvoiceDueAmount>1</InvoiceDueAmount>
        <InvoiceId>1</InvoiceId>
        <InvoicedAmount>1</InvoicedAmount>
        <PaidAmount>2</PaidAmount>
        <PayStatus>sample string 6</PayStatus>
        <WriteOffAmount>3</WriteOffAmount>
      </InvoiceDetails>
      <InvoiceDetails>
        <AmountCancelled>5</AmountCancelled>
        <AppliedAmount>4</AppliedAmount>
        <DueDate>2025-05-02T07:47:10.6374635-07:00</DueDate>
        <InvoiceDate>2025-05-02T07:47:10.6374635-07:00</InvoiceDate>
        <InvoiceDueAmount>1</InvoiceDueAmount>
        <InvoiceId>1</InvoiceId>
        <InvoicedAmount>1</InvoicedAmount>
        <PaidAmount>2</PaidAmount>
        <PayStatus>sample string 6</PayStatus>
        <WriteOffAmount>3</WriteOffAmount>
      </InvoiceDetails>
    </Invoices>
    <IsPaymentSuccess>true</IsPaymentSuccess>
    <IsRVFRequiredProduct>true</IsRVFRequiredProduct>
    <IsReadyForPayment>true</IsReadyForPayment>
    <IsRenewalShow>true</IsRenewalShow>
    <MemberDetails>
      <Email>sample string 8</Email>
      <EntityId>1</EntityId>
      <FirstName>sample string 4</FirstName>
      <IndividualId>sample string 2</IndividualId>
      <Initials>sample string 7</Initials>
      <MembershipNumber>sample string 3</MembershipNumber>
      <Surname>sample string 5</Surname>
      <Title>sample string 6</Title>
    </MemberDetails>
    <PaymentFrequency>sample string 7</PaymentFrequency>
    <PaymentGateway>sample string 5</PaymentGateway>
    <PaymentMode>sample string 6</PaymentMode>
    <PolicyId>2</PolicyId>
    <PolicyNumber>sample string 3</PolicyNumber>
    <PolicyStatus>sample string 8</PolicyStatus>
    <PolicyType>sample string 1</PolicyType>
    <PolicylDueAmount>1</PolicylDueAmount>
    <ProductId>1</ProductId>
    <ProductName>sample string 4</ProductName>
    <ProfitRegion>sample string 9</ProfitRegion>
    <RVFReferenceId>sample string 12</RVFReferenceId>
    <RenewalDate>2025-05-02T07:47:10.6374635-07:00</RenewalDate>
    <TPA>sample string 10</TPA>
  </PaymentInvoices>
  <PaymentInvoices>
    <CountryOfResidence>sample string 13</CountryOfResidence>
    <CreditAmount>1</CreditAmount>
    <Currency>sample string 11</Currency>
    <EffectiveDate>2025-05-02T07:47:10.6374635-07:00</EffectiveDate>
    <Invoices>
      <InvoiceDetails>
        <AmountCancelled>5</AmountCancelled>
        <AppliedAmount>4</AppliedAmount>
        <DueDate>2025-05-02T07:47:10.6374635-07:00</DueDate>
        <InvoiceDate>2025-05-02T07:47:10.6374635-07:00</InvoiceDate>
        <InvoiceDueAmount>1</InvoiceDueAmount>
        <InvoiceId>1</InvoiceId>
        <InvoicedAmount>1</InvoicedAmount>
        <PaidAmount>2</PaidAmount>
        <PayStatus>sample string 6</PayStatus>
        <WriteOffAmount>3</WriteOffAmount>
      </InvoiceDetails>
      <InvoiceDetails>
        <AmountCancelled>5</AmountCancelled>
        <AppliedAmount>4</AppliedAmount>
        <DueDate>2025-05-02T07:47:10.6374635-07:00</DueDate>
        <InvoiceDate>2025-05-02T07:47:10.6374635-07:00</InvoiceDate>
        <InvoiceDueAmount>1</InvoiceDueAmount>
        <InvoiceId>1</InvoiceId>
        <InvoicedAmount>1</InvoicedAmount>
        <PaidAmount>2</PaidAmount>
        <PayStatus>sample string 6</PayStatus>
        <WriteOffAmount>3</WriteOffAmount>
      </InvoiceDetails>
    </Invoices>
    <IsPaymentSuccess>true</IsPaymentSuccess>
    <IsRVFRequiredProduct>true</IsRVFRequiredProduct>
    <IsReadyForPayment>true</IsReadyForPayment>
    <IsRenewalShow>true</IsRenewalShow>
    <MemberDetails>
      <Email>sample string 8</Email>
      <EntityId>1</EntityId>
      <FirstName>sample string 4</FirstName>
      <IndividualId>sample string 2</IndividualId>
      <Initials>sample string 7</Initials>
      <MembershipNumber>sample string 3</MembershipNumber>
      <Surname>sample string 5</Surname>
      <Title>sample string 6</Title>
    </MemberDetails>
    <PaymentFrequency>sample string 7</PaymentFrequency>
    <PaymentGateway>sample string 5</PaymentGateway>
    <PaymentMode>sample string 6</PaymentMode>
    <PolicyId>2</PolicyId>
    <PolicyNumber>sample string 3</PolicyNumber>
    <PolicyStatus>sample string 8</PolicyStatus>
    <PolicyType>sample string 1</PolicyType>
    <PolicylDueAmount>1</PolicylDueAmount>
    <ProductId>1</ProductId>
    <ProductName>sample string 4</ProductName>
    <ProfitRegion>sample string 9</ProfitRegion>
    <RVFReferenceId>sample string 12</RVFReferenceId>
    <RenewalDate>2025-05-02T07:47:10.6374635-07:00</RenewalDate>
    <TPA>sample string 10</TPA>
  </PaymentInvoices>
</ArrayOfPaymentInvoices>

GET api/Payment/GetPaymentsForPrimaryMember

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body