Payouts

API v3

Last updated September 2021

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 yourquery the payout root resourcerequest.

Note: If you want to payout to a wallet please readherefirst.

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

Payout request body:

Copied!

{
    "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"
            }
        }
    }
}

{
    "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/tokenized",
            "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiMjZ5OUp3Q2dEeDVjWEZBcjhjSmRlcmZTcE44ZzRoazFMcmNCSzlqaEVWcz0ifQ"
        }
    }
}

{
    "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/networkToken+applepay",
            "cardHolderName": "Sherlock Holmes",
            "dpan": "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:

Parameter	Required	Description
`instruction`		An object that contains all the information related to your payout request.
`instruction.payoutInstrument`		An object that contains your customer's payout details.
`payoutInstrument.type`		An object that contains your customer's payout type. Possible values: `card/plain` `card/tokenized` `card/networkToken+applepay`
`payoutInstrument.href`		An object that contains your link to anAccess Token. Mandatory for all `"type": "card/tokenized"` requests.
`payoutInstrument.dpan`		An object that contains the device primary account number. Mandatory for all`"type": "card/networkToken+applepay"`requests.
`value.amount`		The payout amount. This is a whole number with an exponent, e.g. if exponent is two, 250 is 2.50. You can find the relevant exponent in ourcurrency table.
`value.currency`		The 3 digit currency code. See list ofsupported currencies.
`instruction.narrative.line1`		First line of text that appears on your customer's statement. Used to identify the merchant. Seenarrative formatfor more details and best practices.
`instruction.narrative.line2`		Second line of text that appears on your customer's statement. Used to give further details about the merchant. Seenarrative formatfor more details and best practices.
`merchant`		An object that contains information about the merchant.
`merchant.entity`		This is mandatory forauthenticationandqueries. Contact your Implementation Manager for more information.
`transactionReference`		A unique reference generated by you, used to identify a payout throughout its lifecycle. Seetransaction reference formatfor more details and best practices.
`payoutInstrument.cardHolderName`		An object that contains your customer's payout card name. This is not a mandatory field however it is recommended that you supply this to improve authorization rates. If not sent, the default is "Not Supplied". We highly recommend you supply the cardholder name, as most issuers require this. Additionally, it increases your acceptance rate.
`payoutInstrument.cardExpiryDate`		An object that contains your customer's payout card expiry date. Mandatory for all `"type": "card/plain"` requests. Can be a date in the past to process unreferenced refunds.
`payoutInstrument.cardNumber`		An object that contains your customer's payout card number. Mandatory for `"type": "card/plain"` requests.
`payoutInstrument.billingAddress`		An object containing the billing address information. If included you must send at least: `countryCode` `postalCode` For requests with Canadian Visa cards `billingAddress` details are mandatory. For this type of request you must send at least: `address1` `city` `state` `countryCode` `postalCode` You can only supply this with a `card/plain` or `card/networkToken+applepay` payout instrument. We recommend to provide `billingAddress` fields for all Payout requests. If not provided for `basicDisbursement` requests with a Visa card, you may see increased failures. This includes `fastAccess` requests that default to standard payout flows. You can find more details in ourVisa OCT mandate article.

The full request schemas are available in theAPI reference.

Payout response

Best Practice: Access Worldpay returns a WP-correlationId in the headers of service responses. We highly recommend you log this. The WP-correlationId is used by us to examine individual service requests.

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:

Copied!

{
    "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
        }]
    }
}

{
    "outcome": "refused",
    "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
        }]
    }
}

{
    "outcome": "error",
    "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
        }]
    }
}

{
    "outcome": "queryRequired",
    "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
        }]
    }
}

Best practice: We recommend using ourEvents serviceto receive the latest Payout status.

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}

Copied!

{
    "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.

Note: If no update is available, you will get an error. You can get further information in ourerror reference.

Fast Access

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

Fast Access is currently only available for Visa payouts via Visa Direct.

Prerequisite: You must be enabled for Fast Access before using it. Please contact your Implementation Manager for more information.

Fast Access payout request

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

If your customers card is not Fast Access enabled, astandard payoutis automatically performed.

Note: If you want to payout to a wallet please readherefirst.

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

Fast Access payout request body:

Copied!

{
    "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"
            }
        }
    }
}

{
    "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/tokenized",
            "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiMjZ5OUp3Q2dEeDVjWEZBcjhjSmRlcmZTcE44ZzRoazFMcmNCSzlqaEVWcz0ifQ"
        }
    }
}

{
    "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/networkToken+applepay",
            "cardHolderName": "Sherlock Holmes",
            "dpan": "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

Parameter	Required	Description
`instruction`		An object that contains all the information related to your payout request.
`payoutInstrument`		An object that contains your customer's payout details.
`payoutInstrument.type`		An object that contains your customer's payout type. Possible values: `card/plain` `card/tokenized` `card/networkToken+applepay`
`payoutInstrument.href`		An object that contains your link to anAccess Token. Mandatory for all `"type": "card/tokenized"` requests.
`payoutInstrument.dpan`		An object that contains the device primary account number. Mandatory for all`"type": "card/networkToken+applepay"`requests.
`value.amount`		The payout amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2.50. You can find the relevant exponent in ourcurrency table.
`value.currency`		The 3 digit currency code. See list ofsupported currencies.
`instruction.narrative.line1`		First line of text that appears on your customer's statement. Used to identify the merchant. Seenarrative formatfor more details and best practices.
`instruction.narrative.line2`		Second line of text that appears on your customer's statement. Used to give further details about the merchant. Seenarrative formatfor more details and best practices.
`merchant`		An object that contains information about the merchant.
`merchant.entity`		This is mandatory forauthenticationandqueries. Contact your Implementation Manager for more information.
`transactionReference`		A unique reference generated by you, used to identify a payout throughout its lifecycle. Seetransaction reference format, for more details and best practices.
`payoutInstrument.cardHolderName`		An object that contains your customer's payout card name. This is not a mandatory field however it is recommended that you supply this to improve authorization rates. If not supplied, the default is "Not Supplied". We highly recommend you supply the cardholder name, as most issuers require this. Additionally, it increases your acceptance rate.
`payoutInstrument.cardExpiryDate`		An object that contains your customer's payout card expiry date. Mandatory for all `"type": "card/plain"` requests. Must be a date in the future.
`payoutInstrument.cardNumber`		An object that contains your customer's payout card number. Mandatory for all `"type": "card/plain"` requests.
`payoutInstrument.billingAddress`		An object containing the billing address information. If included you must send at least: `countryCode` `postalCode` For requests with Canadian Visa cards `billingAddress` details are mandatory. For this type of request you must send at least: `address1` `city` `state` `countryCode` `postalCode` You can only supply this with a `card/plain` or `card/networkToken+applepay` payout instrument. We recommend to provide `billingAddress` fields for all Payout requests. If not provided for `basicDisbursement` requests with a Visa card, you may see increased failures. This includes `fastAccess` requests that default to standard payout flows. You can find more details in ourVisa OCT mandate article.

The full request schemas are available in theAPI reference.

Fast Access payout response

Best Practice: Access Worldpay returns a WP-CorrelationId in the headers of service responses. We highly recommend you log this. The WP-CorrelationId is used by us to examine individual service requests.

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

Copied!

{
    "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
        }]
    }
}

{
    "outcome": "pending",
    "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
        }]
    }
}

{
    "outcome": "approved",
    "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
        }]
    }
}

{
    "outcome": "disbursed",
    "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
        }]
    }
}

{
    "outcome": "refused",
    "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
        }]
    }
}

{
    "outcome": "error",
    "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
        }]
    }
}

{
    "outcome": "queryRequired",
    "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:

Copied!

{
    "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
        }]
    }
}

{
    "outcome": "pending",
    "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
        }]
    }
}

{
    "outcome": "approved",
    "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
        }]
    }
}

{
    "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.

Note: If no update is available, you will get an error. You can get further information in ourerror reference.

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.

You can only get the location from the 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.

Payouts

Standard payout

Payout request

Descriptions of your payout request parameters:

Payout response

Standard payout `outcome` of `queryRequired`

Fast Access

Fast Access payout request

Descriptions of your Fast Access payout request parameters

Fast Access payout response

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

Retrieve a payout using the original resource

Query a payout without the original resource

Searching accross the entire site

Filter by product

Filter by product Searching across the entire site

Payouts

Standard payout

Payout request

Descriptions of your payout request parameters:

Payout response

Standard payout outcome of queryRequired

Fast Access

Fast Access payout request

Descriptions of your Fast Access payout request parameters

Fast Access payout response

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

Retrieve a payout using the original resource

Query a payout without the original resource

Searching accross the entire site

Filter by product

Filter by product Searching across the entire site

​

Standard payout `outcome` of `queryRequired`

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