REST API: fizetések útvonal

A payments útvonallal a fizetések adatbázisát éred el: lekérdezheted, létrehozhatod, módosíthatod és törölheted a fizetéseket.

Fizetések lekérése

GET /wp-json/rcp/{verzió}/payments/

Kötelező paraméter nincs. Választható paraméterek:

Paraméter	Jelentés
user_id	Egy adott felhasználó fizetései.
subscription	Egy adott előfizetés (szint) nevéhez tartozó fizetések.
status	A fizetés állapota: complete, pending, failed, refunded, abandoned.
number	Oldalankénti fizetésszám.
offset	Kihagyott fizetések száma (lapozáshoz).
orderby	Rendezés mező szerint: id, user_id, subscription, subscription_key, status, date.
order	Rendezési irány: ASC, DESC.

Egy fizetés lekérése

GET /wp-json/rcp/{verzió}/payments/{fizetés_id}

Kötelező: id, a fizetés azonosítója (az URL-ben vagy a törzsben).

Új fizetés

POST /wp-json/rcp/{verzió}/payments/new

Kötelező paraméterek:

• user_id (egész): a tagfiók azonosítója, amelyhez a fizetés tartozik.
• amount (tizedes szám): a fizetés teljes összege.
• subscription (szöveg): annak a tagsági szintnek a neve, amelyre a fizetést rögzítik.

Választható paraméterek:

Paraméter	Jelentés
status	A fizetés állapota (complete, pending, failed, refunded, abandoned).
object_id	A tagsági szint azonosítója.
object_type	Az object_id által jelölt objektum típusa.
subscription_key	A szint előfizetési kulcsa.
transaction_id	A fizetésfeldolgozó tranzakcióazonosítója.
date	A feldolgozás ideje MySQL-formátumban.
payment_type	A fizetés típusának leírása, például Credit Card, PayPal vagy Credit Card One Time.
subtotal	A részösszeg.
credits	A fizetésre jóváírt kreditek összege.
fees	A fizetésre kirótt díjak összege.
discount_amount	A kedvezmény összege.
discount_code	A felhasznált kedvezménykód.
gateway	A fizetési átjáró azonosítója (slug).

Fizetés módosítása

POST /wp-json/rcp/{verzió}/payments/update/{fizetés_id}

Kötelező: id (egész), a módosítandó fizetés azonosítója. Választható: minden, ami az új fizetésnél szerepel (user_id, amount, subscription, status, object_id, object_type, subscription_key, transaction_id, date, payment_type, subtotal, credits, fees, discount_amount, discount_code, gateway).

Fizetés törlése

DELETE /wp-json/rcp/{verzió}/payments/delete

Kötelező: id (egész), a törlendő fizetés azonosítója.