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": {}
  }
]
'

import requests

url = "https://api.gofermata.com/v1/accounts/{account_id}/events"

payload = [
    {
        "type": "string",
        "quantity": 0,
        "cost_override": {
            "amount": 0,
            "denomination": "string"
        },
        "metadata": {}
    }
]
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      type: 'string',
      quantity: 0,
      cost_override: {amount: 0, denomination: 'string'},
      metadata: {}
    }
  ])
};

fetch('https://api.gofermata.com/v1/accounts/{account_id}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gofermata.com/v1/accounts/{account_id}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'type' => 'string',
        'quantity' => 0,
        'cost_override' => [
                'amount' => 0,
                'denomination' => 'string'
        ],
        'metadata' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gofermata.com/v1/accounts/{account_id}/events"

	payload := strings.NewReader("[\n  {\n    \"type\": \"string\",\n    \"quantity\": 0,\n    \"cost_override\": {\n      \"amount\": 0,\n      \"denomination\": \"string\"\n    },\n    \"metadata\": {}\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gofermata.com/v1/accounts/{account_id}/events")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"type\": \"string\",\n    \"quantity\": 0,\n    \"cost_override\": {\n      \"amount\": 0,\n      \"denomination\": \"string\"\n    },\n    \"metadata\": {}\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gofermata.com/v1/accounts/{account_id}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"type\": \"string\",\n    \"quantity\": 0,\n    \"cost_override\": {\n      \"amount\": 0,\n      \"denomination\": \"string\"\n    },\n    \"metadata\": {}\n  }\n]"

response = http.request(request)
puts response.read_body

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