GET v1/PaymentAccount/CreditCard?PolicyNumber={PolicyNumber}

Retrieve Credit Card Details

Request Information

URI Parameters

Name	Description	Type	Additional information
PolicyNumber		string	Required

Body Parameters

None.

Response Information

Resource Description

Retrieve Credit Card Details

Collection of CreditCardOutboundDTO

Name	Description	Type	Additional information
Last4Digits	Last 4 digits of credit card number	string	Required
CreditCardType	Card network / provider (e.g. Visa, MasterCard)	CreditCardTypeEnum	Required
MonthOfExpirationDate	Expiration month (January = 1)	integer	Required Range: inclusive between 1 and 12
YearOfExpirationDate	Two or four digit year (e.g. 21 or 2021)	integer	Required
CardHolderName		string	Required
CardHolderAddress		AddressDTO	Required
Id	Primary Id	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Last4Digits": "sample string 1",
    "CreditCardType": "Unknown",
    "MonthOfExpirationDate": 1,
    "YearOfExpirationDate": 2002,
    "CardHolderName": "sample string 3",
    "CardHolderAddress": {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "County": "sample string 5",
      "Country": "sample string 6",
      "Zipcode1": "sample string 7",
      "Zipcode2": "sample string 8",
      "Id": 9
    },
    "Id": 4
  },
  {
    "Last4Digits": "sample string 1",
    "CreditCardType": "Unknown",
    "MonthOfExpirationDate": 1,
    "YearOfExpirationDate": 2002,
    "CardHolderName": "sample string 3",
    "CardHolderAddress": {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "County": "sample string 5",
      "Country": "sample string 6",
      "Zipcode1": "sample string 7",
      "Zipcode2": "sample string 8",
      "Id": 9
    },
    "Id": 4
  }
]

application/xml, text/xml

Sample:

<ArrayOfCreditCardOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <CreditCardOutboundDTO>
    <Expand xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models"></Expand>
    <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models" />
    <Id xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">4</Id>
    <CardHolderAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
      <d3p1:Expand></d3p1:Expand>
      <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
      <d3p1:Id>9</d3p1:Id>
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 5</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1>
      <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2>
    </CardHolderAddress>
    <CardHolderName>sample string 3</CardHolderName>
    <CreditCardType>Unknown</CreditCardType>
    <Last4Digits>sample string 1</Last4Digits>
    <MonthOfExpirationDate>1</MonthOfExpirationDate>
    <YearOfExpirationDate>2002</YearOfExpirationDate>
  </CreditCardOutboundDTO>
  <CreditCardOutboundDTO>
    <Expand xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models"></Expand>
    <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models" />
    <Id xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">4</Id>
    <CardHolderAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
      <d3p1:Expand></d3p1:Expand>
      <d3p1:Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
      <d3p1:Id>9</d3p1:Id>
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 5</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zipcode1>sample string 7</d3p1:Zipcode1>
      <d3p1:Zipcode2>sample string 8</d3p1:Zipcode2>
    </CardHolderAddress>
    <CardHolderName>sample string 3</CardHolderName>
    <CreditCardType>Unknown</CreditCardType>
    <Last4Digits>sample string 1</Last4Digits>
    <MonthOfExpirationDate>1</MonthOfExpirationDate>
    <YearOfExpirationDate>2002</YearOfExpirationDate>
  </CreditCardOutboundDTO>
</ArrayOfCreditCardOutboundDTO>