Converge can manage your wallet through the Shoppers and Stored Cards resource. For more information, see the Pay with Stored Card/Shopper page.
For integrator-managed wallets, the steps below outline the initial transaction for unscheduled merchant-initiated transactions with the customer's card on file:
- Send a Create Transaction POST request to the /transactions endpoint.
- In your request, set the following parameters:
- total - The total amount of the transaction. It contains the fields below:
- amount - The actual value of the transaction. This is required.
- currencyCode - The ISO 4217 three-letter currency code. This is required.
- shopperInteraction - The type of interaction with the customer that generated this transaction. Valid values are the following: ecommerce (default), mailOrder, telephoneOrder. Note that using the default option will not authorize if the 3DS details are not provided.
- credentialOnFileType - Credential on file type. Set to "unscheduledMerchantInitiated".
- card - The customer's card details. It contains the fields below:
- holderName - The customer's full name.
- number - The cardholder's personal account number. This is required and the value is not returned.
- expirationMonth - The card's expiration month. This is required.
- expirationYear - The card's expiration year. This is required.
- securityCode - The card's security code. This is required and the value is not returned.
- billTo - The customer's billing address. It contains the fields below:
- street1 - The first address line.
- street2 - The second address line.
- city - The town or city.
- postalCode - The zip or postal code. This is required for UK merchants.
- countryCode - The ISO 3166-1 Alpha-3 country code.
- total - The total amount of the transaction. It contains the fields below:
- Wait for the response from the /transactions endpoint. In the response, take note of the following:
- id - The transaction resource ID. This is used for retrieving and updating the transaction.
- href - The transaction resource URL.
- credentialOnFileData - The value returned from the initial use of a card in an integrator-managed wallet. This value must be saved and used in any future transactions initiated by the merchant.
The steps below outline any future unscheduled transactions initiated by the merchant with the customer's card on file:
- Send a Create Transaction POST request to the /transactions endpoint.
- In your request, set the following parameters:
- total - The total amount of the transaction. It contains the fields below:
- amount - The actual value of the transaction. This is required.
- currencyCode - The ISO 4217 three-letter currency code. This is required.
- shopperInteraction - The type of interaction with the customer that generated this transaction. Set to "merchantInitiated".
- credentialOnFileType - Credential on file type. Set to "unscheduledMerchantInitiated".
- credentialOnFileData - The value returned from the initial use of a card in an integrator-managed wallet.
- card - The customer's card details. It contains the fields below:
- holderName - The customer's full name.
- number - The cardholder's personal account number. This is required and the value is not returned..
- expirationMonth - The card's expiration month. This is required.
- expirationYear - The card's expiration year. This is required.
- securityCode - The card's security code. This is required and the value is not returned.
- billTo - The customer's billing address. It contains the fields below:
- street1 - The first address line.
- street2 - The second address line.
- city - The town or city.
- postalCode - The zip or postal code. This is required for UK merchants.
- countryCode - The ISO 3166-1 Alpha-3 country code.
- total - The total amount of the transaction. It contains the fields below:
- Wait for the response from the /transactions endpoint. In the response, take note of the following:
- id - The transaction resource ID. This is used for retrieving and updating the transaction.
- href - The transaction resource URL.
The following is an example of a JSON request for the initial unscheduled transaction of EUR 6.00 using John Doe's card.
POST "https://uat.api.converge.eu.elavonaws.com/transactions"
{
"total": {
"amount": "6.00",
"currencyCode": "EUR"
},
"shopperInteraction": "telephoneOrder",
"credentialOnFileType": "unscheduledMerchantInitiated",
"card": {
"holderName": "John Doe",
"number": "5100.0800.0004.1251",
"expirationMonth": 1,
"expirationYear": 2025
}
}The following is an example of a successful JSON response to the request above.
{
"href": "https://uat.api.converge.eu.elavonaws.com/transactions/x7kr3pkqtt7rk2yj87prh8g99hjt",
"id": "x7kr3pkqtt7rk2yj87prh8g99hjt",
"createdAt": "2023-04-12T19:19:14.192Z",
"modifiedAt": "2023-04-12T19:19:14.192Z",
"authorizationExpiresAt": "2023-04-19T19:19:14.192Z",
"type": "sale",
"paymentMethod": "Card",
"paymentMethodOrigin": "Card",
"source": "directApiCall",
"merchant": "https://uat.api.converge.eu.elavonaws.com/merchants/8dkkmt7yh4w4vdcwfk3mtg4qb9qt",
"processorAccount": "https://uat.api.converge.eu.elavonaws.com/processor-accounts/pxj468g3qfv4xvfy7br2vq27mbjf",
"account": "https://uat.api.converge.eu.elavonaws.com/accounts/8dkkmt7yh4w4vdcwfk3mtg4qb9qt",
"total": {
"amount": "6.00",
"currencyCode": "EUR"
},
"totalRefunded": null,
"issuerTotal": null,
"salesTax": null,
"conversionRate": null,
"markupRate": null,
"markupRateAnnotation": null,
"surchargeTotal": null,
"surchargeRate": null,
"parentTransaction": null,
"description": null,
"shopperStatement": null,
"debtorAccount": null,
"customReference": null,
"shopperReference": null,
"processorReference": "HTRVDTHORE4",
"issuerReference": "MSI033005",
"orderReference": null,
"shopperInteraction": "telephoneOrder",
"shopper": null,
"shipTo": null,
"shopperEmailAddress": null,
"shopperIpAddress": null,
"shopperLanguageTag": null,
"shopperTimeZone": null,
"order": null,
"subscription": null,
"credentialOnFileType": "unscheduledMerchantInitiated",
"credentialOnFileData": "MMSI033005 0412 ",
"card": {
"holderName": "John Doe",
"panToken": {
"token": "9568433425770184409",
"provider": "ELAVON_C2_V1",
"type": "pan"
},
"paymentAccountReference": "M5100080107597654010759765401",
"panFingerprint": "ybgrr84w2xx6bmvvvkvh7t3v4gk2",
"expirationMonth": 1,
"expirationYear": 2025,
"billTo": null,
"maskedNumber": "XXXX.XXXX.XXXX.1251",
"last4": "1251",
"bin": "510008",
"scheme": "MasterCard",
"brand": "MasterCard Credit",
"fundingSource": "credit",
"issuingBank": "INTERNATIONAL CARD SERVICES BV",
"issuingCountry": "NLD",
"issuingCurrency": "EUR",
"isDebit": "false",
"isCorporate": "false",
"isDccAllowed": "true"
},
"paymentLink": null,
"paymentGroup": null,
"paymentSession": null,
"createdBy": null,
"modifiedBy": null,
"customFields": null,
"isHeldForReview": false,
"doCapture": true,
"doSendReceipt": true,
"isAuthorized": true,
"authorizationCode": "511914",
"verificationResults": {
"name": "unsupported",
"securityCode": "unprovided",
"addressStreet": "unprovided",
"addressPostalCode": "unprovided",
"threeDSecureV1": "unprovided",
"threeDSecureV2": "unprovided",
"cryptogramSecurity": "unprovided"
},
"state": "authorized",
"batch": null,
"relatedTransactions": [
],
"failures": [
],
"history": [
]
}The following is an example of a JSON request for the succeeding unscheduled transaction of EUR 7.00 initiated by the merchant using John Doe's card.
POST "https://uat.api.converge.eu.elavonaws.com/transactions"
{
"total": {
"amount": "7.00",
"currencyCode": "EUR"
},
"shopperInteraction": "merchantInitiated",
"credentialOnFileType": "unscheduledMerchantInitiated",
"credentialOnFileData": "MMSI033005 0412 ",
"card": {
"holderName": "John Doe",
"number": "5100.0800.0004.1251",
"expirationMonth": 1,
"expirationYear": 2025
}
}The following is an example of a successful JSON response to the request above.
{
"href": "https://uat.api.converge.eu.elavonaws.com/transactions/kjt8jydx9tg8j7vcf6kbtvttqcp6",
"id": "kjt8jydx9tg8j7vcf6kbtvttqcp6",
"createdAt": "2023-04-12T19:20:49.394Z",
"modifiedAt": "2023-04-12T19:20:49.394Z",
"authorizationExpiresAt": "2023-04-19T19:20:49.394Z",
"type": "sale",
"paymentMethod": "Card",
"paymentMethodOrigin": "Card",
"source": "directApiCall",
"merchant": "https://uat.api.converge.eu.elavonaws.com/merchants/8dkkmt7yh4w4vdcwfk3mtg4qb9qt",
"processorAccount": "https://uat.api.converge.eu.elavonaws.com/processor-accounts/pxj468g3qfv4xvfy7br2vq27mbjf",
"account": "https://uat.api.converge.eu.elavonaws.com/accounts/8dkkmt7yh4w4vdcwfk3mtg4qb9qt",
"total": {
"amount": "7.00",
"currencyCode": "EUR"
},
"totalRefunded": null,
"issuerTotal": null,
"salesTax": null,
"conversionRate": null,
"markupRate": null,
"markupRateAnnotation": null,
"surchargeTotal": null,
"surchargeRate": null,
"parentTransaction": null,
"description": null,
"shopperStatement": null,
"debtorAccount": null,
"customReference": null,
"shopperReference": null,
"processorReference": "HU88ARSD9P6",
"issuerReference": "MSI105382",
"orderReference": null,
"shopperInteraction": "merchantInitiated",
"shopper": null,
"shipTo": null,
"shopperEmailAddress": null,
"shopperIpAddress": null,
"shopperLanguageTag": null,
"shopperTimeZone": null,
"order": null,
"subscription": null,
"credentialOnFileType": "unscheduledMerchantInitiated",
"credentialOnFileData": null,
"card": {
"holderName": "John Doe",
"panToken": {
"token": "9532888013198904206",
"provider": "ELAVON_C2_V1",
"type": "pan"
},
"paymentAccountReference": "M5100080107597654010759765401",
"panFingerprint": "ybgrr84w2xx6bmvvvkvh7t3v4gk2",
"expirationMonth": 1,
"expirationYear": 2025,
"billTo": null,
"maskedNumber": "XXXX.XXXX.XXXX.1251",
"last4": "1251",
"bin": "510008",
"scheme": "MasterCard",
"brand": "MasterCard Credit",
"fundingSource": "credit",
"issuingBank": "INTERNATIONAL CARD SERVICES BV",
"issuingCountry": "NLD",
"issuingCurrency": "EUR",
"isDebit": "false",
"isCorporate": "false",
"isDccAllowed": "true"
},
"paymentLink": null,
"paymentGroup": null,
"paymentSession": null,
"createdBy": null,
"modifiedBy": null,
"customFields": null,
"isHeldForReview": false,
"doCapture": true,
"doSendReceipt": true,
"isAuthorized": true,
"authorizationCode": "512050",
"verificationResults": {
"name": "unsupported",
"securityCode": "unprovided",
"addressStreet": "unprovided",
"addressPostalCode": "unprovided",
"threeDSecureV1": "unprovided",
"threeDSecureV2": "unprovided",
"cryptogramSecurity": "unprovided"
},
"state": "authorized",
"batch": null,
"relatedTransactions": [
],
"failures": [
],
"history": [
]
}