Cobros
Cobrar, leer, seguir. El recurso central es la operación; el recorrido nominal es el checkout alojado.
Crear un cobro
POST /v1/payments
| Campo | Obligatorio | Descripción |
|---|---|---|
asset_id |
sí | El activo, por su identificador (GET /v1/assets) |
amount_minor |
sí | Cadena, en unidades menores ("500000" sobre un activo de cero decimales son 500 000) |
country |
sí | País de la operación (ISO 3166-1 alfa-2) |
platform_id |
sí | La plataforma de cobro (GET /v1/corridors) |
platform_account_handle |
— | La subcuenta a abonar. Vacío = la cuenta primaria del corredor |
rail |
— | Fuerza un rail concreto en lugar de dejar elegir al enrutamiento |
payer |
— | { "name", "phone", "email", "country" } |
client_ref |
— | Su referencia, devuelta en las lecturas y en los webhooks |
description |
— | Texto libre |
expires_in_seconds |
— | Duración de validez de la intención de pago |
La respuesta es una operación en estado initiated, con lo necesario para hacer pagar al cliente:
{
"id": "op_01J8Z9K2QW",
"ref": "NP-...",
"client_ref": "pedido-1042",
"kind": "payin",
"status": "initiated",
"asset_id": 1,
"amount_minor": "500000",
"fee_minor": "...",
"net_minor": "...",
"payment_url": "https://pay.neo-pays.com/...",
"is_test": true
}
railfuerza, no sugiere. Omítalo y el enrutamiento elige el mejor rail abierto; nómbrelo y un rail no disponible hace fallar la creación en lugar de pasar a otro.
Leer y listar
GET /v1/payments/{id} — una operación
GET /v1/payments — lista paginada (page, per_page)
{id} acepta el identificador interno, la referencia de la operación, o su propio client_ref.
La lectura es local: no se pregunta nada al rail. Los datos de contacto del pagador están enmascarados, porque el modelo de lectura nunca guarda los originales — la respuesta de creación, en cambio, le devuelve lo que acaba de enviar.
Las listas las sirve una réplica de lectura: ningún informe puede ralentizar un pago.
Las demás familias
El mismo objeto, bajo su propio nombre: /v1/payouts, /v1/refunds, /v1/transfers,
/v1/rebalances. GET /v1/payouts/{id} y sus semejantes devuelven la misma vista enmascarada, con
el mismo control de propiedad.