Get the shareable receipt of a paid payout

GET/payments/{id}/receiptProbar

ServidorURL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

Parámetros de rutaidstringobligatorio

Parámetros de consultaformatjson | pnglanges | en

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

GET

/payments/{id}/receipt

const url = 'http://localhost:3000/v1/payments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/receipt?format=json&lang=es';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/v1/payments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/receipt?format=json&lang=es' \
  --header 'x-api-key: <x-api-key>'

Scope payments:read. The receipt your customer can share (for example, on WhatsApp): sender, amount in Bs, masked beneficiary, bank name, bank reference, date and time in Venezuelan time with its offset, status, concept (your reference) and receipt number (the payment id).

It never includes USD or USDT amounts, rates, fees, the network reference or your Idempotency-Key.

Only payouts that reached settled have a receipt; any other payout returns 409 receipt_not_available. It is built live: if the payout is later reversed or returned, the receipt says so.

format=png returns a 1080×1350 image (image/png). lang sets the labels (es by default).

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

string format: uuid

Query Parameters

format

string

default: json

Allowed values: json png

lang

string

default: es

Allowed values: es en

Responses

200

Receipt

What a paid payout’s receipt shows. No USD or USDT amounts, rates, fees, network reference or Idempotency-Key.

object

receipt_number

The payment id

string format: uuid

status

Live status

string

Allowed values: settled reversed returned

sender_name

Your company name

string

amount

Bs with 2 decimals

string

asset

string

Allowed values: BS

method

string

Allowed values: pago_movil transferencia

beneficiary

object

name

First name and last-name initial

string

nullable

national_id

string

nullable

account

Last 4 digits (transfers)

string

nullable

phone

Last 4 digits (pago_movil)

string

nullable

bank

object

code

string

nullable

name

string

nullable

bank_reference

string

nullable

concept

Your reference of the payout

string

nullable

settled_at

string format: date-time

settled_at_local

Venezuelan time with its offset

string

time_zone

string

Allowed values: America/Caracas

lang

string

Allowed values: es en

verify

Where to verify the receipt

string

Example

{
  "receipt_number": "89920401-26da-4f69-b57d-bc20e0366ce2",
  "status": "settled",
  "sender_name": "Your company",
  "amount": "50000.00",
  "asset": "BS",
  "method": "pago_movil",
  "beneficiary": {
    "name": "Ana P.",
    "national_id": "V-*****123",
    "account": null,
    "phone": "****4567"
  },
  "bank": {
    "code": "0102",
    "name": "Banco de Venezuela"
  },
  "bank_reference": "012345678901",
  "concept": "INV-2026-0042",
  "settled_at": "2026-08-31T19:06:44.120Z",
  "settled_at_local": "2026-08-31T15:06:44-04:00",
  "time_zone": "America/Caracas",
  "lang": "en",
  "verify": "Verify this receipt at bolivarconnect.com"
}

Headers

Cache-Control

string

Example

no-store

404

Error con código estable

application/json

object

error

object

meta

Contexto estructurado del error cuando lo hay: qué límite se superó y de cuánto, qué campo es inválido, cuánto saldo había. No aparece en errores internos.

object

key

additional properties

any

type

string

Allowed values: invalid_request_error authentication_error rate_limit_error upstream_error api_error

code

Código ESTABLE. Programa contra esto.

string

message

string

request_id

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_balance",
    "request_id": "req_8a0312ba896772bc441134cd"
  }
}

409

Error con código estable

application/json

object

error

object

meta

Contexto estructurado del error cuando lo hay: qué límite se superó y de cuánto, qué campo es inválido, cuánto saldo había. No aparece en errores internos.

object

key

additional properties

any

type

string

Allowed values: invalid_request_error authentication_error rate_limit_error upstream_error api_error

code

Código ESTABLE. Programa contra esto.

string

message

string

request_id

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_balance",
    "request_id": "req_8a0312ba896772bc441134cd"
  }
}