Retrieve Payment Results
Every payment event Rightfoot holds for one borrower, oldest first
Retrieve Payment Results
Name one borrower — theauthorizer_unique_id you enrolled them with — and get back everything Rightfoot knows about their payments.
The response is a flat list of events, oldest first, not a list of payments. One payment produces several events over its life, and reference is what tells you which payment an event belongs to.
Pull on whatever cadence suits you. Nothing here expires, and re-reading is free.
events list, not a 404. An empty result is therefore not confirmation that the identifier is correct — a typo looks the same as a borrower with no payments yet.The life of a payment
A payment appears asprocessing when it goes out, and gains a second event when it resolves:
reference, and their events are interleaved in one chronological list.
Statuses
return_code is present on returned and late_returned only, and carries the payment processor’s NACHA R-code — R01 for insufficient funds, R02 for a closed account, and so on.
Posting to your ledger
settledis a payment received against thatreference.returnedandlate_returnedreverse the settlement you booked for thatreference. An ordinaryreturnednever settled in the first place, so most of the time there is nothing to reverse — a reversal with no matching credit is normal here rather than an error.- Every other status moves no money and needs no entry.
event_id as your idempotency key. It is unique, stable, and never reissued, so replaying the same read is safe.
Amounts
amount is an integer number of cents, and is the amount of the payment the event belongs to — 42500 is $425.00. Every event on the same reference carries the same amount.Authorizations
Authentication to the API is performed via Bearer Token Authentication. Provide your API key as the bearer token in the Authorization header.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Query Parameters
The borrower to report on — the identifier you enrolled them with.
1Response
Every payment event held for this borrower, oldest first. An empty
events array is a valid answer.
The borrower these events belong to, echoed from the request.
Oldest first. An empty array means Rightfoot holds no payment events for this borrower — which is also the answer for a borrower Rightfoot has never heard of, so it is not by itself confirmation that the identifier is correct.
