Retrieve a list of STOs

posthttps://api.tranzila.com/v1/stos/get

This is a paid modal

Please contact sales to use this modal.

Request

Body

application/json

terminal_nameterminalName

sto_idinteger

Retrieve specific STO

Example:4192

sto_statusstring

Retrieve STOs with given status

Allowed values:activeinactive

Example:active

client_internal_idinteger

Example:9678

client_namestring

Example:קים קרדשיאן

client_idsocialIDNumber

client_emailemail

tokenstring

Example:f12cF45cI7898t70126

last_4_digitsstring

Example:0126

card_holder_idsocialIDNumber

bank_account_numberstring

Example:73875

response_languageAPILanguage

Responses

The response can be 200 with an Application error code:

Error Code	Description
20302	Failed to retrieve STO
20304	Bad date

Response body

response.json

JSON

1{
2  "error_code": 0,
3  "message": "string",
4  "stos": [
5    {
6      "sto_id": 4192,
7      "terminal_name": "myterminal",
8      "sto_payments_number": 12,
9      "charge_frequency": "monthly",
10      "first_charge_date": "2024-01-01",
11      "charge_dom": 25,
12      "client": {
13        "internal_id": 584567,
14        "name": "האקלברי פין",
15        "id": null,
16        "email": null,
17        "address": "רציף 9 ושלושה רבעים, קינגס קרוס, לונדון",
18        "phone_country_code": "44",
19        "phone_area_code": "001",
20        "phone_number": "555-8965"
21      },
22      "item": {
23        "internal_id": 41356,
24        "code": "AA-1246-974-B",
25        "name": "מפצל HDMI",
26        "unit_price": 230,
27        "units_number": 2,
28        "price_currency": null,
29        "price_type": "G",
30        "vat_percent": 17
31      },
32      "card": {
33        "token": "f12cF45cI7898t75548",
34        "expire_month": 4,
35        "expire_year": 2024,
36        "card_holder_id": null,
37        "card_holder_name": "לובנגולו מלך זולו"
38      },
39      "msv": {
40        "bank_code": 12,
41        "branch_code": "659",
42        "account_number": "127963"
43      },
44      "charge_amount": 150,
45      "last_charge_date_time": null,
46      "next_charge_date_time": null,
47      "response_language": "english",
48      "created_by_user": "הכבשה שושנה"
49    }
50  ]
51}
52

Body

1{
2  "terminal_name": "myterminal",
3  "sto_id": 4192,
4  "sto_status": "active",
5  "client_internal_id": 9678,
6  "client_name": "קים קרדשיאן",
7  "client_id": "012345632",
8  "client_email": "mail@example.com",
9  "token": "f12cF45cI7898t70126",
10  "last_4_digits": "0126",
11  "card_holder_id": "012345632",
12  "bank_account_number": 73875,
13  "response_language": "english"
14}
15

Request Sample

curl --request POST \
  --url https://api.tranzila.com/v1/stos/get \
  --header 'Content-Type: application/json' \
  --data '{  "terminal_name": "myterminal",  "sto_id": 4192,  "sto_status": "active",  "client_internal_id": 9678,  "client_name": "קים קרדשיאן",  "client_id": "012345632",  "client_email": "mail@example.com",  "token": "f12cF45cI7898t70126",  "last_4_digits": "0126",  "card_holder_id": "012345632",  "bank_account_number": 73875,  "response_language": "english"}'

Response Example: Example

1{
2  "error_code": 0,
3  "message": "string",
4  "stos": [
5    {
6      "sto_id": 4192,
7      "terminal_name": "myterminal",
8      "sto_payments_number": 12,
9      "charge_frequency": "monthly",
10      "first_charge_date": "2024-01-01",
11      "charge_dom": 25,
12      "client": {
13        "internal_id": 584567,
14        "name": "האקלברי פין",
15        "id": null,
16        "email": null,
17        "address": "רציף 9 ושלושה רבעים, קינגס קרוס, לונדון",
18        "phone_country_code": "44",
19        "phone_area_code": "001",
20        "phone_number": "555-8965"
21      },
22      "item": {
23        "internal_id": 41356,
24        "code": "AA-1246-974-B",
25        "name": "מפצל HDMI",
26        "unit_price": 230,
27        "units_number": 2,
28        "price_currency": null,
29        "price_type": "G",
30        "vat_percent": 17
31      },
32      "card": {
33        "token": "f12cF45cI7898t75548",
34        "expire_month": 4,
35        "expire_year": 2024,
36        "card_holder_id": null,
37        "card_holder_name": "לובנגולו מלך זולו"
38      },
39      "msv": {
40        "bank_code": 12,
41        "branch_code": "659",
42        "account_number": "127963"
43      },
44      "charge_amount": 150,
45      "last_charge_date_time": null,
46      "next_charge_date_time": null,
47      "response_language": "english",
48      "created_by_user": "הכבשה שושנה"
49    }
50  ]
51}
52