VOvopay
Debit Card Endpoints

debit-card/oct/push-funds

This endpoint is used to instantly send funds from your VoPay account to the debit card linked to the provided CardToken.

If a ClientAccountID is provided, the client account's default card will be used for the transaction.

Note: You must first generate a CardToken using the /debit-card/generate-embed-url endpoint.

post/debit-card/oct/push-funds

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/debit-card/oct/push-funds
  • 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

ClientAccountIDstring

Client Account ID

CardTokenstring required

The token identifying the debit card to charge (returned from /debit-card/generate-embed-url).

Amountnumber required

The amount to send to the customer's debit card.

Currencystring

3 character currency code for the currency to sent to the customer's debit card. If this is not specified the transaction will use the account's local currency (CAD).

IdempotencyKeystring

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

ParentTransactionIDstring

The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.

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

Contains a description of the error if the request failed

TransactionIDinteger required

The unique ID of the transaction that was just submitted.

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

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