Send an invoice

post

https://invoices-api.paymongo.com/v1/invoices/{id}/send

Finalizes a draft to open: mints a hosted checkout session and emails the customer. The optional body's notify: false finalizes without the checkout session or email, for callers that collect payment themselves. A notify send needs at least one payment_methods entry on the invoice and is rejected with 422 without one. It fails with 502 (invoice stays draft) if the checkout session cannot be minted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Invoice ID

Body Params

Send options

allow_duplicate

boolean

AllowDuplicate proceeds past the near-duplicate window after the caller
was shown the collision.

notify

boolean

origin

string

Origin identifies the source that triggered the send so the settled
payment is attributed to the right payment channel. Defaults to
"invoices" when omitted; a caller such as orders-api or subscriptions
passes its own source (e.g. "orders"). Must be a value checkout-api-go
and core-api allow.

Headers

Idempotency-Key

string

Optional replay protection: repeating a send with the same key returns the already-sent invoice without minting a second checkout session or emailing the customer twice. Reusing a key with a different payload is rejected with 422; a concurrent in-flight duplicate answers 409. Max 255 characters, valid for 24h.

X-Acting-User

string

Email of the dashboard user triggering the send (the maker). Consumed by the maker-checker approval gate so a different user must approve; without it the requester falls back to the organization itself.

X-Acting-User-Id

string

Id of the dashboard user triggering the send; pairs with X-Acting-User.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401Unauthorized

404Not Found

409approval_submitted: the send required approval and an approval request was created, so nothing was sent (the invoice stays a draft with approval_status=pending; GET the invoice for its approval_id). approval_pending: already awaiting a decision.

422Unprocessable Entity

500Internal Server Error

502Bad Gateway