Bank Accounts

A Bank Account object can be used to request withdrawal of reseller revenue

• GET/account/bank-account

  Gets all of the bank accounts configured on the account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  200 Response

  {
      "result" : [
          {
              "account_holder" : "Pete Plumber",
              "account_number" : "12345678",
              "bank_name" : "EXAMPLE BANK LIMITED",
              "created_on" : "2023-06-07",
              "nickname" : "My Bank Account",
              "sort_code" : "00-00-00",
              "updated_on" : "2023-06-07",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• POST/account/bank-account

  Creates a new bank account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • account_holder

    • String

    • True

    The complete name of the bank account holder as stored by the bank, this must match for any withdrawals to be processed successfully

  • • account_number

    • String

    • True

    8 digit UK bank account number

  • • nickname

    • String

    • True

    A nickname for this bank account, this is the only field that can be changed on the PUT requests

  • • sort_code

    • String

    • True

    The sort code of the bank account, only UK codes are currently supported

  JSON all-fields example:

  {
      "account_holder" : "Pete Plumber",
      "account_number" : "12345678",
      "nickname" : "My Bank Account",
      "sort_code" : "00-00-00"
  }

  Response Details

  201 Response

  {
      "result" : {
          "account_holder" : "Pete Plumber",
          "account_number" : "12345678",
          "bank_name" : "EXAMPLE BANK LIMITED",
          "created_on" : "2023-06-07",
          "nickname" : "My Bank Account",
          "sort_code" : "00-00-00",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  400 Response

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

• PUT/account/bank-account/{uuid}

  Updates an existing bank account, the only field that can be changed is the nickname.

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  PUT body

  • Name

  • Type

  • Required

  • • account_holder

    • String

    • True

    The complete name of the bank account holder as stored by the bank, this must match for any withdrawals to be processed successfully

  • • account_number

    • String

    • True

    8 digit UK bank account number

  • • nickname

    • String

    • True

    A nickname for this bank account, this is the only field that can be changed on the PUT requests

  • • sort_code

    • String

    • True

    The sort code of the bank account, only UK codes are currently supported

  JSON all-fields example:

  {
      "nickname" : "My Bank Account"
  }

  Response Details

  200 Response

  {
      "result" : {
          "account_holder" : "Pete Plumber",
          "account_number" : "12345678",
          "bank_name" : "EXAMPLE BANK LIMITED",
          "created_on" : "2023-06-07",
          "nickname" : "My Bank Account",
          "sort_code" : "00-00-00",
          "updated_on" : "2023-06-07",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

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

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• DELETE/account/bank-account/{uuid}

  Delete the specified Bank Account, this will not cancel any pending withdrawals for this account.

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Bank Account to be deleted

  Response Details

  204 Response

  {
      "result" : {},
      "status_code" : 204,
      "status_message" : "No Content"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }