SFTP

Merchants can keep track of their iyzico account financial information by using built-in reports and SFTP.

Connection

With an SFTP connection, you will be able to access the root folder that contains all your merchant reports; e.g. transactions, cut-off and the settlement reports.

Sandbox

OptionSetting

Address

sandbox-report.iyzipay.com

Protocol

SFTP

Port

22

Username

Provided to you by your account manager

Password

Provided to you by your account manager

Production

OptionSetting

Address

report.iyzipay.com

Protocol

SFTP

Port

22

Username

Provided to you by your account manager

Password

Provided to you by your account manager

Note that Sandbox and Production SFTP ENVs might differ in certain terms.

Report Types

There are 3 types of reports with two different templates. One template is for transaction reports. And another template is for both the cut-off and settlement reports.

Note that the cut-off/settlement report template doesn’t show (preauth) which the transaction report template report does. Also note that the cut-off/settlement report template has 2 more columns that are not presented in the transaction report template which are:

  • settlementReferenceCode

  • settlementResolveDate

there is also one more column in the summary area.

-totalMerchantPayoutAmount

Transaction Transaction reports are created for every merchant on daily basis and they contain detailed information on the transaction level in CSV format. It includes (auth, preauth, postauth, cancel, refund) The root and name of the file will be /transaction/transaction-MID-20160917.csv

Cutoff Cutoff reports are created for every merchant on daily basis and they contain detailed information on the transaction level in CSV format. It includes (auth, postauth, cancel, refund) The root and name of the file will be /cutoff/cutoff-MID-20160917.csv

The main differences between the cut-off report and the transaction report is that cut-off only shows transactions that are final and are confirmed to be settled to you. In addition to that cut-off report shows a summary for the amount to be settled.

Settlement Settlement files are created for every merchant payout and they contain detailed information at the transaction level in CSV format. It can generated daily, weekly or monthly also includes (auth, postauth, cancel, refund) Root and name of the file will be /settlement/settlement-MID-20160917113007-TRY.csv

Fields

Main

ColumsTypeDescription

transactionDate

date

date of the transaction

transactionType

string

type of the transaction (auth, preauth, postauth, refund,cancel)

isAfterSettlement

integer

iyzico is not returning the conversion amount

paymentTxId

long

item id of payment

paymentId

long

iyzico provided order id

conversationId

string

merchant provided order ID

paymentPhase

string

phase of payment (AUTH, PREAUTH, POSTAUTH)

paymentGroup

string

group of payment (PRODUCT, SUBCRIPTION, LISTING, OTHER)

price

decimal

total item amount

paidPrice

decimal

final amount of payment (installment fee, tax, voucher.. included)

transactionCurrency

ISO

sales currency

installment

integer

installment number

binNumber

string

first 6 digits of card

cardFamily

string

family of card (loyalty program name)

cardAssociation

string

association of card (VISA, MASTERCARD, AMEX, etc.)

cardType

string

type of card (CREDIT, DEBIT..)

isThreeDs

boolean

3D status of payment

buyerName

string

name of buyer

buyerSurname

string

Surname/lastname of buyer

buyerEmail

string

email of buyer

paymentBuyerId

string

ID of buyer

iyziCommissionRateAmount

decimal

commission rate amount of iyico

iyziCommissionFee

decimal

commission fee amount of iyzico

parity

decimal

parity

settlementCurrency

decimal

currency of report

iyziConversionRateAmount

decimal

conversation rate amount of iyzico (if another currency used)

merchantPayoutAmount

decimal

merchant payout amount of transaction

connectorType

string

modal definer

posOrderId

string

valid for gate modal

posName

string

valid for gate modal

subMerchantKey

string

valid for marketplace modal

subMerchantEmail

string

valid for marketplace modal

subMerchantName

string

valid for marketplace modal

subMerchantPayoutAmount

decimal

valid for marketplace modal

settlementReferenceCode

decimal

reference code of settlement

settlementResolveDate

decimal

resolve date of settlement

authCode

integer

six digits authorization code of transaction.

refundConversationId

string

conversationid of refund and cancel request

basketId

string

basketid parameter of the payment request

lastFourDigits

integer

last four digits of card

chargeType

string

type of charge

chargeId

integer

unique id of the charge

disputeReferenceCode

string

reference of dispute

disputeReasonCategoryCode

integer

category of dispute

Summary

ColumsTypeDescription

transactionCurrency

ISO

currency of transactions

totalPayments

decimal

total of all payment events

totalPaymentAmount

decimal

total of payout amounts

totalCancels

decimal

total of all cancel events

totalCancelAmount

decimal

total of cancel amounts

totalRefunds

decimal

total of refund events

totalRefundAmount

decimal

total of refund amounts

totalCharges

decimal

total of refund amounts

totalChargeAmount

decimal

total of refund amounts

totalDisputes

decimal

total of refund amounts

totalDisputeAmount

decimal

total of refund amounts

netAmount

decimal

total file amount.

settlementCurrency

decimal

currency of payout

totalMerchantPayoutAmount

decimal

total payout to merchant

bankName

string

bank name of account

bankAccountNumber

string

IBAN number of the account

bankReferenceCode

string

iyzico generated unique reference code

reportVersion

string

report version of settlement Ex: 120

avalible for cut-off and settlement reports

Notes

Merchants must share their IP address for connection permission. More information about timing will be delivered by the relevant iyzico team.

Transaction and cut-off reports:

  • File creating for sandbox starting at 00:00am, and it is safe to pull at 01:00am (GMT +3)

  • File creating for live starting at 00:00am, safe to pull at 01:00am (GMT +3)

Settlement report:

  • File creating for sandbox starting at 11:00am, and it is safe to pull at 17:00pm (GMT +3)

  • File creating for sandbox starting at 11:00am, and it is safe to pull at 17:00pm (GMT +3)

Last updated