Delete Tokenized Payment Method
Description¶
The deleteTokenizedPaymentMethod endpoint is used to delete a tokenized payment method for a given user.
Request¶
Endpoint¶
/ui/v1/deleteTokenizedPaymentMethodMethod¶
POSTHeader¶
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",
"isoNumericCode": ""
}
},
"paymentType": "SINGLE_PAYMENT",
"consolidatedPayInfo": {
"payments": [{
"type": "creditcard",
"paymentMethodType": "CREDIT_CARD",
"cardNetworkName": "",
"nameOnCard": "",
"firstName": "",
"lastName": "",
"cardNumber": "",
"expiryMonth": "",
"expiryYear": "",
"cvn": "",
"cardSwipe": false,
"posKeyed": false,
"emvContact": false,
"geolocation": "{\"city\":\"Duluth\",\"country\":{\"code\":\"US\",\"name\":\"United States\"},\"timestamp\":1603906864946,\"location\":{\"latitude\":34.0492288,\"longitude\":-84.18754559999999,\"address\":\"620 Oakmont Hill, Duluth, GA 30097, USA\",\"placeId\":\"ChIJW96-njKf9YgR_A1VmLcvgqI\",\"altitude\":null,\"accuracy_radius\":3913,\"altitudeAccuracy\":null,\"heading\":null,\"speed\":null,\"time_zone\":\"America/New_York\"},\"userAgent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.111 Safari/537.36\",\"ip\":\"71.140.147.103\",\"remoteHost\":\"\"}",
"processDebitOrCredit": "",
"refundMethod": {
"name": "ORIGINAL_PAYMENT_METHOD"
},
"refundStatus": {
"name": "NONE"
},
"voidStatus": {
"name": "NONE"
},
"orderId": "u82wh2hmwgfo",
"subscriptionId": "116556708",
"routingNumber": "",
"accountNumber": "",
"reEnterAccountNumber": "",
"accountHolderName": "",
"bankName": "",
"accountType": "",
"dateOfBirth": "",
"driversLicenseNumber": "",
"driversLicenseState": null,
"billingAddress": {
"country": "USA",
"state": null,
"city": "",
"addressLine1": "",
"addressLine2": "",
"addressLine3": "",
"zipCode": ""
},
"money": {
"amount": "",
"currency": {
"currencyCode": "USD",
"isoNumericCode": ""
}
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"payWith": "CARD_NOT_PRESENT",
"posTerminalId": "",
"arqcData": "",
"trackData1": "",
"trackData2": "",
"encryptedTrack1": "",
"encryptedTrack2": "",
"encryptedTrack": false,
"posEntryMode": {
"name": "MANUAL_ENTRY_WIRED"
},
"authCode": "",
"convenienceFees": 0
}]
},
"paymentCycle": "ONCE",
"transactionType": {
"name": "PRE_AUTHORIZATION"
},
"ssoEnabledInd": "false",
"threeDSecurePaReq": "",
"threeDSecureURL": "",
"threeDSecureVISAPit": "",
"realexRequestId": "",
"threeDSecureEncodedMD": "",
"password": "password",
"paymentMethodName": "",
"invoiceNumber": "",
"voidReason": "",
"refundReason": "",
"transactionCategory": {
"name": "CARD_NOT_PRESENT"
},
"paymentAction": {
"name": "PRE_AUTHORIZATION"
},
"memo": "",
"addProfileAsPartOfAuthRequest": false,
"merchantId": "",
"channel": {
"id": ""
},
"userRole": "",
"uiType": "",
"emailAddress": "",
"reEnterEmailAddress": "",
"recurringInd": false,
"id": 162,
"createdUserId": "",
"disablePaymentType": false,
"disableAmount": false,
"digitalSignature": "",
"agreeToPayInd": false,
"agreeToAcceptRefundInd": false,
"goodsAndServicesPurchaseType": {
"name": "UNKNOWN"
},
"checkInDate": "",
"checkOutDate": "",
"bookingNumber": "",
"groupName": "",
"customerName": "",
"merchantLocation": null,
"customerId": "",
"numberOfCards": "1",
"confirmationInd": false,
"productCode": null,
"geolocation": "{\"city\":\"Duluth\",\"country\":{\"code\":\"US\",\"name\":\"United States\"},\"timestamp\":1603906864946,\"location\":{\"latitude\":34.0492288,\"longitude\":-84.18754559999999,\"address\":\"620 Oakmont Hill, Duluth, GA 30097, USA\",\"placeId\":\"ChIJW96-njKf9YgR_A1VmLcvgqI\",\"altitude\":null,\"accuracy_radius\":3913,\"altitudeAccuracy\":null,\"heading\":null,\"speed\":null,\"time_zone\":\"America/New_York\"},\"userAgent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.111 Safari/537.36\",\"ip\":\"71.140.147.103\",\"remoteHost\":\"\"}"
}
Response¶
{
"id": 162,
"createdDateTime": 1603907176000,
"orderId": "u82wh2hmwgfo",
"lastUpdatedDateTime": null,
"encryptedGeolocationInfo": "i8VOiBH4rtgAtne4yrQsmmaH76WPa5kih1wtIbjdOvhfT7bl/Xogshsi78El66jk/16bP7lkGAPocHn1p/zKZTWkSjpJXie+1Hgr2r+KcHpIXZDI24E654VKcQdojs3l8OZUbYlFB4GusIabcz+QY/wHf3is3L9CtyFYGudGSChGzNShUe1LlgKbY+fFnPS7DKcskYkDkzNB6eurrbw7EddV7/tzYhz98aYamQLKAMVjFpBGgy3+94lpUY3myk2ApquS3xrZX83kRNFYlBan3j6TYSsgQuc0JaKqUM4tFd+yEMMzYiXA9pWzCtTPwq9Dum6P3+jAhyyjta/TG7ftmdHeeYvV8d0yvb3cgIlamBQjqQ2op1aDdXMi4vTGtSVTyBDuy9VlFa6iX0a9r4h2eRalKHYQiiyuEA/bfb4jZuY/DBuhHSLdiqFxC0T+dRV67NiCRMvJD24asBFSaAcqPZniVcnjng4pvmdPQql9JftflQhz82wm2zvlU8Hwgvr0iv7hG/VUyR8BuOhDskmseQsCQMJ9GChMQmhFu1KJyMWi66ekQq/B0SHudy1l/1XeAsel3qGqgf5Oan4bBpRcg+M013jSFNVfyvo2ssoBn6GOWd8ss4rXuiR82YNKag/Zr0LZSpoF6HEwCb2c5+kO4rjz4Jas+3/SlyDMelaH3hooebpCafyLBG+4N8I0bsJmLhX8wN5BnwfJUJufTqwDoA==",
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"pymtMthdType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"lastFourDigitsOfAcctNum": "4113",
"responseMsg": "Profile Created",
"responseCode": "0",
"lockedByUserId": null,
"lockedDateTime": null,
"paymentMethodStatus": {
"value": "Failed",
"name": "FAILED"
},
"pymtGtwyRefNumber": "5F99AE6752D46F28EBE623F5E2537D22F51B54EB",
"paymentMethodNickname": "Customer's VISA ending in 4113",
"useThisPymtMthdAsDefault": false,
"channel": {
"id": 40,
"channelName": "Chase Paymentech-Orbital",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "External",
"name": "EXTERNAL"
},
"createdDateTime": 1535552429000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 158,
"industryType": {
"value": "eCommerce",
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": true,
"allowMoneyOrderAsPaymentMethodInd": true,
"allowPaperCheckAsPaymentMethodInd": true,
"paymentMethods": [{
"id": 317,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 712,
"createdUserId": 40,
"lastModifiedUserId": 158,
"createdDateTime": 1591650449000,
"lastUpdatedDateTime": null,
"position": 43
}, {
"id": 326,
"paymentMethodType": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 40,
"lastModifiedUserId": 158,
"createdDateTime": 1591650449000,
"lastUpdatedDateTime": null,
"position": 52
}, {
"id": 327,
"paymentMethodType": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"cardId": null,
"createdUserId": 40,
"lastModifiedUserId": 158,
"createdDateTime": 1591650450000,
"lastUpdatedDateTime": null,
"position": 53
}, {
"id": 306,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 701,
"createdUserId": 40,
"lastModifiedUserId": 158,
"createdDateTime": 1591650449000,
"lastUpdatedDateTime": null,
"position": 32
}],
"allowDynamicRoutingCapabilityInd": false,
"secondaryPaymentGateway": null,
"tertiaryPaymentGateway": null,
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"createdUserId": 40,
"lastModifiedUserId": null,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1531511916000,
"isoNumericCode": "840"
},
"subscriptionId": "116556708",
"authCode": "090503",
"expires": "03/23",
"cardNetworkName": {
"value": "VISA",
"name": "VISA"
},
"encryptedPaymentMethod": "uV7zqMZHuuLiQuV+tqRFZrnn45qSL27aBt1LErRGZXQNlRNc17MXj0IZgZyOXkFJk3P8YzFbamc1jSypxbFsOH0PCAoQz0NcEME6PXsHipQzD8/FT+HZF67oK5U1KzDT1fBP+TgPFWOshVMoO/TSFsR9iR1MNfT8QLmPOD87om6KpvLPI4SkjmXJ30xUUNm6Wt6uSDbp1jtuykptSCEwpE1MmP8EIZMeSOG7aGDdPxizoORSBfYxBwHhgCj/wUsc91bUelk+FjRkU3zo9CWMOI4FWPN9j/UyfFOpzTd/DbrzsPhlFlaq9JWdh6qebrG4hWsyvPGMyAixsE0ivuh3WItda2X/RKl8w8qKCWTN7/C3QPsIE5sQyNiNpM8JcoF+VfDF8Kpyzfd5ta3O+6fC0OcCGtuaHqK0kMCxTEQ0hfo33jtI9E/DSMoivEhnaNlfHwm+YcCQdcrxypJf8aJEsnZlBJ4fyghtcyKLNJr7IOtpneFUJYKb7pQtwjvWLdSGnnuwf3wtM+3QRD8HVYYaTmr7+S2DbWaH6+WnAQhzhLM8Ym96teMpwVbV3QwH9cIBBaZz6wO6biU4N5sa8UUYfJgx7SsZw2SQ908P55SZ6lIto0iTybK5ppXqsxebUh3vEpWSbU0rtfOunqSMRXwQ+Ijbt5Ne0o89ATFnB3G+CYYycRhFwJ+vQ3aXKJj+1z2V0duN/pMGSAoa8Ss5jGjOTgbVIe9fBgFtNFSAiPxAQ2AlYPS5Wofyjcm9JlkyioR/Be1uriKYQv82Lchdlsya4wC/I9xaYpW4qYcAl8qHmQhfPbrSEvcDjHa38ss7L5u3gxAxMUnmiMETIbnLzK1Xa436Bsna3X2zpEt4rWprb72uRf9BY+P4VyJM+XnzlsHw4mQaKnuJKH3ZSrkXwPpA7O5kabd0bH2R0rDLj7ejbxx8Wkrodh+Qe+zd0kqE4LSD+j+DXAZH7vP5Hx+fyFV7e/HdZEzDM1sW83D71ImFDaNYdkU7UuJ0GxPmnxPuRqSuJKx9xFFF8BtbWAvjs+4RS+BUN7D3BSbEuPiCQlZZhhp7WHFx5mxdZ9d/yZBkdtLl1wQgy2XO0swbfxYzWgJwNV02MoB0rHjaCSdv9PUl/f9WGfTJQiR/5D0IeMVTa0YVy2R7u8N6vjBa6b6OHHxPRgfxmhrPhwryW0D3LYay681DjLuL4Q4umoAncTz8iBch0GRked6I279ZoOwyMFaaKyuWzSRvwQuZ3Sy+/uR48kzRymkVxQFMWn65DEDjh3mhoAqeik2M4ayX9yRnv/IWvkbU2KC0TpW68bTj4j9Te+UJhL/hQTK5gvpm+h/XfuoBqhuPdR2eP+vbb1SLTUn1jj0KCbL2BQEcbxxvSKpNioaytvwzbwGSu6uKGC1ENK6TejDgaLM88TXtu17FavaBAST+I7EiCf5nLor9FCfrlhca6zYelD/jaUVWXebd4ShA9gMH6l9Q6whlFlZUeL09v2jnE/VqJNTpojnmQo1PkN+gl8I3Bn8iKfSXYovzcFQgRSNsO40ieqZfLlkTT+QR12jQ8hKg9vFjLAUjzyUeLo27+bdy4YI86G+cZrfSNx9vHuWAjAst4D1POk4I8rklh1zMhK9+UTnzFf9NrpyTPzZRJpt1CpBR2/vHxm4WaE5P63gjS+yZusfvaOxsDKD0diIaT1Y1X7L6VstdqI8IGWFf2r/oM7i3h3sDt/V+yzVCT7SDwHF4VdirRkZxqgJB7zreQiNKwsPAYZIlbC21zqpwTBPzN6hB3IJYXMeWZ6YtVwoeEuX3aWYxW2IKr7HaabTdLBMkJio3+3Vw1Lo88NWn86z7ypfE1QZAokLaqhoD7a+w0gjcJWCCadM9ypvQChwFLuXNXZV77E+K9nHEuXSVMQvh/zBJTEgTdwUA8IiihoVGb3jHL3Kf1sRF4gWvEVSUDlpmWx07sOlDPpb2zInM9qNVIfhrL/A+13pxB1YTaZgDotKDeLTyKfmWeVBplvhdtVUZxi5lj6bOXd6YnqDRk4Qa2Ylv8B5bqkRJEKh6k20QFEtvCOG1AqtjfOVXxGcZ2QNSNgMGZpe2mRXmwyMtWOuX/6GcImy47VDUIaeh9Wu4xviOX+5VgKMwMi4sSXQS30IbWblvn3Aik+mUVfQ=",
"merchantId": 1,
"message": {
"code": "49",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The Payment Method <strong>VISA ending in 4113</strong> has been deleted successfully."
},
"cardType": null,
"iPaymentMethod": null,
"paymentMethodName": "VISA ending in 4113",
"createdUserName": null,
"geolocation": null,
"merchantName": null,
"ipaymentMethod": null
}
Updated As Of Version 3.3.0.5