debit-card/oct/push-funds

post

https://earthnode-dev.vopay.com/api/v2/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

ClientAccountID

string

Client Account ID

CardToken

string

required

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

Amount

number

required

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

Currency

string

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).

IdempotencyKey

string

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

ParentTransactionID

string

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.

GLCode

string

An optional unique identification general ledger code.

TransactionTypeCode

string

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

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200