DEEPayment Merchant API

DEEPayment Merchant API provides unified endpoints for payments, payouts, subscriptions, order queries, balances, payout receipts, merchant webhooks, and Subscription Events. All requests use HTTPS + JSON. Protected business APIs are signed with the merchant Ed25519 key (RFC 9421), and POST bodies are encrypted with an X25519 sealed box; the platform SDK handles both.

Recommended path: generate keys, configure the SDK, create orders, handle webhooks, and use query APIs as the source of truth when callbacks are delayed or duplicated.

Quick Start

Prerequisites, Base URL, order examples, and response envelopes.

Authentication

Ed25519 signing, Signature-Input, Content-Digest, sealed-box body encryption, and GET/POST rules.

Subscription Quick Start

Plans, hosted Checkout, state confirmation, billing, cancellation, and recovery.

webhook

Final-state callbacks, signature verification, event fields, and idempotent processing.

Subscription Events

Independent signatures, event fields, duplicate delivery, ordering, and query fallback.

API Reference

Open complete endpoint docs by payments, payouts, countries, and methods.

Postman Collection

Import request examples for payments, payouts, queries, balances, and receipts. Signing and body encryption require the SDK.

API Map

POST

Create payment order

Open an independent method page by country and payment method. Each page includes complete request and response schemas.

/paymentsPOST

Create payout order

Open an independent method page by country and payout method, with fields and error handling in one place.

/payoutsGET

Query payment order

Confirm the final payment status by platform order number or merchant order number.

/payments?orderNo=...POST

Create and manage Subscriptions

Create Plans and hosted Checkout Sessions, confirm Subscription state, then query Invoices and Payment Orders.

/subscription/**GET

Query payout order

Use this after payout creation timeouts, callback delays, or status conflicts.

/payouts?merchantOrderNo=...GET

Query balance

Check available merchant balance by currency.

/balances?currency=BRLGET

Query payout receipt

Retrieve payout receipt details for reconciliation or customer support.

/payouts/{orderNo}/receipt

Integration Path

Prepare merchant credentials
Send production requests to https://panama.deepayment.com/api/v1. Get the Access Key and platform public keys during onboarding, upload your Ed25519 public key, and keep credentials separated by environment.
Choose the business integration path
Use Payments & Payouts for one-time orders, or the Subscription Quick Start for recurring billing and hosted Checkout.
Sign the exact outgoing request
Sign with your Ed25519 key over the RFC 9421 signature base and seal POST bodies to the platform X25519 key. The SDK does this for you.
Create payment or payout orders
Use merchantOrderNo as your idempotency key, and pass the lowerCamelCase method branch that matches the selected code.
Handle webhooks and query recovery
Verify signatures before posting final states. Use query APIs when callbacks are delayed, duplicated, out of order, or when create requests return 5xx.

Method Shape

Order creation uses merchantOrderNo, currency, amount, webhookUrl, and a method object. Method objects follow code + lowerCamelCase branch:

{
  "paymentMethod": {
    "code": "PIX",
    "pix": {
      "payerCPF": "12345678901",
      "payerName": "Joao Silva"
    }
  }
}

code uses uppercase enum values. Branch fields use lowerCamelCase, for example PIX -> pix, PSE -> pse, and BANK_TRANSFER -> bankTransfer.

Navigation​