Test webhook

curl --request POST \
  --url https://api.fincle.com.br/webhooks/{webhookId}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "transaction_paid"
  ]
}
'

import requests

url = "https://api.fincle.com.br/webhooks/{webhookId}/test"

payload = { "events": ["transaction_paid"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({events: ['transaction_paid']})
};

fetch('https://api.fincle.com.br/webhooks/{webhookId}/test', 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.fincle.com.br/webhooks/{webhookId}/test",
  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([
    'events' => [
        'transaction_paid'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.fincle.com.br/webhooks/{webhookId}/test"

	payload := strings.NewReader("{\n  \"events\": [\n    \"transaction_paid\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.fincle.com.br/webhooks/{webhookId}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    \"transaction_paid\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fincle.com.br/webhooks/{webhookId}/test")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    \"transaction_paid\"\n  ]\n}"

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

{
  "success": true,
  "data": {
    "webhookId": 412,
    "url": "https://api.example.com/webhooks/fincle",
    "results": [
      {
        "event": "transaction_paid",
        "success": true,
        "httpStatus": 200,
        "error": null
      }
    ]
  }
}

{
  "success": false,
  "message": "Não foi possível concluir: uma regra de negócio recusou os dados enviados."
}

{
  "success": false,
  "message": "Token inválido ou expirado"
}

{
  "success": false,
  "message": "Recurso não encontrado"
}

{
  "success": false,
  "message": "name: Nome é obrigatório"
}

{
  "success": false,
  "message": "Muitas requisições. Tente novamente em breve."
}

{
  "success": false,
  "message": "Erro interno do servidor"
}

POST

webhooks

{webhookId}

test

Test webhook

curl --request POST \
  --url https://api.fincle.com.br/webhooks/{webhookId}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "transaction_paid"
  ]
}
'

import requests

url = "https://api.fincle.com.br/webhooks/{webhookId}/test"

payload = { "events": ["transaction_paid"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({events: ['transaction_paid']})
};

fetch('https://api.fincle.com.br/webhooks/{webhookId}/test', 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.fincle.com.br/webhooks/{webhookId}/test",
  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([
    'events' => [
        'transaction_paid'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.fincle.com.br/webhooks/{webhookId}/test"

	payload := strings.NewReader("{\n  \"events\": [\n    \"transaction_paid\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.fincle.com.br/webhooks/{webhookId}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    \"transaction_paid\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fincle.com.br/webhooks/{webhookId}/test")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    \"transaction_paid\"\n  ]\n}"

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

{
  "success": true,
  "data": {
    "webhookId": 412,
    "url": "https://api.example.com/webhooks/fincle",
    "results": [
      {
        "event": "transaction_paid",
        "success": true,
        "httpStatus": 200,
        "error": null
      }
    ]
  }
}

{
  "success": false,
  "message": "Não foi possível concluir: uma regra de negócio recusou os dados enviados."
}

{
  "success": false,
  "message": "Token inválido ou expirado"
}

{
  "success": false,
  "message": "Recurso não encontrado"
}

{
  "success": false,
  "message": "name: Nome é obrigatório"
}

{
  "success": false,
  "message": "Muitas requisições. Tente novamente em breve."
}

{
  "success": false,
  "message": "Erro interno do servidor"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

webhookId

integer

required

Webhook identifier.

Required range: x > 0

Body

application/json

events

enum<string>[]

Events to send in the test. When omitted, one payload is sent for each subscribed event. An event the webhook does not subscribe to returns 400.

Required array length: 1 - 17 elements

Available options:

transaction_created,

transaction_paid,

transaction_refunded,

transaction_updated,

transfer_completed,

transfer_canceled,

transfer_created,

transfer_updated,

infraction,

card_declined,

sale_lost,

cart_abandoned,

product_canceled,

release_access,

vturb_paid,

vk_metrics_purchase,

refund_requested

Response

Result of the test delivery.

success

boolean

required

Always true in a successful response.

data

object

required

Show child attributes

Authentication

Charges

Subscriptions

Transactions

Refunds

Infractions and MED

Webhooks

Balance and transfers

Test webhook

Authorizations

Path Parameters

Body

Response