# Card Payments Payments root resource, returns links to available payments actions. Version: 6 ## Servers Test (Try) ``` https://try.access.worldpay.com ``` Live ``` https://access.worldpay.com ``` ## Security ### BasicAuth Type: http Scheme: basic ## Download OpenAPI description [Card Payments](https://developer.worldpay.com/_bundle/products/card-payments/@v6/openapi.yaml) ## Take a one-time payment To take a payment, you must first create an authorization request. Your response contains links to your next available actions. ### Create an authorization - [POST /payments/authorizations](https://developer.worldpay.com/products/card-payments/v6/openapi/take-a-one-time-payment/authorize.md): Take online card payments using our Card Payments API. ## Take repeat payments Take a payment using a stored credential ### Authorize using card on file with verification - [POST /payments/authorizations/cardOnFile/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/take-repeat-payments/cardonfileauthorize.md): Use our card on file authorize resource when your customer is initiating a payment using stored card details verifying their account first ### Authorize using card on file, no verification - [POST /payments/authorizations/migrateCardOnFile](https://developer.worldpay.com/products/card-payments/v6/openapi/take-repeat-payments/migratecardonfileauthorize.md): Use our card on file authorize resource when your customer is initiating a payment using stored card details (without verifying their account first) ### Card on file sale - [POST /payments/sales/migrateCardOnFile](https://developer.worldpay.com/products/card-payments/v6/openapi/take-repeat-payments/migratecardonfilesale.md): Use our card on file sale resource when your customer is initiating a payment using stored card details, and you want to instantly trigger the settlement process ### Authorize recurring payment, no verification - [POST /payments/authorizations/migrateRecurring](https://developer.worldpay.com/products/card-payments/v6/openapi/take-repeat-payments/migraterecurringauthorize.md): Use our migrate recurring authorize resource when you are initiating a payment using your customer's stored card details, without verifying their account first ### Authorize recurring payment with verification - [POST /payments/authorizations/recurring/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/take-repeat-payments/recurringauthorize.md): Use our recurring authorize resources when you are initiating a payment using your customer's stored card details, verifying your customer's account first. ### Recurring sale - [POST /payments/sales/recurring/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/take-repeat-payments/recurringsale.md): Use our recurring sale resource to authorize and settle merchant initiated transactions where you have stored the card details. You must verify your customer's account before submitting your first recurring payment for authorization. ## Manage payments Cancel, settle, refund or reverse payments ### Settle for full amount - [POST /payments/settlements/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/manage-payments/settle.md): To receive all the funds from the customer, send us a settle request. ### Settle for partial amount - [POST /payments/settlements/partials/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/manage-payments/partialsettlement.md): To receive a portion of the funds of a payment, send us a partial settle request. ### Refund full amount - [POST /payments/settlements/refunds/full/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/manage-payments/refund.md): Send a refund request to return the full settled amount to your customer. Note: No request body is needed for this request. ### Refund partial amount - [POST /payments/settlements/refunds/partials/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/manage-payments/partialrefund.md): Send a partial refund request to return a portion of the settled amount to your customer. Send the amount to refund and the authorization currency in the body. ### Cancel authorization - [POST /payments/authorizations/cancellations/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/manage-payments/cancel.md): If you don’t want to proceed with a payment, you can send a cancel request Note: You can only cancel a payment which is authorized. If the payment is settled, you must create a refund. ### Reversal - [POST /payments/sales/reversals/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/manage-payments/reversal.md): Your reversal request is processed as a cancel or refund request. This depends on the time passed after your sale request was submitted. For US entities the payment is refunded after one day after a successful sale request. Any other payment moves to refunded after 15 minutes. Note: No request body is needed for this request. ### Recurring mandate - [POST /payments/recurringMandates](https://developer.worldpay.com/products/card-payments/v6/openapi/manage-payments/recurringmandate.md): Create a recurring mandate using a scheme transaction ID ## Query a payment Send a request to find out the current status of your payment after it has been authorized. ### Query payment status - [GET /payments/events/{linkData}](https://developer.worldpay.com/products/card-payments/v6/openapi/query-a-payment/eventquery.md): Send a request to find out the current status of your payment after it has been authorized using the events action link. Note: It can take up to 15 minutes for a payment event to update. ### Query payment status recovery - [GET /payments/events](https://developer.worldpay.com/products/card-payments/v6/openapi/query-a-payment/eventrecovery.md): Send a request to find out the current status of your payment after it has been authorized using the events action link. This action is only to be used for recovery purposes. Use this action if your authorization requests timed out. The response determines if your authorization request was successful and your next available actions are returned.