BYbyaccrue
Wallets

Closed-Loop Withdraw

Withdraw funds from a wallet back to the user's linked account(s). The amount is split across linked accounts. Requires the wallet to have withdrawable balance (see Get Wallet Balance with includeWithdrawableAmount=true).

post/api/v1/wallets/:walletId/withdraw

Request

Path parameters

walletIdstring uuid required

The wallet ID to withdraw from.

Example:123e4567-e89b-12d3-a456-426614174000

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Request body

Example request

{
  "data": {
    "attributes": {
      "amount": 5000
    }
  }
}

Response

201 Created

Example response

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "split": [
        {
          "linkedAccountId": "123e4567-e89b-12d3-a456-426614174000",
          "institutionName": "Example Bank",
          "accountMask": "1234",
          "amount": 2500
        }
      ]
    }
  }
}

Changes

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