- Home
- All APIs
- Worldpay Online Payments Guide
- FAQs
- Taking payments
Taking payments
To understand what the order states on your dashboard mean, take a look at the diagram below. Here we can see all the possible states an order may go through.
Further information about the order states can be found in the table below:
SUCCESS | The card issuer/payment service has approved the payment, reserving the payment amount for the merchant. |
SETTLED | The payment has been received from the card issuer/payment service and has been included in a settlement transfer to your bank. |
FAILED | There was a problem with the payment, eg card details were not valid, the shopper could not authenticate the payment, or there were insufficient funds in the customer's account. |
AUTHORISED | The card issuer/payment service has authorised the order, and the funds are now ring-fenced on the customer account, awaiting capture to take payment. |
CANCELLED | The order has been cancelled by the merchant, and the formerly ring-fenced funds are now released on the customer account. |
EXPIRED | The authorised order has expired, and the formerly ring-fenced funds are now released on the customer account. |
REFUNDED | Shown if you issued a refund – either in response to a customer request, or if you decided not to proceed, for example when goods or services are no longer available. Note: If you refund a payment very shortly after it has been placed (usually within ten minutes) it may appear as REFUNDED . However this is not technically classed as a refund because the payment was never made, so you will not be charged any fees for the transaction. |
PARTIALLY_REFUNDED | If you issued a partial refund - perhaps you could only fulfil part of an order, eg if one of the goods or services were no longer available, but the rest of the order was delivered. |
SENT_FOR_REFUND | When you request a refund or partial refund various checks are performed e.g. on the credit status of the account, and while these checks are ongoing the order will be in this transition state. When the refund is complete the order will transition to REFUNDED or PARTIALLY_REFUNDED as appropriate. In the unlikely event that there is a problem with the refund, we will return the order to its former state, and inform you via email that the refund failed. |
CHARGED_BACK | If a customer did not recognise a payment and complained to his card issuer/payment service, the card issuer/payment service may reverse the payment, and the order will appear as CHARGED_BACK . |
INFORMATION_REQUESTED | If Worldpay are notified of a disputed payment that can be contested, we will ask you (the merchant) to provide additional information (such as a delivery note, proof of purchase, etc) so that you can try to avoid incurring a chargeback. The order status in this case will be INFORMATION_REQUESTED . |
INFORMATION_SUPPLIED | This is the order state after you have supplied us with information to dispute a chargeback. |
Yes, Worldpay supports authorisations.
Also known as pre-authorisation or “hold”, this feature enables you to reserve funds on the shopper's payment card without immediately taking payment. This allows you more time to review the transaction and detect potential fraud.
Authorisations use the same request as a normal order, with an additional flag. Once you decide to take payment a capture
request is sent. You could even decide to capture less than the reserved amount, for example a two night hotel stay was changed to one night, so only half of the authorised amount was due.
Authorisation is traditionally used in certain types of transaction, e.g.:
- Hotels
- Car rentals
- Cruise liners
Authorisations remain available for five to eleven days depending on the card issuer. During this time the shopper will be unable to use that portion of the credit available on their card. If the payment is no longer required then the order should be cancelled, which will release the reserved funds on the card in 5 to 7 days.
If not captured or cancelled the authorisation will eventually automatically be expired, meaning the payment can no longer be captured. A new order will need to be created if payment is still required after this point.
Please review the
World payment methods, like Sofort, work a little differently from traditional card based payment methods like Visa and MasterCard. Instead of staying on your checkout page to make a payment, with Sofort customers are redirected to the Sofort website to choose their bank to login to and authorise the payment. Once complete your customer is then redirected back to your site.
Starting taking payments with Sofort is easy. You can
- Enable Sofort on your Payment Types page, and we'll email you when registration is complete
- Add a Sofort button to your website and make Sofort payments
The 'settlement' currency is the currency that Worldpay will pay you in. This can be different from the 'acceptance' currency which is the currency in which your customer pays you on your website.
Worldpay allows you to add 5 settlement currencies out of a list of 9 possible currencies: GBP, EUR, USD, CAD, DKK, HKD, NOK, SEK, SGD (a full list of ISO currency codes can be found
At time of
For every settlement currency you add, you will need to enter bank details in the name of your legal entity and upload a copy of a bank statement that validates this.
This video shows you how to add settlement currencies with Worldpay Online Payments:
.
To start taking payments with Worldpay, follow this simple process:
2.
Please note: this stage is only possible to do when you are logged in, and also that some websites and companies (for example gaming sites or those with adult content) may not be accepted by Worldpay, or may require further diligence checks
3. Make sure that you have entered a valid bank account, and that the account holder name matches your company name
4.
5. Ensure that you have integrated Worldpay with your website or app and tested the integration
6. Integrate your live API keys (client and service) with your website or app. Your live API keys will be available
7. Check that your website is compliant with
Now you are ready to start taking payments.
To view details of a payment, click on theorders
Find the specific transaction you are looking for (you may find it helpful to use the date filter for this), then click on it to see details such as the payment amount, order description, status and billing address.
The conversion rate is the percentage of times that someone coming to your checkout page results in a successful order. The higher the number, the better it is. If you have a conversion rate of 100 per cent, this means that every visit to your checkout page resulted in a successful order.
If this number is low, it could mean that a lot of orders are failing (to see failed orders, use the payment status filter on the
World payment methods, like Przelewy 24, work a little differently from traditional card based payment methods like Visa and MasterCard. Instead of staying on your checkout page to make a payment, with Przelewy 24 customers are redirected to Przelewy 24 to choose and login to the online bank they want to pay from. Once complete your customer is then redirected back to your site.
Starting taking payments with Przelewy 24 is easy. You can
- Enable Przelewy 24 on your Payment Types page, and we'll email you when registration is complete
- Add an Przelewy 24 button to your website and make Przelewy 24 payments
World payment methods, like Bancontact, work a little differently from traditional card based payment methods like Visa and MasterCard. Instead of staying on your checkout page to make a payment, with Bancontact customers are redirected to the Bancontact website to login and authorise the payment. Once complete your customer is then redirected back to your site.
Starting taking payments with Bancontact is easy. You can
- Enable Bancontact on your Payment Types page, and we'll email you when registration is complete
- Add a Bancontact button to your website and make Bancontact payments
World payment methods, like Giropay, work a little differently from traditional card based payment methods like Visa and MasterCard. Instead of staying on your checkout page to make a payment, with Giropay customers will be redirected to their own online banking to complete their payment, and then back to your site.
Starting taking payments with Giropay is easy. You can
- Enable Giropay on your Payment Types page, and we'll email you when registration is complete
- Add an Giropay button to your website and make Giropay payments
World payment methods, like Postepay, work a little differently from traditional card based payment methods like Visa and MasterCard. Instead of staying on your checkout page to make a payment, with Postepay customers are redirected to Postepay to authenticate pre-purchased money vouchers. Once complete your customer is then redirected back to your site.
Starting taking payments with Postepay is easy. You can
- Enable Postepay on your Payment Types page, and we'll email you when registration is complete
- Add a Postepay button to your website and make Postepay payments
When you tokenise a payment card, one of the fields we return describes the Card Product Type. This information allows you to more accurately identify the card's properties.
The Card Product Types that you may encounter are:
Visa Credit: | |
Visa Credit Personal | |
CL Visa Credit Pers | |
Visa Debit: | |
Visa Dr/Elec Per Int | |
Visa Debit | |
CL Visa Debit | |
CL VisaDr/Elec PsInt | |
Visa Electron | |
CL Visa Electron | |
Visa Commercial: | |
Visa Commercial | |
Visa Business | |
Visa Commerce | |
Visa Corporate | |
Visa Purchasing | |
Visa Dr Com Intl | |
Contactless Visa Commercial: | |
CL Visa Commercial | |
CL Visa Business | |
CL Visa Commerce | |
CL Visa Corporate | |
CL Visa Purchasing | |
CL Visa Dr Com Intl | |
MasterCard Credit: | |
MasterCard Cr Per | |
MasterCard Signia | |
MasterCard World | |
CL MasterCard Cr Per | |
CL MCard Signia | |
CL MasterCard World | |
MasterCard Debit: | |
MasterCard Dr Per Int | |
Dr MasterCard EEA | |
CL MCard Dr Per Int | |
CL Dr MasterCard EE | |
MasterCard Commercial: | |
MasterCard Comm | |
MasterCard Business | |
MasterCard Corporate | |
MasterCard Purchase | |
MasterCard Fleet | |
MasterCardDr Com Int | |
Contactless MasterCard Commercial: | |
CL MasterCard Comm | |
CL MasterCard Bus | |
CL MasterCard Corp | |
CL MasterCard Purch | |
CL MasterCard Fleet | |
CL MCard Dr Com Int | |
Maestro: | |
Maestro Intl | |
CL Maestro Intl | |
Maestro UK (DOM) | |
CL Maestro UK (DOM) | |
Others: | |
All Star | |
American Express | |
BP Agency | |
CardMaster | |
Compower | |
Clydesdale | |
Diners Club | |
Dialcard | |
Elfin | |
Foreserve | |
GE Capital Store Crd | |
JCB | |
Keyfuels | |
Lombard CreditCharge | |
Lombard Edge | |
Loyalty Cards | |
Overdrive | |
Laser | |
Tesco (TPF) | |
Style Co Branded | |
Supercharge | |
Sears | |
Shell Gold | |
Shell Agency | |
Style Private Label | |
Style | |
Texaco Eire | |
Routex | |
Venture |
Yes, we support Giropay.
Worldpay's API allows you to accept Card, Giropay, and PayPal orders using a single integration, so you can concentrate on your business while we handle your payments.
Giropay is Germany's most popular Bank Transfer payment system giving you access to 17 million users and over 60% of commercial bank customers in Germany.
Giropay payments are managed in the same place and in the same way as other payments via Worldpay - in your dashboard. The only differences are :
- Recurring payments are not supported
- Virtual Terminal / phone orders are not supported
As a Worldpay corporate merchant wishing to offer Giropay, you can request enablement of Giropay via your Settings, and start integrating your website with our
World payment methods, like iDEAL, work a little differently from traditional card based payment methods like Visa and MasterCard. Instead of staying on your checkout page to make a payment, with iDEAL customers will be redirected to their own online banking to complete their payment, and then back to your site.
Starting taking payments with iDEAL is easy. You can
- Enable iDEAL on your Payment Types page, and we'll email you when registration is complete
- Add an iDEAL button to your website and make iDEAL payments
World payment methods, like Alipay, work a little differently from traditional card based payment methods like Visa and MasterCard. Instead of staying on your checkout page to make a payment, with Alipay customers are redirected to Alipay to choose and login to the online bank they want to pay from. Once complete your customer is then redirected back to your site.
Starting taking payments with Alipay is easy. You can
- Enable Alipay on your Payment Types page, and we'll email you when registration is complete
- Add an Alipay button to your website and make Alipay payments
Shoppers want to pay with the card that they have in their hand – luckily, we’re here to help keep your customers happy, by enabling you to accept a full range of global payment methods.
Mastercard credit and debit cards | Accepted |
Maestro | Accepted |
Visa credit and debit cards | Accepted |
American Express | Accepted |
Visa Electron | Accepted for UK merchants, processed as a debit card transaction in GBP only |
Visa Purchasing | Accepted, treated as credit card payments. Worldpay does not support the "line item detail" features of Visa Purchasing cards |
PayPal | Accepted, alternative payment method |
There is no minimum amount for payments you can accept with Worldpay.
At present the maximum payment amount is £5,000. This upper limit helps us to protect you from fraudulent payments, however if you would like to change it, please
Yes, we support 3D Secure, or “3DS”.
3DS is the generic name for ‘Verified by Visa’, ‘MasterCard SecureCode’, 'Amex Safekey’ etc. It is the second page that some online retailers present in which you need to enter the password of your credit or debit card provider.
The main benefit of 3DS for you is that it protects you against
The downside of 3DS is that your customers have to fill in an additional screen, which can be a hassle, particularly on mobile phones. We make it possible to enable or disable 3DS on an order-by-order basis which gives you full control over when to use it and when not to.
How to implement 3DS is described
Worldpay makes it easy to see what kind of card your customer is using, which allows you to make the right business decision for that transaction.
When you collect your customer's card details and store them in our secure systems, we will always tell you what type of card it is - Visa, Mastercard, Amex and so on. For the majority of the world's payment cards we can also let you know these additional properties:
- Credit Card or Debit Card
- Consumer or Corporate
- Country of Issue
- Issuer Name
- Prepaid
- Card Product Type
Some card schemes don't return these details - we're working on increasing the coverage.
For guidance on how to use this information with your website please see the
The 'acceptance' currencies are the currencies in which your customer can pay in on your website. This can be different from the 'settlement' currency which is the currency in which we will pay you.
Worldpay allows you to add up to 5 acceptance currencies for every settlement currency out of a list of over 140 currencies.
At time of Activation we will enable GBP, EUR and USD for you by default. Once you have submitted your application form and have confirmation that your account is live, you will be able to add additional acceptance and settlement currencies by going here (requires you to be logged in).
This video shows you how to add acceptance currencies with Worldpay Online Payments:
.
You may wish to store a shopper's card details so that you can use them to take payments directly from your server in the future - for example when setting up subscriptions (also called recurring payments). You can learn how to take subscriptions/recurring payments
Recurring payments are different from card-on-file payments in that the first payment is initiated by the shopper; subsequent recurring payments or subscriptions are initiated from your server by you.
To use the recurring payments feature you will need to turn it on when activating your account. If you already have a full account and would like to offer recurring billing, you can go to the Orders page in Account Settings and turn on recurring payments.
Please note that it takes at least 24 hours to enable recurring payments - you will receive an email notifying you once the process is complete and you are ready to go. If you later decide to stop making subscription/recurring payments, you do not need to turn the feature off from the Orders settings page.
It's easy for your customers to store their card details for future use with Worldpay Online Payments, to prevent them having to re-enter information when making future transactions. Since this type of "card-on-file" payment is initiated by the shopper, it is classed as a regular e-commerce payment rather than a
How to implement card-on-file payments is explained
Yes, you can.
Worldpay's tokenisation features allow you to avoid coming into contact with sensitive card details, by entirely removing the presence of card details from your systems. Tokenisation of card details is essential where you don't want the added process, certification and infrastructure costs associated with full PCI DSS compliance. However some larger organisations need access to this information, and are able to store it securely. This can also mean the organisation does not require tokenisation.
Tokenless orders allow you to collect and manage card and cardholder details in your own PCI-compliant environment, and send these details directly to our order service in a single, securely-encrypted API call. Only the API request content changes compared to token-based orders - it now contains all payment details as well as order details - all order functionality and API response contents stay exactly the same as if a token had been used.
You can learn how to create tokenless orders for any payment method in our
World payment methods, like PaySafeCard, work a little differently from traditional card based payment methods like Visa and MasterCard. Instead of staying on your checkout page to make a payment, with PaySafeCard customers are redirected to the PaySafeCard website to complete the transaction by entering details of pre-purchased money vouchers. Once complete your customer is then redirected back to your site.
Starting taking payments with PaySafeCard is easy. You can
- Enable PaySafeCard on your Payment Types page, and we'll email you when registration is complete
- Add a PaySafeCard button to your website and make PaySafeCard payments
No, we do not support Apple Pay.
UK Businesses who operate in the Financial Services sector - for example Banks, Mortgage Providers, Payday Loan Operators - need to collect additional details when processing UK Visa transactions for the purposes of better Anti-Money Laundering detection and prevention.
Visa requires that UK businesses who are in Merchant Category Code (MCC) 6012, and are processing a UK-issued Visa card transaction, must collect the name, postcode, date of birth and account number of the recipient of the funds.
The following customerIdentifier key-value attributes must be included in any such order request, and can optionally be specified for an order involving any other card or payment method:
customerIdentifier Key Name | Value Example | Description |
---|---|---|
accountReference | "1234567" or "6759128722" | Receiving bank account number or first 6 and last 4 digits of receiving credit card number |
dateOfBirth | "01-01-1970" | Date of birth of the recipient of the funds in DD-MM-YYYY format |
familyName | "Smith" | Family name of the recipient of the funds |
postalCode | "EC4N 8AF" | Residential post code of the recipient of the funds, including a space |
Providing incorrect values can result in refusal of the transaction.
See the
Yes, you can.
All you have to do is go to thecreate telephone order
, enter the amount you want to charge and the customer’s card details and click create order
.
You can use this feature to take orders via the telephone, but you can also use it to take orders via mail. In the payments industry, this feature is also sometimes referred to as "Mail Order Telephone Order" (MOTO) or "Virtual Terminal".
Important: fees for telephone orders are always the same as fees for credit card payments, even if the customer paid with a debit card.
The create telephone order button will not be visible on live mode unless you have enabled telephone orders on your account. You can do so from thetelephone orders
to on
.
To ensure that you are