Odero API-nin qayıdış parametrləri əməliyyatın uğurlu olub-olmamasından və tək və ya çoxlu nəticə dəyərinin qaytarılmasından asılı olaraq fərqlənsə də, onlar öz aralarında ümumi çərçivədən istifadə edirlər.
Sistemdə və ya quruluşda bir xəta yarandıqda istifadə edilən çıxış formatıdır. Yalnız aralarında xəta məlumatlarını özündə birləşdirən errors adlı bir xanadan ibarətdir.
| Parametrin Adı | Növü | Hər Zaman Mövcuddur | Açıqlama |
|---|---|---|---|
errors |
Error |
Bəli | Baş vermiş xəta haqqında məlumatlardan ibarətdir. Ətraflı məlumat üçün baxın. Xəta Kodları |
Uğurlu əməliyyatların nəticəsində çıxan cavablar əməliyyatın nəticəsinin tək və ya çox olmasından asılı olaraq fərqli parametrlərdən ibarət olur.
Ödənişin qəbulu, ödənişin qaytarılması, alıcının yaradılması, üzv biznes təfərrüatlarına baxmaq kimi tək nəticələr yaradan əməliyyatlar və ya sorğular üçün istifadə edilən qaytarma formatıdır. Yalnız əməliyyatın nəticəsini ehtiva edən data adlı sahəden ibarətdir.
| Parametrin Adı | Növü | Hər Zaman Mövcuddur | Açıqlama |
|---|---|---|---|
data |
any |
Xeyr | Həyata keçirilən əməliyyat və ya sorğunun nəticəsi. Xüsusiyyət və məzmunu ilə əlaqəli əməliyyat və ya sorğu ilə əlaqəli sənədlərin səhifəsində təfərrüatlı təsvir edilmişdir. |
Axtarış və ya sadalama kimi bir çox nəticə çıxarmaq potensialına malik olan əməliyyatlar və ya sorğular nəticəsində qaytarılan cavab formatıdır.
| Parametrin Adı | Növü | Hər Zaman Mövcuddur | Açıqlama |
|---|---|---|---|
items |
any[] |
Bəli | Əməliyyat və ya sorğu nəticəsində əldə edilən nəticələri əks etdirir. Nəticələrin xarakteri və məzmunla əlaqəli əməliyyat və ya sorğu üçün sənədləşmə səhifəsində ətraflı təsvir edilmişdir. |
totalSize |
long |
Xeyr | Axtarış və ya sadalama kimi səhifələşdirmə ilə əməliyyatlar nəticəsində qaytarılır. Sorğunun nəticəsində əldə edilən cəmi nəticə sayını idarə edir. Xətalı əməliyyatların qayıdışlarında bu sahə yoxdur |
size |
long |
Xeyr | Axtarış və ya sadalama kimi səhifələşdirmə ilə əməliyyatlar nəticəsində qaytarılır. Sorğuda hər səhifəyə qaytarılacaq nəticələrin sayını göstərir. Xətalı əməliyyatların qayıdışlarında bu sahə yoxdur |
Saxlanılan kartın silinməsi kimi səmərəsiz əməliyyatlar nəticəsində boş cavab qaytarıla bilər. Bu cür əməliyyatlar olduqca nadir olsa da, silmə əməliyyatlarında heç bir cavabın qaytarılmayacağı gözləntiləri ilə devam etmek tövsiyə olunur. Digər tərəfindən, bu cavablar 204 No Content HTTP kodu ilə qaytarıla bildiyindən və bu kod da uğurlu əməliyyatları göstərdiyinə görə sorğunun uğurlu olub-olmadığını yoxlayarkən status kodunun yalnız 200 OK olub-olmadığını yoxlamaq tövsiyə edilmir.
Fərqli əməliyyatların sorğu və qayıdış parametrləri kimi istifadə edilən müəyyən sabitlər və enum dəyərləri bu başlıq altında sadalanmışdır.
Odero API ilə əməliyyat apararkən istifadə edilə bilən statuslar
| Dəyər | Açıqlama |
|---|---|
ACTIVE |
Aktiv, mövcud qeydi təmsil edir |
PASSIVE |
Passiv, mövcud olmayan qeydləri təmsil edir |
Odero API ilə əməliyyat apararkən istifadə edilə bilən valyutalar
| Dəyər | Açıqlama |
|---|---|
AZN |
Azərbaycan manatı |
USD |
ABŞ Dolları |
EUR |
Avro |
Kartın istifadə xüsusiyyətini ifadə edən növlər
| Dəyər | Açıqlama |
|---|---|
CREDIT_CARD |
Kredit kartı |
DEBIT_CARD |
Debit karti |
PREPAID_CARD |
Prepaid kart |
Kartı təmin edən təşkilatları ifadə edən adlardır
| Dəyər | Açıqlama |
|---|---|
VISA |
Visa |
AMEX |
American Express |
MASTER_CARD |
Master Card |
TROY |
Troy |
| Dəyər | Açıqlama |
|---|---|
PERSONAL |
Fərdi Sahibkarlıq |
PRIVATE_COMPANY |
Özəl Şirkət |
LIMITED_OR_JOINT_STOCK_COMPANY |
Məhdud Məsuliyyətli Cəmiyyət və ya Açıq Səhmdar Cəmiyyəti |
Bir ödənişin tutulma qaydasını ifadə edən dəyərlər
| Dəyər | Açıqlama |
|---|---|
CARD_PAYMENT |
Ödəniş tam olaraq kartdan çıxarıldı |
DEPOSIT_PAYMENT |
Kartdan pul yükləmə ödənişi |
WALLET_PAYMENT |
Ödəniş tam olaraq pul kissəsindən çıxarıldı |
CARD_AND_WALLET_PAYMENT |
Bir hissəsi kartdan, bir hissəsi pul kisəsindən çıxarılan ödəniş |
BANK_TRANSFER |
Pul köçürülməsi/EFT ödənişi |
Ödənişin aid olduğu məhsul və ya xidməti ifadə edən qrup adları
| Dəyər | Açıqlama |
|---|---|
PRODUCT |
Məhsul |
LISTING_OR_SUBSCRIPTION |
Elan, xidmət və ya abunəlik |
SUBSCRIPTION |
Təkrar ödəmə |
Ödənişin statusunu ifadə edən dəyərlər
| Dəyər | Açıqlama |
|---|---|
FAILURE |
Ödəniş uğursuzdur |
SUCCESS |
Ödəniş uğurludur |
INIT_THREEDS |
3D Secure başladıldı |
CALLBACK_THREEDS |
3D Secure callback mərhələsində |
Ödənişin avtorizasiya fazasının statusu
| Dəyər |
|---|
AUTH |
3D Secure ilə edilən ödənişlərin yoxlanılmasından sonra bank tərəfindən Odero API-yə gönderilən rəqəmsal dəyərlərdir. Banklar və ödəniş təşkilatları bəzən unikal MD Status dəyərlərini qaytarsalar da, aşağıdakı cədvəldəki dəyərlər standart sayıla bilər.
| MD Status | Açıqlama |
|---|---|
0 |
3D Secure imzası və ya təsdiq kodu etibarsızdır |
1 |
Təsdiq kodu uğurludur |
2 |
Kartın sahibi və ya bankı sistemdə qeydiyyatda deyil |
3 |
Bank kartı sistemdə qeydiyyatlı deyil |
4 |
Təsdiq xətası, kart sahibi sistemdə daha sonra qeydiyyatdan keçməyi seçib |
5 |
Təsdiq xətası |
6 |
3D Secure xətası |
7 |
Sistem xətası |
Geri qaytarmanın statusunu ifadə edən dəyərlərdir
| Dəyər | Açıqlama |
|---|---|
SUCCESS |
Uğurlu |
FAILURE |
Uğursuz |
Geri qaytarılan məbləğin hara yatırılacağını ifadə edən dəyərlərdir
| Dəyər | Açıqlama |
|---|---|
CARD |
Karta |
WALLET |
Pul kisəsinə |
Ödənişlə əlaqəli pul göndərmə statusunu ifadə edən dəyərlərdir
| Dəyər | Açıqlama |
|---|---|
WAITING_FOR_APPROVAL |
Pulun köçürülməsi üçün təsdiq gözlənilir |
APPROVED |
Pul köçürməsi təsdiqləndi |
PAYOUT_STARTED |
Pul köçürməsi başladı |
Ödəniş ODERO-ya aid POS-lardan keçdikdə connectorType dəyərinə TOKENPOS, üzv biznesin özünə aid POS-dan keçdikdə isə TOKENGATE olaraq yazılır. Üzv bizneslər ODERO gateway xüsusiyyətindən istifadə edərək özlərinə aid POS-ları Odero sistemi vasitəsilə ödəniş edərkən istifadə edə bilərlər.
Odero API-lərinə hər hansı birbaşa sorğu üzv biznes hesabının giriş açarlarından istifadə etməklə doğrulanmalıdır. Üzv biznesə aid giriş açarları məlumatlarını Merchant Panel vasitəsilə əldə edə bilərsiniz.
Odero Client-dən istifadə edirsinizsə giriş açarlarının məlumatlarını Odero obyektinə parametr kimi verməniz kifayətdir. Client-dən istifadə etmirsinizsə aşağıdakı əməliyyatların həyata keçirilməsi tələb olunur.
Üzv biznes hesabınızla birlikdə identifikasiya məlumatlarının təsdiq edilməsini üçün API Gateway-ə göndəriləcək hər sorğuda aşağıdakı header-ləri göndərməyiniz tələb olunur:
| Header-in Adı | Açıqlama |
|---|---|
x-api-key |
API giriş açarı |
x-rnd-key |
Xüsusilə yaradılmış təsadüfi string dəyəri |
x-auth-version |
İdentifikasiya məlumatının təsdiq alqoritminin versiya nömrəsi. Hansı dəyəri verməli olduğundan əmin deyilsinizsə V1 verə bilərsiniz |
x-signature |
Yuxarıdakı parametrlər, gizli giriş şifrəsi və göndərilən tələbə uyğun müəyyən məlumatlardan istifadə edərək yaradılmış signature. Daha ətraflı məlumat üçün baxın. Signature Hesablama Algoritmi |
Signature, sorğunun düzgün mənbədən gəldiyini yoxlamaq üçün istifadə edilən yoxlama dəyəridir. Sorğuya mehsus olduğu üçün yenidən hesablanmalı və sorğu ilə birlikde göndərilməlidir. Signature dəyərini hesablamaq üçün:
| Ad | Dəyər |
|---|---|
| İstek URL | https://api-gateway.tokenpay.com.tr/onboarding/v1/sub-merchants/1 |
| Request Body | - |
| API Key | key-1 |
| Secret Key | FooBar123! |
| Random Key | Xa15Fp11T |
https://api-gateway.tokenpay.com.tr/onboarding/v1/sub-merchants/1key-1FooBar123!Xa15Fp11Thttps://api-gateway.tokenpay.com.tr/onboarding/v1/sub-merchants/1key-1FooBar123!Xa15Fp11TL/F2ZAOH/AGXZPIULNHDGOFZ+D5JS1097UP6RH11VSO=| Ad | Dəyər |
|---|---|
| x-api-key | key-1 |
| x-rnd-key | rGciw1df |
| x-auth-version | V1 |
| x-signature | L/F2ZAOH/AGXZPIULNHDGOFZ+D5JS1097UP6RH11VSO= |
| Ad | Dəyər |
|---|---|
| İstek URL | https://api-gateway.tokenpay.com.tr/onboarding/v1/buyers |
| Request Body | {"email":"haluk.demir@example.com","name":"Haluk","surname":"Demir","gsmNumber":"905551111111","identityNumber":"11111111110","buyerExternalId":"0ac49f08-f2a9-4326-a4d8-f6c1b01596fb"} |
| API Key | key-1 |
| Secret Key | FooBar123! |
| Random Key | Xa15Fp11T |
https://api-gateway.tokenpay.com.tr/onboarding/v1/buyerskey-1FooBar123!Xa15Fp11T{"email":"haluk.demir@example.com","name":"Haluk","surname":"Demir","gsmNumber":"905551111111","identityNumber":"11111111110","buyerExternalId":"0ac49f08-f2a9-4326-a4d8-f6c1b01596fb"}https://api-gateway.tokenpay.com.tr/onboarding/v1/buyerskey-1FooBar123!Xa15Fp11T{"email":"haluk.demir@example.com","name":"Haluk","surname":"Demir","gsmNumber":"905551111111","identityNumber":"11111111110","buyerExternalId":"0ac49f08-f2a9-4326-a4d8-f6c1b01596fb"}IRWQTISFBKCSM/NGZZ9XGN9PCTBXC0YSUJIBZMUZ9VS=| Ad | Dəyər |
|---|---|
| x-api-key | key-1 |
| x-rnd-key | Xa15Fp11T |
| x-auth-version | V1 |
| x-signature | IRWQTISFBKCSM/NGZZ9XGN9PCTBXC0YSUJIBZMUZ9VS= |