Account Endpoints

account/fund-my-account

Changed on

This endpoint will fund your VoPay account by debiting your default bank account or charging your default operational credit card.

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

post/account/fund-my-account

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/fund-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 debit from 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.

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

Sourcestring

Funding source: bank (default) debits your default operational bank account; credit charges your default operational credit card (requires FundMyAccountCreditCardEnabled). Credit card funding charges a 3% convenience fee on top of the Amount; the card is charged Amount plus fee, the balance is credited the same, and the fee is immediately debited so the net balance credit equals the Amount

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

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status