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 |
|---|---|---|
| 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 |
| •• subscriptionId | Required Required when using a saved/tokenized payment method Subscription ID |
1122334455667788 |
| •• money | Required Amount |
10.00 or 1000 |
| •• currency | Required | |
| ••• currencyCode | Required 3-character currency code |
Currency Codes |
| •• paymentGatewayType | 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 |
| • emailAddress | Required Email Address of the user |
|
| • customerName | Required Name of the customer |
Credit Card Payment¶
Request (Existing Payment Method)¶
{
"consolidatedPayInfo": {
"payments": [{
"type": "creditcard",
"cardNetworkName": "VISA",
"subscriptionId": "210207520",
"money": {
"amount": "45.00",
"currency": {
"currencyCode": "USD"
}
},
"paymentGateway": {
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"payWith": "CARD_ON_FILE"
}]
},
"paymentAction": {
"name": "SALE"
},
"merchantId": "3",
"emailAddress": "smithh@gmail.com",
"customerName": "John"
}
Response (Existing Payment Method)¶
{
"tiList": [
{
"id": 2472,
"originalOrderId": "1hravuwge3p6h",
"pymtGtwyRefNumber": "6148F5BCF1F820D45A8C195ED86DA186D4B454DC",
"authCode": "097425",
"parentPymtGtwyRefNumber": null,
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"money": {
"amount": 45.000,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608316900000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"orderId": "1hravuwge3p6h",
"splitPaymentsTxnSequence": "2",
"encryptedPaymentMethod": "uV7zqMZHuuLiQuV+tqRFZrnn45qSL27aBt1LErRGZXSEzp3VyGlyy97/Es/CnyHu2qWCdQLBvUSsGCOBMTXR9qveqiRovJP7U1ktcf67hSiTH55bFQB798mC8dCoKazopchaAUle+zpu5vnv7dH/tp/g8l76gJO/9YsOvrlmu5WOXDdRgp9fuu03zER/iABPJEVZDrTFFrmtALSUN+u8vqSaOG+rMGCN7c3KMNLH8kvlIyXbLOpdIN+ZBtKJsngcMHUMxI1iup+UzePoOT4iU3brzAahQek7M6TZzz0Yl0RuHjp5VaEC6gD5wMaLxGS6JHKtYL9J+n6aEj0aoZGvhKJDv1zkQo6FSMbQDlnTC49HHxX/waUy/OonVy+cMAQLAYFQvzooPKldv7IHXRAAIlIS/DSSEVvIVmFLHkk5wuJshoRA4M3DlsFbT6eM4sRBmt92i+2pQFjx71t01apSWM/MDMf5NQx03fKBdTlEW5K/yvOLXpKTBJ+VlAySvQNEiOtcBu159EsSF1Z6XI+GLIY1zi/UDn+oJaytOAC1ChXb2pa2XY83QTKSHbamK7aFZkezqwuz4zrrj+VRY+k7N+PbP/sHpDBiXFY6UokdnifPqq7Lk2YKjTXkFlO7e1AOsmTBTSG2f3RM720mQ97v17Hd2iBvq4XZ6557+3/F0lGTY4SfuO0ntZa5YiPnXuvuW2kh4l08Msvrdg4KFgNpjSCZyIEeUHAalTmSEWcjkwzH6Bpu0ZhBRz7qM89RndrFohwe6dT1+NXhCpBSBHD++3HqbJWw06FVV+o+a6DC6glO4+zfHScU9SGeN5cSDJbo6+m1gJdcKBYDALH+L41XYIlWoG6isj+ltu6HNFzT7/cBO432g1D6Lw/HH5npkcRvQrDz0qY2h0xqgCEnaa6uHDNXyY2vXPLbmyJNhqLnaQ4EQE2cF2PGQQ8tMzbz35H2VvDPNL15evpjqEJbVrthIhprI2MS9HM+qlWDpjDyu0hG3he6a8/8q8n6M5ZXkkQEMi31ayW4WeRixDZz4AdXGPCYaah4PFj519AEytSn8wKfnCFXZN+hUwdkUh/iiFsTPbuUC0CiUVf+RYrQXIHdkseFKrPMGjNkgCl0YVXR8WSYZfC/zob6Apo0638KTilc9zKrJgCIJU7Rt3WhB9QrevPVvKUXvdqsQMmZsGT3pLwd80N0UxOOs7GUvPuB75YpYdFTy2h/uFaCbdK+KgQ5668qOT+zlo7F7wWnT84+giXKxGK3WbNGXTDWfaKMzXpcZgPbQelNnaH7SbmVvw8J7gHQ7jofQmj7bT0PPhSGiPzTP7xuurNGxaguujl2EX24pIhK+r29R4C5U1vbQ053XWgfsFX3aB49zjCUpjMSohbajV/Av8zYaE1kR8EIt8CiQVSk9vz3xxZqE6U/5ryqDZSOb5Yzc4+pC2nfVkf8yg+RTQL9c+EV+t99exgH4tjAq0DUJW1avPcIvPkCEgJtl3hmiqtTqeDGt/uFsK4PpzuHpBZhhPxscWadnHkthAIgHv8tiDr1dSq3ZpYIn12cwHEAhNcON55U0BycD6TjeDTjOkWwC4fX5F7ixzuF0hUv7M+mFbP59GrGgL2fvMz9P1Exl2YrxY+Kiovkp7c9NhRz1qdD7ESLSuJAnJ0+19MwdYjsCF4ul5KwBkSJJUCeQVyDZpSd4tu0XIIVmlFccBIr4Xb2t8rai85KvhPq3+bHH9x+kd75Ca0Q7jH3Fm/y/o4WjbsPysf8j6bIU+48p1os3tIDrjaDUxrZt3GzG1tiWUP3ANTMTQ8jLZesh2ygjgEdV0kYuP9YpxPGjnXbumU=",
"paymentMethodType": {
"value": "VISA",
"name": "VISA"
},
"encodedMetaData": null,
"responseMsg": "Approved",
"responseCode": "00",
"createdDateTime": 1632171452000,
"lastUpdatedDateTime": null,
"initiatedDateTime": 1632171452000,
"transactionStatus": {
"value": "Success",
"name": "SUCCESS"
},
"channel": {
"id": 63,
"channelName": "Fiserv-eCommerce",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "External",
"name": "EXTERNAL"
},
"createdDateTime": 1611950805000,
"merchantId": 3,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 218,
"lastModifiedUserId": 218,
"industryType": {
"value": "eCommerce",
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"allowEStoreCreditAsPaymentMethodInd": false,
"paymentMethods": [
{
"id": 711,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"value": "Fiserv (Datawire & ISO-8583)",
"name": "FISERV_DATAWIRE_ISO_8583"
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 1201,
"createdUserId": 218,
"lastModifiedUserId": 218,
"createdDateTime": 1611950805000,
"lastUpdatedDateTime": null,
"position": 162
},
{
"id": 719,
"paymentMethodType": {
"value": "Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"value": "Fiserv (Datawire & ISO-8583)",
"name": "FISERV_DATAWIRE_ISO_8583"
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 1220,
"createdUserId": 218,
"lastModifiedUserId": 218,
"createdDateTime": 1611950805000,
"lastUpdatedDateTime": null,
"position": 170
}
],
"allowDynamicRoutingCapabilityInd": false,
"secondaryPaymentGateway": null,
"tertiaryPaymentGateway": null,
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"transactionType": {
"value": "Sale",
"name": "SALE"
},
"batchStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 195,
"lastModifiedUserId": null,
"reconcileTransactionRefNumber": null,
"batchID": null,
"voidActionInd": false,
"refundActionInd": false,
"captureActionInd": false,
"incrementalAuthActionInd": false,
"paymentType": null,
"recurringInd": false,
"paymentCycle": null,
"totalRefundedAmount": null,
"refundStatus": {
"value": "None",
"name": "NONE"
},
"refundMethod": null,
"totalVoidedAmount": null,
"voidStatus": {
"value": "None",
"name": "NONE"
},
"incrementalAuthAmount": null,
"totalAuthAmount": null,
"scheduledPaymentDateTime": null,
"subscriptionId": "210207520",
"transactionOwnerId": 195,
"vcOrderId": null,
"invoiceNumber": null,
"transactionCategory": {
"value": "Card Not Present (CNP)",
"name": "CARD_NOT_PRESENT"
},
"encryptedGeolocationInfo": null,
"voidReason": null,
"refundReason": null,
"captureAmount": null,
"voidAmount": null,
"posEntryMode": {
"value": "Manual Entry - Wired (Current EMV)",
"name": "MANUAL_ENTRY_WIRED"
},
"merchantId": 3,
"memo": null,
"partialAuthAmount": null,
"retryTraceNumber": 7075208020421456,
"lastFourDigitsOfAcctNum": null,
"merchantNumber": "700000012567",
"digitalSignature": "",
"goodsAndServicesPurchaseType": null,
"checkInDate": null,
"checkOutDate": null,
"bookingNumber": null,
"groupName": null,
"customerName": "John",
"merchantLocation": null,
"customerId": null,
"routingLevel": {
"value": "Primary",
"name": "PRIMARY"
},
"productCode": null,
"convenienceFees": null,
"acquirerTerminalId": "001",
"transactionStatusInformation": null,
"applicationIdentifier": null,
"terminalVerificationResults": null,
"issuerApplicationData": null,
"cardholderVerificationMethod": null,
"macKSN": null,
"issuerAuthenticationData": null,
"issuerScriptTemplate1": null,
"issuerScriptTemplate2": null,
"applicationLabel": null,
"fiservIPGTransactionId": null,
"transactionDetails": [],
"posTerminalId": null,
"qualifiedHealthcareAmount": null,
"amountType": {
"value": "Unknown",
"code": "",
"name": "UNKNOWN"
},
"avsResultCode": null,
"cvvResultCode": null,
"fiservLocalTransmissionDateTime": null,
"numberOfInstallments": 0,
"posTerminal": null,
"returnURL": null,
"cancelURL": null,
"paymentRedirectURL": null,
"cardType": null,
"realex3DSecureVISAPit": "",
"realex3DSecureURL": "",
"realex3DSecurePaReq": "",
"realex3DSecureEncodedMD": "",
"realexRequestID": "",
"iPaymentMethod": null,
"createdUserName": null,
"capturePymtGtwyRefNumber": null,
"transactionOwnerUserName": null,
"geolocation": null,
"addProfileAsPartOfAuthRequest": false,
"paymentAction": null,
"merchantName": null,
"productName": null,
"strCheckInDate": null,
"strCheckOutDate": null,
"serialNumber": null,
"textMessageType": null,
"profileSubscriptionId": null,
"ssoenabledInd": "",
"transactionDetailMap": {},
"ipaymentMethod": null,
"IFDSerialNumber": null
}
]
}