Webhook Endpoints

account/webhook-url/test

In this endpoint, you will be able to test your webhook URL. We will send you an example of the payload that you will receive.

post/account/webhook-url/test

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/webhook-url/test
  • 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

Typestring

The type of webhook notification you wish to receive. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction. Default is transaction.

Payloadstring

A custom JSON payload to send to the webhook URL. If not provided, a sample payload will be generated based on the Type parameter.

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
}

Changes

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