Payouts

Make payouts from your merchant account to any external account or to an account from which you have received a payment.

You can make a payout from your merchant account to any external account or to an account from which you have received a payment. You'll find the following field in a payment resource that has a successful or settled status.

{
    .
  .
  .
  "source_of_funds": {
    "type": "external_account",
    "scheme_identifiers": [
      .
      .
      .
    ],
    "external_account_id": "{{external-account-id}}",
    "account_holder_name": "John Doe"
  },
  .
  .
}

Make a POST request to /payouts, and include the external_account_id. The following code sample is an example of the request body:

{
  "merchant_account_id": "string",
  "amount_in_minor": 1,
  "currency": "GBP",
  "beneficiary": {
    "type": "payment_source",
    "user_id": "{{user_id}}",
    "external_account_id": "{{external-account-id}}"
    "reference": "string"
  }
}

You can make payouts to any external accounts. The following code sample is such an example of a request to /payouts:

{
  "merchant_account_id": "string",
  "amount_in_minor": 1,
  "currency": "GBP",
  "beneficiary": {
    "type": "external_account",
    "name": "John Doe",
    "scheme_identifier": {
        "type": "sort_code_account_number",
      "sort_code": "123456",
      "account_number": "12345678"
    },
    "reference": "string"
  }
}

You can find your payments in and payouts from your merchant accounts in your Transactions.


Next steps
Did this page help you?