Disburses funds to the payout instrument specified.

Request

Disburse funds to a payout instrument.

Security

BasicAuth

Bodyapplication/vnd.worldpay.payouts-v1+json

instructionobjectrequired

Basic disbursement input.

merchantobjectrequired

An object that contains information about the merchant.

transactionReferencestringrequired

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

Successful Basic Disbursement

{
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "value": {
      "amount": 300,
      "currency": "GBP"
    },
    "payoutInstrument": {
      "type": "card/plain",
      "cardHolderName": "Sherlock Holmes",
      "cardExpiryDate": {
        "month": 1,
        "year": 2025
      },
      "cardNumber": "4444333322221111"
    },
    "narrative": "STATEMENT"
  },
  "transactionReference": "transaction-ref"
}

Responses

Funds have been disbursed or queued for disbursal successfully.

Bodyapplication/vnd.worldpay.payouts-v1+json

curiesArray of objectsrequired

outcomestringrequired

outcome of payouts request

receivedAtstringrequired

A timestamp of receivedAt

Response

Successful Basic Disbursement

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