POST v1/Generic/PaymentMethodUpdate
Updates existing Payment Method for a customer
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
PaymentMethodUpdateRequest
PaymentMethodUpdateRequestName | Description | Type | Additional information |
---|---|---|---|
CustomerId |
Provide the CustomerId |
integer |
Required |
TokenId |
Provide the TokenId (PK - FSCustomerPaymentTokenId) |
integer |
None. |
Token |
Provide the Token |
string |
Max length: 50 |
PaymentType |
Provide the PaymentType (Credit Card / ACH) |
string |
Required 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 |
ExpirationMonth |
Provide the ExpirationMonth |
integer |
None. |
ExpirationYear |
Provide the ExpirationYear |
integer |
None. |
IsDefault | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "CustomerId": 1, "TokenId": 1, "Token": "sample string 2", "PaymentType": "sample string 3", "NickName": "sample string 4", "NameOnCard": "sample string 5", "City": "sample string 6", "StateCode": "sample string 7", "Zip": "sample string 8", "CountryCode": "sample string 9", "EmailAddress": "sample string 10", "ExpirationMonth": 11, "ExpirationYear": 12, "IsDefault": true }
application/xml, text/xml
Sample:
<PaymentMethodUpdateRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <CustomerId>1</CustomerId> <TokenId>1</TokenId> <Token>sample string 2</Token> <PaymentType>sample string 3</PaymentType> <NickName>sample string 4</NickName> <NameOnCard>sample string 5</NameOnCard> <City>sample string 6</City> <StateCode>sample string 7</StateCode> <Zip>sample string 8</Zip> <CountryCode>sample string 9</CountryCode> <EmailAddress>sample string 10</EmailAddress> <ExpirationMonth>11</ExpirationMonth> <ExpirationYear>12</ExpirationYear> <IsDefault>true</IsDefault> </PaymentMethodUpdateRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Response Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string>sample string 1</string>