Withdrawals

Create Withdrawal Request

Changed on

Request to withdraw USD+ payment tokens from a managed Account and send the equivalent amount of USDC to the specified recipient Account.

The recipient Account must belong to the same Entity as the managed Account.

post/api/v2/accounts/{account_id}/withdrawal_requests

Request

Request body

recipient_account_idstring uuid required

ID of the Account that will receive payment tokens from the Withdrawal.

payment_token_quantitynumber required

Amount of USD+ payment tokens to be withdrawn. Must be greater than 0 and have at most 6 decimal places.

Response

OK

idstring uuid required

ID of the WithdrawalRequest.

account_idstring uuid required

ID of the Account of the WithdrawalRequest.

recipient_account_idstring uuid required

ID of the Account that will receive USDC payment tokens from the Withdrawal. This Account must be connected to a non-managed Wallet and belong to the same Entity.

payment_token_amountstring decimal required

Amount of USD+ payment tokens submitted for withdrawal.

status'PENDING' | 'SUBMITTED' | 'ERROR' | 'CANCELLED' required
created_dtstring date-time required

Datetime at which the WithdrawalRequest was created. ISO 8601 timestamp.

updated_dtstring date-time required

Datetime at which the WithdrawalRequest was updated. ISO 8601 timestamp.

Changes

    • breaking

      the response's property type changed from number to string, and format from no format to decimal for status

    • warning

      the request property's min was set to 0.00