POST v1/Generic/PaymentMethodList

Get saved payment method list for a customer based on CustomerID

Request Information

URI Parameters

None.

Body Parameters

PaymentMethodListRequest object for input filtering.

PaymentMethodListRequest
NameDescriptionTypeAdditional information
CustomerId

Provide the CustomerId

 integer

Required
Token

Provide the Token - null if no filter

 string

Max length: 50
TokenId

Provide the TokenId (PK - FSCustomerPaymentTokenId) - null if no filter

 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

List of PaymentMethodSelectResponse objects

Collection of PaymentMethodSelectResponse
NameDescriptionTypeAdditional information
TokenId

Provide the TokenId (PK - FSCustomerPaymentTokenId)

 integer

None.
ModifiedDate

Provide the ModifiedDate

 date

None.
IsDefault

Is Default

 boolean

None.
CustomerId

Provide the CustomerId

 integer

Required
Token

Provide the Token

 string

Required

Max length: 50
PaymentType

Provide the PaymentType (Credit Card / ACH)

 string

Required

Max length: 50
AccountType

Provide the Account Type (FS paymentMethod: Discover, Visa, PersonalChecking, BusinessSavings, etc.)

 string

Max length: 50
NickName

Provide the NickName

 string

Max length: 150
NameOnCard

Provide the NameOnCard (aka NameOnAccount)

 string

Max length: 150
City

Provide the City

 string

Max length: 50
StateCode

Provide the StateCode

 string

Max length: 10
Zip

Provide the Zip

 string

Max length: 20
CountryCode

Provide the CountryCode

 string

Max length: 10
EmailAddress

Provide the EmailAddress

 string

Max length: 150
CardType

Provide the CardType

 string

Max length: 50
CardNumber

Provide the CardNumber

 string

Max length: 50
ExpirationMonth

Provide the ExpirationMonth

 integer

None.
ExpirationYear

Provide the ExpirationYear

 integer

None.
AccountNumber

Provide the Account Number

 string

Max length: 50
RoutingNumber

Provide the Routing Number

 string

Max length: 50
CheckDate

Provide the Check Date

 string

Max length: 50
CheckNumber

Provide the Check Number

 string

Max length: 50

Response Formats

application/json, text/json

Sample: 
[
  {
    "TokenId": 1,
    "ModifiedDate": "2025-06-01T02:47:02.5668264+00: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": "2025-06-01T02:47:02.5668264+00: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>2025-06-01T02:47:02.5668264+00: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>2025-06-01T02:47:02.5668264+00:00</ModifiedDate>
  </PaymentMethodSelectResponse>
</ArrayOfPaymentMethodSelectResponse>