Basic Disbursement

Disburse funds to a card instrument

Methods

POST

Disburses funds to the card instrument specified.

Request

Copied!
{
 "type": "object",
 "properties": {
  "instruction": {
   "type": "object",
   "properties": {
    "narrative": {
     "type": "object",
     "properties": {
      "line1": {
       "type": "string"
      },
      "line2": {
       "type": "string"
      }
     },
     "required": [
      "line1"
     ]
    },
    "payoutInstrument": {
     "type": "object",
     "properties": {
      "cardExpiryDate": {
       "type": "object",
       "properties": {
        "month": {
         "type": "integer"
        },
        "year": {
         "type": "integer"
        }
       },
       "required": [
        "month",
        "year"
       ]
      },
      "cardHolderName": {
       "type": "string"
      },
      "cardNumber": {
       "type": "string"
      },
      "type": {
       "type": "string"
      }
     },
     "required": [
      "cardExpiryDate",
      "cardHolderName",
      "cardNumber",
      "type"
     ]
    },
    "value": {
     "type": "object",
     "properties": {
      "amount": {
       "type": "integer"
      },
      "currency": {
       "type": "string"
      }
     },
     "required": [
      "amount",
      "currency"
     ]
    }
   },
   "required": [
    "narrative",
    "payoutInstrument",
    "value"
   ]
  },
  "merchant": {
   "type": "object",
   "properties": {
    "entity": {
     "type": "string"
    }
   },
   "required": [
    "entity"
   ]
  },
  "transactionReference": {
   "type": "string"
  }
 },
 "required": [
  "instruction",
  "merchant",
  "transactionReference"
 ]
}

Responses

Response schema

Copied!
{
 "type": "object",
 "properties": {
  "_links": {
   "type": "object",
   "format": "hal+json"
  },
  "outcome": {
   "type": "string"
  },
  "receivedAt": {
   "type": "string"
  }
 },
 "required": [
  "_links",
  "outcome",
  "receivedAt"
 ]
}

Examples

POST
 Successful Basic Disbursement
View
POST
 Unsuccessful Payout request
View
POST

Disburses funds to the token specified.

Request

Copied!
{
 "type": "object",
 "properties": {
  "instruction": {
   "type": "object",
   "properties": {
    "narrative": {
     "type": "object",
     "properties": {
      "line1": {
       "type": "string"
      },
      "line2": {
       "type": "string"
      }
     },
     "required": [
      "line1"
     ]
    },
    "payoutInstrument": {
     "type": "object",
     "properties": {
      "href": {
       "type": "string"
      },
      "type": {
       "type": "string"
      }
     },
     "required": [
      "href",
      "type"
     ]
    },
    "value": {
     "type": "object",
     "properties": {
      "amount": {
       "type": "integer"
      },
      "currency": {
       "type": "string"
      }
     },
     "required": [
      "amount",
      "currency"
     ]
    }
   },
   "required": [
    "narrative",
    "payoutInstrument",
    "value"
   ]
  },
  "merchant": {
   "type": "object",
   "properties": {
    "entity": {
     "type": "string"
    }
   },
   "required": [
    "entity"
   ]
  },
  "transactionReference": {
   "type": "string"
  }
 },
 "required": [
  "instruction",
  "merchant",
  "transactionReference"
 ]
}

Responses

Response schema

Copied!
{
 "type": "object",
 "properties": {
  "_links": {
   "type": "object",
   "format": "hal+json"
  },
  "outcome": {
   "type": "string"
  },
  "receivedAt": {
   "type": "string"
  }
 },
 "required": [
  "_links",
  "outcome",
  "receivedAt"
 ]
}

Examples

POST
 Successful Basic Disbursement
View
POST
 Unsuccessful Payout request
View

Link relationship

post
 Successful Basic Disbursement 
POST https://try.access.worldpay.com/payouts/basicDisbursement
Copied!
{
  "Authorization": "Basic Auth",
  "Content-Type": "application/vnd.worldpay.payouts-v3+json",
  "Accept": "application/vnd.worldpay.payouts-v3+json"
}
Copied!
{
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "value": {
      "amount": 300,
      "currency": "GBP"
    },
    "payoutInstrument": {
      "type": "card/plain",
      "cardHolderName": "Mr Arjen Lucassen",
      "cardExpiryDate": {
        "month": 1,
        "year": 2025
      },
      "cardNumber": "4444333322221111"
    },
    "narrative": {
      "line1": "STATEMENT",
      "line2": "OPTIONAL"
    }
  },
  "transactionReference": "transaction-ref"
}

201

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