Incassi
Incassare, leggere, seguire. La risorsa centrale è l'operazione; il percorso nominale è il checkout ospitato.
Creare un incasso
POST /v1/payments
| Campo | Obbligatorio | Descrizione |
|---|---|---|
asset_id |
sì | L'asset, tramite il suo identificativo (GET /v1/assets) |
amount_minor |
sì | Stringa, in unità minori ("500000" su un asset a zero decimali vale 500 000) |
country |
sì | Paese dell'operazione (ISO 3166-1 alpha-2) |
platform_id |
sì | La piattaforma di incasso (GET /v1/corridors) |
platform_account_handle |
— | Il sottoconto da accreditare. Vuoto = il conto primario del corridoio |
rail |
— | Forza un rail preciso invece di lasciar scegliere l'instradamento |
payer |
— | { "name", "phone", "email", "country" } |
client_ref |
— | Il suo riferimento, restituito nelle letture e nei webhook |
description |
— | Testo libero |
expires_in_seconds |
— | Durata di validità dell'intenzione di pagamento |
La risposta è un'operazione nello stato initiated, con quanto serve a far pagare il cliente:
{
"id": "op_01J8Z9K2QW",
"ref": "NP-...",
"client_ref": "ordine-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
}
railforza, non suggerisce. Lo ometta e l'instradamento sceglie il miglior rail aperto; lo nomini e un rail non disponibile fa fallire la creazione invece di ripiegare su un altro.
Leggere ed elencare
GET /v1/payments/{id} — un'operazione
GET /v1/payments — elenco paginato (page, per_page)
{id} accetta l'identificativo interno, il riferimento dell'operazione, o il suo client_ref.
La lettura è locale: al rail non si chiede nulla. I recapiti del pagatore vi sono mascherati, perché il modello di lettura non conserva mai quelli grezzi — la risposta alla creazione, invece, le restituisce ciò che ha appena inviato.
Gli elenchi sono serviti da una replica di lettura: nessun report può rallentare un pagamento.
Le altre famiglie
Lo stesso oggetto, sotto il proprio nome: /v1/payouts, /v1/refunds, /v1/transfers,
/v1/rebalances. GET /v1/payouts/{id} e i suoi simili restituiscono la stessa vista mascherata,
con lo stesso controllo di proprietà.