Payment Object

1min

Attribute
Type
Description
id
string
payment’s unique ID.
status
string
payment status. (default: initiated)
amount
integer
A positive integer in the smallest currency unit (e.g 100 cents to charge an amount of $1.00, 100 halalah to charge an amount of 1 SAR, or 1 to charge an amount of ¥1, a 0-decimal currency) representing how much to charge the card. The minimum amount is $0.50 (or equivalent in charge currency).
fee
integer
the transaction fee in halals.
currency
string
3-letter  for currency. E.g., SAR, CAD, USD. (default: SAR)
refunded
integer
refunded amount in halals. (default: 0)
refunded_at
string
DateTime of when the refund was issued. (default: null)
captured
integer
Captured amount in halals. (default: 0)
captured_at
string
DateTime of when the authorized payment was captured. (default: null)
voided_at
string
DateTime of when the payment got voided. (default: null)
description
string
The description is only for your reference and it is NOT displayed to users.
invoice_id
string
The ID of the invoice this payment is for if one exists. (default: null)
ip
string
The Cardholder's IP address
callback_url
string
page URL in the customer’s site for final redirection. (used for creditcard 3-D secure and form payment)
created_at
string
creation timestamp in ISO 8601 format.
updated_at
string
modification timestamp in ISO 8601 format.
metadata
object
metadata object (default: null)
source
object
source object defined the type of payment.
﻿

Updated 23 Nov 2023

Did this page help you?

Metadata

Payment Status Reference

Attribute	Type	Description
id	string	payment’s unique ID.
status	string	payment status. (default: initiated)
amount	integer	A positive integer in the smallest currency unit (e.g 100 cents to charge an amount of $1.00, 100 halalah to charge an amount of 1 SAR, or 1 to charge an amount of ¥1, a 0-decimal currency) representing how much to charge the card. The minimum amount is $0.50 (or equivalent in charge currency).
fee	integer	the transaction fee in halals.
currency	string	3-letter for currency. E.g., SAR, CAD, USD. (default: SAR)
refunded	integer	refunded amount in halals. (default: 0)
refunded_at	string	DateTime of when the refund was issued. (default: null)
captured	integer	Captured amount in halals. (default: 0)
captured_at	string	DateTime of when the authorized payment was captured. (default: null)
voided_at	string	DateTime of when the payment got voided. (default: null)
description	string	The description is only for your reference and it is NOT displayed to users.
invoice_id	string	The ID of the invoice this payment is for if one exists. (default: null)
ip	string	The Cardholder's IP address
callback_url	string	page URL in the customer’s site for final redirection. (used for creditcard 3-D secure and form payment)
created_at	string	creation timestamp in ISO 8601 format.
updated_at	string	modification timestamp in ISO 8601 format.
metadata	object	metadata object (default: null)
source	object	source object defined the type of payment.