VOvopay
Account Endpoints

account/withdraw-my-account

Changed on

This endpoint will credit your default bank account by withdarwing funds from your VoPay account.

To set a default bank account, please use the /bank-account/set-my-bank-account endpoint.

post/account/withdraw-my-account

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/withdraw-my-account
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Amountnumber required

The amount to credit to your bank account.

ClientReferenceNumberstring

An optional reference number to associate with the transactions

Notesstring

An optional note to associate with the transactions.

IdempotencyKeystring

A unique key which the server can use to recognize and reject subsequent retries of the same request.

GLCodestring

An optional unique identification general ledger code.

ParentTransactionIDstring

The parent funding transaction the withdrawal will be linked to, can become a split payment with multiple withdrawals. The withdrawal is created in the waiting status and is released automatically once the funds of the parent transaction have been released. The parent transaction must belong to your account and its currency must match the withdrawal currency.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

TransactionIDinteger required

The unique ID of the funding transaction that was just created. This ID should be saved as it is required order to look up the status information on the transaction.

Flaggedstring

Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.

Example response

{
  "Success": true,
  "Flagged": "The transaction has been flagged as a potential duplicate."
}

Changes

  • 71f251deb318Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status