API
Invoices
Create Invoice
1min
Create a new invoice for your users
POST
Request
Body Parameters
amount
required
Integer
Amount intended to be collected by this payment. A positive integer represents how much to charge in the smallest currency unit (e.g., 100 Halala to charge 1.00 SAR or 100 to charge ¥100, a zero-decimal currency). The minimum amount is 1 SAR or equivalent in charge currency.
currency
optional
String
3-letter ISO code for currency. E.g., SAR, CAD, USD. (default: SAR)
description
required
String
An arbitrary string which you can attach to a invoice object. This may include a description about the merchandise or the service that your customer is billed for. Invoice description is displayed on the invoice alongside with the charge when the invoice is presented to the user. Note that if you use Moyasar to send automatic email receipts to your customers, your receipt emails will include the description of the payment(s) that they are describing.
metadata
optional
Object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
callback_url
optional
String
An endpoint on your server, for receiving notifications about paid invoices.
back_url
optional
String
An endpoint on your site, that we will redirect to after the user clicks on the back button.
success_url
optional
String
An endpoint on your site, that we will redirect to after the customer pays successfully.
expired_at
optional
String
Specifies when the invoice will get expired. An expired invoice cannot have payment attempts as its status will be expired. The argument can be a date string (e.g. 2017-01-12) or datetime string (e.g. 2018-01-01T09:55:14.000Z) in ISO 8601 format (default: null).
Updated 11 Feb 2024
Did this page help you?