POST v1/Generic/PaymentMethodInsert

Creates new payment method for a customer. PaymentType needs to be "Credit Card" or "ACH".

This is secure method and requires below attributes in header

Authorization: PRC Authorize Token
Authorization: Midnight Authorize Token
MISKEY: MIS Key

Request Information

URI Parameters

None.

Body Parameters

PaymentMethodInsertRequest object representing new payment method.

PaymentMethodInsertRequest
NameDescriptionTypeAdditional information
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
IsDefault

Provide to Make the Payment Method as Default

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerId": 1,
  "Token": "sample string 2",
  "PaymentType": "sample string 3",
  "AccountType": "sample string 4",
  "NickName": "sample string 5",
  "NameOnCard": "sample string 6",
  "City": "sample string 7",
  "StateCode": "sample string 8",
  "Zip": "sample string 9",
  "CountryCode": "sample string 10",
  "EmailAddress": "sample string 11",
  "CardType": "sample string 12",
  "CardNumber": "sample string 13",
  "ExpirationMonth": 1,
  "ExpirationYear": 1,
  "AccountNumber": "sample string 14",
  "RoutingNumber": "sample string 15",
  "CheckDate": "sample string 16",
  "CheckNumber": "sample string 17",
  "IsDefault": true
}

application/xml, text/xml

Sample: 
<PaymentMethodInsertRequest 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>
  <PaymentType>sample string 3</PaymentType>
  <AccountType>sample string 4</AccountType>
  <NickName>sample string 5</NickName>
  <NameOnCard>sample string 6</NameOnCard>
  <City>sample string 7</City>
  <StateCode>sample string 8</StateCode>
  <Zip>sample string 9</Zip>
  <CountryCode>sample string 10</CountryCode>
  <EmailAddress>sample string 11</EmailAddress>
  <CardType>sample string 12</CardType>
  <CardNumber>sample string 13</CardNumber>
  <ExpirationMonth>1</ExpirationMonth>
  <ExpirationYear>1</ExpirationYear>
  <AccountNumber>sample string 14</AccountNumber>
  <RoutingNumber>sample string 15</RoutingNumber>
  <CheckDate>sample string 16</CheckDate>
  <CheckNumber>sample string 17</CheckNumber>
  <IsDefault>true</IsDefault>
</PaymentMethodInsertRequest>

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 'PaymentMethodInsertRequest'.

Response Information

Response Formats

application/json, text/json

Sample: 
"sample string 1"

application/xml, text/xml

Sample: 
<string>sample string 1</string>