Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

Payouts (4)

Payouts root resource, returns links to available payouts actions.

Download OpenAPI description
Languages
Servers
testing (try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Retrieve payout details

Request

Retrieve the details of an existing Basic Disbursement or Fast Access Payout.

Path
resourcestringrequired

original resource

curl -i -X GET \
  -u undefined:undefined \
  'https://try.access.worldpay.com/payouts/{resource}'

Responses

Payout resource.

Bodyapplication/vnd.worldpay.payouts-v4+json
outcomestringrequired

outcome of payouts request

receivedAtstringrequired

A timestamp of receivedAt

Response
application/vnd.worldpay.payouts-v4+json

Basic Disbursement: Successful resource retrieval with outcome requestReceived

{ "outcome": "requestReceived", "receivedAt": "2023-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 } ] } }

Retrieve the payout details of a historic resource.

Request

Query by transaction reference and entity to retrieve a Payout.

Query
transactionReferencestringrequired

A unique reference generated by you, used to identify a payout throughout its lifecycle

Example:

transactionReference=12345

entitystringrequired

merchant entity

Example:

entity=default

curl -i -X GET \
  -u undefined:undefined \
  'https://try.access.worldpay.com/payouts/query?entity=default&transactionReference=12345'

Responses

Returns a payout resource, provided one matches the transaction and entity references.

Bodyapplication/vnd.worldpay.payouts-v4+json
outcomestringrequired

outcome of payouts query request

receivedAtstringrequired

A timestamp of receivedAt

Response
application/vnd.worldpay.payouts-v4+json

Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'

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

Disburses funds to the payout instrument specified.

Request

Disburse funds to a payout instrument.

Bodyapplication/vnd.worldpay.payouts-v4+json
instructionobjectrequired

An object that contains all the information related to your payout request.

narrativeobjectrequired

An object that contains identification and further details of the merchant.

line1stringrequired

First line of text that appears on your customer's statement.

line2string

Second line of text that appears on your customer's statement.

payoutInstrumentanyrequired

An object that contains your customer's payout type.

cardExpiryDateobjectrequired

An object that contains your customer's payout card expiry date. Must be a date in the future.

monthintegerrequired
yearintegerrequired
cardNumberstringrequired

An object that contains your customer's payout card number.

typestringrequired
Discriminator
billingAddressobject

An object containing the billing address information.

cardHolderNamestring

An object that contains your customer's payout card name.

valueobjectrequired

An object that contains payout amount and currency.

amountintegerrequired

The payout amount.

currencystringrequired

The 3 digit currency code.

merchantobjectrequired

An object that contains information about the merchant.

entitystringrequired

This is mandatory for authentication and queries. Contact your Implementation Manager for more information.

transactionReferencestringrequired

A unique reference generated by you, used to identify a payout throughout its lifecycle.

curl -i -X POST \
  -u undefined:undefined \
  https://try.access.worldpay.com/payouts/basicDisbursement \
  -H 'Content-Type: application/vnd.worldpay.payouts-v4+json' \
  -d '{
    "merchant": {
      "entity": "default"
    },
    "instruction": {
      "value": {
        "amount": 300,
        "currency": "GBP"
      },
      "payoutInstrument": {
        "type": "card/plain",
        "cardHolderName": "Sherlock Holmes",
        "cardExpiryDate": {
          "month": 1,
          "year": 2025
        },
        "cardNumber": "4444333322221111",
        "billingAddress": {
          "address1": "address1",
          "address2": "address2",
          "address3": "address3",
          "postalCode": "postalCode",
          "city": "city",
          "state": "state",
          "countryCode": "GB"
        }
      },
      "narrative": {
        "line1": "STATEMENT",
        "line2": "OPTIONAL"
      }
    },
    "transactionReference": "transaction-ref"
  }'

Responses

Funds have been disbursed or queued for disbursal successfully.

Bodyapplication/vnd.worldpay.payouts-v4+json
outcomestringrequired

outcome of payouts request

receivedAtstringrequired

A timestamp of receivedAt

Response
application/vnd.worldpay.payouts-v4+json

Successful Basic Disbursement

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

Disburses funds to the payout instrument specified.

Request

Disburse funds to a payout instrument using fastAccess.

Bodyapplication/vnd.worldpay.payouts-v4+json
instructionobjectrequired

An object that contains all the information related to your payout request.

narrativeobjectrequired

An object that contains identification and further details of the merchant.

line1stringrequired

First line of text that appears on your customer's statement.

line2string

Second line of text that appears on your customer's statement.

payoutInstrumentanyrequired

An object that contains your customer's payout type.

cardExpiryDateobjectrequired

An object that contains your customer's payout card expiry date. Must be a date in the future.

monthintegerrequired
yearintegerrequired
cardNumberstringrequired

An object that contains your customer's payout card number.

typestringrequired
Discriminator
billingAddressobject

An object containing the billing address information.

cardHolderNamestring

An object that contains your customer's payout card name.

valueobjectrequired

An object that contains payout amount and currency.

amountintegerrequired

The payout amount.

currencystringrequired

The 3 digit currency code.

merchantobjectrequired

An object that contains information about the merchant.

entitystringrequired

This is mandatory for authentication and queries. Contact your Implementation Manager for more information.

transactionReferencestringrequired

A unique reference generated by you, used to identify a payout throughout its lifecycle.

curl -i -X POST \
  -u undefined:undefined \
  https://try.access.worldpay.com/payouts/fastAccess \
  -H 'Content-Type: application/vnd.worldpay.payouts-v4+json' \
  -d '{
    "merchant": {
      "entity": "default"
    },
    "instruction": {
      "value": {
        "amount": 300,
        "currency": "GBP"
      },
      "payoutInstrument": {
        "type": "card/plain",
        "cardHolderName": "Sherlock Holmes",
        "cardExpiryDate": {
          "month": 1,
          "year": 2025
        },
        "cardNumber": "4444333322221111",
        "billingAddress": {
          "address1": "address1",
          "address2": "address2",
          "address3": "address3",
          "postalCode": "postalCode",
          "city": "city",
          "state": "state",
          "countryCode": "GB"
        }
      },
      "narrative": {
        "line1": "STATEMENT",
        "line2": "OPTIONAL"
      }
    },
    "transactionReference": "transaction-ref"
  }'

Responses

Funds have been disbursed or queued for disbursal successfully.

Bodyapplication/vnd.worldpay.payouts-v4+json
outcomestringrequired

outcome of payouts request

receivedAtstringrequired

A timestamp of receivedAt

Response
application/vnd.worldpay.payouts-v4+json

Successful issuing of a disbursal request

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