Update Invoice

1min
Update an invoice by ID, all invoice attributes can be updated when the status is "initiated"
, for any other status; you can update the metadata object only.
PUT
Request
Path Params
id
required
String
the invoices unique ID
Body Parameters
amount
optional
String
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
the currency of the amount 
description
optional
String
Describe the goods or services you're selling
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 notification 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 user pays successfully.
expired_at
optional
String
The invoice will expire on this date
Curl
curl -X PUT -u sk_key:\
     -H "Content-Type: application/json" \
     -d '{"amount": 80000}' \
     "https://api.moyasar.com/v1/invoices/73bda482-5f95-4f59-87d3-3fe3615c54bc"
curl -X PUT -u sk_key:\
     -H "Content-Type: application/json" \
     -d '{"amount": 80000}' \
     "https://api.moyasar.com/v1/invoices/73bda482-5f95-4f59-87d3-3fe3615c54bc"
Responses
200
404
{
  "id": "73bda482-5f95-4f59-87d3-3fe3615c54bc",
  "status": "initiated",
  "amount": 80000,
  "currency": "SAR",
  "description": "Order #123126",
  "logo_url": "https://s3-eu-west-1.amazonaws.com/moyasar.api.assets.prod/entities/logos/default.png",
  "amount_format": "800.00 SAR",
  "url": "https://checkout.moyasar.com/invoices/73bda482-5f95-4f59-87d3-3fe3615c54bc?lang=en",
  "callback_url": "https://mystore.com/notify-paid",
  "expired_at": null,
  "created_at": "2023-08-23T11:21:15.690Z",
  "updated_at": "2023-08-23T11:35:41.446Z",
  "back_url": null,
  "success_url": null,
  "metadata": null,
  "payments": []
}
{
  "id": "73bda482-5f95-4f59-87d3-3fe3615c54bc",
  "status": "initiated",
  "amount": 80000,
  "currency": "SAR",
  "description": "Order #123126",
  "logo_url": "https://s3-eu-west-1.amazonaws.com/moyasar.api.assets.prod/entities/logos/default.png",
  "amount_format": "800.00 SAR",
  "url": "https://checkout.moyasar.com/invoices/73bda482-5f95-4f59-87d3-3fe3615c54bc?lang=en",
  "callback_url": "https://mystore.com/notify-paid",
  "expired_at": null,
  "created_at": "2023-08-23T11:21:15.690Z",
  "updated_at": "2023-08-23T11:35:41.446Z",
  "back_url": null,
  "success_url": null,
  "metadata": null,
  "payments": []
}
﻿
﻿
Updated 23 Nov 2023
Did this page help you?
Fetch Invoice
Cancel Invoice