VOvopay
Wire Endpoints

batch/wire/withdraw

Submits a batch of wire transactions. Each row's wire rail is detected from its bank identifiers exactly as on /wire/withdraw; a row whose identifiers are missing, ambiguous or name a rail that is not yet available is rejected on its own.

post/batch/wire/withdraw

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/batch/wire/withdraw
  • 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

BatchNamestring required

Name of the batch

BatchDatastring required

An array of objects. Each object contains the input params for the /wire/withdraw endpoint, including WireType and the bank identifiers that WireType requires. This endpoint accepts a maximum of 5000 transactions per batch submission.

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

BatchTransactionRequestIDinteger required

Unique ID of your batch transaction request.

TotalSubmittedTransactionsinteger required

Total number of transactions submitted.

NumberOfRejectedTransactionsinteger required

Total number of rejected transactions.

RejectedTransactionsstring

JSON object containing the rejected transactions

Example response

{
  "Success": true,
  "RejectedTransactions": "{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}"
}

Changes

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