create a standing order

posthttps://api.tranzila.com/v1/sto/create

Deprecated

Migrate to V2

Request

Headers

X-tranzila-api-request-timestringrequired

Request time sent in Unix format (large integer counting seconds from Jan 1 st , 1970 00:00:00

X-tranzila-api-app-keystringrequired

Application public key supplied by Tranzila

X-tranzila-api-noncestringrequired

A 40 bytes NONCE – unique random string generated with any random bytes function

X-tranzila-api-access-tokenstringrequired

hash_hmac using ‘sha256’ on application key with secret + request-time + nonce. hash_hmac is available for all programming languages with samples found here: https://www.jokecamp.com/blog/examples-of-creating-base64-hashes-using-hmac-sha256-in- different-languages/

Body

application/json

sto_idinteger

Example:4192

terminal_nameterminalNamerequired

sto_payments_numberintegerrequired

Example:12

charge_frequencystringrequired

Allowed values:weeklymonthlyquarterlyhalf-yearlyyearly

Example:monthly

first_charge_datedbDate

charge_domintegerrequired

Example:25

clientSTOClient

itemSTOItemrequired

cardtokenDetails

msvbankDetails

charge_amountnumber

Example:150

last_charge_date_timeunknown

next_charge_date_timeunknown

response_languageAPILanguage

created_by_userstring

Example:הכבשה שושנה

Responses

The response can be 200 with an Application error code:

Error Code	Description
20300	Too many payment methods
20301	Failed to insert STO
20302	Failed to retrieve STO
20303	No payment method
20304	Bad date
20305	Failed to create token

Response body

response.json

JSON

1{
2  "error_code": 0,
3  "message": "string",
4  "sto_id": 0
5}
6

Body

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

Request Sample

curl --request POST \
  --url https://api.tranzila.com/v1/sto/create \
  --header 'Content-Type: application/json' \
  --header 'X-tranzila-api-request-time: <X-tranzila-api-request-time>' \
  --header 'X-tranzila-api-app-key: <X-tranzila-api-app-key>' \
  --header 'X-tranzila-api-nonce: <X-tranzila-api-nonce>' \
  --header 'X-tranzila-api-access-token: <X-tranzila-api-access-token>' \
  --data '{  "sto_id": 4192,  "terminal_name": "myterminal",  "sto_payments_number": 12,  "charge_frequency": "monthly",  "first_charge_date": "2024-01-01",  "charge_dom": 25,  "client": {    "internal_id": 584567,    "name": "האקלברי פין",    "id": null,    "email": null,    "address": "רציף 9 ושלושה רבעים, קינגס קרוס, לונדון",    "phone_country_code": "44",    "phone_area_code": "001",    "phone_number": "555-8965"  },  "item": {    "internal_id": 41356,    "code": "AA-1246-974-B",    "name": "מפצל HDMI",    "unit_price": 230,    "units_number": 2,    "price_currency": null,    "price_type": "G",    "vat_percent": 17  },  "card": {    "token": "f12cF45cI7898t75548",    "expire_month": 4,    "expire_year": 2024,    "card_holder_id": null,    "card_holder_name": "לובנגולו מלך זולו"  },  "msv": {    "bank_code": 12,    "branch_code": "659",    "account_number": "127963"  },  "charge_amount": 150,  "last_charge_date_time": null,  "next_charge_date_time": null,  "response_language": "english",  "created_by_user": "הכבשה שושנה"}'

Response Example: Example

1{
2  "error_code": 0,
3  "message": "string",
4  "sto_id": 0
5}
6