{"openapi":"3.0.3","info":{"title":"MoneyPaga Merchant API","version":"2026-07-01","description":"Merchant API for customers, products, prices, orders, invoices, charges, payments, refunds, subscriptions, entitlements, portal sessions, and webhook testing."},"servers":[{"url":"https://api.moneypaga.com.br","description":"MoneyPaga API"}],"paths":{"/v1/charges":{"get":{"summary":"List charges","description":"Required merchant scope: charges:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/charges/{id}":{"get":{"summary":"Get charge","description":"Required merchant scope: charges:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/customers":{"get":{"summary":"List customers","description":"Required merchant scope: customers:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}},"post":{"summary":"Create customer","description":"Required merchant scope: customers:write.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"email":"client@example.com","external_id":"customer-123","name":"Client Example"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/customers/{id}":{"get":{"summary":"Get customer","description":"Required merchant scope: customers:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/entitlements":{"get":{"summary":"List entitlements","description":"Required merchant scope: customers:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/entitlements/check":{"get":{"summary":"Check entitlement balance","description":"Required merchant scope: customers:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/entitlements/consume":{"post":{"summary":"Consume entitlement units","description":"Required merchant scope: customers:write.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"customer_id":"\u003ccustomer_uuid\u003e","feature_key":"software_development_hours","units":1}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/invoices":{"get":{"summary":"List invoices","description":"Required merchant scope: invoices:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/invoices/{id}":{"get":{"summary":"Get invoice","description":"Required merchant scope: invoices:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/invoices/{id}/charge":{"get":{"summary":"Get invoice payment instructions","description":"Required merchant scope: charges:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}},"post":{"summary":"Create or reuse invoice charge","description":"Required merchant scope: charges:write.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/invoices/{id}/pdf":{"get":{"summary":"Download invoice PDF","description":"Required merchant scope: invoices:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/orders":{"get":{"summary":"List orders","description":"Required merchant scope: orders:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}},"post":{"summary":"Create order","description":"Required merchant scope: orders:write.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"currency":"BRL","customer_id":"\u003ccustomer_uuid\u003e","items":[{"description":"Software service hours","quantity":"1","unit_amount_cents":55000}]}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/orders/{id}":{"get":{"summary":"Get order","description":"Required merchant scope: orders:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/orders/{id}/invoice":{"post":{"summary":"Create invoice for order","description":"Required merchant scope: invoices:write.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/payments":{"get":{"summary":"List payments","description":"Required merchant scope: charges:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/payments/{id}/refund-request":{"post":{"summary":"Request payment refund","description":"Required merchant scope: refunds:write.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/portal/sessions":{"post":{"summary":"Create customer portal session","description":"Required merchant scope: customers:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"customer_id":"\u003ccustomer_uuid\u003e","return_url":"https://merchant.example.com/billing"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/prices":{"get":{"summary":"List prices","description":"Required merchant scope: orders:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/products":{"get":{"summary":"List products","description":"Required merchant scope: orders:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/products/{id}":{"get":{"summary":"Get product","description":"Required merchant scope: orders:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/subscriptions":{"get":{"summary":"List subscriptions","description":"Required merchant scope: subscriptions:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}},"post":{"summary":"Create subscription","description":"Required merchant scope: subscriptions:write.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}},"/v1/subscriptions/{id}":{"get":{"summary":"Get subscription","description":"Required merchant scope: subscriptions:read.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}},"patch":{"summary":"Update subscription","description":"Required merchant scope: subscriptions:write.","tags":["MoneyPaga Merchant API"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Missing API key scope"}}}}},"components":{"securitySchemes":{"bearerAuth":{"description":"Use a scoped rm_test_ or rm_live_ merchant API key.","scheme":"bearer","type":"http"}}}}