Last Updated: 29 August 2024 | Change Log

Payouts

Send funds to your customer's cards.

Standard payout

Payout request

Pay your customers by sending a request to our payouts:basicDisbursement action link received in your query the payout root resource request.

POST https://try.access.worldpay.com/payouts/basicDisbursement

Payout request body:

{
    "transactionReference": "unique-transactionReference",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "abc",
            "line2": "abc"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/plain",
            "cardHolderName": "John Appleseed",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            }
        }
    }
}

Descriptions of your payout request parameters:

Payout response

In your response we return:

• The outcome, which could be:

  • requestReceived - We have received your basic disbursement request and are processing it within 3-5 working days.
  • refused - This payout method is refused, try another card.
  • error - A downstream system failed to process your request.
  • queryRequired - Due to a downstream issue, the outcome of your request could not be determined at this time.

• A timestamp of receivedAt

• The location of the payout resource

Example responses:

{
    "outcome": "requestReceived",
    "receivedAt": "2018-09-01T10:37:36.923Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

Standard payout outcome of queryRequired

Send a GET request to the payouts:payout action link, to retrieve the outcome of your payout request. When an update to the outcome is available the payouts:update action link appears in the queryRequired response.

Example response:

GET https://try.access.worldpay.com/payouts/{resource}

{
    "outcome": "queryRequired",
    "receivedAt": "2018-09-01T10:37:36.923Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "payouts:update": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

Send a GET request to the payouts:update action link to find out the update to the outcome.

Fast Access

Use Fast Access to pay your customers within 30 minutes or less.

Fast Access payout request

Send your payout request to our payouts:fastAccess action link received in your query the payout root resource request.

If your customers card is not Fast Access enabled, a standard payout is automatically performed.

POST https://try.access.worldpay.com/payouts/fastAccess

Fast Access payout request body:

{
    "transactionReference": "unique-transactionReference",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "abc",
            "line2": "abc"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/plain",
            "cardHolderName": "John Appleseed",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            }
        }
    }
}

Descriptions of your Fast Access payout request parameters">

Fast Access payout response

In our response we return:

• The outcome, which could be:
  • requested - We have received your Fast Access disbursement.
  • pending - We have sent your Fast Access disbursement request to Visa. If there are no updates within 48 hours then this moves to an error outcome.
  • approved - Visa has approved your request and the funds are allocated within 30 minutes if the issuer is Fast Access enabled. If not, standard timescales apply.
  • disbursed - The transaction is reconciled with Visa’s daily reporting.
  • refused - Your Fast Access disbursement request is refused. Possible refusal reasons:
    • The card issuer declines the disbursement
    • Visa declines your request because the issuing bank is not responding
    • Disbursements are not allowed in the requested country
  • error - There is no response from Visa within 48 hours or Visa returns an error confirming the request has failed
  • queryRequired - Due to a downstream issue, the outcome of your request could not be determined at this time.
• A timestamp receivedAt
• The location of the payout resource

{
    "outcome": "requested",
    "receivedAt": "2018-09-01T10:37:36.923Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

Fast Access payout outcome of requested, pending, approved or queryRequired

Send a GET request to the payouts:payout action link, to retrieve the outcome of your payout request. When an update to the outcome is avaliable the payouts:update action link will appear in this response.

Example:

GET https://try.access.worldpay.com/payouts/{resource}

Example responses:

{
    "outcome": "requested",
    "receivedAt": "2018-09-01T10:37:36.923Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "payouts:update": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

Send a GET request to the payouts:update action link to find out the update to the outcome.

Retrieve a payout using the original resource

Send a GET to the resource of the payouts:payout action link, returned in the response of the initial basicDisbursement or fastAccess request.

GET https://try.access.worldpay.com/payouts/{resource}

Replace {resource} in the link above with the location given in your initial response.

Query a payout without the original resource

If the location of an existing payout is lost, the result can still be recovered using the payouts:query endpoint.

To do this you must have the entity and transactionReference of the original request.

Send a GET to the resource of payouts:query action link.

GET https://try.access.worldpay.com/payouts/query?transactionReference={transactionReference}&entity={entity}

Replace {transactionReference} and {entity} in the link above with the transactionReference and entity of the original payout.