POST v1/Generic/PaymentMethodList

Request Information

URI Parameters

None.

Body Parameters

PaymentMethodListRequest
NameDescriptionTypeAdditional information
CustomerId

integer

Required
Token

string

Max length: 50
TokenId

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerId": 1,
  "Token": "sample string 2",
  "TokenId": 1
}

application/xml, text/xml

Sample: 
<PaymentMethodListRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerId>1</CustomerId>
  <Token>sample string 2</Token>
  <TokenId>1</TokenId>
</PaymentMethodListRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PaymentMethodListRequest'.

Response Information

Resource Description

Collection of PaymentMethodSelectResponse
NameDescriptionTypeAdditional information
TokenId

integer

None.
ModifiedDate

date

None.
IsDefault

boolean

None.
CustomerId

integer

Required
Token

string

Required

Max length: 50
PaymentType

string

Required

Max length: 50
AccountType

string

Max length: 50
NickName

string

Max length: 150
NameOnCard

string

Max length: 150
City

string

Max length: 50
StateCode

string

Max length: 10
Zip

string

Max length: 20
CountryCode

string

Max length: 10
EmailAddress

string

Max length: 150
CardType

string

Max length: 50
CardNumber

string

Max length: 50
ExpirationMonth

integer

None.
ExpirationYear

integer

None.
AccountNumber

string

Max length: 50
RoutingNumber

string

Max length: 50
CheckDate

string

Max length: 50
CheckNumber

string

Max length: 50

Response Formats

application/json, text/json

Sample: 
[
  {
    "TokenId": 1,
    "ModifiedDate": "2024-11-21T04:51:34.4811811-05:00",
    "IsDefault": true,
    "CustomerId": 3,
    "Token": "sample string 4",
    "PaymentType": "sample string 5",
    "AccountType": "sample string 6",
    "NickName": "sample string 7",
    "NameOnCard": "sample string 8",
    "City": "sample string 9",
    "StateCode": "sample string 10",
    "Zip": "sample string 11",
    "CountryCode": "sample string 12",
    "EmailAddress": "sample string 13",
    "CardType": "sample string 14",
    "CardNumber": "sample string 15",
    "ExpirationMonth": 1,
    "ExpirationYear": 1,
    "AccountNumber": "sample string 16",
    "RoutingNumber": "sample string 17",
    "CheckDate": "sample string 18",
    "CheckNumber": "sample string 19"
  },
  {
    "TokenId": 1,
    "ModifiedDate": "2024-11-21T04:51:34.4811811-05:00",
    "IsDefault": true,
    "CustomerId": 3,
    "Token": "sample string 4",
    "PaymentType": "sample string 5",
    "AccountType": "sample string 6",
    "NickName": "sample string 7",
    "NameOnCard": "sample string 8",
    "City": "sample string 9",
    "StateCode": "sample string 10",
    "Zip": "sample string 11",
    "CountryCode": "sample string 12",
    "EmailAddress": "sample string 13",
    "CardType": "sample string 14",
    "CardNumber": "sample string 15",
    "ExpirationMonth": 1,
    "ExpirationYear": 1,
    "AccountNumber": "sample string 16",
    "RoutingNumber": "sample string 17",
    "CheckDate": "sample string 18",
    "CheckNumber": "sample string 19"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPaymentMethodSelectResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PaymentMethodSelectResponse>
    <CustomerId>3</CustomerId>
    <Token>sample string 4</Token>
    <PaymentType>sample string 5</PaymentType>
    <AccountType>sample string 6</AccountType>
    <NickName>sample string 7</NickName>
    <NameOnCard>sample string 8</NameOnCard>
    <City>sample string 9</City>
    <StateCode>sample string 10</StateCode>
    <Zip>sample string 11</Zip>
    <CountryCode>sample string 12</CountryCode>
    <EmailAddress>sample string 13</EmailAddress>
    <CardType>sample string 14</CardType>
    <CardNumber>sample string 15</CardNumber>
    <ExpirationMonth>1</ExpirationMonth>
    <ExpirationYear>1</ExpirationYear>
    <AccountNumber>sample string 16</AccountNumber>
    <RoutingNumber>sample string 17</RoutingNumber>
    <CheckDate>sample string 18</CheckDate>
    <CheckNumber>sample string 19</CheckNumber>
    <IsDefault>true</IsDefault>
    <TokenId>1</TokenId>
    <ModifiedDate>2024-11-21T04:51:34.4811811-05:00</ModifiedDate>
  </PaymentMethodSelectResponse>
  <PaymentMethodSelectResponse>
    <CustomerId>3</CustomerId>
    <Token>sample string 4</Token>
    <PaymentType>sample string 5</PaymentType>
    <AccountType>sample string 6</AccountType>
    <NickName>sample string 7</NickName>
    <NameOnCard>sample string 8</NameOnCard>
    <City>sample string 9</City>
    <StateCode>sample string 10</StateCode>
    <Zip>sample string 11</Zip>
    <CountryCode>sample string 12</CountryCode>
    <EmailAddress>sample string 13</EmailAddress>
    <CardType>sample string 14</CardType>
    <CardNumber>sample string 15</CardNumber>
    <ExpirationMonth>1</ExpirationMonth>
    <ExpirationYear>1</ExpirationYear>
    <AccountNumber>sample string 16</AccountNumber>
    <RoutingNumber>sample string 17</RoutingNumber>
    <CheckDate>sample string 18</CheckDate>
    <CheckNumber>sample string 19</CheckNumber>
    <IsDefault>true</IsDefault>
    <TokenId>1</TokenId>
    <ModifiedDate>2024-11-21T04:51:34.4811811-05:00</ModifiedDate>
  </PaymentMethodSelectResponse>
</ArrayOfPaymentMethodSelectResponse>