# APM API

 __Authentication__
    Set your headers
```
    Authorization: {your_credentials}
    Content-Type: application/json
    WP-Api-Version: 2023-06-01
```
    Replace `{your_credentials}` with your base64-encoded Basic Auth username and password.
    <br><br>
    __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.
 

Version: 2023-06-01

## Servers

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

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

## Security

### BasicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[APM API](https://worldpay-portal.eu.redocly.app/access/_bundle/products/apms/@20230601/openapi.yaml)

## Operational

### Used to check whether the service is up

 - [GET /apmPayments/status](https://worldpay-portal.eu.redocly.app/access/products/apms/20230601/openapi/operational/status.md)

## Payment lifecycle

### Get the last event for an APM payment

 - [GET /apmPayments/{paymentId}](https://worldpay-portal.eu.redocly.app/access/products/apms/20230601/openapi/payment-lifecycle/query.md): Lookup the state of a payment, including the available action that can be performed.

### Reverse an APM payment

 - [POST /apmPayments/{paymentId}/reversals](https://worldpay-portal.eu.redocly.app/access/products/apms/20230601/openapi/payment-lifecycle/partialreverse.md): Perform a reversal on the funds taken from a sale.

### Settle an APM payment

 - [POST /apmPayments/{paymentId}/settlements](https://worldpay-portal.eu.redocly.app/access/products/apms/20230601/openapi/payment-lifecycle/settle.md): Perform a settlement on authorized funds. Not all APMs support this, please check the links returned from querying a payment.

## Other

### Create an APM payment

 - [POST /apmPayments](https://worldpay-portal.eu.redocly.app/access/products/apms/20230601/openapi/other/payment.md): Perform a sale.