Last Updated: 11 September 2023 | Change Log

Make a Card Payout

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": "Memory265-13/08/1876",
    "merchant": {
        "entity": "MindPalaceLtd"
    },
    "instruction": {
        "narrative": {
            "line1": "The Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/plain",
            "cardHolderName": "Sherlock Holmes",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            },
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            }
        }
    }
}

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.

• A timestamp of receivedAt

• The location of the payout resource

Example responses:

{
    "outcome": "requestReceived",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_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

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": "Memory265-13/08/1876",
    "merchant": {
        "entity": "MindPalaceLtd"
    },
    "instruction": {
        "narrative": {
            "line1": "The Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/plain",
            "cardHolderName": "Sherlock Holmes",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            },
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            }
        }
    }
}

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 Direct/Mastercard Send. If there are no updates within 48 hours then this moves to an error outcome.
  • approved - Visa/Mastercard 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/Mastercard’s daily reporting.
  • refused - Your Fast Access disbursement request is refused. Possible refusal reasons:
    • The card issuer declines the disbursement
    • Visa/Mastercard 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/Mastercard within 48 hours or Visa/Mastercard returns an error confirming the request has failed
• A timestamp receivedAt
• The location of the payout resource

{
    "outcome": "requested",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_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 or approved

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": "2023-09-06T12:29:39.625884Z",
    "_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.