Create invoice

post

https://sandbox.dev.business.mamopay.com/manage_api/v1/invoices

Creates an invoice and emails it to your customer, with a link to pay it online.

Provide the amount, the customer's email, and a description; add the customer's name, address, and tax details to have them printed on the invoice. Use additional_cc_emails to copy other people, and external_id to match the invoice to an order in your own system.

The response includes the invoice's payment_url (the page your customer pays on) and its status, which stays outstanding until the invoice is paid. Use webhooks to be notified when it is.

Body Params

amount

number

required

≥ 0

Defaults to 123

Invoice amount before processing fee and VAT. The customer pays this plus any processing fee, plus 5% VAT on both when vat_enabled is true.

amount_currency

string

Defaults to AED

Currency code for the invoice amount. Accepted currencies are configured by Mamo and can change; see Supported currencies for the current list. American Express cards can pay in AED or USD only.

string

required

The customer's email address where the invoice will be sent.

description

string

length ≤ 75

A description of the invoice. This will appear on the invoice sent to the customer.

customer_type

string

enum

required

Defaults to individual

The type of customer receiving the invoice.

Allowed:

first_name

string

required

The first name of the customer.

last_name

string

required

The last name of the customer.

phone_number

string

The customer's phone number.

business_name

string

The customer's business name. Applicable when customer_type is business.

address

string

The customer's address. Applicable when customer_type is business.

city

string

The customer's city. Applicable when customer_type is business.

country

string

The customer's country. Applicable when customer_type is business.

uae_tax_reference_number

string

The customer's UAE tax reference number (TRN). Applicable when customer_type is business.

vat_enabled

boolean

Defaults to false

Whether to charge 5% VAT on the invoice amount plus any processing fee, and show it on the invoice.

additional_heading

string

An optional heading that will appear as additional information on the invoice.

additional_details

string

Optional additional details or notes to include on the invoice.

additional_cc_emails

array of strings

A list of additional email addresses to CC when the invoice is sent.

additional_cc_emails

external_id

string

length ≤ 20

An external reference ID of your choice to associate with this invoice.

processing_fee_percentage

number | null

≥ 0

A processing fee percentage to be added on top of the invoice amount and charged to the customer. If you send both fee fields, this one is used and processing_fee_amount is ignored.

processing_fee_amount

number | null

≥ 0

A fixed processing fee amount to be added on top of the invoice amount and charged to the customer. Ignored if processing_fee_percentage is also sent.

Headers

Idempotency-Key

string

A unique key, such as a UUID, that makes it safe to retry this request. Reuse the same key when you retry. See Idempotency.

Responses

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

201Successful response

403Unauthorised

422Unprocessable entity