payments.create (to create and send) and
payments.view (to read).
Create one
Pick the MID it’s paid to (GET /accounts, its id), then:
The answer (
201) is the invoice, with its id, its status and the customer’s pay link. Send an
Idempotency-Key so a retry can’t create it twice.
Business customers’ cards cost less to accept when the invoice carries its lines and PO number (Level 3 data): Mojo
Payments sends them with the payment.
Send it later
POST /payment-requests/{id}/send sends (or re-sends) an open or part-paid invoice, by the customer’s choice of email or
text, else the invoice’s delivery. The invoice’s sentAt, sentVia and sendProblem say what happened.
Follow it
GET /payment-requests/{id} gives the invoice with its lines, every payment made toward it, and the customer’s saved
cards. GET /payment-requests lists them, a page at a time (Pagination): q searches
invoice and PO numbers, the customer’s company, name, email and phone, and amounts; status keeps one status.
A customer can pay with up to three cards. Each approved card is one entry in
payments, with its amount, last four
digits and retRef (the processor’s reference, also on your deposits).
Cancel it
POST /payment-requests/{id}/cancel stops an unpaid or part-paid invoice. What was paid stays paid.
Saved cards
When you let customers save a card (Settings → Payment page), an invoice lists that customer’s saved cards (savedCards: brand, last four, expiry). DELETE /saved-cards/{id} removes one, at the processor too.