Menu

Manage your payments

APMs v1
Last updated May 2022
Change log

Query

Make a GET request on the action:query action link.

Note: No request body is needed for this request.

Query example request

GET https://try.access.worldpay.com/payments/alternative/action/ideal/query?transactionReference=uniqueReference&entity=yourMerchantEntity

Query response for sentForSettlement

You receive:

Example response:

Copied!
{
  "lastEvent": "sentForSettlement",
  "_links": {
    "action:query": {
      "href": "https://try.access.worldpay.com/payments/alternative/action/ideal/query/payment?transactionReference={transactionReference}&entity={entity}"
    },
    "action:refund": {
      "href": "https://try.access.worldpay.com/payments/alternative/action/ideal/refunds/full/WvNPnBd78Z2Nc_yAdaeAmeCuoRS0-RgC0as4j9DhHvU="
    },
    "action:partialRefund": {
      "href": "https://try.access.worldpay.com/payments/alternative/action/ideal/refunds/partials/WvNPnBd78Z2Nc_yAdaeAmeCuoRS0-RgC0as4j9DhHvU="
    },
    "curies": [{
        "name": "action",
        "href": "https://try.access.worldpay.com/rels/payments/alternative/action/ideal/{rels}",
        "templated": true
      }]
  }
}

Query response for lastEvents other than sentForSettlement

You receive:

  • an HTTP code 201
  • the lastEvent for your query request
  • links toquery

Example response:

Copied!
{
    "lastEvent": "|Authorized|sentForRefund|refused|cancelled|error|refundFailed",
    "_links": {
      "action:query": {
        "href": "https://try.access.worldpay.com/payments/alternative/action/ideal/query/payment?transactionReference={transactionReference}&entity={entity}"
      },
      "curies": [{
          "name": "action",
          "href": "https://try.access.worldpay.com/rels/payments/alternative/action/ideal/{rels}",
          "templated": true
        }]
    }
}

Full refund

To refund a payment the latest status must be sentForSettlement.

POST your request to the action:full-refund action link.

Note: No request body is needed for this request.

Full refund example request

POST https://try.access.worldpay.com/payments/alternative/action/ideal/refunds/full/WvNPnBd78Z2Nc_yAdaeAmeCuoRS0-RgC0as4j9DhHvU=

Full refund response

You receive:

  • sentForRefund - The refund has been accepted.
  • refundFailed - The refund was not successful.
  • sentForSettlement - Query the payment again later. The refund might already be in process.
  • an HTTP code 202
  • links toquery

Example response:

Copied!
{
  "_links": {
    "action:query": {
      "href": "https://try.access.worldpay.com/payments/alternative/action/ideal/query/payment?transactionReference={transactionReference}&entity={entity}"
    },
    "curies": [{
        "name": "action",
        "href": "https://try.access.worldpay.com/rels/payments/alternative/action/ideal/{rels}",
        "templated": true
      }]
  }
}

Possible outcomes

  • sentForRefund - The refund has been accepted.
  • refundFailed - The refund was not successful.
  • sentForSettlement - Query the payment again later. The refund might already be in process.

Partial refund

Partial refund request

Send the amount to partial refund and the authorization currency in the body.

Partial refund example request

POST https://try.access.worldpay.com/payments/alternative/action/ideal/refunds/partials/WvNPnBd78Z2Nc_yAdaeAmeCuoRS0-RgC0as4j9DhHvU=

Partial refund request body:

Copied!
{
  "value": {
    "amount": 100,
    "currency": "EUR"
  },
  "reference": "partial-refund-reference"
}

Description of your partial refund request parameters

ParameterRequiredDescription
value.amountAn identifier for the amount being used.
value.currencyAn identifier for the currency being used.
referenceA unique reference generated by you to identify the partial refund. For more information and best practice seereference format.

Partial refund response

You receive:

  • an HTTP code 202
  • links toqueryyour payment

Example response:

Copied!
{
  "_links": {
    "action:query": {
      "href": "https://try.access.worldpay.com/payments/alternative/action/ideal/query/payment?transactionReference={transactionReference}&entity={entity}"
    },
    "curies": [
      {
        "name": "action",
        "href": "https://try.access.worldpay.com/rels/payments/alternative/action/ideal/{rels}",
        "templated": true
      }
    ]
  }
}