Sign in
Payments

Payment Status

post/api/v1/payment/status

Request body

application_keystring required

It is the key of your application on our environment

order_idstring required

It must be one the order_id's that you send to payment request previously.

langstring

Its default value is tr. If you want to get messages in other languages, please send it. You can find supported languages in the api supported_languages.

Example request

{
  "application_key": "6e3cdaa3-65df-4eff-aed2-9d74387701dd",
  "order_id": "9ee3fd53-42f9-4f16-b454-77e6b714c2e9",
  "lang": "tr"
}

Response

Successful Response

response_codestring

The status of query operation. 00200 means it is successful, 00404 means no transaction with the queried order_id

messagestring

Here is the explanation of response code

order_idstring

The queried order_id

transaction_idstring

Unique id of payment order in our system

transaction_datestring

Payment transaction date

virtual_pos_namestring

Virtual pos name the payment had been processed

virtual_pos_idinteger

Virtual pos id the payment had been processed

successfulboolean

Describes the payment is successful or not

completedboolean

Describes the payment is completed or not

is_3dboolean

Describes the payment is done with 3d secure process

amountnumber

Payment requested amount

paid_amountnumber

Payment amount

rem_amountnumber

Remaining Payment amount

commission_amountnumber

Payment commission amount

expected_cost_ratenumber

Payment expected cost rate

expected_cost_amountnumber

Payment expected cost amount

payment_systemstring

Payment System

currencystring

Payment currency

installment_countinteger

Installment count

inst_periodinteger

Installment period

auth_codestring

Bank authorization code

service_ref_idstring

Payment unique reference id on payment organisation

cancelledboolean

It is true if the payment cancelled on same day

refund_amountnumber

Payment refund amount

bin_codestring

Card Bin Code

card_typestring

Card Type

card_programstring

Card Program

card_familystring

Card Family

card_bank_eft_codestring

Card Bank Eft Code

card_bank_namestring

Card Bank Name

pos_bank_eft_codestring

Pos Bank Eft Code

pos_bank_namestring

Pos Bank Name

error_messagestring

Error message

payment_response_codestring

Payment response code

payment_response_messagestring

Payment response message

credit_bankstring

Credit Bank EFT Code

credit_status'Unknown' | 'Approved' | 'Cancelled' | 'Refund' | 'PartialRefund' | 'BankProcess' | 'NewCustomer'

An enumeration.

preauthboolean

Payment is pre auth ?

postauthboolean

Pre auth payment is approved ?

approval_codestring

Bank authorization code

bank_trace_numberstring

Bank Trace No

Example response

{
  "response_code": "00",
  "message": "Here is the payment info",
  "order_id": "order-hugin-0921341",
  "transaction_id": "9ee3fd53-42f9-4f16-b454-77e6b714c2e9",
  "transaction_date": "2021-12-09 00:13:35",
  "virtual_pos_name": "Garanti Sanal Pos",
  "virtual_pos_id": 35,
  "successful": true,
  "completed": true,
  "is_3d": true,
  "amount": 12.5,
  "paid_amount": 12.5,
  "rem_amount": 12.5,
  "commission_amount": 0.5,
  "expected_cost_rate": 0.5,
  "expected_cost_amount": 12.5,
  "payment_system": "GARANTI",
  "currency": "TRY",
  "installment_count": 1,
  "inst_period": 1,
  "auth_code": "058942",
  "service_ref_id": "145564688XVT1234",
  "refund_amount": 2.7,
  "bin_code": "521807",
  "card_type": "Credit",
  "card_program": "Mastercard",
  "card_family": "Axess",
  "card_bank_eft_code": "046",
  "card_bank_name": "Akbank T.A.Ş.",
  "pos_bank_eft_code": "15",
  "pos_bank_name": "T.VAKIFLAR BANKASI T.A.O.",
  "error_message": "00",
  "payment_response_code": "00",
  "payment_response_message": "00",
  "credit_bank": "00",
  "preauth": true,
  "postauth": true,
  "approval_code": "021965",
  "bank_trace_number": "618109934932"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.