GİRİŞ

    API Endpoint
        https://api.imzapos.com/
                

Test Kullanıcı Bilgileri

TOKEN ALMA

    curl --request POST \
    --url https://api.imzapos.com/api/v1/token \
    --header 'Content-Type: application/json' \
    --data '{
    "resellerId":16,
    "userName":"apitest",
    "password":"[email protected]*DK?rbu[_w4/"
    }'
    

    
            Response Örneği:
            {
            "status": true,
            "statusCode": 200,
            "data": {
            "token": "chSRNKH9vbrzJOxzLplOzDn9X62v0dl3rnCFo5n9uOKcK7zWVOh0Ro2Y3S3RSVJRzyHfLsLQClek3LzaGgam6vlDunLVBWrZF2mVzUKnCQyqJRfsddLw5gVENEvhgzOp4EfAidlwWwjp753cIc2iL5eihiIuimGNCIwEwfJ91ZaI7pGSKSZD6qe8k6cAU0NtpWnyJyqnT3qwfVl2b0kQMDQVoxdzCJoBMqckCRJVmwuDAsdPVjieP6gmGSKVU0kJ",
            "expire_date": "3000-01-01T00:00:00",
            "expire_at": 60
            }
            }
        

Token süresi response içerisinde dakika cinsinden ve expire date olarak belirtilmektedir. Mevcut sürümde 1 saattir.

Mevcut token expire olana kadar kullanılması, uygulama performansı açısından tavsiye edilmektedir.

Token Kullanımı

Authorization key olarak "Bearer" kullanılmaktadır.

İstek "Header" bölümüne "Authorization" anahtar kelimesi ile "Bearer + token" değeri girilmelidir.

Request Parametreleri

Response Parametreleri

Hash Üretme

Yapılacak her istekte Token yanı sıra, Store Key ile şifrelenmiş bir hash değeri oluşturulması gerekir.

Hash oluşturulurken bazı random değerler kullanılır. Bu değerleri Header ile API'ye belirtmeniz gerekmektedir.

Hash Hesaplama

Hash bazı anahtarların uç uca bağlanması ile(arada boşluk ya da herhangi bir karakter olmadan) oluşturulan bir değerdir

Sırası ile

• İstek body'sinin Base64 Encode hali(İstek body'si boşsa eklemeyiniz)
• Header alanında oluşturduğunuz "x-random" değeri
• API Anahtarı

Örnek 1

Yukarıdaki değerler ile oluşturulan bir hash değerinin sonucu "lhceKXBqAPsayVzHhL6L/5a4o37UPbVuSxXuvwvmPYU=" olacaktır.

Örnek 2

Yukarıdaki değerler ile oluşturulan bir hash değerinin sonucu "U+0UETNzHZHr7YHms3Tc0t8pSDNTWZi0nV3gbbhBpXc=" olacaktır.

Non-Secure Ödeme

    
            curl --request POST \
            --url https://api.imzapos.com/api/v1/payment/non-secure \
            --header 'Authorization: Bearer chSRNKH9vbrzJOxzLplOzDn9X62v0dl3rnCFo5n9uOKcK7zWVOh0Ro2Y3S3RSVJRzyHfLsLQClek3LzaGgam6vlDunLVBWrZF2mVzUKnCQyqJRfsddLw5gVENEvhgzOp4EfAidlwWwjp753cIc2iL5eihiIuimGNCIwEwfJ91ZaI7pGSKSZD6qe8k6cAU0NtpWnyJyqnT3qwfVl2b0kQMDQVoxdzCJoBMqckCRJVmwuDAsdPVjieP6gmGSKVU0kJ' \
            --header 'Content-Type: application/json' \
            --header 'x-hash: R3JskSf3HE79k9T9uUKAcmhX003s63Q7m6eEmeblUzo=' \
            --header 'x-random: 3ad657cc-5526-4728-88c5-9b4d0e87f793' \
            --data '{"payment_type":"Auth","reference_transaction_id":"daae358c-b0e7-4070-a867-9cbeb142d568","card_owner_name":"YILMAZ ERDOGAN","card_bin":"4022780000000000","exp_month":"10","exp_year":"3000","cvv":"000","installment":1,"client_ip":"192.168.1.1","amount":104,"currency":"TRY","buyer":{"name":"YILMAZ","surname":"ERDOGAN"},"productList":[{"name":"Ürün1","price":31.12,"quantity":1},{"name":"Ürün2","price":12.01,"quantity":1}]}'
        
                

    
            Response Örneği:
            {
            "status": false,
            "statusCode": 1001,
            "data": {
            "oid": "45365649-0c78-435e-8041-1afa5f288c15",
            "reference_transaction_id": "daae358c-b0e7-4070-a867-9cbeb142d568",
            "payment_type": "Auth",
            "secure_flag": false,
            "reseller_id": 16,
            "user_id": 0,
            "gateway_provider": "provider",
            "amount": 1.04,
            "currency": "TRY",
            "installment": 1,
            "cost_rate": 1.00,
            "sale_rate": 0.00,
            "card_owner_name": "YILMAZ ERDOGAN",
            "card_number": "402278******0000",
            "client_ip": "192.168.1.1",
            "payment_status": 7,
            "status_code": 1001,
            "status_code_description": "Bilinmeyen Hata. Hata Detayına Bakınız",
            "provider_status_message": "41-Kredi karti numarasi gecerli formatta degil.-",
            "provider_reference_id": "164244680950685",
            "transaction_date": "0001-01-01T00:00:00"
            },
            "errors": [
            "Bilinmeyen Hata. Hata Detayına Bakınız"
            ]
            }
        

3D şifre koruması olmadan yapılan ödeme türüdür. Kart sahibine herhangi bir onay mesajı gitmeden ödeme hesaba geçer

Request Parametreleri

Response Parametreleri

3D-Secure Ödeme

    
            curl --request POST \
            --url https://api.imzapos.com/api/v1/payment/3d-secure \
            --header 'Authorization: basic MTY6YXBpdGVzdDpGeDlAKkRLP3JidVtfdzQv' \
            --header 'Content-Type: application/json' \
            --header 'x-hash: np8YX1OaSbIam6DBzmHGVHEvP2MYrD151zdBJIHAxl0=' \
            --header 'x-random: 46697aa9-ed4d-454e-9d89-a751fd9b242d' \
            --data '{"payment_type":"Auth","reference_transaction_id":"daae358c-b0e7-4070-a867-9cbeb142d568","card_owner_name":"YILMAZ ERDOGAN","card_bin":"4022780000000000","exp_month":"10","exp_year":"3000","cvv":"000","installment":1,"client_ip":"192.168.1.1","amount":104,"currency":"TRY","success_url":"https://domain.com#success","error_url":"https://domain.com#error","buyer":{"name":"YILMAZ","surname":"ERDOGAN"},"productList":[{"name":"Ürün1","price":31.12,"quantity":1},{"name":"Ürün2","price":12.01,"quantity":1}]}'
        
                

    
            Response Örneği:
            {
            "status": true,
            "statusCode": 10,
            "data": {
            "redirect_url": "https://api.imzapos.com/redirect-service/3d-secure/c76hEaqtAwu3dYTQ4G8YjW35zQXrT1MxJSyfoeKS0D8bHYZK6F3TqyPFEAsxC9ZJ",
            "expire_date": "3000-01-01T00:00:00",
            "expire_at": 1
            }
            }
        

3D şifre koruması ile yapılan ödeme türüdür

İstek yapıldıktan sonra "redirect_url" parametresi dönülür. Kart sahibi bu url'e yönledirilmelidir.

Request Parametreleri

Response Parametreleri

Success ve Error URL'lerine dönen değerler

Ön Otorizasyon(Provizyon) Onaylama

    curl --request POST \
    --url https://api.imzapos.com/api/v1/payment/post-auth \
    --header 'Authorization: basic MTY6YXBpdGVzdDpGeDlAKkRLP3JidVtfdzQv' \
    --header 'Content-Type: application/json' \
    --header 'x-hash: xRFAliek2iiKh2U7GuJO0zqnMkbTEgkQ0WnBuajwRlQ=' \
    --header 'x-random: 5771f471-ac6e-4543-8c56-28ee575a08c6' \
    --data '{"oid":"bbde07f9-637e-410c-8c97-ae9b84c14970","reseller_id":19,"reference_transaction_id":"4a0f2571-f4d0-4735-840c-788d9d9cdd73","amount":0}'

        
            Başarılı Response Örneği:
            {
            "status": true,
            "statusCode": 100
            }


            Başarısız Response Örneği:
            {
            "status": false,
            "statusCode": 1056,
            "errors": [
            "Satış işlemlerinde provizyon kapama yapılamaz"
            ]
            }
        

PreAuth ile yapılan ön otorizasyon işlemlerinin 25 gün içerisinde kapatılması gerekmektedir. Aksi takdirde karttaki bloke kaldırılır.

Provizyon kapama işlemleri ödeme sağlayıcınıza bağlı olarak parçalı olarak yapılabilmektedir. Ör: 300 TL'lik bir Provizyonun önce 100 TL'lik bir kısmını daha sonra 200 TL'lik bir kısmını onaylayabilirsiniz.

Request Parametreleri

Response Parametreleri

Ödeme İade

    curl --request POST \
    --url https://api.imzapos.com/api/v1/payment/refund \
    --header 'Authorization: basic MTY6YXBpdGVzdDpGeDlAKkRLP3JidVtfdzQv' \
    --header 'Content-Type: application/json' \
    --header 'x-hash: ZmvDxQztMCahRButcEsMxMKPgP92WPSX0QdOszqMvMM=' \
    --header 'x-random: ab53e87c-57d3-4daa-8f19-34bc4766a81f' \
    --data '{"oid":"bbde07f9-637e-410c-8c97-ae9b84c14970","reseller_id":19,"reference_transaction_id":"4a0f2571-f4d0-4735-840c-788d9d9cdd73","amount":10}'

        
            Başarılı Response Örneği:
            {
            "status": true,
            "statusCode": 100
            }


            Başarısız Response Örneği:
            {
            "status": false,
            "statusCode": 202,
            "errors": [
            "Hatalı işlem numarası"
            ]
            }
        

Request Parametreleri

Response Parametreleri

Durum Kodları