Push Events

Push an event to the billing engine. This endpoint can accept very high volume of requests and will be low latency. It returns a success if the data appears to be valid

POST /v1/accounts/{account_id}/events

Push Events

cURL

curl --request POST \
  --url https://api.gofermata.com/v1/accounts/{account_id}/events \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "type": "string",
    "quantity": 0,
    "cost_override": {
      "amount": 0,
      "denomination": "string"
    },
    "metadata": {}
  }
]
'

200

{
  "events_submitted": 123
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

account_id · string · required

Body

application/json

Minimum array length: 1

type · string · required

quantity · integer

metadata · object

cost_override_amount · integer

cost_override_denomination · string

state · enum<string>

Available options: pending, completed, cancelled

gate_on_balance · boolean

Return an error if there is not enough balance to handle the event

Response

200 - application/json

OK

events_submitted · integer