Pay with iyzico

Pay with iyzico (PWI) — Initialize

post

Starts a PWI session; returns the token and page URL for redirection.

Header parameters
AuthorizationstringRequired

Authorization header; starts with IYZWSv2 and is a signed hash in Base64.

Example: IYZWSv2 aXBzaWduYXR1cmU...
Content-TypestringRequiredExample: application/json
Body
localestring · enumOptional

Language code. Default; tr

Example: enPossible values:
conversationIdstringOptional

Request/response correlation ID.

Example: conversationID
pricedecimalRequired

Basket total amount.

Example: 10
basketIdstringRequired

Basket ID.

Example: basketID
paymentGroupstring · enumOptional

Payment group.

Example: PRODUCTPossible values:
callbackUrlstringRequired

URL to redirect after the transaction.

Example: callbackUrl
currencystring · enumRequired

Currency. Default; TRY.

Example: TRYPossible values:
paidPricedecimalRequired

Amount to be collected.

Example: 10
paymentChannelstring · enumOptional

Payment channel.

Example: WEBPossible values:
Responses
chevron-right
200

Successful response (PWI initialized)

application/json
statusstring · enumOptional

Outcome of the request.

Example: successPossible values:
localestring · enumOptional

Response language.

Example: enPossible values:
systemTimeintegerOptional

Timestamp (epoch ms).

Example: 1755252275214
conversationIdstringOptional

Correlation ID of the request.

Example: conversationID
tokenstringOptional

Token generated for Pay with iyzico. Returned per request and required to retrieve the result.

Example: 54481021-e605-407e-93d7-776ef481c4d7
tokenExpireTimeintegerOptional

Token validity in seconds; 1800 seconds.

Example: 1800
payWithIyzicoPageUrlstringOptional

Payment page URL to redirect to.

Example: https://sandbox-ode.iyzico.com/?token=54481021-e605-407e-93d7-776ef481c4d7&lang=tr
signaturestringOptional

Response signature (hash).

Example: a35338903267271c38465924d7d1903b2e10870bebaef1a00923be864e475818
post
/payment/pay-with-iyzico/initialize

Pay with iyzico (PWI) — Retrieve

post

Queries the PWI transaction result by token.

Header parameters
AuthorizationstringRequired

Authorization header; starts with IYZWSv2 and is a signed hash in Base64.

Example: IYZWSv2 aXBzaWduYXR1cmU...
Content-TypestringRequiredExample: application/json
Body
localestring · enumOptional

Language code. Default; tr

Example: enPossible values:
conversationIdstringOptional

Request/response correlation ID.

Example: 8152109759
tokenstringRequired

Token of the PWI session to be retrieved.

Example: da7431f4-89fc-4f65-8533-d83a4fede7d9
Responses
chevron-right
200

Successful response (payment completed)

application/json
statusstring · enumOptional

Outcome of the request.

Example: successPossible values:
localestring · enumOptional

Response language (tr/en).

Example: enPossible values:
systemTimeintegerOptional

Timestamp (epoch ms).

Example: 1755252706797
conversationIdstringOptional

Correlation ID of the request.

Example: 8152109759
pricedecimalOptional

Basket total.

Example: 10
paidPricedecimalOptional

Total collected amount.

Example: 10
installmentintegerOptional

Installment count.

Example: 1
paymentIdstringOptional

Payment ID.

Example: 25152948
fraudStatusinteger · enumOptional

Fraud status of the payment.

  • 1: Approved
  • 0: In review
  • -1: Rejected
Example: 1Possible values:
merchantCommissionRatedecimalOptional

Merchant’s commission/deferral rate (informational). For example, if price=100 and paidPrice=110, the rate is 10%.

Example: 0
merchantCommissionRateAmountdecimalOptional

Merchant’s commission/deferral amount (informational). For example, if price=100 and paidPrice=110, the amount is 10.

Example: 0
iyziCommissionRateAmountdecimalOptional

iyzico commission amount for the payment.

Example: 0.2094
iyziCommissionFeedecimalOptional

iyzico fee for the payment.

Example: 0.25
cardTypestring · enumOptional

Card type.

Example: CREDIT_CARDPossible values:
cardAssociationstring · enumOptional

Card association.

Example: MASTER_CARDPossible values:
cardFamilystring · enumOptional

Card family.

Example: AxessPossible values:
binNumberstringOptional

BIN (first 8 digits).

Example: 552608
lastFourDigitsstringOptional

Last four digits of the card.

Example: 0006
basketIdstringOptional

Basket ID.

Example: basketId
currencystring · enumOptional

Currency of the payment.

Example: TRYPossible values:
authCodestringOptional

Auth code returned by the bank.

Example: 277568
phasestringOptional

Payment phase.

Example: AUTH
hostReferencestringOptional

Bank-provided host reference for the payment.

Example: mock00007iyzihostrfn
signaturestringOptional

Signature value for verification.

Example: 57b1be1f094d17da286c748e2b2779e078e550bafe9734d4fd8c092aeee022be
tokenstringOptional

Token associated with the transaction (returned by the retrieval).

Example: 0b7b67d2-fdf0-4c9a-905f-2b0003b1b8c7
callbackUrlstringOptional

Callback URL sent at initialization.

Example: https://callbackurl.com
paymentStatusstring · enumOptional

Payment status.

Example: SUCCESSPossible values:
memberEmailstringOptional

Email of the member who paid via PWI.

Example: [email protected]
memberGsmNumberstringOptional

GSM number of the member who paid via PWI.

Example: +905555555555
post
/payment/iyzipos/checkoutform/auth/ecom/detail

Last updated