VOvopay
Withdraw Endpoints

gcm/withdraw

Create a crossborder withdrawal transaction from a provided quote.

post/gcm/withdraw

Request

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

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

CrossborderQuoteIDstring required

The crossborder quote ID

DeliveryMethodTokenstring required

The delivery method token

PurposeOfPaymentstring required

The purpose of the payment

RelationshipWithBeneficiarystring

The relationship with the beneficiary

Request body application/x-www-form-urlencoded

GLCodestring

An optional unique identification general ledger code.

TransactionTypeCodestring

CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Error message if any

TransactionIDstring required

The transaction ID

Flaggedstring

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

CashoutCodestring

The cashout code

Example response

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

Changes

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