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/v1/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 |
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 |
| • checkInDate | Optional Date on which the customer is checking in |
21-04-2024 Date format is dependent on the Merchant Configuration |
| • checkOutDate | Optional Date on which the customer is checking out |
24-04-2024 Date format is dependent on the Merchant Configuration |
| • membershipNumber | Optional Membership number of the user for whom the payment is being made |
EX: 123456 |
| • bookingNumber | Optional Booking or the Transaction Number of the payment |
123456 |
| • productCode | Optional Product or service Code for which the payment has been collected |
Ex: ABCD123 |
| • merchantId | Required Merchant Id to which the user belongs |
|
| • emailAddress | Optional Email Address of the user |
|
| • customerName | Required Name of the customer |
Credit Card Payment¶
Request (Existing Payment Method)¶
{
"paymentAction": {
"name": "PRE_AUTHORIZATION"
},
"paymentType": {
"name": "SINGLE_PAYMENT"
},
"checkInDate": "10-04-2024",
"checkOutDate": "18-04-2024",
"recurrenceEndDate": "",
"bookingNumber": "1234567",
"groupName": "",
"membershipNumber": "1234",
"productCode": "IXTA002",
"invoiceNumber": "VELA-12345678-20230418092439",
"merchantId": "11",
"consolidatedPayInfo": {
"payments": [
{
"money": {
"amount": 11,
"currency": {
"currencyCode": "DOP"
}
},
"paymentGateway": {
"name": "FISERV_DATAWIRE_ISO_8583"
},
"payWith": "CARD_ON_FILE",
"subscriptionId": "1hbfzxsdivoz8",
"cardNetworkName": "VISA",
"cardNumber": "8291",
"cvn": "",
"type": "creditcard"
}
]
}
}
Response (Existing Payment Method)¶
{
"tiList": [
{
"id": 32012,
"originalOrderId": "100000008257",
"pymtGtwyRefNumber": "014075924395220",
"authCode": "OK332C",
"parentPymtGtwyRefNumber": null,
"paymentGateway": {
"value": "Fiserv (Datawire & ISO-8583 & Nashville)",
"name": "FISERV_DATAWIRE_ISO_8583"
},
"money": {
"amount": 11.000,
"currency": {
"id": 48,
"currencyCode": "DOP",
"currencyText": "Dominican Peso",
"currencySymbol": "$",
"fractionalUnit": "Centavo",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": false,
"createdDateTime": 1608260909000,
"isoNumericCode": "214",
"isoCountryCode": "214"
}
},
"orderId": "100000008257",
"splitPaymentsTxnSequence": "2",
"encryptedPaymentMethod": "uV7zqMZHuuLiQuV+tqRFZrnn45qSL27aBt1LErRGZXSEzp3VyGlyy97/Es/CnyHuUdqjkDhc29oH0cvpM8S2dujceoM/ku5uP18Cl0nBqtxEQRFlxILKOiz5Qli2es/0RYF98bWcmmJiaIbF4VsKUBrZnIJXK1c0dgbYiWI9FXn9D5rmxW6pzPDXNxZo1QTnR4rTgJZYvOXDsgNvQeBFPCqGEZm9U2n3Fqlsm3KkBQoz1l5DhvbunMAglkB7VaKyUeIxyRs2hMxSrpMVHTGNCSe/hyr3e9nxpE6DJml8DwQeXVq4cyptanTTHKe/VFf+qXQFQjQROARwY+x8pWDCJ4LByFGhh3AfL065zmoZE3Cdqq5waR63z/fHYe1e1sdY/edMUVCrWL2P+2lldP2zw2TiGHRJivRH6akmgG7A2VqL6ox0A3KV9VtzNcjzi2h0Tr2W4B6kmVFU7xwXtk9bi3MEMAgVMfxaq4xLvKTfAFqPKE99rhZhIRb8HIzpMu7lGu91qiyrFiqhOY2sXHMtzqSUuQKZCYwQi+Qw4fK8LusueIYjGwZafbHSQhmirKV3eZCepXfHr5rL2t+iFh7AwdXVgkv6iQ+uiSYJi/vSUljptbHVVjmt4KwfmcCtZEhFpHLQP7EATmkbSQ0YOLN354f1uUes9MLFJOQVqYrwziSGODmFTCYlEHu8d4wm+QNmw1cA1AF1H9GZmd2VIrA9bdJCR7ZyGRerw7trbKlDTK7pOJv8FsqFGhP4CgT/MHx6gTOersKs8YzkOqUTMYi86h8M8gNzn6mYQlWeT4hEB5wg11OqlpHep53gc6c0Eom3t1LzIW6ZsMTRThfJudGkzVAhVreRwjIdeK7pu5HAtXRvzF7DknJzG/Ze4jy0fVahHecd1iQ6VJ0TyJtg5qlxM05bMJUA7U26ZiemA9bQ+O/4mTWPFNfP4NueFt9IqRkmYeWcIyHIltoVdNP2fCoc9BPXyGwA/8oByuZOOaGn2RxK9Y264NSBSPNAa+rcxrJWVzrlxVQWzhobIrF4eRVUpz9NEjn8HgHxbxlKtqwjVK8sAajYm0V/fTwFbxl7/7kh1gLSSR1g8X9QPtSP9HOnqf4TFvRjTm7GRDmoY8FcNRyXVfbiCXua6e74LUFinVqTSNzD9YKzExGiAG8S8dkFFFOgXp76gkUDmm7Gj7+RmtNaaMllbC8Eil3Bhnl8bCj5EkfmCfMbQVabvM5MYe4AdOqzA6LnD1b/7jBr9KxLvV2KHx+lruWu0PaQvTfl+N5KbLfGvQExjJEvAMe8AGuaVLRmFdsYHMj42eDwGDEIIypsNDlynjlqPyIXC9zpUtGhQ/uXyVlXif4FTfWROgg6YNBlNgKEwJ9CHHuaK1pRfvH9bvH6CVZbS1fR4VMLgJEVQRChby/7crf+CY7UkEXIt2ptcY7bkdws9BizkbHzHsKX8vMsM08Ce9LQgpD+m4Jx57kGFyyJvjif3M/bqI+IUGTkrhiSftnXRWxBvyRwec/1ol6kM4Xl9HvcYOren+EoTPYRhIEVdQk/GyG6IJ7JKPGx6/SiJK9YN5sV9WDIm1s37SzTKtVyZ84DW639rqV6/+PwEM3Qfd7RcBbarzUp60IPpcClhyYVJE1/pru+pOQJ0JirgN3rcht595P78THXvtjXH0qEfAarCvuOBzU1P6ZDE3nA08ccWi60gS5ChTdrkI6PvhBfWqsW8G2jxPeSuqenUv0WPnz/gnhoE6QnujDt7z5+EDHna8n5lFprgSAh39nRFoYWjbn7j4CIi3Ndskl7mYVaZG6ENGro9490O+MJOgjNHu44FKoqKVz5AT0Cbo9l+eV6iytyiVJPoUEeH7RnDIDkDEghsgASutTVCrmStROA7eo2iAyj9rmN9NZOKNAywEhhjbaaMzS/AakzRhV7C19n+9abuVijhALZSao9mmQLOBUv34uOOWu7S64=",
"paymentMethodType": {
"value": "VISA",
"name": "VISA"
},
"encodedMetaData": null,
"responseMsg": "APPROVAL",
"responseCode": "00",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"initiatedDateTime": 1710512736000,
"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": 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)",
"name": "CIELO_ECOMMERCE"
},
"cardBrand": {
"value": "Masterpass",
"name": "MASTERPASS"
},
"cardId": null,
"createdUserId": 631,
"lastModifiedUserId": 586,
"createdDateTime": 1674443859000,
"lastUpdatedDateTime": null,
"position": 80
},
{
"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
}
],
"allowDynamicRoutingCapabilityInd": false,
"secondaryPaymentGateway": null,
"tertiaryPaymentGateway": null,
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"transactionType": {
"name": "PRE_AUTHORIZATION"
},
"batchStatus": {
"name": "NEW"
},
"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": "1hbfzxsdivoz8",
"transactionOwnerId": 629,
"vcOrderId": null,
"invoiceNumber": "VELA-12345678-20230418092439",
"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": 107071,
"lastFourDigitsOfAcctNum": "8291",
"merchantNumber": "000039349410050",
"digitalSignature": null,
"goodsAndServicesPurchaseType": null,
"checkInDate": null,
"checkOutDate": null,
"bookingNumber": null,
"groupName": null,
"customerName": null,
"merchantLocation": null,
"customerId": null,
"routingLevel": {
"name": "PRIMARY"
},
"productCode": null,
"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": 94703,
"fieldNumber": "63.14.8",
"fieldName": "TOTAL_AUTHORIZED_AMOUNT",
"fieldValue": "000000000000",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94704,
"fieldNumber": "63.22.2",
"fieldName": "RESPONSE_DATA",
"fieldValue": "APPROVAL ",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94693,
"fieldNumber": "63.14.4",
"fieldName": "VALIDATION_CODE",
"fieldValue": "G385",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94698,
"fieldNumber": "63.SD.TC",
"fieldName": "TERMINAL_TYPE_CAPABILITY",
"fieldValue": "601100000000000",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94702,
"fieldNumber": "63.14.7",
"fieldName": "FIRST_AUTHORIZED_AMOUNT",
"fieldValue": "000000000000",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94697,
"fieldNumber": "63.VI.2",
"fieldName": "CARD_LEVEL_RESPONSE_CODE",
"fieldValue": "C ",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94700,
"fieldNumber": "63.SD.AR",
"fieldName": "ASSOCIATION_RESPONSE_CODE",
"fieldValue": "V000",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94699,
"fieldNumber": "63.49.2",
"fieldName": "CARD_CODE_RESPONSE_VALUE",
"fieldValue": "M",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94696,
"fieldNumber": "63.14.5",
"fieldName": "MARKET_SPECIFIC_DATA_IND",
"fieldValue": "H",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94701,
"fieldNumber": "63.14.6",
"fieldName": "REQUESTED_PAYMENT_SERVICE_IND",
"fieldValue": " ",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94695,
"fieldNumber": "63.14.2",
"fieldName": "AUTHORIZATION_CHARACTER_IND",
"fieldValue": "P",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94694,
"fieldNumber": "63.SD.ZY",
"fieldName": "63.SD.ZY",
"fieldValue": "AON",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
},
{
"id": 94692,
"fieldNumber": "63.14.3",
"fieldName": "TRAN_ID",
"fieldValue": "014075924395220",
"createdDateTime": 1710512737000,
"lastUpdatedDateTime": null,
"createdUserId": 629,
"lastModifiedUserId": null
}
],
"posTerminalId": null,
"qualifiedHealthcareAmount": null,
"amountType": {
"code": "",
"name": "UNKNOWN"
},
"avsResultCode": "M",
"cvvResultCode": "M",
"fiservLocalTransmissionDateTime": "031524102536",
"numberOfInstallments": 0,
"merchantCategoryCode": "3742",
"membershipNumber": null,
"field55EMVData": null,
"captureMode": {
"name": "HOST_CAPTURE"
},
"eightDigitBIN": null,
"binIssuingCountryCode": null,
"cardNetworkTransactionId": "014075924395220",
"recurrenceEndDate": null,
"electronicCommerceIndicator": null,
"salesOrderNumber": null,
"purchaseOrderNumber": null,
"posTerminal": null,
"returnURL": null,
"cancelURL": null,
"paymentRedirectURL": null,
"cardType": null,
"realex3DSecureVISAPit": "",
"realex3DSecureURL": "",
"realex3DSecurePaReq": "",
"realex3DSecureEncodedMD": "",
"realexRequestID": "",
"createdUserName": null,
"capturePymtGtwyRefNumber": null,
"transactionOwnerUserName": null,
"geolocation": null,
"addProfileAsPartOfAuthRequest": false,
"paymentAction": null,
"merchantName": null,
"productName": null,
"strCheckInDate": null,
"strCheckOutDate": null,
"serialNumber": null,
"avsResponseStatus": null,
"cvvResponseStatus": null,
"profileSubscriptionId": null,
"message": null,
"hasTransactionDocuments": false,
"ipaymentMethod": null,
"ssoenabledInd": false,
"qrcodeBase64Image": null,
"qrcodeCopyURL": null,
"transactionDetailMap": {
"63.VI.2": "C ",
"63.22.2": "APPROVAL ",
"63.49.2": "M",
"63.SD.ZY": "AON",
"63.14.8": "000000000000",
"63.14.6": " ",
"63.14.7": "000000000000",
"63.14.4": "G385",
"63.14.5": "H",
"63.14.2": "P",
"63.14.3": "014075924395220",
"63.SD.AR": "V000",
"63.SD.TC": "601100000000000"
},
"qrcodeBase64ImageString": null,
"IFDSerialNumber": null
}
]
}
Updated As Of Version 5.5.1.1