Payment Model

The Payment Model – is a model for show platform payment parameters. Model fields are presented in the table (Table 4.17), with an example below (Listing 4.13). Types of Payment Methods describes in the Table 4.18 and types of Refill Types – in the table 4.19. { "unix_timestamp": "1711929600", "human_time": "17:25:11", "human_date": "2024-06-12", "timezone": "UTC" } { "uuid": "1711929600", "name": "Rule for refills", "description": "Send notif to email when usage reaches 100MB" } Sheets Doc. No. Date Sheet Rev. Push API Documentation 18 3 27 PPAD.01

Table 4.17 – Fields of Payment Model

№	Key	Type	Exists	Description
1	uuid	uuid v4, string	required	Main identifier of payment
2	ransaction_id	string	required	Identificator of transaction
3	amount	float	required	Money amount for payment
4	currency_code	string	required	EUR, USD, etc
5	payment_method	string	required	Wallet, card, etc.
6	refill_type	string	required	Payment object – refill balance, sim or etc.
7	credit_card	Credit Card Model	optional	If payment was made with card
8	email	string	optional	Purchaser email
9	name	string	optional	Purchaser name
10	company	Account Model	optional	Purchaser company if end user does not exist
11	end_user	End User Model	optional	Purchaser end user
12	receipt_url	string	optional	Link to see original receipt
13	metadata	array	optional	Additional info about payment
14	payment_at	Date Time Model	required	Operation date

Listing 4.13 – Example of Payment Model (JSON)

{
    "uuid":             "b528bcb9-86cf-2d72834d02ab",
    "transaction_id":   "txn_322Knxiwkaxi4d26770123zOgB",
    "amount":           "35.20",
    "currency_code":    "EUR",
    "payment_method":   "card",
    "refill_type":      "refill_sim",
    "credit_card":      {...//Credit Card Model},
    "email":            "[e-mail]",
    "name":             "Purchaser Name",
    "company":          {...//Account Model},
    "end_user":         {...//End User Model},
    "receipt_url":      "https://payment.com/jajkxawjj...",
    "metadata":         ["sim_iccid" => "8991712410", ...],
    "payment_at":       {...//Date Time Model},
}

Table 4.18 – Payment Types

№	Title	Description
1	wallet	Money for payment was used from Wallet
2	bancontact	One of Internet payment types. Depends on your payment integration
3	card	Money for payment was used from assigned to the Account credit card
4	cardknox	One of Internet payment types. Depends on your payment integration
5	ideal	One of Internet payment types. Depends on your payment integration
6	manual	Payment was made by admin manually
7	paypal	One of Internet payment types. Depends on your payment integration
8	stripe	One of Internet payment types. Depends on your payment integration

Table 4.19 – Refill Types

№	Title	Description
1	Refill SIM	SIM Card MB amount was refilled
2	Refill eSIM	eSIM Card MB amount was refilled
3	Refill Wallet	Wallet money amount was refilled
4	Buying an eSIM	eSIM Purchase