Get Tokenized Payment Method

Description

The getTokenizedPaymentMethod endpoint is used to retrieve a tokenized payment method for a given user.

Request

Endpoint

/ui/v1/getTokenizedPaymentMethod

Method

POST
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 Conditional
Required when modifying a payment method

Tokenized payment method's identifier from VELA's database
15

Request Body

{
    "money": {
        "currency": {
            "currencyCode": "USD"
        }
    },
    "consolidatedPayInfo": {
        "payments": [{
                "type": "creditcard",
                "paymentMethodType": "CREDIT_CARD",
                "cardNetworkName": "VISA",
                "nameOnCard": "",
                "firstName": "",
                "lastName": "",
                "cardNumber": "",
                "expiryMonth": "",
                "expiryYear": "",
                "cvn": "",
                "processDebitOrCredit": "",
                "orderId": "e0d0a037-a5ad-49ea-b05c-fc28a83e4023",
                "subscriptionId": "9909000191278244",
                "routingNumber": "",
                "accountNumber": "",
                "bankName": "",
                "accountType": "",
                "dateOfBirth": "2017-12-11",
                "driversLicenseNumber": "",
                "driversLicenseState": "AL",
                "billingAddress": {
                    "country": "USA",
                    "state": "AL",
                    "city": "",
                    "addressLine1": "",
                    "addressLine2": "",
                    "zipCode": ""
                },
                "money": {
                    "currency": {
                        "currencyCode": "USD"
                    }
                },
                "paymentGatewayType": {
                    "name": "CYBERSOURCE"
                }
            }
        ]
    },
    "threeDSecurePaReq": "",
    "threeDSecureURL": "",
    "threeDSecureVISAPit": "",
    "realexRequestId": "",
    "threeDSecureEncodedMD": "",
    "password": "password",
    "paymentMethodName": "",
    "id": 5
}

Response

{
    "paymentType": null,
    "paymentCycle": null,
    "money": {
        "amount": null,
        "currency": {
            "id": null,
            "currencyCode": "USD",
            "currencyText": null,
            "currencySymbol": null,
            "fractionalUnit": null,
            "numOfDecimalPlaces": null,
            "supportedByVisaCheckout": false,
            "createdDateTime": null
        }
    },
    "consolidatedPayInfo": {
        "payments": [{
                "type": "creditcard",
                "processDebitOrCredit": null,
                "refundMethod": null,
                "money": null,
                "paymentMethodType": "CREDIT_CARD",
                "orderId": "e0d0a037-a5ad-49ea-b05c-fc28a83e4023",
                "billingAddress": {
                    "country": "USA",
                    "addressLine1": "123 Maple Street",
                    "addressLine2": "Apt. 2A",
                    "city": "Atlanta",
                    "state": "GA",
                    "zipCode": "12345"
                },
                "subscriptionId": "9909000191278244",
                "emailAddress": "johnsmithvela@datumsoftware.com",
                "paymentGatewayType": {
                    "value": "CyberSource",
                    "name": "CYBERSOURCE"
                },
                "refundStatus": null,
                "nameOnCard": null,
                "firstName": "SMITH",
                "lastName": "JOHN",
                "cardNetworkName": "VISA",
                "cardNumber": "411111XXXXXX1111",
                "expiryMonth": "09",
                "expiryYear": "19",
                "cvn": null
            }
        ]
    },
    "emailAddress": "johnsmithvela@datumsoftware.com",
    "reEnterEmailAddress": "johnsmithvela@datumsoftware.com",
    "transactionType": null,
    "reconcileTransactionRefNumber": null,
    "voidActionInd": false,
    "refundActionInd": false,
    "captureActionInd": false,
    "recurringInd": false,
    "ssoEnabledInd": null,
    "realexRequestId": "",
    "threeDSecureEncodedMD": "",
    "paymentMethodName": "VISA ending in 1111",
    "paymentMethodNickname": "Credit Card 1111",
    "useThisPymtMthdAsDefault": false,
    "id": 5,
    "returnURL": null,
    "cancelURL": null,
    "createdUserId": null,
    "application": null,
    "invoiceNumber": null
}