v1.0

Respawn Pay API Documentation

Welcome to the official Respawn Pay API documentation. Here you will find everything you need to integrate PIX payments into your application.

PIX - Instant Payments

Receive payments in real time via PIX with dynamic QR Code, PIX key and instant webhook notifications.

Security

Every request is authenticated with the X-Client-Id and X-API-Key headers and sent over HTTPS.

Real Time

Instant webhooks for payment and withdrawal notifications.

Easy Integration

RESTful API with JSON responses and complete documentation.

Base URL

https://api.respawnpay.com

All production requests use this URL as the base. For testing without real money, use the sandbox base URL (see Sandbox).

Response Format

Responses are JSON. Errors use the HTTP status code plus a JSON body; the body shape is not the same on every endpoint (see Errors). Error messages are currently returned in Portuguese.

Success Response Example (create transaction, shortened)

Response 200

{
  "data": {
    "id": "f2d96218-6635-4839-81d7-9f2d5aaf4f14",
    "status": "WAITING_PAYMENT",
    "paymentMethod": "PIX",
    "amount": 500
  },
  "status": 200,
  "message": "Transação criada e registrada com sucesso (OnlyUp)."
}

Next Steps

Authentication

Set up your API credentials

→

Create Transaction

Create your first PIX transaction

→

Webhooks

Receive real-time notifications

→

Error Handling

Understand the error codes

→