Delete Tokenized Payment Method¶
Description¶
The deleteTokenizedPaymentMethod endpoint is used to delete a tokenized payment method for a given user.
Request¶
Endpoint¶
/ui/v1/deleteTokenizedPaymentMethod
Method¶
POST
Header¶
Content-Type: application/json
Authorization: Basic $TOKEN
Note
Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.
Given a username of username and a password of password, the request header would appear as follows:
Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Attributes¶
| ELEMENT | DESCRIPTION | FORMAT |
|---|---|---|
| consolidatedPayInfo | Required Array index |
|
| • payments | Required Array index |
|
| •• type | Required Type of payment method being used |
• creditcard • echeck • pinlessdebitcard • paypal |
| •• subscriptionId | Required Payment method's Subscription ID |
|
| •• orderId | Required Order ID of the original tokenization request |
|
| •• paymentGatewayType | Required Array index |
|
| ••• name | Required Name of payment gateway processing the payment |
Payment Gateways |
| id | Required Tokenized payment method's identifier from VELA's database |
15 |
Request Body¶
{
"money": {
"amount": "",
"currency": {
"currencyCode": "USD"
}
},
"paymentType": "SINGLE_PAYMENT",
"consolidatedPayInfo": {
"payments": [{
"type": "creditcard",
"paymentMethodType": "CREDIT_CARD",
"cardNetworkName": "",
"nameOnCard": "",
"firstName": "",
"lastName": "",
"cardNumber": "",
"expiryMonth": "",
"expiryYear": "",
"cvn": "",
"processDebitOrCredit": "",
"refundMethod": {
"name": "ORIGINAL_PAYMENT_METHOD"
},
"refundStatus": {
"name": "FULL"
},
"orderId": "e0d0a037-a5ad-49ea-b05c-fc28a83e4023",
"subscriptionId": "9909000191278244",
"routingNumber": "",
"accountNumber": "",
"bankName": "",
"accountType": "",
"dateOfBirth": "",
"driversLicenseNumber": "",
"driversLicenseState": "AL",
"billingAddress": {
"country": "USA",
"state": "AL",
"city": "",
"addressLine1": "",
"addressLine2": "",
"zipCode": ""
},
"money": {
"amount": "",
"currency": {
"currencyCode": "USD"
}
},
"paymentGatewayType": {
"name": "CYBERSOURCE"
}
}
]
},
"paymentCycle": "ONCE",
"transactionType": {
"name": "AUTH"
},
"ssoEnabledInd": "false",
"threeDSecurePaReq": "",
"threeDSecureURL": "",
"threeDSecureVISAPit": "",
"realexRequestId": "",
"threeDSecureEncodedMD": "",
"password": "password",
"paymentMethodName": "",
"invoiceNumber": "",
"sameAsUserAddress": [false, false],
"id": 5
}
Response¶
{
"id": 5,
"createdDateTime": 1513024990000,
"orderId": "e0d0a037-a5ad-49ea-b05c-fc28a83e4023",
"lastUpdatedDateTime": 1513025222000,
"geolocationInfo": "{\"city\":\"Arnold\",\"country\":{\"name\":\"United States\",\"code\":\"US\"},\"location\":{\"accuracy_radius\":1000,\"latitude\":38.4231,\"longitude\":-90.4006,\"time_zone\":\"America/Chicago\"},\"ip\":\"74.223.27.18\",\"remoteHost\":\"127.0.0.1\",\"userAgent\":\"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36\"}",
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"pymtMthdType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"lastFourDigitsOfAcctNum": "1111",
"responseMsg": "ACCEPT",
"responseCode": "100",
"lockedByUserId": null,
"lockedDateTime": null,
"paymentMethodStatus": {
"value": "Deleted",
"name": "DELETED"
},
"pymtGtwyRefNumber": "5130249905776350704012",
"paymentMethodNickname": "Credit Card 1111",
"useThisPymtMthdAsDefault": false,
"application": {
"id": 1,
"applicationName": "Test Channel",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "Internal",
"name": "INTERNAL"
},
"createdDateTime": 1513010147000,
"companyId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"paymentMethods": [{
"id": 12,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 133,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513025461000,
"lastUpdatedDateTime": null,
"position": 43
}, {
"id": 11,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 101,
"createdUserId": 1,
"lastModifiedUserId": 1,
"createdDateTime": 1513023820000,
"lastUpdatedDateTime": null,
"position": 11
}, {
"id": 13,
"paymentMethodType": {
"value": "eCheck",
"name": "ECHECK"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "eCheck",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513025461000,
"lastUpdatedDateTime": null,
"position": 50
}
],
"createdUserId": 1,
"lastModifiedUserId": 1,
"userCount": null,
"assignedPaymentMethods": null,
"message": null
},
"createdUserId": 3,
"lastModifiedUserId": 3,
"money": {
"amount": null,
"currency": {
"id": null,
"currencyCode": "USD",
"currencyText": null,
"currencySymbol": null,
"fractionalUnit": null,
"numOfDecimalPlaces": null,
"supportedByVisaCheckout": false,
"createdDateTime": null
}
},
"subscriptionId": "9909000191278244",
"authCode": "831000",
"expires": "09/19",
"cardNetworkName": "VISA",
"encryptedPaymentMethod": "uV7zqMZHuuLiQuV+tqRFZrnn45qSL27aBt1LErRGZXQNlRNc17MXj0IZgZyOXkFJnvsIG3t1dIAbG2C9iRL0pGjHLmvWrT1zV7vcsWVfW3jPJzYOg1x3nv5Tk3tM0It5YydMYWOpbS6fhDYjME9TkIACJg/rGq7IzoQIKesPBZ9Qa3oPHQIJ1uwpk44Uywod8NqZmJ5w7MOo9uoh6rSSL38lAg8oYTCMNdz+E2StakSWuQJmf0TttFNpB8o2eTzw5fBbA3LUvJ10R95X75lbH87soXdU2HsNhfLeVtktEFQiy4wMAw/lfMjdzMUrPP/UCXWtb0BEi4QejGo4VoZ4XHXiyb94n9n7LKLONpCCJhW/VT91sjUJXCgWhEdTmMJReHiO0RLyIKrhTz0a9dOkRO71wigTy3AecyBpUgwbYHSpm1S402krEw8YKyMuMNjR/LjFQMl2qjeJtSIxkewvSPznH2BhjDSJYMDu6nuueWwdBFR6MqLN6RogdWuq+QBwLtSUcT1VNh82IGSElh+Flz5HyIXSnM+SpjyWQ1HvIaJqGh63UE/E4GZPTk0Xdrx7D5sHEqQm5IjRGS6aBlPMowk+n3jU6PGFGl4Qe3yW5Rd1nhI8rfd2dmvLmg0OR72N3pU2qilzoFKfIL+cE12gBUb/1aoe2QYVb7Btps+RsxETWM5+NjEvCS2cO0dhDEypOdXFhscYV8Aods3bRBBOJLZ787CPoG8veenLXjCj2qokxnsfdQ1BGUBa71hAU2wH/lzPVpNmPQhnvsz4Jw/GuYtzYKufFZjp17T0uVvd5MpqcIf9o/UGrnyproaSBeOUzG+dMqPTCokRoDFwehwyfAe5uMZOI5md5gkJEYPalaPtND0SH9Z4N+QkEo57rA6dj1JdjntfucVkhgdfckphwPRtV022C3Yix4pe2TuwE2lDWYwO36nO4MF9601u/C3CStnNVQEmykGJ06u5I0084n7sAhv4WxV3u8BevoNo11t/ODxbWz0tgvAG+cGMLzHk+oQAOACxlov+jqZh63FMxw==",
"message": {
"code": "49",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The Payment Method <strong>VISA ending in 1111</strong> is deleted successfully."
},
"cardType": null,
"transactionStatus": {
"value": "Success",
"name": "SUCCESS"
},
"paymentMethodName": "VISA ending in 1111",
"createdUserName": null,
"ipaymentMethod": null
}