Account Endpoints

account/pre-funding-settings

Changed on

This endpoint is used to configure your account's pre-funding settings. When pre-funding is enabled, outbound transactions are automatically backed by a funding transaction pulled from your default operational bank account, and are processed once that funding settles. The pre-funding payment rail is limited to your account's local rail: eft for Canadian accounts and ach for US accounts.

post/account/pre-funding-settings

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/pre-funding-settings
  • 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

FundingTriggerstring required

When a pre-funding transaction should be created for outbound transactions. Accepted values: always (every outbound transaction is pre-funded), insufficient-balance (only when the account balance does not cover the transaction), never (disables pre-funding).

PaymentRailstring

The payment rail used to create pre-funding transactions. Accepted values: eft (Canadian accounts) or ach (US accounts). Defaults to your account's local rail when omitted.

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

Example response

{
  "Success": true,
  "PreFundingSettings": {
    "Enabled": true,
    "FundingTrigger": "insufficient-balance",
    "PaymentRail": "eft"
  }
}

Changes