Payment Object

1min

Types with ? at the end are nullable.
Field
Type
Description
Standard
id
string
Payment’s unique ID.
UUIDv4
status
string
Payment status. (default: initiated)
﻿
amount
integer
A positive integer in the smallest currency unit, e.g. cents.
Here some example currencies and how to convert the amount:
15.00 SAR = 100 * 15.00 = 1500 Halalah
35.99 USD = 100 * 35.99 = 3599 Cents
Other currencies like the Kuwaiti Dinar are sub divided into 1000 units:
12.450 KWD = 1000 * 12.450 = 12450 Fils
Some currencies are not divided, for example:
100 JPY is the smallest unit of the Japanese Yen
The minimum amount is 100 currency unit.
﻿
fee
integer
The transaction fee in the smallest currency unit.
﻿
currency
string
Three-letter currency code from ISO 4217. Defaults to SAR.
ISO 4217
refunded
integer
Refunded amount in the smallest currency unit.
﻿
refunded_at
string?
Timestamp of when the payment was refunded.
﻿Zulu ISO 8601﻿
captured
integer
Captured amount in the smallest currency unit.
﻿
captured_at
string?
Timestamp of when the payment was refunded captured.
﻿Zulu ISO 8601﻿
voided_at
string?
Timestamp of when the payment was refunded voided.
﻿Zulu ISO 8601﻿
description
string?
Human readable text describing the payment. This is not displayed to the payer.
﻿
invoice_id
string?
ID of the invoice this payment was initiated for.
﻿
ip
string
The payer IP address.
IPv4
callback_url
string?
Redirection URL that is used by Moyasar to redirect the payer to the merchant page.
﻿
created_at
string
Timestamp of the payment creation.
﻿Zulu ISO 8601﻿
updated_at
string
Timestamp of when the payment was last updated.
﻿Zulu ISO 8601﻿
metadata
object?
Shows the key-value data object that was sent during the payment creation.
String => String
source
object
Payment source object
﻿
﻿
﻿

Field	Type	Description	Standard
id	string	Payment’s unique ID.	UUIDv4
status	string	Payment status. (default: initiated)
amount	integer	A positive integer in the smallest currency unit, e.g. cents. Here some example currencies and how to convert the amount: 15.00 SAR = 100 * 15.00 = 1500 Halalah 35.99 USD = 100 * 35.99 = 3599 Cents Other currencies like the Kuwaiti Dinar are sub divided into 1000 units: 12.450 KWD = 1000 * 12.450 = 12450 Fils Some currencies are not divided, for example: 100 JPY is the smallest unit of the Japanese Yen The minimum amount is 100 currency unit.
fee	integer	The transaction fee in the smallest currency unit.
currency	string	Three-letter currency code from ISO 4217. Defaults to SAR.	ISO 4217
refunded	integer	Refunded amount in the smallest currency unit.
refunded_at	string?	Timestamp of when the payment was refunded.	Zulu ISO 8601
captured	integer	Captured amount in the smallest currency unit.
captured_at	string?	Timestamp of when the payment was refunded captured.	Zulu ISO 8601
voided_at	string?	Timestamp of when the payment was refunded voided.	Zulu ISO 8601
description	string?	Human readable text describing the payment. This is not displayed to the payer.
invoice_id	string?	ID of the invoice this payment was initiated for.
ip	string	The payer IP address.	IPv4
callback_url	string?	Redirection URL that is used by Moyasar to redirect the payer to the merchant page.
created_at	string	Timestamp of the payment creation.	Zulu ISO 8601
updated_at	string	Timestamp of when the payment was last updated.	Zulu ISO 8601
metadata	object?	Shows the key-value data object that was sent during the payment creation.	String => String
source	object	Payment source object

Updated 22 Apr 2024

Did this page help you?

Payment Validations

Payment Status Reference