Menu

Get started with our Payouts API

API v3
Last updated September 2021
Change log

Make yourself familiar with ourAPI Principlesto ensure a resilient integration.

Set your headers

Setting your headers is an important part of an API request. The headers represent the meta-data associated with your API request.

Copied!
Authorization: {your_credentials}
Content-Type: application/vnd.worldpay.payouts-v3+json
Accept: application/vnd.worldpay.payouts-v3+json
HeaderDescription
AuthorizationWe use the Authorization header to identify and authenticate you within Access Worldpay. You must use the Authorization header for any request you send to our Payouts API, unless you are using client certificate authentication over TLS. If you must use this, read our reference guide onAuthenticating with SSL/TLS.
Content-TypeWe require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT.
AcceptWe use the Accept header to identify which version of our Payouts API you are using. You must use the Accept header for any request you send to our Payouts API.

If you're using both the Content-Type and Accept headers, they must match.

Note: Replace {your_credentials} with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your Implementation Manager.

Query the root resource

Our APIs guide you by providing you with links to the next available actions.

To discover and start using our APIs you must first query the root resource. This returns the available resources within Access Worldpay.

Request

GET https://try.access.worldpay.com/

Note: No request body is needed for this request.

Response

You receive all our available API resources in the response.

Copied!
{
    "_links": {
        "payments:authorize": {
            "href": "https://try.access.worldpay.com/payments/authorizations"
        },
        "service:payments": {
            "href": "https://try.access.worldpay.com/payments"
        },
        "service:sessions": {
            "href": "https://try.access.worldpay.com/sessions"
        },
        "service:tokens": {
            "href": "https://try.access.worldpay.com/tokens"
        },
        "service:verifications/accounts": {
            "href": "https://try.access.worldpay.com/verifications/accounts"
        },
        "service:verifications/customers/3ds": {
            "href": "https://try.access.worldpay.com/verifications/customers/3ds"
        },
        "service:verifiedTokens": {
            "href": "https://try.access.worldpay.com/verifiedTokens"
        },
        "service:fraudsight": {
            "href": "https://try.access.worldpay.com/fraudsight"
        },
        "service:exemptions": {
            "href": "https://try.access.worldpay.com/exemptions"
        },
        "service:payouts": {
            "href": "https://try.access.worldpay.com/payouts"
        },
        "service:payment_pages": {
            "href": "https://try.access.worldpay.com/payment_pages"
        },
        "service:payments/alternative/direct": {
            "href": "https://try.access.worldpay.com/payments/alternative/direct"
        },
        "service:payments/alternative/action/paypal": {
            "href": "https://try.access.worldpay.com/payments/alternative/action/paypal"
        },
        "service:payments/alternative/action/ideal": {
            "href": "https://try.access.worldpay.com/payments/alternative/action/ideal"
        },
        "service:moneyTransfers": {
            "href": "https://try.access.worldpay.com/moneyTransfers"
        },
        "curies": [
            {
                "href": "https://try.access.worldpay.com/rels/payments/{rel}",
                "name": "payments",
                "templated": true
            }
        ]
    }
}

Query the Payouts root resource

Query the service:payouts resource which gives you links to your next available actions and resources for our Payouts API.

GET https://try.access.worldpay.com/payouts

No request body is needed for this request.

The response

Copied!
{
    "_links": {
        "resourceTree": {
            "href": "https://try.access.worldpay.com/rels/payouts/resourceTree"
        },
        "payouts:basicDisbursement": {
            "href": "https://try.access.worldpay.com/payouts/basicDisbursement",
            "templated": true
        },
        "payouts:fastAccess": {
            "href": "https://try.access.worldpay.com/payouts/fastAccess",
            "templated": true
        },
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}",
            "templated": true
        },
        "payouts:query": {
            "href": "https://try.access.worldpay.com/payouts/query",
            "templated": true
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

Choose one of the action links and send your request to the corresponding resource.

Next steps

Payouts