List With Filters

GET {{host}}/payments

Request Params

KeyDatatypeRequiredDescription
payment_idnumber
payer_idnumber
pagenumber
statusnumberAvailable = 10,
Processing = 20,
Failed = 30,
Paid = 40,
Refunded = 50
activebooleantrue ou false
is_recurrentboolean
recurrence_codenumberCódigo da único da recorrência.
created_at_startstring
created_at_endstring
paid_at_startstring
paid_at_endstring

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"data":[{"id":11,"name":"Pedido 999 na StoreXYZ","amount":139900,"installments":6,"frequency":"monthly","is_boleto":false,"active":false,"status":30,"status_label":"Falhou","start_date":"2022-06-29 20:00","created_at":"2022-03-29 20:00","updated_at":"2022-08-24 17:41"}],"links":{"first":"http://webpag.local/api/payments?page=1","last":"http://webpag.local/api/payments?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"\u0026laquo; Previous","active":false},{"url":"http://webpag.local/api/payments?page=1","label":"1","active":true},{"url":null,"label":"Next \u0026raquo;","active":false}],"path":"http://webpag.local/api/payments","per_page":15,"to":1,"total":1}}