Get Tokenized Payment Method
Description¶
The getTokenizedPaymentMethod endpoint is used to retrieve a tokenized payment method for a given user.
Request¶
Endpoint¶
/ui/v1/getTokenizedPaymentMethodMethod¶
POSTHeader¶
Content-Type: application/json
Authorization: $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: 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 | Conditional Required when modifying a payment method 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": "VISA",
"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": "37a90d61-7317-4a44-99ff-dd09a9a70ac9",
"subscriptionId": "9909000307224009",
"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": "CyberSource",
"name": "CYBERSOURCE"
},
"payWith": "CARD_NOT_PRESENT",
"posTerminalId": "",
"arqcData": "",
"trackData1": "",
"trackData2": "",
"encryptedTrack1": "",
"encryptedTrack2": "",
"encryptedTrack": false,
"posEntryMode": {
"name": "MANUAL_ENTRY_WIRED"
},
"authCode": "",
"convenienceFees": 0,
"merchantId": 1
}]
},
"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": 1,
"channel": {
"id": ""
},
"userRole": "",
"uiType": "",
"emailAddress": "",
"reEnterEmailAddress": "",
"recurringInd": false,
"id": 161,
"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¶
{
"paymentType": null,
"paymentCycle": null,
"money": {
"amount": null,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1531511916000,
"isoNumericCode": "840"
}
},
"consolidatedPayInfo": {
"payments": [{
"type": "creditcard",
"processDebitOrCredit": "",
"refundMethod": {
"value": "Original Payment Method",
"name": "ORIGINAL_PAYMENT_METHOD"
},
"money": {
"amount": null,
"currency": {
"id": null,
"currencyCode": "USD",
"currencyText": null,
"currencySymbol": null,
"fractionalUnit": null,
"numOfDecimalPlaces": null,
"supportedByVisaCheckout": false,
"createdDateTime": null,
"isoNumericCode": ""
}
},
"paymentMethodType": "CREDIT_CARD",
"orderId": "37a90d61-7317-4a44-99ff-dd09a9a70ac9",
"billingAddress": {
"country": "USA",
"addressLine1": "12000 Findley Road",
"addressLine2": "Suite 350",
"addressLine3": null,
"city": "Johns Creek",
"state": "GA",
"zipCode": "30097"
},
"subscriptionId": "9909000307224009",
"emailAddress": "merchantadmin.vela@gmail.com",
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"refundStatus": {
"value": "None",
"name": "NONE"
},
"convenienceFees": 0,
"nameOnCard": "",
"firstName": "John",
"lastName": "Smith",
"cardNetworkName": "VISA",
"cardNumber": "411111xxxxxx1111",
"expiryMonth": "08",
"expiryYear": "27",
"applicationExpiryDate": null,
"applicationPANSeqNum": null,
"cvn": "",
"cardSwipe": false,
"emvContact": false,
"trackData1": "",
"trackData2": "",
"posKeyed": false,
"posTerminalId": null,
"posEntryMode": {
"value": "Manual Entry - Wired (Current EMV)",
"name": "MANUAL_ENTRY_WIRED"
},
"encryptedTrack": false,
"ksn": null,
"arqcData": "",
"cardBINInfo": {
"bin": "411111",
"bank": "JPMORGAN CHASE BANK, N.A.",
"card": "VISA",
"type": "CREDIT",
"level": "",
"country": "UNITED STATES",
"countrycode": "US",
"website": "HTTP://WWW.JPMORGANCHASE.COM",
"phone": "1-212-270-6000",
"valid": "true"
},
"authCode": "",
"encryptedTrack1": "",
"encryptedTrack2": "",
"chipCardData": null,
"decryptedEMVPayload": null
}]
},
"emailAddress": "merchantadmin.vela@gmail.com",
"reEnterEmailAddress": "merchantadmin.vela@gmail.com",
"transactionType": null,
"reconcileTransactionRefNumber": null,
"voidActionInd": false,
"refundActionInd": false,
"captureActionInd": false,
"recurringInd": false,
"ssoEnabledInd": null,
"realexRequestId": "",
"threeDSecureEncodedMD": "",
"paymentMethodName": "VISA ending in 1111",
"paymentMethodNickname": "VISA-2-20201028",
"useThisPymtMthdAsDefault": false,
"id": 161,
"returnURL": null,
"cancelURL": null,
"createdUserId": null,
"channel": null,
"invoiceNumber": null,
"geolocation": null,
"voidReason": null,
"refundReason": null,
"transactionCategory": {
"value": "Card Not Present (CNP)",
"name": "CARD_NOT_PRESENT"
},
"memo": null,
"addProfileAsPartOfAuthRequest": false,
"paymentAction": null,
"merchantId": null,
"digitalSignature": null,
"goodsAndServicesPurchaseType": null,
"checkInDate": null,
"checkOutDate": null,
"bookingNumber": null,
"groupName": null,
"customerName": null,
"merchantLocation": null,
"customerId": null,
"numberOfCards": 0,
"confirmationInd": false,
"productCode": null
}
Updated As Of Version 3.3.0.5