Branta
  • Branta API
    • Start Here
  • Guardrail
    • Authentication
    • Environments
    • Name, Image and Block Height
    • V1
      • Adding Payments
      • Displaying Payments
      • Getting Payments
      • Indexing Payments
    • Guardrail+
  • More
    • API Status
    • Key Rotation
  • BTCPayServer Plugin
Powered by GitBook
On this page
  1. Guardrail
  2. V1

Indexing Payments

HTTP GET to show all registered payments in Branta.

PreviousGetting PaymentsNextGuardrail+

Last updated 11 days ago

This endpoint is provided for debugging. Prints out all non-expired payments for a given API key.

Get all payments

get

Get all payments created by a given API KEY

Header parameters
API_KEYstringRequired

The API_KEY is required to authorize the request. This key is unique to each client and must be included in the header of every request. Failure to provide a valid API_KEY will result in an unauthorized error.

Make sure to keep your api_key confidential.

Responses
200
Payments retrieved successfully.
application/json
401
Unauthorized - API key missing or invalid.
get
GET /v1/payments HTTP/1.1
Host: staging.branta.pro
API_KEY: text
Accept: */*
[
  {
    "payment": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "created_at": "2024-09-02T12:34:56Z",
    "platform": "Example Platform",
    "ttl": 86400
  }
]