# 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&#x20;

**Table 4.17 – Fields of Payment Model**&#x20;

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

**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":            "purchaser@gmail.com",
    "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&#x20;

<table><thead><tr><th width="69">№</th><th width="151">Title </th><th>Description </th></tr></thead><tbody><tr><td>1</td><td>wallet </td><td>Money for payment was used from Wallet</td></tr><tr><td>2</td><td>bancontact </td><td>One of Internet payment types. Depends on your payment integration</td></tr><tr><td>3</td><td>card </td><td>Money for payment was used from assigned to the Account credit card</td></tr><tr><td>4</td><td>cardknox </td><td>One of Internet payment types. Depends on your payment integration</td></tr><tr><td>5</td><td>ideal </td><td>One of Internet payment types. Depends on your payment integration</td></tr><tr><td>6</td><td>manual</td><td>Payment was made by admin manually</td></tr><tr><td>7</td><td>paypal </td><td>One of Internet payment types. Depends on your payment integration</td></tr><tr><td>8</td><td>stripe </td><td>One of Internet payment types. Depends on your payment integration</td></tr></tbody></table>

**Table 4.19 – Refill Types**&#x20;

<table><thead><tr><th width="69">№</th><th width="199">Title </th><th>Description </th></tr></thead><tbody><tr><td>1</td><td>Refill SIM</td><td>SIM Card MB amount was refilled</td></tr><tr><td>2</td><td>Refill eSIM</td><td>eSIM Card MB amount was refilled </td></tr><tr><td>3</td><td>Refill Wallet</td><td>Wallet money amount was refilled</td></tr><tr><td>4</td><td>Buying an eSIM</td><td>eSIM Purchase</td></tr></tbody></table>
