[go: up one dir, main page]

Webhook Samples for Funding Events

Webhook Samples

While every webhook notification will pass a set of common fields, the data object will have specific details based on the type of event that has occurred. Below you will find these definitions and samples.

Funding Event Samples

The data fields you will find for Funding events along with sample messages are as follows:

Field

Type

Description

clientName

string

Unique Client/Merchant name assigned to your ConnexPay merchant record.

mid

string

Unique MID number assigned to your ConnexPay merchant account.

amount

decimal

Amount of the funding transaction. A negative amount indicates a debit/withdrawal of the funding account and a positive amount indicates a credit/deposit.

dateTime

string (date/time)

Date/time that the funding was processed.

availableBalance

decimal

Reflects the available balance at your merchant account level as a result of the event.

merchantIdentifier

string

Unique GUID assigned to your ConnexPay merchant record.

merchantName

string

Unique Client/Merchant name assigned to your ConnexPay merchant record.

guid

string

Globally unique identifier (GUID) of the funding event.

type

string

Description representing the type of funding event. Bank "A" and "B" nomenclature is a ConnexPay identifier that may be ignored when considering the possible options:
• "Bank A (or B) Deposit", which identifies a funds transfer from your Bank Account to ConnexPay.
• "Wire/ACH Deposit", which identifies a credit of your cash balance from a Wire or ACH deposit.
• "Bank A (or B) Withdrawal", which identifies a debit of your Bank Account from ConnexPay during non-Daily Accounting funds movement.
• "Bank A (or B) Daily Funding", which is either a credit or debit of your cash balance as a result of the difference between your sales and purchases Total Activity.
• "Bank A (or B) Flex Funding", which is either a credit or debit of your account as part of the daily accounting funds movement.
• "Return", which indicates the deduction of funds from your cash balance when a sale is returned.
• "Bank A (or B) ACH Debit Reject", which indicates that an ACH payment was rejected.
• "Transfer Sent", which indicates that funds were transferred to another merchant's cash balance within a chained Parent/Sub hierarchy.
• "Transfer Received", which indicates that funds were received from another merchant's cash balance within a chained Parent/Sub hierarchy.

sale.cash.balance.funding

[{
  "id": "0349bf3d-51cd-445d-972e-b65219df2ff9",
  "subject": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
  "data": {
    "clientName": "clientName",
    "mid": "1210000111110110",
    "amount": 9999.99,
    "dateTime": "2023-05-09T23:10:39+00:00",
    "availableBalance": 9999.99,
    "merchantIdentifier": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
    "merchantName": "CXP Self Service Funding Account",
    "guid": "8e9de111-b255-4e47-8c47-cedf5a99dddd",
    "type": "Bank A Deposit"
  },
  "eventType": "sale.cash.balance.funding",
  "eventTime": "2023-05-09T19:10:48.5486619Z",
  "dataVersion": "1"
}]