Skip to content
e-Payouts API
ES EN

Developer documentation · API v2

The e-Payouts API

Accept several payment methods through the paymentbox, the payment page hosted by e-Payouts. Your server creates the payment through the API, the customer pays on the paymentbox and you receive the result by signed webhook.

Get started API reference

Base URL https://api.e-payouts.com/v2 JSON · UTF-8 · HTTPS

Create a payment
POST /v2/payments
Content-Type: application/json
X-Api-Key-Id: 1b0c…
X-Api-Signature: 5d41…

{
  "module": "7c1e4a52-5d0b-4f7e-9a1d-3b8f2c6d9e10",
  "amount": "49.90",
  "currency": "EUR",
  "ucode": "PEDIDO-1042"
}
201 CreatedOK
{"data": {
  "checkout_url": "https://…/pagar?t=Xk3v…",
  "amount": "49.90", "ucode": "PEDIDO-1042"
}}

Start here

Everything you need to integrate

Authentication Sign every call with HMAC-SHA256. Examples in PHP, Node.js and Python. Read guide Paymentbox Send the customer to the payment page with a link or an iframe. Read guide Webhooks Receive the result of every payment and verify the signature. Read guide Test mode Test your integration end to end without moving money. Read guide Errors What each error code means and how to fix it. Read guide API reference Every endpoint with its parameters, responses and examples. Read guide
Coming from version 1? Your v1 integration keeps working. See how to move to API v2 step by step. v1 integration →

How it works

  1. Get your keys — in your merchant panel → API: Key ID (public) and secret (shown only once). Never put the secret in a browser or an app.
  2. Create the payment — POST /v2/payments with the module, the amount and your order code (ucode). You sign the call with your secret (see Authentication).
  3. Redirect the customer — to checkout_url. They choose the method and pay on the paymentbox.
  4. Receive the webhook — at the module's notification URL, with the status and your ucode. Verify the signature before delivering the order.
Prefer not to code? Use the link or iframe from "Integration code" in your merchant panel: no API needed. Checkout parameters →

First call

Test your credentials with GET /v2/ping (full examples in Authentication):

HTTP
GET https://api.e-payouts.com/v2/ping
X-Api-Key-Id: 1b0c…
X-Api-Timestamp: 1790380000
X-Api-Nonce: 9f2c4e6a8b0d1f3a5c7e9b1d
X-Api-Signature: 5d41…
Response
{"data":{"object":"ping","merchant":"Mi tienda","uid":1001,"server_time":"2026-09-25T12:00:00Z"}}

Conventions

Rules that apply to the whole API

Amounts

As strings with a dot and two decimals: "10.00". Never as floating point numbers.

Dates

In UTC, ISO 8601: 2026-09-25T12:00:00Z.

Ids

Public ids are UUIDs. Modules also accept their v1 mid.

Responses

{"data": …}. Lists with has_more and next_cursor. Errors: {"error": {"code", "message", "fields", "request_id"}}.

Limits

120 calls per minute per key and 300 per IP. Headers X-RateLimit-Limit and X-RateLimit-Remaining; when exceeded, 429 with Retry-After.

Security

Everything over HTTPS and signed in headers. No security value travels in the URL.

Ready to start getting paid?

Create your account, generate your keys in the panel and make your first test payment.

Create a free account My API keys