POST POS/Customers/{id}/PaymentModes/CreditCard Try Now
Adds the credit card payment mode.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The customer identifier.
|
string |
Required
|
Body Parameters
The credit card detail.
| Name | Description | Type | Additional information |
|---|---|---|---|
| CardNumber |
The card number.
|
string |
Required
|
| CardName |
The name of the credit/debit card.
|
string |
Required
|
| CVV |
The CVV (Card Verification Value).
|
string |
None.
|
| Type |
The type of credit/debit card, viz.: MasterCard, Visa etc.
|
CardType |
Required
|
| ExpirationYear |
The credit/debit card expiration year.
|
integer |
Required
|
| ExpirationMonth |
The credit/debit card expiration month.
|
integer |
Required
|
| VerifyCard |
A value indicating whether to verify given credit/debit card on braintree or not .
|
boolean |
Optional - Required only if the credit/debit card is valid braintree card.
|
| BillingAddress |
The billing address.
|
BillingInformation |
Optional - Required only if the credit/debit card is valid braintree card.
|
| AddressId |
The address identifier.
|
string |
Optional - Required in case customer wants to use existing payment mode billing information instead of providing billing information.
|
| Nonce |
The nonce.
|
string |
Optional
|
| RegisterGateway |
The value indicating whether to register credit/debit card on braintree gateway or not.
|
boolean |
Optional - Required 'true' in case of valid Braintree card.
|
Request Formats
application/json, text/json
Sample:
{
"CardNumber": "",
"CardName": "",
"CVV": "",
"Type": "None",
"ExpirationYear": 1,
"ExpirationMonth": 1,
"VerifyCard": true,
"BillingAddress": {
"Name": "",
"DisplayName": "",
"Company": "",
"Email": "",
"Phone": "",
"Address1": "",
"Address2": "",
"Zip": "",
"Country": "",
"State": "",
"City": "",
"FirstName": "",
"LastName": ""
},
"AddressId": "",
"Nonce": "",
"RegisterGateway": true
}
Response Information
Resource Description
The newly added credit card details.
| Name | Description | Type | Additional information |
|---|---|---|---|
| PaymentModeId |
The customer's payment mode identifier.
|
string |
None.
|
| CustomerId |
The customer identifier.
|
string |
None.
|
| ModeType |
The type of the payment mode, viz.: CreditCard, Cash, COD, paypal etc.
|
PaymentMode |
None.
|
| CardNumber |
The credit/debit card number.
|
string |
None.
|
| CardType |
The type of credit/debit card, viz.: Visa, Master Card etc.
|
CardType |
None.
|
| ExpirationYear |
The credit/debit card expiration year.
|
integer |
None.
|
| ExpirationMonth |
The credit/debit card expiration month.
|
integer |
None.
|
| CardName |
The name on credit/debit card.
|
string |
None.
|
| PaypalEmail |
The paypal email id.
|
string |
None.
|
| OtherDetail |
The other detail of payment mode "Other".
|
string |
None.
|
| AccountNumber |
The bank account number.
|
string |
None.
|
| BankName |
The bank name.
|
string |
None.
|
| Status |
The payment mode status, viz.: Active, Deleted etc.
|
PaymentModeStatus |
None.
|
| GateWay |
The payment gateway, viz.: Braintree, paypal etc. of respective payment mode.
|
PaymentProcessors |
None.
|
| GateWayToken |
The payment gateway token.
|
string |
None.
|
| GateWayVerified |
A value indicating whether the credit/debit card is verified on respective payment gateway or not.
|
boolean |
None.
|
Response Formats
application/json, text/json
Sample:
{
"PaymentModeId": "",
"CustomerId": "",
"ModeType": "Any",
"CardNumber": "",
"CardType": "None",
"ExpirationYear": 4,
"ExpirationMonth": 5,
"CardName": "",
"PaypalEmail": "",
"OtherDetail": "",
"AccountNumber": "",
"BankName": "",
"Status": "None",
"GateWay": "None",
"GateWayToken": "",
"GateWayVerified": true
}