# Payments

Use a single API that orchestrates the payment flow to include FraudSight, 3DS and Token creation.

__Authentication__

Set your headers 

```   
Authorization: {your_credentials}    
Content-Type: application/json    
WP-Api-Version: 2024-06-01
```    

Replace `{your_credentials}` with your base64-encoded Basic Auth username and password.  

__DNS whitelisting__

Whitelist the following URLs:    
* `https://try.access.worldpay-bsh.securedataplatform.com/`
* `https://access.worldpay-bsh.securedataplatform.com/`

Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned. 

__API collection__

A full set of API examples based on different scenarios. 

 * __[Download Postman collection](./collections/index.md)__


Version: 2024-06-01
Metadata:
  - category: ["3DS","SCA Exemptions","Card Payments","Risk Assessments","Tokens","Wallets"]
  - tags: ["Orchestration"]
  - generated: true
  - business: ["Enterprise","SMB (Worldpay eCommerce)"]
  - catalog-list: true

## Servers

Test (Try)
```
https://try.access.worldpay-bsh.securedataplatform.com
```

Live
```
https://access.worldpay-bsh.securedataplatform.com
```

## Security

### BasicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[Payments](https://worldpay-portal.eu.redocly.app/access/_bundle/products/payments/@20240601/openapi.yaml)

## Payment

Take a payment

### Payment request

 - [POST /api/payments](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/payment/payment.md): Initiate payment

## 3DS actions

If 3DS is enabled additional actions are required

### Supply 3DS device data

 - [POST /api/payments/{linkData}/3dsDeviceData](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/3ds-actions/supply3dsdevicedata.md): Gather additional device data

### Continue with the payment after a 3DS challenge

 - [POST /api/payments/{linkData}/3dsChallenges](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/3ds-actions/complete3dschallenge.md): Verify authentication challenge

## Manage payments

Additional payment actions following authorization

### Payment query request

 - [GET /api/payments/{linkData}](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/manage-payments/queryevents.md): Query a payment

### Submit a payment settle request

 - [POST /api/payments/{linkData}/settlements](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/manage-payments/settle.md): Settle a payment

### Submit a payment partial settle request

 - [POST /api/payments/{linkData}/partialSettlements](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/manage-payments/partialsettle.md): Partially settle a payment

### Submit a payment refund request

 - [POST /api/payments/{linkData}/refunds](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/manage-payments/refund.md): Refund a payment

### Submit a payment partial refund request

 - [POST /api/payments/{linkData}/partialRefunds](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/manage-payments/partialrefund.md): Partially refund a payment

### Submit a payment cancel request

 - [POST /api/payments/{linkData}/cancellations](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/manage-payments/cancel.md): Cancel a payment

### Submit a payment reverse request

 - [POST /api/payments/{linkData}/reversals](https://worldpay-portal.eu.redocly.app/access/products/payments/openapi/manage-payments/reversal.md): Reverse a payment