Revenue Withdrawal

A revenue withdrawal will request a transfer of funds from your account balance to the provided bank account

• GET/account/withdrawal

  Gets all of the withdrawals for this account, includes both any pending ones and all complete or cancelled ones

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  200 Response

  {
      "result" : [
          {
              "amount" : "46f90260-822c-42a0-bd00-6d5402c87302",
              "bank_account" : "",
              "completed_on" : "2021-01-01T12:00:00",
              "created_on" : "2023-03-24",
              "updated_on" : "2023-03-24",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• POST/account/withdrawal

  Create a new withdrawal, only one withdrawal may be active at once, the minimum withdrawal is £25.0, larger withdrawals may require additional verification.

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • amount

    • BigDecimal

    • True

    Amount of money to withdraw from the account balance, the minimum is £25.0

  • • bank_account_uuid

    • String

    • True

    The UUID of the bank account to receive the withdrawal

  • • completed_on

    • Date

    • True

    Date this withdrawal was requested

  JSON all-fields example:

  {
      "amount" : "46f90260-822c-42a0-bd00-6d5402c87302",
      "bank_account_uuid" : "46f90260-822c-42a0-bd00-6d5402c87302",
      "completed_on" : "2021-01-01T12:00:00"
  }

  Response Details

  201 Response

  {
      "result" : {
          "amount" : "46f90260-822c-42a0-bd00-6d5402c87302",
          "bank_account" : "",
          "completed_on" : "2021-01-01T12:00:00",
          "created_on" : "2023-03-24",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  402 Response

  {
      "result" : {},
      "status_code" : 402,
      "status_message" : "Payment Required"
  }

  409 Response

  {
      "result" : {},
      "status_code" : 409,
      "status_message" : "Conflict"
  }