Process one-off payments without saving your customers' card details. You can either settle the transaction and charge as soon as possible, or authorize for now and charge later.
Back Office UI
Create a Transaction
- Click the Payments menu item.
- Click the Transactions tab.
- Click the New Transaction button. The New Transaction form appears.
- Enter the Transaction Amount.
- Select the Action from the dropdown list. Options are the following:
- Capture for Settlement - Select this option to settle the transaction and charge the customer as soon as possible.
- Authorise - Select this option if the transaction has yet to be fulfilled and should be charged on a later date. For example, if you need to settle an order after it has been shipped to the customer, select this option. You may then capture this transaction for settlement later.
- Enter the Order Ref Number for this transaction, if required. To generate a randomized order reference number, click the Generate button instead.
- In the Payment Method section, click the Pay with Card button.
- Enter the Customer Name and the Email where the receipt will be sent, if required.
- To email the receipt, select the Email Receipt checkbox. The Email field will be required if this is selected.
- To save the customer profile for future use, select the Save customer profile checkbox.
- In the Payment section, enter the Card Number and the Expiry Date in MM/YY format.
- Enter the card's Security Code. If this is not available, select the Security Code Unavailable checkbox instead.
- If the security code is available and you want to verify the validity of the card details, click the Verify Card button.
- To enter the customer's billing address, do the following:
- Toggle the Billing Address button. Additional fields appear.
- Select the Country from the dropdown list.
- Enter the Address Line, Town/City, and Postal Code in the corresponding fields.
- To enter the customer's shipping address, do the following:
- Toggle the Shipping Address button. Additional fields appear.
- If the shipping address is the same as the billing address, select the Same as Billing checkbox and proceed to step 16.
- Select the Country from the dropdown list.
- Enter the Address Line, Town/City, and Postal Code in the corresponding fields.
- Click the Process Transaction button to proceed with the transaction. The transaction details will appear after the transaction is processed.
Depending on your account settings, you may need to select a currency for the transaction amount. If your account is set to use only one currency, the default currency will be used.
API Integration
Converge API Resource: Transactions
Create Transaction
- Send a Create Transaction POST request to the /transactions endpoint.
- In your request, set the following parameters:
- type - The transaction type. The default value is "sale".
- 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.
- orderReference - The order reference number for the transaction.
- shopperInteraction - The type of interaction with the customer that generated this transaction. Valid values are the following: ecommerce (default), mailOrder, telephoneOrder, merchantInitiated. Note that using the default option will not authorize if the 3DS details are not provided.
- shipTo - The customer's shipping 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.
- shopperEmailAddress - The customer's email address.
- 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 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.
- doCapture - The action to be used on the transaction. If set to true (default), the transaction will capture for settlement. If set to false, the transaction will authorize only.
- doSendReceipt - If set to true, receipt will be sent to the customer's email. If set to false (default), receipt will not be emailed.
- 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.
- isAuthorized - Indicates whether the transaction is authorized. Sale transactions are authorized by the gateway, processor, and issuer.
Examples
The following is an example of a JSON request for a one-off transaction of EUR 10.00 using John Doe's card.
POST "https://uat.api.converge.eu.elavonaws.com/transactions"
{
"total": {
"amount": "10.00",
"currencyCode": "EUR"
},
"card": {
"holderName": "John Doe",
"number": "5100.0800.0004.1251",
"expirationMonth": 1,
"expirationYear": 2025
},
"shopperInteraction": "telephoneOrder"
}The following is an example of a successful JSON response to the request above.
{
"href": "https://uat.api.converge.eu.elavonaws.com/transactions/h67d6hjb8866bpc3kddrgtpjmjvq",
"id": "h67d6hjb8866bpc3kddrgtpjmjvq",
"createdAt": "2022-04-04T19:16:52.627Z",
"modifiedAt": "2022-04-04T19:16:52.627Z",
"type": "sale",
"source": "directApiCall",
"merchant": "https://uat.api.converge.eu.elavonaws.com/merchants/XrDXRBh9YHxwqQTj2Cmq7j49",
"processorAccount": "https://uat.api.converge.eu.elavonaws.com/processor-accounts/KmvmfQJpCBJpXHyP2kgrK2hD",
"account": "https://uat.api.converge.eu.elavonaws.com/accounts/XrDXRBh9YHxwqQTj2Cmq7j49",
"total": {
"amount": "10.00",
"currencyCode": "EUR"
},
"totalRefunded": null,
"issuerTotal": null,
"conversionRate": null,
"markupRate": null,
"markupRateAnnotation": null,
"parentTransaction": null,
"description": null,
"shopperStatement": null,
"debtorAccount": null,
"customReference": null,
"shopperReference": null,
"processorReference": "HT47QCT5196",
"issuerReference": "MSI017585",
"orderReference": null,
"shopperInteraction": "telephoneOrder",
"shopper": null,
"shipTo": null,
"shopperEmailAddress": null,
"shopperIpAddress": null,
"shopperLanguageTag": null,
"shopperTimeZone": null,
"order": null,
"subscription": null,
"credentialOnFileType": "none",
"credentialOnFileData": null,
"card": {
"holderName": "John Doe",
"panToken": {
"token": "9504348934017131320",
"provider": "ELAVON_C2_V1",
"type": "pan"
},
"panFingerprint": "brwmhqf8m7q49xc9wfg6t32hbhxm",
"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,
"paymentSession": null,
"createdBy": null,
"modifiedBy": null,
"isHeldForReview": false,
"doCapture": true,
"doSendReceipt": true,
"isAuthorized": true,
"authorizationCode": "511653",
"verificationResults": {
"name": "unsupported",
"securityCode": "unprovided",
"addressStreet": "unprovided",
"addressPostalCode": "unprovided",
"threeDSecureV1": "unprovided",
"threeDSecureV2": "unprovided"
},
"state": "authorized",
"batch": null,
"customFields": null,
"relatedTransactions": [
],
"failures": [
],
"history": [
]
}For more request and response examples, and for the complete and detailed list of parameters, see the Transactions resource.