HaiPay

English

简体中文

English

简体中文

Appearance

Turkey Payment API

About 2557 wordsAbout 9 min

Warning

Before reading this API document, please make sure to check API Description Guide

Limits

Transaction TypeLimit (Unit: TRY)
Collection10-99000
Disbursement10-99000

Collection API

Collection Application

Brief Description:

  • Create a collection order

URL：/try/collect/apply
Note: appId should use TRY corresponding one, user payment success will increase TRY balance

Parameters:

Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from the backend, must pass the corresponding business ID according to the currency in the URL)
orderIdYesStringMerchant Order Number (must be unique, max length 48)
nameYesStringPayee Name
phoneYesStringReal mobile number (format reference Phone Number Format )
emailYesStringReal email
amountYesStringTransaction Amount (unit: local currency, accurate to two decimal places; punctuation such as “,” is prohibited)
currencyNoStringCurrency (TRY)
payTypeYesStringTransaction Type PAYMENT_GATEWAY
inBankCodeYesStringPayment Method
callBackUrlYesStringRedirect URL after successful payment
callBackFailUrlYesStringRedirect URL after failed payment
notifyUrlNoStringCallback URL
subjectNoStringPayment Remark
bodyNoStringRemark Details
partnerUserIdYesStringUnique user identifier (e.g., user ID userId), used for risk control, must be real and valid, otherwise it may affect the transaction. Format: numbers, uppercase/lowercase letters, or commonly used symbols -~!@#$%&*()_.
signYesStringSignature

request

{
    "appId": 1054,
    "orderId": "M233323000059",
    "amount": "300",
    "phone": "09230219312",
    "email": "23423@qq.com",
    "name": "test",
    "inBankCode": "GPay",
    "payType": "PAYMENT_GATEWAY",
    "partnerUserId": "149597870",
    "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}

va-response

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M233323000059",
        "orderNo": "6023071013539074",
        "payUrl": "",
        "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
    }
}

Turkey Payment API

Warning

Before reading this API documentation, please check API Description Guide

Collection API

Collection Apply

Brief Description:

  • Create a collection order

URL: /try/collect/apply
Note: appId in TRY, amount in TRY, settlement in TRY

Response data parameter description

Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
payUrlStringPayment link
signStringSignature

Collection Query

Brief Description:

  • Create a collection order
  • When "payType=BANK_TRANSFER" synchronously returns orderNo can be queried directly
  • Other payment methods after asynchronous notification, through orderNo query secondary confirmation status

URL：/try/collect/query

Parameters:

ParameterRequiredTypeDescription
appIdYesLongBusiness ID (obtained from the backend; must match the currency in the URL)
orderIdYesStringMerchant Order ID
orderNoNoStringPlatform Order ID (faster response)
signYesStringSignature

request

{
    "appId": 1054,
    "orderId": "M22222000028",
    "sign": "EmyJGm3ELzG4FsOd0Krs9ncbSjo4oTGuXWML+7djYla3+VAwd9wS17z38p/7U2ZAjroO04XrE7YXcB1o76Dtyipj3h3bJzs7FYma1QNkMUdt9hh7m8U6hMsMQX7vIWHtXNwz4pbTSC75+kQWXaCew7KoE6LXECdJU8AISgNgeki2TK9R0pCfshr0Z2SZBPeuT6OvIH5LdmqgdZhuqnffGU2qnXk4KMkO848e6/WALLBR+LE1wyKHfPnYVcuKSMVYxkvKyyIL5JIPEgW0o5bh4RCbaUn3NZtyYwrU1uQ3ZDFRThm9j6XAQP+LBlmq3nOePqBtp/VDVarRaV+7FbQg3A=="
}

response

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M22222000028",
        "orderNo": "6023042811314347",
        "amount": "50.00",
        "actualAmount": "0.00",
        "fee": "0.00",
        "status": 1,
        "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
    }
}

Response data parameter description

Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
amountStringTransaction amount
actualAmountStringReceived amount
feeStringTransaction fee
statusIntegerStatus (0 not started, 1 collecting, 2 collection success, 3: collection failed, -1 exception pending confirmation)
payTimeStringPayment success time (when status=2 has value), format: yyyy-MM-dd HH:mm:ss
errorMsgStringPayment failure reason (when status=3 has value)
signStringSignature

Payment Methods

CurrencyPayment Type (payType)Payment Code (inBankCode)LimitStatusDescription
TRYBANK_ACCOUNTIBAN1000-500000AvailableInternational Bank Account Number
TRYPAYMENT_GATEWAYPAPARA10-99000MaintenancePapara Wallet

Disbursement API

Disbursement Apply

Brief Description:

  • Create a disbursement order

URL：/try/pay/apply

Parameters:

ParameterRequiredTypeDescription
appIdYesLongBusiness ID (obtained from the backend; must match the currency in the URL)
orderIdYesStringMerchant Order ID (must be unique, maximum length 48)
amountYesStringTransaction amount (in local currency)
accountTypeYesStringAccount type: BANK_ACCOUNT, EWALLET
bankCodeYesStringBank Code
identifyTypeNoStringRequired when bankCode=PAPARA:
PAPARA_NUMBER (Papara ID)
PHONE (registered Papara phone)
EMAIL (registered Papara email)
TURKISH_ID (registered Papara ID number)
accountNoYesStringUser account (IBAN if BANK_ACCOUNT)
nameYesStringRecipient name
phoneYesStringValid phone number
emailYesStringValid email
notifyUrlNoStringCallback URL
subjectNoStringPayment remark (transaction title, product name, or payment reason)
bodyNoStringRemark details
partnerUserIdYesStringUnique user identifier (e.g., userId), required for risk control. Must be valid; otherwise it may affect the transaction. Format: numbers, letters, or symbols -~!@#$%&*()_.
signYesStringSignature

request（accountType为BANK_ACCOUNT类型时）

{
    "appId": 1054,
    "orderId": "M100000450012",
    "amount": "500",
    "accountType": "BANK_ACCOUNT",
    "bankCode": "BDO",
    "accountNo": "09876543210",
    "ibanAccount": "09876543210",
    "name": "john doe",
    "phone": "09876543210",
    "email": "johndoe@cashfree.com",
    "subject": "iphone13",
    "body": "ProMotion technology with adaptive refresh rates up to 120Hz",
    "partnerUserId": "149597870",
    "sign": "I1PeK3eJOVsFFNowxVRqMXpeWm1lr/BcRpBi8WsW4wVo1+5CC3JsrFq/m/L2O69NzKHvtDWi4zia3DL3dPut0yMyUyqL91LNCSaeISbGsQPlhEsQpyTOryS/RKOfsrn2Xo37SCF/phAvndOk2jwwGwqM5xLz1ms9Ukl85wv27QFNrXIMxK2p18oe7MpMYrgf+xvEBE/VqCtKMtN9pO449wWwXzHWNPbZ76s4pAvKwRE9yXQDr7Iw14Dktcnl1FoLM4gWM/obkO+mz6SyAGDuXhVh/+OD/IGNiCyTCNq6ciQY28UnCFV6ZIP40gxsFhfBJKbK+Raw7y1Bh912ifYfug=="
}

response

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M100000450013",
        "orderNo": "3023062014149637",
        "sign": "LmhUnkw5j0pMiimsG8rKwdNNZGvXH5MpSmD6mdHZwq1SQwuK5BohmdEoqKB/jkMk28o3da4Cxh6Q+tW97+yTCemRrF+dMaHA73rpOeUuujKQl/UcFvJuMhfLBa2tp09L71NzoBqpPD6aXf37mYAz8E1HmERwFPpac5FVxIYanHG8cqmMLJYsVmHTSxWavgWU03ys9UczBePkBiR8sl2FSOhFABB0wAP28lswrV/ABS68IsLKtyd1fyI3GBfSbIK5nDEEnlE+EdElFdLs9taAxJImeVF1x4eT47+bkPJ2qS8z3K8QGzKLF3W+8SiRZGfSwDTsLKH+2Vycvy5auRl+ag=="
    }
}

Response data parameter description

Parameter NameRequiredTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
signStringSignature

Disbursement Query

Brief Description:

  • Query a disbursement order

URL：/try/pay/query

Parameters:

ParameterRequiredTypeDescription
appIdYesLongBusiness ID (obtained from the backend; must match the currency in the URL)
orderIdYesStringMerchant Order ID
orderNoNoStringPlatform Order ID (faster response)
signYesStringSignature

request

{
    "appId": 1000,
    "orderId": "M1234567111",
    "orderNo": "3022111516571436",
    "sign": "ZxkVZL+GAyv0VhvWn4IvuYahTzxgQuthkuV2ONWiqIfIDb2avvHlFOUJVzqZi1q8CPHXZm1ltanRTRVTxfsuftLvGeDioUHglWt46/RU6c1OPznpLGsZ35Q3n5tW2y1EnOsxPynXBFLuDQy+aZ3l9u6AQ30T0zQexMGT+IxuFkmUp02g/6juaHa5ZgNMv7lN67ixIp162wrM7OJuaOif872QijSceRdZhzaMGImAwB0D4MosRV4WMBOKkwgPdmS7GuZN66YUidXk3wTGqX3MYRw6M0kj4eNegSUwPXvp4q4p0KO8Y3xUMld54GY2ApX3WN3CBtC/vpJqEszjGBbbGg=="
}

response — Order Failed

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567111",
        "orderNo": "3022111516571436",
        "amount": "100000.00",
        "fee": "0.00",
        "status": 3,
        "errorMsg": "Đơn hàng không tồn tại",
        "sign": "KKuvCl0SuNANJs+l2ogDaJm8pmV+Hi+Xa7q27vJ6D1Ehs4aOp13kRbITfJAhczh3T81BE9qwHeJaYwf+r0EypKM9TL6pMwfG8Az4gRy1D57wiUaVjl2PWcvbEqrn1hL0b+btkjvAM9I+CcSv+wuOW3/uku17Ws3FhgJLj9sFsQUBAPjDO+758VnwBytCOLBmljLBXyKgNgpmFQ1/DNkqWl0UNzyLK45Zw3yf5NiwhEFbvW0jlOWlfu/ql4hluISUQG573jEoFCBEnQLb2tQoRZj1QYNRCXPf5lbej0vzqbEwvR9h+ZOf255t1MocJkdIe463DTV5U3KZdVT87HMagw=="
    }
}

response — Order Successful

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567112",
        "orderNo": "3022111517401574",
        "amount": "100000.00",
        "fee": "1003.00",
        "status": 2,
        "payTime": "2024-03-01 23:59:59",
        "sign": "khPtOmGq+cpKX0HFAI/lbP0dx4oVyNAnL5oLsdmhDJdASlQm0yg5I3o+MhImYggEsL6c2bo5fP29t54OZFqSdQDfIuNDvGbAMAr4mRBxc0hoHLkBLyyagfVPBLyQA1JY8XV3ZL4ySzQ3ZQnMCfrh2K39ueUuz6HpZ03Hj0KYijVRCXAZaio/L5jfLBT12QXmvIfAHa8s/k9flhK05ENHPep3zjj/MZGOEaX7jkEJLfjK0duypDCa61BRQjM+oePOdVsgleIl1Yf98UAxMDZ/A3912KFHEb+/jvmdnulNbiJFyuT1fEe+j2teUgw3vFsZAtwNWAgxhC7UO+N0Q5z4EA=="
    }
}

Response data parameter description

Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
amountStringTransaction amount
feeStringTransaction fee
statusIntegerOrder status (0 not started, 1 disbursing, 2 disbursement success (final), 3 disbursement failed (final), -1 exception pending confirmation)
payTimeStringPayment success time (when status=2 has value), format: yyyy-MM-dd HH:mm:ss
errorMsgStringPayment failure reason (when status=3 has value)
signStringSignature

Payment Methods

CurrencyPayment Type (accountType)Payment Code (bankCode)LimitStatusDescription
TRYBANK_ACCOUNTAKB2000-500000AvailableAKBANK T.A.Ş.
TRYBANK_ACCOUNTBurgan_Bank2000-500000AvailableAKBANK T.A.Ş.
TRYBANK_ACCOUNTCITI_BANK2000-500000AvailableCITIBANK A.Ş..
TRYBANK_ACCOUNTDENIZ_BANK2000-500000AvailableDENİZBANK A.Ş..
TRYBANK_ACCOUNTFIBA_BANK2000-500000AvailableFIBABANKA A.Ş.
TRYBANK_ACCOUNTFINANS_BANK2000-500000AvailableFİNANS BANK A.Ş..
TRYBANK_ACCOUNTQNB2000-500000AvailableQNB Finansbank.
TRYBANK_ACCOUNTHSBC_BANK2000-500000AvailableHSBC BANK A.Ş.
TRYBANK_ACCOUNTING_BANK2000-500000AvailableING BANK A.Ş..
TRYBANK_ACCOUNTKUVEYT_TURK2000-500000AvailableKUVEYT TÜRK KATILIM BANKASI A.Ş..
TRYBANK_ACCOUNTODEA_BANK2000-500000AvailableODEA BANK A.Ş..
TRYBANK_ACCOUNTSEKER_BANK2000-500000AvailableŞEKERBANK T.A.Ş.
TRYBANK_ACCOUNTTEKFEN_BANK2000-500000AvailableTEKFENBANK A.S..
TRYBANK_ACCOUNTYAPI_KREDI2000-500000AvailableYapıkredi
TRYBANK_ACCOUNTZIRAAT_BANK2000-500000AvailableT.C. ZİRAAT BANKASI A.Ş..
TRYBANK_ACCOUNTVAKIF_BANK2000-500000AvailableT. VAKIFLAR BANKASI.
TRYBANK_ACCOUNTISB2000-500000AvailableT. İŞ BANKASI A.Ş..
TRYBANK_ACCOUNTGARANTI_BANK2000-500000AvailableT. GARANTİ BANKASI A.Ş..
TRYBANK_ACCOUNTTCMB10-99000MaintenanceT.C.MERKEZ BANKASI A.Ş.
TRYBANK_ACCOUNTILB10-99000MaintenanceİLLER BANKASI.
TRYBANK_ACCOUNTHALK_BANK10-99000MaintenanceT. HALK BANKASI A.Ş..
TRYBANK_ACCOUNTTSKB10-99000MaintenanceT.SINAİ KALK. BANKASI A.S..
TRYBANK_ACCOUNTTURK_EXIMB10-99000MaintenanceT.IHRACAT KREDI BANKASI A.S.
TRYBANK_ACCOUNTKALKINMA_BANK10-99000MaintenanceT.KALKINMA BANKASI A.S..
TRYBANK_ACCOUNTBAYINDIR_BANK10-99000MaintenanceBAYINDIRBANK A.S..
TRYBANK_ACCOUNTEKONOMI_BANK10-99000MaintenanceT.EKONOMİ BANKASI A.S..
TRYBANK_ACCOUNTYAPI_KREDI10-99000MaintenanceYAPI ve KREDİ BANKASI A.Ş..
TRYBANK_ACCOUNTTURK_TICARET10-99000MaintenanceT.DIŞ TICARET_BANKASI A.S..
TRYBANK_ACCOUNTROMA_BANK10-99000MaintenanceBANCA DI ROMA S.P.A..
TRYBANK_ACCOUNTABN_AMRO10-99000MaintenanceABN AMRO BANK N.V..
TRYBANK_ACCOUNTATB10-99000MaintenanceARAP TÜRK BANKASI A.S..
TRYBANK_ACCOUNTKOC_BANK10-99000MaintenanceKOÇBANK A.S.
TRYBANK_ACCOUNTTURKISH_BANK10-99000MaintenanceTURKISH BANK A.Ş..
TRYBANK_ACCOUNTJPMORGAN_BANK10-99000MaintenanceJP MORGAN CHASE BANK NA MERK C.
TRYBANK_ACCOUNTING_BANK10-99000MaintenanceING BANK A.Ş..
TRYBANK_ACCOUNTADA_BANK10-99000MaintenanceADABANK A.S..
TRYBANK_ACCOUNTDEUTSCHE_BANK10-99000MaintenanceDEUTSCHE BANK A.S..
TRYBANK_ACCOUNTCALYON_BANK10-99000MaintenanceCALYON BANK T.A.S.
TRYBANK_ACCOUNTALTERNATIF_BANK10-99000MaintenanceALTERNATİFBANK A.S..
TRYBANK_ACCOUNTANADOLU_BANK10-99000MaintenanceANADOLUBANK A.Ş..
TRYBANK_ACCOUNTDILER_BANK10-99000MaintenanceDİLER YATIRIM BANKASI A.S..
TRYBANK_ACCOUNTGSD_BANK10-99000MaintenanceGSD YATIRIM BANKASI A.S..
TRYBANK_ACCOUNTNUROL_BANK10-99000MaintenanceNUROL YATIRIM BANKASI A.S..
TRYBANK_ACCOUNTCALIK_BANK10-99000MaintenanceÇALIK YATIRIM BANKASI A.S.
TRYBANK_ACCOUNTTURKLAND_BANK10-99000MaintenanceTURKLAND BANK A.Ş..
TRYBANK_ACCOUNTURGAN_BANK10-99000MaintenanceURGAN BANK A.Ş..
TRYBANK_ACCOUNTAKTIF_BANK10-99000MaintenanceAKTİF YATIRIM BANKASI A.Ş.
TRYBANK_ACCOUNTALBARAKA_TURK10-99000MaintenanceALBARAKA TÜRK KATILIM BANKASI A.Ş..
TRYBANK_ACCOUNTASYA_BANK10-99000MaintenanceASYA KATILIM BANKASI A.Ş..
TRYBANK_ACCOUNTPTT10-99000MaintenancePTT.
TRYBANK_ACCOUNTTURKIYE_FINANS10-99000MaintenanceTÜRKİYE FİNANS KATILIM BANKASI A.Ş..
TRYBANK_ACCOUNTININAL10-99000MaintenanceIninal.

Theme by cotmier

Copyright © 2019-2025 HaiPay | MIT License