Settlement Webhook

data Object (event payload)

Field	Value	Is Required	Description
account	object	Yes	IDs and identifiers associated with the account of an event (see below)
timestamp	Date	Yes	Date and time the event is received by Berkeley
type	string	No	Type of transaction
amount	string	Yes	Settlement Amount. Ex: "21.45"
network	string	Yes	Network for transaction that was settled
authorization_id	string	No	ID of the authorization that was settled
billing_curr_code	string	No	Currency code. Ex: "840"
local_currency	string	No	Currency code for local_currency_amount. Ex: "124"
local_currency_amount	string	No	Amount of the transaction in the currency at the point of sale. No fees or upcharges included. Ex: "1245.20"
merchant	object	Yes	Merchant Information

account Object

Field	Value	Is Required	Description
id	integer	Yes	id of cardholder account
cardholder_id	integer	Yes	id of cardholder
processor_reference	string	Yes	Reference to the account on the processor's system
available_balance	string	No	available balance of account to spend

Sample Request

{
  "program_id": 7,
  "event": "settlement",
  "event_time": "2022-11-18T15:06:22.195121884-05:00",
  "data": {
    "account": {
      "id": 11,
      "cardholder_id": 25,
      "processor_reference": "129201212666",
      "available_balance": "500.00"
    },
    "timestamp": "2019-12-29T18:20:33Z",
    "amount": "10.75",
    "authorization_id": "254568",
    "type": "VIW",
    "network": "V",
    "billing_curr_code": "840",
    "local_currency": "124",
    "local_currency_amount": "112.20",
    "merchant": {
      "mcc": "5712",
      "name": "Widgets Incorporated",
      "location": "NEW YORK, NY"
    }
  }
}

JSON Schema

{
  "$id": "https://api.pungle.io/schemas/event/settlement",
  "title": "Settlement Event payload",
  "type": "object",
  "properties": {
    "account": {
      "title": "Account Information",
      "type": "object",
      "properties": {
        "id": {
          "description": "ID of cardholder account",
          "type": "number",
          "minimum": 0
        },
        "cardholder_id": {
          "description": "ID of cardholder",
          "type": "number",
          "minimum": 0
        },
        "processor_reference": {
          "description": "Reference to the account on the processor's system",
          "type": "string"
        },
        "available_balance": {
          "description": "The available balance of the account to spend"
          "type": "string"
        }
      }
    },
    "timestamp": {
      "description": "Date and time Berkeley receives the event",
      "type": "string"
    },
    "type": {
      "description": "Type of transaction",
      "type": "string"
    },
    "amount": {
      "description": "Settlement Amount. Ex: 21.45",
      "type": "string"
    },
    "authorization_id": {
      "description": "ID of the authorization that was settled",
      "type": "string"
    },
    "network": {
      "description": "See below list (Network Codes)",
      "type": "string"
    },
    "billing_curr_code": {
      "description": "Currency code for billing_amt",
      "type": "string"
    },
    "local_currency": {
      "description": "Currency code for local_currency_amount",
      "type": "string"
    },
    "local_currency_amount": {
      "description": "Amount of the transaction in the currency at the point of sale",
      "type": "string"
    },
    "merchant": {
      "$ref": "/schemas/merchant"
    }
  }
}