Changelog

​

Introduced payment_outcome on Payment Sessions, deprecating payment_status

• payment_outcome — the canonical state of the payment associated with the session

• not_started — payment has not been initiated
• pending — payment is in flight, awaiting a final outcome
• paid — payment succeeded (terminal)
• unpaid — payment failed, expired, or was cancelled (terminal)
• reserved — funds were authorised on a capture_method: manual flow; subsequent capture and void operations are tracked on the underlying Payment resource
• payment_method_verified — supported amount: 0 verification flow succeeded and the payment method was vaulted

• payment_status is now deprecated. It continues to be populated with paid, unpaid, or pending for backwards compatibility. New integrations should read payment_outcome.

​

Added Authorisation and Capture and Payment Method Verification to Payments and Payment Sessions APIs

• POST /collect/payments/{id}/captures — capture a previously authorised payment
• POST /collect/payments/{id}/voids — cancel a previously authorised payment

• capture_method — whether the payment uses immediate or manual capture
• authorized_amount — the amount held under authorisation
• paid_amount — the amount captured and collected
• voided_amount — the amount voided when an authorisation is cancelled
• intent — indicates whether the payment was initiated for verification or payment collection
• metadata now accepted on capture and void requests
• external_reference enforces a pattern of ^[a-zA-Z0-9_-]+$

• payment_method_options added to One Time, First In Series, and Next In Series payment sessions to configure the capture method and enable payment method verification flows

​

Added Mandate and Subscription Options to Payment Sessions API

• mandate_options added to First In Series payment sessions
• Supported mandate types: Scheduled, On Demand, and Installment
• Execution constraints control when recurring payments can be collected: day_of_month, day_of_week, day_of_year, nth_day_of_month
• Period limits define how much can be collected within a given window, with support for calendar-aligned and cycle-aligned windows
• Amount can be fixed or variable within defined bounds

• subscription_options added to support plan-driven recurring payments
• Recurrence can be configured as daily, weekly, or monthly with flexible scheduling

​

Added Payment Rules and Schema Refinements to Billing API

• payment_rules.min_amount — minimum payment amount accepted
• payment_rules.max_amount — maximum payment amount accepted
• payment_rules.overpayment_allowed — whether payments exceeding the balance are accepted
• payment_rules.underpayment_allowed — whether partial payments are accepted

• external_reference on accounts now excludes the reserved bacc_ prefix
• external_reference on customers and bills now excludes the reserved bcus_ prefix
• conflict and payment_not_found error codes added across all billing endpoints

​

Added Presentation Mode to Payment Sessions API

• redirect — redirects the customer to the Moment-hosted checkout page
• embedded_modal — displays checkout as a modal overlay within the merchant’s page
• embedded_inline — renders checkout inline within the merchant’s page

• display_pay_button replaces the previous displayPayButton field on embedded mode options
• payment_not_found added as a new error code across create and retrieve endpoints

​

Introduced Payments API

• GET /collect/payments/{id} — retrieve the full Payment object by its identifier

​

Introduced Payment Requests API

• POST /collect/payment_requests — create a payment request
• GET /collect/payment_requests/{id} — retrieve a payment request
• PATCH /collect/payment_requests/{id} — update a payment request
• DELETE /collect/payment_requests/{id} — delete a payment request

• payment_request.created — triggered when a payment request is created
• payment_request.updated — triggered when a payment request is updated
• payment_request.paid — triggered when a payment request is paid

​

Added obligation.amount_applied Webhook to Billing API

​

Introduced Payment Pages API

• POST /collect/payment_pages — create a payment page
• GET /collect/payment_pages/{id} — retrieve a payment page
• PATCH /collect/payment_pages/{id} — update a payment page
• DELETE /collect/payment_pages/{id} — delete a payment page
• PATCH /collect/payment_pages/{id}/inactive — deactivate a payment page
• GET /collect/payment_pages/{id}/transactions — retrieve transactions for a payment page

• payment_page.payment_received — triggered when a payment is received on a hosted page

​

Introduced Billing API

• POST /billing/customers — create a customer
• GET /billing/customers/{customer} — retrieve a customer
• PATCH /billing/customers/{customer} — update a customer

• POST /billing/accounts — create an account under a customer
• GET /billing/accounts/{account} — retrieve an account
• PATCH /billing/accounts/{account} — update an account

• POST /billing/bills — create a bill
• GET /billing/bills/{bill} — retrieve a bill
• PATCH /billing/bills/{bill} — update a bill
• POST /billing/bills/{bill}/void — cancel a bill

​

Added Checkout Options to Payment Sessions API

​

Introduced Payment Sessions API

• POST /collect/payment_sessions — create a new payment session
• GET /collect/payment_sessions/{id} — retrieve a payment session by its identifier

• One Time — a single payment flow with checkout and payment method options
• First In Series — initiates a recurring payment flow and captures the mandate
• Next In Series — continues a recurring payment flow using an existing mandate