Card On File Payment
Description¶
The makeAPayment endpoint is used to submit a card on the file payment request. Requests are made using a Card On File Payment Method. The Card On File Payment Method is a unique token that is created by the Payment Processor/Acquirer, stored securely in their Vault, and is used to initiate a payment without entering the full card information.
Request¶
Endpoint¶
/ui/v2/makeAPaymentMethod¶
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¶
A • is a child element, • • is a grandchild element, • • • is a great-grandchild element.
| ELEMENT | DESCRIPTION | FORMAT |
|---|---|---|
| money | Required |
|
| • amount | Required Amount |
10.00 or 1000 The maximum Amount limit is 999,999.99 |
| • currency | Required | |
| •• currencyCode | Required 3-character currency code |
Currency Codes |
| paymentType | Required | |
| • name | Required Name of Payment Type being used |
Payment Types |
| consolidatedPayInfo | Required |
|
| • payments | Required Array index |
|
| •• type | Required Type of payment method being used |
• creditcard • echeck • pinlessdebitcard • paypal |
| •• paymentMethodType | Required Payment method type name |
Payment Method Types |
| •• cardNetworkName | Required Applies to credit card and debit card payments only. Card network name |
Card Networks |
| •• cardNumber | Required Applies to credit card, debit card, and eCheck payments only. Card number |
Last Four digits of Card/Account Number 1234 |
| •• cvn | Conditional Required if Card Security Code is mandatory at the Processor level, otherwise Optional. |
4 digits for American Express cards, 3 digits for others |
| •• subscriptionId | Required Required when using a saved/tokenized payment method Subscription ID |
1122334455667788 |
| money | Required |
|
| • amount | Required Amount |
10.00 or 1000 The maximum Amount limit is 999,999.99 |
| • currency | Required | |
| •• currencyCode | Required 3-character currency code |
Currency Codes |
| •• paymentGateway | Required | |
| ••• name | Required Name of payment gateway processing the payment |
Payment Gateways |
| •• payWith | Required saved payment method |
• CARD_ON_FILE |
| paymentAction | Required | |
| •name | Required Name of Payment Action being used |
• SALE • PRE_AUTHORIZATION |
| transactionType | Required | |
| • name | Required Transaction Type being used |
• SALE • PRE_AUTHORIZATION |
| transactionCategory | Required | |
| • name | Required Transaction Category being used |
Transaction Categories |
| membershipNumber | Optional Membership number of the user for whom the payment is being made |
Ex: 123456 |
| productCode | Conditonal Product or service Code for which the payment has been collected Required when the Product/Services feature is enabled at the merchant level NOTE: For Merchant specific configurations, please contact vela@datumtg.com. |
Ex: ABCD123 |
| bookingNumber | Conditional Booking or Transaction number related to the payment. Required if the Product Type is LODGING |
Ex: 123456 |
| checkInDate | Conditional Date on which the customer is checking in. Required if the Product Type is LODGING |
2024-03-01 Date format is dependent on the Merchant Configuration |
| checkOutDate | Conditional Date on which the customer is checking out Required if the Product Type is LODGING |
2024-04-01 Date format is dependent on the Merchant Configuration |
| merchantId | Required Merchant Id to which the user belongs |
|
| goodsAndServicesPurchaseType | Conditional | |
| • name | Conditional Required when the Processor is Chase Paymentech Netconnect |
Goods and Services Purchase Types |
| emailAddress | Optional Email Address of the user |
|
| customerName | Required Name of the customer |
Ex: John Smith |
Credit Card Payment¶
Request (Existing Payment Method)¶
{
"money": {
"amount": "1000.00",
"currency": {
"currencyCode": "DOP"
}
},
"paymentType": {
"name": "SINGLE_PAYMENT"
},
"consolidatedPayInfo": {
"payments": [
{
"type": "creditcard",
"paymentMethodType": "CREDIT_CARD",
"cardNetworkName": "VISA",
"cardNumber": "",
"cvn": "",
"subscriptionId": "qe9c36ay1tte",
"money": {
"amount": "1000.00",
"currency": {
"currencyCode": "DOP"
}
},
"paymentGateway": {
"name": "FISERV_DATAWIRE_ISO_8583"
},
"payWith": "CARD_ON_FILE"
}
]
},
"transactionType": {
"name": "SALE"
},
"transactionCategory": {
"name": "CARD_NOT_PRESENT"
},
"paymentAction": {
"name": "SALE"
},
"merchantId": "11",
"emailAddress": "smithh@gmail.com",
"customerName": "Vela User",
"productCode": "PUNC001",
"checkInDate": "08-08-2024",
"checkOutDate": "08-10-2024",
"bookingNumber": "456654"
}
Response (Existing Payment Method)¶
{
"tiList": [
{
"id": 33166,
"originalOrderId": "100000008540",
"pymtGtwyRefNumber": "014193727823758",
"authCode": "OK706C",
"parentPymtGtwyRefNumber": null,
"paymentGateway": {
"value": "Fiserv (Datawire & ISO-8583 & Nashville)",
"name": "FISERV_DATAWIRE_ISO_8583"
},
"money": {
"amount": 1000.000,
"currency": {
"id": 48,
"currencyCode": "DOP",
"currencyText": "Dominican Peso",
"currencySymbol": "₱",
"fractionalUnit": "Centavo",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": false,
"createdDateTime": 1608260909000,
"isoNumericCode": "214",
"isoCountryCode": "214"
}
},
"orderId": "100000008540",
"splitPaymentsTxnSequence": "2",
"encryptedPaymentMethod": "uV7zqMZHuuLiQuV+tqRFZrnn45qSL27aBt1LErRGZXSEzp3VyGlyy97/Es/CnyHuUdqjkDhc29oH0cvpM8S2dujceoM/ku5uP18Cl0nBqtxEQRFlxILKOiz5Qli2es/0RYF98bWcmmJiaIbF4VsKULOZmXIBVZ/4mB3Qkug6QqdM3Mwmc30mOf6ldfRrOeUvSLj8Oj0MqRDGSAQHUlB1UDNZI9xNFaz5KKSWyKLrBXXSTEHXFQNHSzP8ZC4FZET6AsylOgf/cqgGKOz4H4y7u7u2szflZHkF8oVnXzs4lghD4w1HGBPQrl8AKxdMyEBPFoeunwjExaPX4FPCgRctO+ec9lg67r2pVQC5UQ0K0L0vMAlWgn9HZkDDnuM53bI1ncbyaf08DD1mMXRsmfVeB/CVUeGz+AnUSqWTAvvxI77ur/9lrb3M80oEKzsLYYkSOvR3uzAXlVqt3JVBiGn25HLRJoCkfNHU5mR1CSlrxxqwi+8A9EfOw2fu3cJt+1RA8fzhL4HqSwGCao+cG42VwBflkvD4s62b7a1GEDhQQCcL2SLtdp+977Gqmrsy07cs6decfF3qyC4LKwnOw/5UkbksuHEjgkQSbimvoKTAuBVEW4Q0Dm7uPTluoiL71zGqocp4PeRkByYyZ6+QX3cJgJjA3go4DU40ubdaeWAV6dPrPGaUsbImPzTUp+QSr95W+m5+ajiD51otT7lBTRX2DKNzS4+vGgr6xycEYQE+UVst4IJ68YTxiF1Efv1ATlpFdkEuPhkrLSZHsdwAwkwLur1hYM5eMapUT59V+BOvw9t1pTJ/54xV/BDhZsRrwejGVeVBjSfy6hYI8rCOVhM2Tb7k5dolxRU/5UofXIB5IwzkuvuvaffRGoRf7Rd2VHVgVmxLTHMa+LEpy8Reg1c1PBDFr+9OL251ShBI0IgopR08OEU11y3Nj1vObfx2aAVBReZ5yGTDJMHMu2rftcm1g75+JxKTOusdAe1JZwb3bYJn9etpC7+kAPU0PIQpd+oqrNgsGVMR49Z4dtuE/I+DsY7jHYWkxNG4rGz9nllequC3wm74aU1AjsDMFmRV7l50SjjxRgw6rCNLHPcVvunAPnChHTXp/4KFR9M+KHOPok5pjXdKhlOUqUwyJofpmxpzUsq4ssAeGIMltWcYRQx45mNYOMltDaTjDjtIYC5B7pUW2UGzVJtVLPHLrxq9X8gUslFheroY1jLlxC9Q0DFPW9OHalx9VVZaOLdcsBIBWllWBf5BXE0P3SdhAtlnVPRAGSmWHNPiSuapb0UAF7Uoyx7kbbkI54teZIj5w5eR8QgGGvn+gjokSFsbqx6wyvTy6t8qRAPrd5LUkPWM9hnXTxpjVxcatOi6BQuRkyZKAhtjSYm1eV62862iUPhsXMmUq2j85BeLnyUakulqSPO9Cyu8dXs8C2/x+YuqdUCsxW3w2j8qDmRElQqhJZALCSay8IATtZL5BMAeFaDsIVWvGkFp0TUyP2+NiFvg+raZE20yYuE2UEjXW7QEAB1o1JJv2Q+hsnHc4RFheNqb3MpBhoxMhNuh6Qp9A1qhx2MyxO9YiEYfygHcqQYKI6KJUVbKHju3Pr64uukRymtLMXXlvfOsfyfoioBQxQ3oaJ2gpOlbe4QlLFPGmTE6zk9wGyzf6l4u638d9o8BId5fIn9Anbj6jU3mBGVragkYRWnSl/inXNfKOHgtspQwkZcWDM5MkPnhng0QhAwSEWDeJGjB4TPs2/GPuD3G78DvwhqCzrsz0qUfAogz5ZwFpAScvi3w15rc3y4V+mJvsnTq5RXLVotptvgHM8uPa7pXkydjAzTS2w9rTZCTKN3ogpHBZKGMUAusB0k7LNcJ9REWoRQlXHOhx5xf8VnUbeKuH+BwYLghGOTWDFCXSkkCq7+Yu30ugb/jihaZXh3evZf4aLTMu0Syd4KswYVfCjeICSkVwuzkquqwwz+ueSXeNCznuB+SY2HOLri8/exoPYqqXjDuyA==",
"paymentMethodType": {
"value": "VISA",
"name": "VISA"
},
"encodedMetaData": null,
"responseMsg": "APPROVAL",
"responseCode": "00",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"initiatedDateTime": 1720707079000,
"transactionStatus": {
"name": "SUCCESS"
},
"channel": {
"id": 86,
"channelName": "Fiserv-ecommerce",
"channelStatus": {
"name": "ACTIVE"
},
"channelType": {
"name": "EXTERNAL"
},
"createdDateTime": 1568119974000,
"merchantId": 11,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 586,
"industryType": {
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"allowEStoreCreditAsPaymentMethodInd": false,
"paymentMethods": [
{
"id": 2547,
"paymentMethodType": {
"value": "Google Pay",
"name": "GOOGLE_PAY"
},
"paymentGateway": {
"value": "Authorize.Net",
"name": "AUTHORIZENET"
},
"cardBrand": {
"value": "Google Pay",
"name": "GOOGLE_PAY"
},
"cardId": null,
"createdUserId": 631,
"lastModifiedUserId": 586,
"createdDateTime": 1674443819000,
"lastUpdatedDateTime": null,
"position": 0
},
{
"id": 706,
"paymentMethodType": {
"value": "Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"value": "Fiserv (Datawire & ISO-8583 & Nashville)",
"name": "FISERV_DATAWIRE_ISO_8583"
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 1220,
"createdUserId": 1,
"lastModifiedUserId": 586,
"createdDateTime": 1568119974000,
"lastUpdatedDateTime": 1599098866000,
"position": 65
},
{
"id": 698,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"value": "Fiserv (Datawire & ISO-8583 & Nashville)",
"name": "FISERV_DATAWIRE_ISO_8583"
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 1201,
"createdUserId": 1,
"lastModifiedUserId": 586,
"createdDateTime": 1568119974000,
"lastUpdatedDateTime": 1599098866000,
"position": 57
},
{
"id": 2548,
"paymentMethodType": {
"value": "Masterpass",
"name": "MASTERPASS"
},
"paymentGateway": {
"value": "Cielo (E-commerce) 3.0",
"name": "CIELO_ECOMMERCE"
},
"cardBrand": {
"value": "Masterpass",
"name": "MASTERPASS"
},
"cardId": null,
"createdUserId": 631,
"lastModifiedUserId": 586,
"createdDateTime": 1674443859000,
"lastUpdatedDateTime": null,
"position": 80
}
],
"allowDynamicRoutingCapabilityInd": false,
"secondaryPaymentGateway": null,
"tertiaryPaymentGateway": null,
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"transactionType": {
"name": "SALE"
},
"batchStatus": {
"name": "PROCESSED"
},
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 629,
"lastModifiedUserId": null,
"reconcileTransactionRefNumber": null,
"paymentService2000Data": null,
"batchID": null,
"voidActionInd": false,
"refundActionInd": false,
"captureActionInd": false,
"incrementalAuthActionInd": false,
"reAuthActionInd": false,
"paymentType": {
"name": "SINGLE_PAYMENT"
},
"paymentCycle": null,
"totalCapturedAmount": null,
"surchargeAmount": null,
"totalRefundedAmount": null,
"refundStatus": {
"name": "NONE"
},
"refundMethod": null,
"totalVoidedAmount": null,
"voidStatus": {
"name": "NONE"
},
"incrementalAuthAmount": null,
"reAuthAmount": null,
"totalAuthAmount": null,
"scheduledPaymentDateTime": null,
"subscriptionId": "qe9c36ay1tte",
"transactionOwnerId": 629,
"vcOrderId": null,
"invoiceNumber": null,
"customerNumber": null,
"transactionCategory": {
"name": "CARD_NOT_PRESENT"
},
"encryptedGeolocationInfo": null,
"voidReason": null,
"refundReason": null,
"captureAmount": null,
"voidAmount": null,
"posEntryMode": {
"name": "MANUAL_ENTRY_WIRED"
},
"merchantId": 11,
"memo": null,
"partialAuthAmount": null,
"retryTraceNumber": 107343,
"lastFourDigitsOfAcctNum": "0026",
"merchantNumber": "000039349410050",
"digitalSignature": null,
"goodsAndServicesPurchaseType": null,
"checkInDate": 1723089600000,
"checkOutDate": 1728360000000,
"bookingNumber": "456654",
"groupName": null,
"customerName": "Vela User",
"merchantLocation": null,
"customerId": null,
"routingLevel": {
"name": "PRIMARY"
},
"productCode": "PUNC001",
"productQuantity": 0,
"totalRefundedQuantity": 0,
"convenienceFees": null,
"acquirerTerminalId": "01340065",
"transactionStatusInformation": null,
"applicationIdentifier": null,
"terminalVerificationResults": null,
"issuerApplicationData": null,
"cardholderVerificationMethodResults": null,
"macKSN": null,
"issuerAuthenticationData": null,
"issuerScriptTemplate1": null,
"issuerScriptTemplate2": null,
"applicationLabel": null,
"fiservIPGTransactionId": null,
"transactionDetails": [
{
"id": 99656,
"fieldNumber": "63.49.2",
"fieldName": "CARD_CODE_RESPONSE_VALUE",
"fieldValue": "M",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99646,
"fieldNumber": "63.14.4",
"fieldName": "VALIDATION_CODE",
"fieldValue": "G330",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99649,
"fieldNumber": "63.SD.AR",
"fieldName": "ASSOCIATION_RESPONSE_CODE",
"fieldValue": "V000",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99654,
"fieldNumber": "63.14.6",
"fieldName": "REQUESTED_PAYMENT_SERVICE_IND",
"fieldValue": " ",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99657,
"fieldNumber": "63.VI.2",
"fieldName": "CARD_LEVEL_RESPONSE_CODE",
"fieldValue": "C ",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99650,
"fieldNumber": "63.14.2",
"fieldName": "AUTHORIZATION_CHARACTER_IND",
"fieldValue": "P",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99655,
"fieldNumber": "63.14.8",
"fieldName": "TOTAL_AUTHORIZED_AMOUNT",
"fieldValue": "000000000000",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99645,
"fieldNumber": "63.14.5",
"fieldName": "MARKET_SPECIFIC_DATA_IND",
"fieldValue": "H",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99653,
"fieldNumber": "63.SD.TC",
"fieldName": "TERMINAL_TYPE_CAPABILITY",
"fieldValue": "601100000000000",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99644,
"fieldNumber": "63.SD.AS",
"fieldName": "63.SD.AS",
"fieldValue": "C",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99648,
"fieldNumber": "63.22.2",
"fieldName": "RESPONSE_DATA",
"fieldValue": "APPROVAL ",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99647,
"fieldNumber": "63.SD.ZX",
"fieldName": "63.SD.ZX",
"fieldValue": "INO",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99652,
"fieldNumber": "63.14.7",
"fieldName": "FIRST_AUTHORIZED_AMOUNT",
"fieldValue": "000000000000",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 99651,
"fieldNumber": "63.14.3",
"fieldName": "TRAN_ID",
"fieldValue": "014193727823758",
"createdDateTime": 1720707080000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
}
],
"posTerminalId": null,
"qualifiedHealthcareAmount": null,
"amountType": {
"code": "",
"name": "UNKNOWN"
},
"avsResultCode": null,
"cvvResultCode": "M",
"fiservLocalTransmissionDateTime": "071124101119",
"numberOfInstallments": 0,
"merchantCategoryCode": "3742",
"membershipNumber": null,
"field55EMVData": null,
"captureMode": {
"name": "HOST_CAPTURE"
},
"eightDigitBIN": "029a7b281343ad86a2eb54bd670f8a5db3901f5e3c37a79f9f417e2a3aacacdb",
"binIssuingCountryCode": null,
"cardNetworkTransactionId": "014193727823758",
"recurrenceEndDate": null,
"electronicCommerceIndicator": null,
"salesOrderNumber": null,
"purchaseOrderNumber": null,
"addTokenAsPartOfPaymentSubmission": false,
"posTerminal": null,
"returnURL": null,
"cancelURL": null,
"paymentRedirectURL": null,
"cardType": null,
"realex3DSecureVISAPit": "",
"realex3DSecureURL": "",
"realex3DSecurePaReq": "",
"realex3DSecureEncodedMD": "",
"realexRequestID": "",
"createdUserName": null,
"capturePymtGtwyRefNumber": null,
"transactionOwnerUserName": null,
"geolocation": null,
"paymentAction": null,
"merchantName": null,
"productName": null,
"strCheckInDate": null,
"strCheckOutDate": null,
"serialNumber": null,
"avsResponseStatus": null,
"cvvResponseStatus": null,
"profileSubscriptionId": null,
"message": null,
"hasTransactionDocuments": false,
"releaseRemainingFundsInd": false,
"ipaymentMethod": null,
"ssoenabledInd": false,
"transactionDetailMap": {
"63.VI.2": "C ",
"63.49.2": "M",
"63.22.2": "APPROVAL ",
"63.SD.ZX": "INO",
"63.14.8": "000000000000",
"63.14.6": " ",
"63.14.7": "000000000000",
"63.14.4": "G330",
"63.14.5": "H",
"63.14.2": "P",
"63.14.3": "014193727823758",
"63.SD.AR": "V000",
"63.SD.AS": "C",
"63.SD.TC": "601100000000000"
},
"qrcodeBase64Image": null,
"qrcodeCopyURL": null,
"qrcodeBase64ImageString": null,
"IFDSerialNumber": null
}
]
}
Updated As Of Version 6.4.0.8