Updated on June 9, 2023

Update Platform Account

Use PUT method to update an existing Platform Account. To update a Platform Account, inquire a source Platform Account data packet via the GET method and pass it with the PUT method. Change parameters’ values you wish to override.

Endpoint: PUT

Sandbox: https://sandbox.4levers.com/managementapi/api/accounts/{accountId} Production: https://managementapi.4levers.com/api/accounts/{accountId} The values indicated in the URL is a target Platform Account identifier {accountId} that you wish to update. The id value that you pass in the request body is a mandatory value and also corresponds to the target Platform Account identifier. The values in the URL and the request body must match to validate the request. Please note that in case a parameter is not sent or sent without any value, the parameter field will be empty.

Request Parameters

Name Type Required Description
id integer ✓ Platform Account identifier.
serviceProviderId integer Service Provider identifier.
accountName string Platform Account Name. MaxLength(250)
contactEmail string Platform Account contact email address. MaxLength(50)
manualPayout bool Enables manual payout processing option. Disables external payout processor. To enable Manual Payouts pass "processor": "None"
skipBalanceCheck bool Set True to disable account balance check to perform payout transaction.
negativePayout bool Set True to allow negative payouts.
payouts object Platform payouts instructions settings.
payoutConfiguration object Platform payout processor settings.
billing object Platform Account billing settings. Only for Fees, that have feeSource=Platform Account.
sumUpCutOffHour integer Auto cut-off value.
payoutCutOffHour integer Payout cut-off value.
Response Parameters
№ Name Type Description
id integer New Platform Account identifier
name string New Platform Account Name
Response Codes
Response Code Description
200 Success.
400 Bad Request — Your request is invalid.
401 Unauthorized — Authorization failed.
403 Forbidden — Access denied.
404 Not Found — Wrong URL.
415 Unsupported Media Type — Wrong request format.
500 Internal Server Error — We had a problem with our server. Try again later.
503 Service Unavailable — We’re temporarily offline for maintenance. Please try again later. 
				
					{
  "id": 0,
  "serviceProviderId": 0,
  "accountName": "string",
  "contactEmail": "string",
  "manualPayout": true,
  "skipBalanceCheck": true,
  "negativePayout": true,
  "payouts": [
    {
      "payoutMethodsAch": [
        {
          "currency": "USD",
          "accountNumber": "string",
          "accountType": "None",
          "entityType": "Personal",
          "nameOnAccount": "string",
          "routingNumber": "string"
        }
      ],
      "calculation": {
        "fixedAmount": 0,
        "intervalCount": 0,
        "intervalGap": 0,
        "payoutType": "Fixed",
        "percentageAmount": 0
      },
      "name": "string",
      "scheduler": {
        "id": 0,
        "isSchedulerDisabled": false,
        "dayNumber": 0,
        "endDate": "2021-02-08T16:59:01.127Z",
        "expiration": "UntilDate",
        "interval": "Daily",
        "intervalCount": 0,
        "monthNumber": 0,
        "occurrencesQuantity": 0
      },
      "twoStepApproval": true
    }
  ],
  "payoutConfiguration": {
    "id": 0,
    "parameters": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "processor": "NoAcquirer"
  },
  "billing": {
    "scheduledFees": [
      {
        "currency": "USD",
        "id": 0,
        "amount": 0,
        "dayNumber": 0,
        "endDate": "2021-02-08T16:59:01.127Z",
        "expiration": "UntilDate",
        "interval": "Daily",
        "intervalCount": 0,
        "monthNumber": 0,
        "name": "string",
        "occurrencesQuantity": 0
      }
    ],
    "slidingScaleFees": [
      {
        "id": 0,
        "name": "string",
        "ranges": [
          {
            "amount": 0,
            "maxCount": 0,
            "minCount": 0,
            "percentage": 0
          }
        ],
        "reversalEnabled": [
          "Void"
        ]
      }
    ],
    "transactionFees": [
      {
        "includeOwnTransactions": true,
        "amount": 0,
        "typeId": 0,
        "name": "string",
        "percentage": 0,
        "reversalEnabled": [
          "Void"
        ]
      }
    ],
    "slidingScaleCounterReset": {
      "timeInterval": "Weekly",
      "numberOfIntervals": 0
    }
  },
  "sumUpCutOffHour": 0,
  "payoutCutOffHour": 0
}

Response

{
  "id": "Platform Account Id",
  "name": "Platform Account Name"
}