Disburses funds to the payout instrument specified

Request

Disburse funds to a payout instrument using fastAccess.

Security

BasicAuth

Bodyapplication/vnd.worldpay.payouts-v2+json

instructionobjectrequired

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

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 issuing of a disbursal request

{
  "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-v2+json

curiesArray of objectsrequired

outcomestringrequired

outcome of payouts request

receivedAtstringrequired

A timestamp of receivedAt

Response

Successful issuing of a disbursal request

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