STstarkbank
Corporate Withdrawal

Create a Corporate Withdrawal

Use this route to create a new Corporate Withdrawal and return cash from your Corporate balance to your Banking balance. NOTE:The Corporate Transaction that debits your Corporate balance is created within the same request, so corporateTransactionId comes back filled. The cash is credited to your Banking balance right after, so transactionId comes back empty and is filled in a few moments later. NOTE:The request is refused when your Corporate balance does not cover the amount.

post/v2/corporate-withdrawal

Request

  • Base URL
    https://api.starkbank.com
  • URL
    https://api.starkbank.com/v2/corporate-withdrawal
  • Auth
    API key in header Digital-Signature

Request body

amountinteger required

A positive integer that represents the amount in cents to be returned to your Banking balance. Example: 10000 (R$100.00)

externalIdstring required

Unique id chosen by you to identify the Corporate Withdrawal. An externalId already used in your Workspace is rejected instead of creating a second Corporate Withdrawal. Example: "my-external-id"

tagsstring[]

Array of up to 100 strings to tag the entity for future queries. Each tag can have up to 100 characters and all tags will be converted to lowercase. Example: ["tony", "stark"]

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.