**Last updated**: 06 March 2026 | [**Change log**](/products/card-payouts/changelog/) # 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](/products/card-payouts/get-started#query-the-payouts-root-resource) request. Note If you want to payout to a wallet please read [here](/products/card-payouts/wallets) first. `POST` `https://try.access.worldpay-bsh.securedataplatform.com/payouts/basicDisbursement` Payout request body: Standard payout ```json { "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "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" } } } } ``` Token/wallet payout ```json { "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "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-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoiMjZ5OUp3Q2dEeDVjWEZBcjhjSmRlcmZTcE44ZzRoazFMcmNCSzlqaEVWcz0ifQ" } } } ``` Apple Pay decrypted payout ```json { "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "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" } } } } ``` Network token payout ```json { "instruction": { "value": { "amount": 100, "currency": "GBP" }, "payoutInstrument": { "type": "card/networkToken", "cardHolderName": "Sherlock Holmes", "expiryDate": { "month": 12, "year": 2029 }, "tokenNumber": "5555555555554444", "billingAddress": { "address1":"address1", "address2":"address2", "address3":"address3", "postalCode":"AB1 2CD", "city":"city", "state":"state", "countryCode":"GB" } }, "narrative": { "line1":"test1", "line2": "test2" } }, "merchant": { "entity": "default" }, "transactionReference": "{{$guid}}" } ``` ### Payout schema ```json { "$ref": "#/components/schemas/payouts_basicDisbursement", "components": { "schemas": { "card_plain": { "required": [ "type", "cardNumber", "cardExpiryDate" ], "type": "object", "description": "Plain card details.", "properties": { "type": { "type": "string" }, "cardNumber": { "type": "string", "description": "Your customer's payout card number.", "maxLength": 19, "minLength": 12, "pattern": "^[0-9]*$" }, "cardExpiryDate": { "required": [ "month", "year" ], "type": "object", "description": "The expiry date of your customer's card. Must be a date in the future.", "properties": { "month": { "type": "integer" }, "year": { "type": "integer" } } }, "cardHolderName": { "type": "string", "pattern": "^(?=.*[A-Za-z])[-A-Za-z0-9_ ]*$", "description": "The name on your customer's card. 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\". Must not contain only numeric characters." }, "billingAddress": { "required": [ "countryCode", "postalCode" ], "type": "object", "description": "An object containing the billing address information. We recommend you provide `billingAddress` fields for all Payout requests.", "properties": { "countryCode": { "type": "string", "description": "Must be provided in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes)." }, "postalCode": { "type": "string" }, "address1": { "type": "string", "description": "First line of the address. Required if `city` is provided." }, "address2": { "type": "string", "description": "Second line of the address." }, "address3": { "type": "string", "description": "Third line of the address." }, "city": { "type": "string", "description": "City. Required if `address1` is provided." }, "state": { "type": "string", "description": "Billing contact state code.\n\n * For North America, you must use the two-letter state abbreviations as defined in the latter part of the [ISO 3166-2 standard](https://www.iso.org/obp/ui/#iso:code:3166:US).\n * For all other regions and provinces around the world, this is a free text field.\n\n Example:\n\n * `AZ`\n\n * `Cambridgeshire`" } } } } }, "card_tokenized": { "required": [ "type", "href" ], "type": "object", "description": "Tokenized card details.", "properties": { "type": { "type": "string" }, "href": { "type": "string", "description": "An object that contains your link to an Access Token." } } }, "card_networkToken": { "required": [ "type", "tokenNumber", "expiryDate" ], "type": "object", "description": "Network Payment Token details.", "properties": { "type": { "type": "string" }, "tokenNumber": { "type": "string", "description": "The network payment token number.", "maxLength": 19, "minLength": 12, "pattern": "^[0-9]*$", "example": "4444333322221111" }, "expiryDate": { "required": [ "month", "year" ], "type": "object", "description": "The expiry date of the network token. Must be a date in the future.", "properties": { "month": { "type": "integer" }, "year": { "type": "integer" } } } } }, "applepay_decrypted": { "required": [ "type", "dpan", "cardExpiryDate" ], "type": "object", "description": "Wallet details.", "properties": { "type": { "type": "string" }, "dpan": { "type": "string", "description": "The device primary account number (DPAN).", "maxLength": 19, "minLength": 12, "pattern": "^[0-9]*$", "example": "4444333322221111" }, "cardExpiryDate": { "required": [ "month", "year" ], "type": "object", "description": "The expiry date of the payout DPAN. Must be a date in the future.", "properties": { "month": { "type": "integer" }, "year": { "type": "integer" } } }, "billingAddress": { "required": [ "countryCode", "postalCode" ], "type": "object", "description": "An object containing the billing address information. We recommend you provide `billingAddress` fields for all Payout requests.", "properties": { "countryCode": { "type": "string", "description": "Must be provided in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes)." }, "postalCode": { "type": "string" }, "address1": { "type": "string", "description": "First line of the address. Required if `city` is provided." }, "address2": { "type": "string", "description": "Second line of the address." }, "address3": { "type": "string", "description": "Third line of the address." }, "city": { "type": "string", "description": "City. Required if `address1` is provided." }, "state": { "type": "string", "description": "Billing contact state code.\n\n * For North America, you must use the two-letter state abbreviations as defined in the latter part of the [ISO 3166-2 standard](https://www.iso.org/obp/ui/#iso:code:3166:US).\n * For all other regions and provinces around the world, this is a free text field.\n\n Example:\n\n * `AZ`\n\n * `Cambridgeshire`" } } }, "cardHolderName": { "type": "string", "pattern": "^(?=.*[A-Za-z])[-A-Za-z0-9_ ]*$", "description": "The name on your customer's card. 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\". Must not contain only numeric characters." } } }, "payouts_basicDisbursement": { "required": [ "instruction", "merchant", "transactionReference" ], "type": "object", "description": "Basic disbursement input.", "properties": { "instruction": { "required": [ "narrative", "payoutInstrument", "value" ], "type": "object", "description": "An object that contains all the information related to your payout request.", "properties": { "narrative": { "required": [ "line1" ], "type": "object", "description": "An object that contains identification and further details of the merchant.", "properties": { "line1": { "type": "string", "description": "First line of text that appears on your customer's statement." }, "line2": { "type": "string", "description": "Second line of text that appears on your customer's statement." } } }, "payoutInstrument": { "type": "object", "description": "An object that contains your customer's payout type.", "oneOf": [ { "$ref": "#/components/schemas/card_plain" }, { "$ref": "#/components/schemas/card_tokenized" }, { "$ref": "#/components/schemas/card_networkToken" }, { "$ref": "#/components/schemas/applepay_decrypted" } ], "discriminator": { "propertyName": "type", "mapping": { "card/plain": "#/components/schemas/card_plain", "card/tokenized": "#/components/schemas/card_tokenized", "card/networkToken": "#/components/schemas/card_networkToken", "card/networkToken+applepay": "#/components/schemas/applepay_decrypted" } } }, "value": { "required": [ "amount", "currency" ], "type": "object", "description": "An object that contains payout amount and currency.", "properties": { "amount": { "type": "integer", "description": "The payout amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2.50.", "example": 250 }, "currency": { "type": "string", "description": "The three character currency code. See list of [supported currencies](/products/reference/supported-countries-currencies#iso-currency-codes).", "example": "USD" } } } } }, "merchant": { "required": [ "entity" ], "type": "object", "description": "An object that contains information about the merchant.", "properties": { "entity": { "maxLength": 32, "minLength": 1, "pattern": "^([A-Za-z0-9]+[A-Za-z0-9 ]*)?$", "example": "default", "type": "string", "description": "Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries." } } }, "transactionReference": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$", "description": "A unique reference generated by you, used to identify a payout throughout its lifecycle." } } } } } } ``` ### 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. * a timestamp of `receivedAt` * the location of the payout resource Example responses: requestReceived ```json { "outcome": "requestReceived", "receivedAt": "2023-09-06T12:29:39.625884Z", "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` refused ```json { "outcome": "refused", "receivedAt": "2023-09-06T12:29:39.625884Z", "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` error ```json { "outcome": "error", "receivedAt": "2023-09-06T12:29:39.625884Z", "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` Best practice We recommend using our [Events service](/products/events) to receive the latest payout status. ## Fast Access payouts Use Fast Access to pay your customers within 30 minutes or less. Prerequisite You must be enabled for Fast Access before using it. Please contact your Worldpay Implementation Manager for more information. ### Fast Access request Send your payout request to our `payouts:fastAccess` action link received in your [query the payout root resource](/products/card-payouts/get-started#query-the-payouts-root-resource) request. If your customer's card is not Fast Access enabled, a [standard payout](#standard-payout) is automatically performed. Note If you want to payout to a wallet please read [here](/products/card-payouts/wallets) first. `POST` `https://try.access.worldpay-bsh.securedataplatform.com/payouts/fastAccess` Fast Access payout request body: Fast Access payout ```json { "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "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" } } } } ``` Token payout ```json { "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "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-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoiMjZ5OUp3Q2dEeDVjWEZBcjhjSmRlcmZTcE44ZzRoazFMcmNCSzlqaEVWcz0ifQ" } } } ``` Apple Pay decrypted payout ```json { "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "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" } } } } ``` Network token payout ```json { "instruction": { "value": { "amount": 100, "currency": "GBP" }, "payoutInstrument": { "type": "card/networkToken", "cardHolderName": "Sherlock Holmes", "expiryDate": { "month": 12, "year": 2029 }, "tokenNumber": "5555555555554444", "billingAddress": { "address1":"address1", "address2":"address2", "address3":"address3", "postalCode":"AB1 2CD", "city":"city", "state":"state", "countryCode":"GB" } }, "narrative": { "line1":"test1", "line2": "test2" } }, "merchant": { "entity": "default" }, "transactionReference": "{{$guid}}" } ``` #### Routing your Fast Access request Where a card supports multiple card schemes, you may optionally submit a `preferredCardBrand` in your card payout request. Example: Some US-issued Visa cards also support Maestro as a debit network. This is typically indicated by Maestro appearing on the back of the card. You may optionally opt to route your payout to Mastercard in this case. By default, the transaction is routed to the primary card scheme (sometimes described as the "front of card" network). The `scheme.name` in the response indicates the route that was used. If your `preferredCardBrand` is not supported for the card, the transaction is automatically routed to the primary card scheme. Refer to our [testing page](/products/card-payouts/testing#routing-magic-values) to test various routing outcomes. Note - Preferred card brand routing is only available for: - Fast Access card payouts - US domiciled merchants - `card/plain` and `card/tokenized` payout instruments - `cardHolderName` and `billingAddress` fields are mandatory for preferred card brand routing Preferred card brand - plain card ```json { "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "instruction": { "routing": { "preferredCardBrand": "mastercard" }, "narrative": { "line1": "The Mind Palace Ltd", "line2": "Memory265-13/08/1876" }, "value": { "currency": "USD", "amount": 100 }, "payoutInstrument": { "type": "card/plain", "cardHolderName": "Sherlock Holmes", "cardNumber": "4444333322221111", "cardExpiryDate": { "month": 5, "year": 2035 }, "billingAddress": { "address1": "789 Palm Drive", "address2": "Unit 12", "address3": "Sunset Villas", "postalCode": "33101", "city": "Miami", "state": "FL", "countryCode": "US" } } } } ``` Preferred card brand - token ```json { "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "instruction": { "routing": { "preferredCardBrand": "mastercard" }, "narrative": { "line1": "The Mind Palace Ltd", "line2": "Memory265-13/08/1876" }, "value": { "currency": "USD", "amount": 100 }, "payoutInstrument": { "type": "card/tokenized", "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/eyJrIjoxLCJkIjoiMjZ5OUp3Q2dEeDVjWEZBcjhjSmRlcmZTcE44ZzRoazFMcmNCSzlqaEVWcz0ifQ" } } } ``` We also check whether the supplied card supports Visa Direct / Mastercard Send disbursements and by default we will fall back to a basic disbursement where we do not get a response from the scheme. You can decide whether to fall back to basic or not by sending an optional `fallbackToBasic` field in the routing request. If you set `fallbackToBasic` to "disabled", instead of falling back we send an error message to you. fallbackToBasic - enabled ```json { "instruction": { "value": { "amount": 100, "currency": "USD" }, "routing": { "fallbackToBasic": "enabled" }, "payoutInstrument": { "type": "card/plain", "cardHolderName": "Sherlock Holmes", "cardExpiryDate": { "month": 12, "year": 2029 }, "cardNumber": "5555555555554444", "billingAddress": { "address1":"789 Palm Drive", "address2":"Unit 12", "address3":"Sunset Villas", "postalCode":"33101", "city":"Miami", "state":"FL", "countryCode":"US" } }, "narrative": {"line1":"PAYOUT"} }, "merchant": { "entity": "default" }, "transactionReference": "{{$guid}}" } ``` fallbackToBasic - disabled ```json { "instruction": { "value": { "amount": 100, "currency": "USD" }, "routing": { "fallbackToBasic": "disabled" }, "payoutInstrument": { "type": "card/plain", "cardHolderName": "Sherlock Holmes", "cardExpiryDate": { "month": 12, "year": 2029 }, "cardNumber": "5555555555554444", "billingAddress": { "address1":"789 Palm Drive", "address2":"Unit 12", "address3":"Sunset Villas", "postalCode":"33101", "city":"Miami", "state":"FL", "countryCode":"US" } }, "narrative": {"line1":"PAYOUT"} }, "merchant": { "entity": "default" }, "transactionReference": "{{$guid}}" } ``` fallbackToBasic - disabled VisaResponse ```json { "errorName": "noInquiryDetailsReceivedfromVisa", "message": "The card scheme didn't provide the card details during inquiry, please try again later." } ``` fallbackToBasic - disabled MastercardResponse ```json { "errorName": "noInquiryDetailsReceivedfromMastercard", "message": "The card scheme didn't provide the card details during inquiry, please try again later." } ``` ### Fast Access schema ```json { "$ref": "#/components/schemas/payouts_fastAccess", "components": { "schemas": { "card_plain": { "required": [ "type", "cardNumber", "cardExpiryDate" ], "type": "object", "description": "Plain card details.", "properties": { "type": { "type": "string" }, "cardNumber": { "type": "string", "description": "Your customer's payout card number.", "maxLength": 19, "minLength": 12, "pattern": "^[0-9]*$" }, "cardExpiryDate": { "required": [ "month", "year" ], "type": "object", "description": "The expiry date of your customer's card. Must be a date in the future.", "properties": { "month": { "type": "integer" }, "year": { "type": "integer" } } }, "cardHolderName": { "type": "string", "pattern": "^(?=.*[A-Za-z])[-A-Za-z0-9_ ]*$", "description": "The name on your customer's card. 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\". Must not contain only numeric characters." }, "billingAddress": { "required": [ "countryCode", "postalCode" ], "type": "object", "description": "An object containing the billing address information. We recommend you provide `billingAddress` fields for all Payout requests.", "properties": { "countryCode": { "type": "string", "description": "Must be provided in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes)." }, "postalCode": { "type": "string" }, "address1": { "type": "string", "description": "First line of the address. Required if `city` is provided." }, "address2": { "type": "string", "description": "Second line of the address." }, "address3": { "type": "string", "description": "Third line of the address." }, "city": { "type": "string", "description": "City. Required if `address1` is provided." }, "state": { "type": "string", "description": "Billing contact state code.\n\n * For North America, you must use the two-letter state abbreviations as defined in the latter part of the [ISO 3166-2 standard](https://www.iso.org/obp/ui/#iso:code:3166:US).\n * For all other regions and provinces around the world, this is a free text field.\n\n Example:\n\n * `AZ`\n\n * `Cambridgeshire`" } } } } }, "card_tokenized": { "required": [ "type", "href" ], "type": "object", "description": "Tokenized card details.", "properties": { "type": { "type": "string" }, "href": { "type": "string", "description": "An object that contains your link to an Access Token." } } }, "card_networkToken": { "required": [ "type", "tokenNumber", "expiryDate" ], "type": "object", "description": "Network Payment Token details.", "properties": { "type": { "type": "string" }, "tokenNumber": { "type": "string", "description": "The network payment token number.", "maxLength": 19, "minLength": 12, "pattern": "^[0-9]*$", "example": "4444333322221111" }, "expiryDate": { "required": [ "month", "year" ], "type": "object", "description": "The expiry date of the network token. Must be a date in the future.", "properties": { "month": { "type": "integer" }, "year": { "type": "integer" } } } } }, "applepay_decrypted": { "required": [ "type", "dpan", "cardExpiryDate" ], "type": "object", "description": "Wallet details.", "properties": { "type": { "type": "string" }, "dpan": { "type": "string", "description": "The device primary account number (DPAN).", "maxLength": 19, "minLength": 12, "pattern": "^[0-9]*$", "example": "4444333322221111" }, "cardExpiryDate": { "required": [ "month", "year" ], "type": "object", "description": "The expiry date of the payout DPAN. Must be a date in the future.", "properties": { "month": { "type": "integer" }, "year": { "type": "integer" } } }, "billingAddress": { "required": [ "countryCode", "postalCode" ], "type": "object", "description": "An object containing the billing address information. We recommend you provide `billingAddress` fields for all Payout requests.", "properties": { "countryCode": { "type": "string", "description": "Must be provided in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes)." }, "postalCode": { "type": "string" }, "address1": { "type": "string", "description": "First line of the address. Required if `city` is provided." }, "address2": { "type": "string", "description": "Second line of the address." }, "address3": { "type": "string", "description": "Third line of the address." }, "city": { "type": "string", "description": "City. Required if `address1` is provided." }, "state": { "type": "string", "description": "Billing contact state code.\n\n * For North America, you must use the two-letter state abbreviations as defined in the latter part of the [ISO 3166-2 standard](https://www.iso.org/obp/ui/#iso:code:3166:US).\n * For all other regions and provinces around the world, this is a free text field.\n\n Example:\n\n * `AZ`\n\n * `Cambridgeshire`" } } }, "cardHolderName": { "type": "string", "pattern": "^(?=.*[A-Za-z])[-A-Za-z0-9_ ]*$", "description": "The name on your customer's card. 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\". Must not contain only numeric characters." } } }, "payouts_fastAccess": { "required": [ "instruction", "merchant", "transactionReference" ], "type": "object", "description": "Fast access input.", "properties": { "instruction": { "required": [ "narrative", "payoutInstrument", "value" ], "type": "object", "description": "An object that contains all the information related to your payout request.", "properties": { "narrative": { "required": [ "line1" ], "type": "object", "description": "An object that contains identification and further details of the merchant.", "properties": { "line1": { "type": "string", "description": "First line of text that appears on your customer's statement." }, "line2": { "type": "string", "description": "Second line of text that appears on your customer's statement." } } }, "payoutInstrument": { "type": "object", "description": "An object that contains your customer's payout type.", "required": [ "type" ], "oneOf": [ { "$ref": "#/components/schemas/card_plain" }, { "$ref": "#/components/schemas/card_tokenized" }, { "$ref": "#/components/schemas/card_networkToken" }, { "$ref": "#/components/schemas/applepay_decrypted" } ], "discriminator": { "propertyName": "type", "mapping": { "card/plain": "#/components/schemas/card_plain", "card/tokenized": "#/components/schemas/card_tokenized", "card/networkToken": "#/components/schemas/card_networkToken", "card/networkToken+applepay": "#/components/schemas/applepay_decrypted" } } }, "value": { "required": [ "amount", "currency" ], "type": "object", "description": "An object that contains payout amount and currency.", "properties": { "amount": { "type": "integer", "description": "The payment amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2.50.", "example": 250 }, "currency": { "type": "string", "description": " The three character currency code. See list of [supported currencies](/products/reference/supported-countries-currencies#iso-currency-codes).", "example": "USD" } } }, "routing": { "type": "object", "properties": { "preferredCardBrand": { "type": "string", "enum": [ "maestro", "mastercard" ], "description": "Specifies the preferred card brand to be used for routing the transaction, where a card supports more than one routing option. If the supplied card brand is not supported by the card payout instrument, we will route the card payout to the available route. \n Available for US-domiciled merchants only." }, "fallbackToBasic": { "type": "string", "enum": [ "disabled", "enabled" ], "description": "We check whether the supplied card supports Visa Direct / Mastercard Send disbursements. By default, we will fall back to a [basic disbursement](/products/card-payouts/payouts#standard-payout) where we do not get a response from the scheme. Select this option to disable this behavior and instead receive an error." } } } } }, "merchant": { "required": [ "entity" ], "type": "object", "description": "An object that contains information about the merchant.", "properties": { "entity": { "maxLength": 32, "minLength": 1, "pattern": "^([A-Za-z0-9]+[A-Za-z0-9 ]*)?$", "example": "default", "type": "string", "description": "Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries." } } }, "transactionReference": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$", "description": "A unique reference generated by you, used to identify a payout throughout its lifecycle." } } } } } } ``` Note The full request schema is available in the [API reference](/products/card-payouts/openapi). ### Fast Access 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` * a timestamp `receivedAt` * the location of the payout resource * scheme name and reference for `requested`, `pending`, `approved`, `refused` and `requestReceived` outcomes * refusal code for outcome `refused` #### Possible outcomes | Outcome | Description | | --- | --- | | `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 disbursementVisa/Mastercard declines your request because the issuing bank is not respondingdisbursements are not allowed in the requested country | | `inReview` | We are reviewing your Fast Access disbursement request, but the card does not support Fast Access. If the review is successful, then your payout is processed and moves to an `approved` or `refused` outcome. If the review fails, the payout moves to an `error` outcome | | `requestReceived` | We have received your Fast Access disbursement request, but the card does not support Fast Access. | | `error` | There is no response from Visa/Mastercard within 48 hours or Visa/Mastercard returns an error confirming the request has failed. | #### Outcome examples requested ```json { "outcome": "requested", "receivedAt": "2023-09-06T12:29:39.625884Z", "scheme": { "name": "visa", "reference": "972128663763829" }, "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` pending ```json { "outcome": "pending", "receivedAt": "2025-08-01T12:29:39.625884Z", "scheme": { "name": "visa", "reference": "972128663763829" }, "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` approved ```json { "outcome": "approved", "receivedAt": "2025-08-01T12:29:39.625884Z", "scheme": { "name": "visa", "reference": "972128663763829" }, "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` disbursed ```json { "outcome": "disbursed", "receivedAt": "2025-08-01T12:29:39.625884Z", "scheme": { "name": "visa", "reference": "972128663763829" }, "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` refused ```json { "outcome": "refused", "refusalCode": "9G", "receivedAt": "2025-08-01T12:29:39.625884Z", "scheme": { "name": "visa", "reference": "972128663763829" }, "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` inReview ```json { "outcome": "inReview", "receivedAt": "2025-08-01T12:29:39.625884Z", "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` requestReceived ```json { "outcome": "requestReceived", "receivedAt": "2025-10-07T11:39:47.780549Z", "scheme": { "name": "mastercard", "reference": "528000000610" }, "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/MjorYjlBc3BsYkhNZmpRMEFIWWxpa1B3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6ays2T2xBZnU0b1NBSWVRbEFFZUt2MU03SW8rYUJHNVhJeUM2NTlNWHk5VUM4cWxPdHVHTHNnTU0vR01adE5YaCtHN3RoaEdVN1JoWkpFZlJIWTdaSmRmTHNHa0lWdnJXMHdVVW5SbjJWOXM9" }, "curies": [ { "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true } ] } } ``` error ```json { "outcome": "error", "receivedAt": "2025-08-01T12:29:39.625884Z", "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.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 available the `payouts:update` action link will appear in this response. Example: `GET` `https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}` Example responses: requested ```json { "outcome": "requested", "receivedAt": "2023-09-06T12:29:39.625884Z", "scheme": { "name": "visa", "reference": "972128663763829" }, "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "payouts:update": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` pending ```json { "outcome": "pending", "receivedAt": "2023-09-06T12:29:39.625884Z", "scheme": { "name": "visa", "reference": "972128663763829" }, "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "payouts:update": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payouts/{rel}", "templated": true }] } } ``` approved ```json { "outcome": "approved", "receivedAt": "2025-08-01T12:29:39.625884Z", "scheme": { "name": "visa", "reference": "972128663763829" }, "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/{resource}" }, "curies": [{ "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.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 our [error reference](/products/reference/worldpay-error-responses). ## 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-bsh.securedataplatform.com/payouts/{resource}` Replace `{resource}` in the link above with the location given in your initial response. Note 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-bsh.securedataplatform.com/payouts/query?transactionReference={transactionReference}&entity={entity}` Replace `{transactionReference}` and `{entity}` in the link above with the `transactionReference` and `entity` of the original payout.