Pix2DePix API
  1. API Endpoints
Pix2DePix API
  • 📜 API Overview
  • Docs
    • 🔑 Authentication
    • 💻 Examples
    • 🪝 Webhook
    • 🛡️ Security & Limits
      • ✅ Best Practices
      • 🧱 Firewall
      • 🪲 Bug Bounty
      • 🚦 API Limits
    • 🧩 Advanced (optional)
      • 🎲 Nonce
      • 🔀 Sync / Async call
  • API Endpoints
    • Ping
      GET
    • Deposit (PIX ➔ DePix)
      POST
    • Deposit Status
      GET
  1. API Endpoints

Ping

GET
ping
The API "does nothing" except return "Pong!" if everything is OK. Additionally, it returns the JWT token in a human-readable format. Useful for checking overall API system availability and also debugging the JWT token.

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Header Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://depix.eulen.app/api/ping' \
--header 'X-Nonce;' \
--header 'X-Async: auto'

Responses

🟢200Success
application/json
Headers

Body

Examples
{
    "response": {
        "msg": "Pong!",
        "claims_for_token_debug": {
            "alg": "RS256",
            "env": "dev",
            "exp": 1734676306,
            "iat": 1734244306,
            "jti": "65e9f0b92ded",
            "scope": [
                "deposit",
                "withdraw"
            ],
            "sub": "noksys",
            "typ": "JWT"
        }
    },
    "async": false
}
🟠401Unauthorized
🟠403Forbidden
🔴500Server Error
🔴503Service Unavailable
Modified at 2024-12-31 14:59:39
Previous
🔀 Sync / Async call
Next
Deposit (PIX ➔ DePix)
Built with