Access Worldpay
/
US and Canadian APMs
/
ACH/eCHeck
/
Manage your APM

Last Updated: 13 November 2024 | Change Log

Manage your payments

Reversal

POST your request to the direct:reverse action link.

Note

No request body is needed for this request.

Reversal example request

POST https://try.access.worldpay.com/payments/alternative/direct/reversals/linkData

Reversal response

You receive:

  • an HTTP code 201
  • the outcome for your reversal request
  • a link to query your payment

Example response:

{
    "_links": {
        "direct:events": {
            "href": "https://try.access.worldpay.com/payments/alternative/direct/linkData"
        },
        "curies": [{
            "name": "direct",
            "href": "https://try.access.worldpay.com/rels/payments/alternative/direct/{rels}",
            "templated": true
        }]
    }
}

Query and Events

GET your request to the direct:events action link.

Note

No request body is needed for this request.

Query example request

GET https://try.access.worldpay.com/payments/alternative/direct/events?transactionReference=uniqueReference&entity=yourMerchantEntity

Query responses

You receive:

  • an HTTP code 201
  • the outcome for your events request
  • links to reverse or query your payment

Example response:

{
    "outcome": "sentForSettlement|refused|reversed",
    "_links": {
        "direct:events": {
            "href": "https://try.access.worldpay.com/payments/alternative/direct/linkData"
        },
        "direct:reversal": {
            "href": "https://try.access.worldpay.com/payments/alternative/direct/reversals/linkData"
        },
        "curies": [{
            "name": "direct",
            "href": "https://try.access.worldpay.com/rels/payments/alternative/direct/{rels}",
            "templated": true
        }]
    }
}

Events example request

GET https://try.access.worldpay.com/payments/alternative/direct/events/linkData

Events responses

You receive:

  • an HTTP code 201
  • the lastEvent for your events request
  • links to reverse or query your payment

Example response:

{
    "lastEvent": "sentForSettlement|refused|reversed",
    "_links": {
        "direct:events": {
            "href": "https://try.access.worldpay.com/payments/alternative/direct/linkData"
        },
        "direct:reversal": {
            "href": "https://try.access.worldpay.com/payments/alternative/direct/reversals/linkData"
        },
        "curies": [{
            "name": "direct",
            "href": "https://try.access.worldpay.com/rels/payments/alternative/direct/{rels}",
            "templated": true
        }]
    }
}