REST API
The Extra Payment extension exposes its payments through the standard Magento REST API, so you can create, read, update, delete, and email extra payments programmatically or integrate them with external systems.
All endpoints require a Magento access token (integration or admin token) with access to the Extra Payment ACL resource (System -> Permissions -> User Roles -> Sales -> Operations -> Orders -> Actions -> Extra Payment). For general authentication and request/response details, refer to the Magento REST API developer guide.
| Method | Endpoint | Description |
|---|---|---|
| GET | /V1/mst-extra-payment/payments | List extra payments (supports standard searchCriteria filtering) |
| GET | /V1/mst-extra-payment/payment/:paymentId | Get a single extra payment by ID |
| POST | /V1/mst-extra-payment/payment | Create an extra payment |
| PUT | /V1/mst-extra-payment/payment/:paymentId | Update an extra payment |
| DELETE | /V1/mst-extra-payment/payment/:paymentId | Delete an extra payment |
| POST | /V1/mst-extra-payment/payment/:paymentId/email | Send (or resend) the payment notification email to the customer |
Key fields on an extra payment object mirror the General information, Items, Additional, and Email notification settings: order_id, store_id, customer_id, customer_email, status (draft, pending, or paid), link, items (each with item_name and item_price), note, internal_note, email_sender, email_template, payment_order_id, and increment_id.