Instructional Funding Submitted Webhook

The InstructionalFundingSubmitted webhook triggers when funding instructions are submitted via the Backoffice UI or API. This webhook provides the DepositId, the reference identification number of the deposit, and a Status value indicating if the submission was received successfully or if a failure occurred. Resubmissions of funding will also trigger this webhook.

  • A Status value of 1 indicates that the funding instructions were received successfully by the processor.
  • A Status value of 6 indicates that a failure occurred during the submission process.
    • For funding instructions submitted via UI, depending on the processor, additional details may be available in the Response Message field of the Transaction Details window.
    • For funding instructions submitted via the API, users can query deposit information for details.

Response Schema

See the table below for information received in the webhook response.

Field

Type

Description

DepositId

Integer

The reference ID of the deposit.

Status

Integer

Expected values:
1 = Submitted
6 = Failed

Example JSON Response

See an example of the webhook response below.

{
"DepositId": 1234,
"DepositStatus": 1
}