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
X-Nonce
string <uuid>
optional
A random uuid string to identify an CLIENT INTENTION as unique. In case of retrying the same request, always use the same nonce. For new operations, use a new one. By default, if this param is empty, a new nonce would be generated.
X-Async
string 
write-onlyoptional
Can be true, false or auto. If not auto forces API async or sync behavior.
Default:
auto

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
X-Request-ID
string 
required
UUID for each request
Example:
8ddc3426-1425-4d80-b588-a05371119da0
X-Nonce
string 
required
The same nonce sent by user
Example:
3e5f32c10786
Body
response
PingObjOrError
required
Custom object response
One of
PingObj
msg
enum<string> 
read-onlyrequired
If everything goes well, it should return "Pong!"
Allowed value:
Pong!
Default:
Pong!
claims_for_token_debug
object 
JWTClaims
read-onlyrequired
JWT Token Claims
async
enum<boolean> 
read-onlyrequired
Always false in sync responses
Allowed value:
false
Default:
false
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