Einzüge
Einziehen, lesen, verfolgen. Die zentrale Ressource ist die Operation; der Normalweg ist das gehostete Checkout.
Einen Einzug anlegen
POST /v1/payments
| Feld | Pflicht | Beschreibung |
|---|---|---|
asset_id |
ja | Das Asset, über seine Kennung (GET /v1/assets) |
amount_minor |
ja | Zeichenkette, in kleinsten Einheiten ("500000" bei einem Asset ohne Nachkommastellen sind 500 000) |
country |
ja | Land der Operation (ISO 3166-1 alpha-2) |
platform_id |
ja | Die Einzugsplattform (GET /v1/corridors) |
platform_account_handle |
— | Das gutzuschreibende Unterkonto. Leer = das primäre Konto des Korridors |
rail |
— | Erzwingt ein bestimmtes Rail, statt das Routing wählen zu lassen |
payer |
— | { "name", "phone", "email", "country" } |
client_ref |
— | Ihre Referenz, in Lesevorgängen und Webhooks zurückgegeben |
description |
— | Freitext |
expires_in_seconds |
— | Gültigkeitsdauer der Zahlungsabsicht |
Die Antwort ist eine Operation im Status initiated, mit allem, um den Kunden zahlen zu lassen:
{
"id": "op_01J8Z9K2QW",
"ref": "NP-...",
"client_ref": "bestellung-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
}
railerzwingt, es schlägt nicht vor. Lassen Sie es weg, und das Routing wählt das beste offene Rail; nennen Sie es, und ein nicht verfügbares Rail lässt die Erstellung scheitern, statt auf ein anderes auszuweichen.
Lesen und auflisten
GET /v1/payments/{id} — eine Operation
GET /v1/payments — paginierte Liste (page, per_page)
{id} akzeptiert die interne Kennung, die Referenz der Operation oder Ihre eigene client_ref.
Das Lesen ist lokal: beim Rail wird nichts angefragt. Die Kontaktdaten des Zahlers sind dort maskiert, weil das Lesemodell die Rohdaten nie hält — die Antwort auf die Erstellung gibt Ihnen dagegen zurück, was Sie gerade gesendet haben.
Listen liefert eine Lese-Replik: kein Bericht kann eine Zahlung verlangsamen.
Die anderen Familien
Dasselbe Objekt unter eigenem Namen: /v1/payouts, /v1/refunds, /v1/transfers,
/v1/rebalances. GET /v1/payouts/{id} und seinesgleichen liefern dieselbe maskierte Sicht, mit
derselben Eigentumsprüfung.