Payments

Payments

Payments root resource, returns links to available payments actions.

Methods

GET

Retrieve links to next available actions.

Responses

Examples

GET
 Retrieve the Payments top-level collection resource.
View

Link relationship

  • payments:authorize

    Authorize a payment.

  • payments:migrateRecurringAuthorizations

    Migrate a recurring authorization.

  • payments:migrateCardOnFileAuthorize

    Migrate a CardOnFile authorization.

  • payments:recurringMandate

    Create a recurring mandate.

  • payments:events

    Query a payment event.

  • resourceTree

    A document showing possible interactions with the Payments API.

get
 Retrieve the Payments top-level collection resource.
GEThttps://try.access.worldpay.com/payments/

200

Copied!
{
  "_links": {
    "resourceTree": {
      "href": "https://try.access.worldpay.com/payments/resourceTree"
    },
    "payments:authorize": {
      "href": "https://try.access.worldpay.com/payments/authorizations"
    },
    "payments:migrateRecurringAuthorizations": {
      "href": "https://try.access.worldpay.com/payments/authorizations/migrateRecurring"
    },
    "payments:migrateCardOnFileAuthorize": {
      "href": "https://try.access.worldpay.com/payments/authorizations/migrateCardOnFile"
    },
    "payments:recurringMandate": {
      "href": "https://try.access.worldpay.com/payments/recurringMandates"
    },
    "payments:events": {
      "href": "https://try.access.worldpay.com/payments/events"
    },
    "curies": [
      {
        "name": "payments",
        "href": "https://try.access.worldpay.com/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}