Skip to main content

Installment Loan Details Receiving

By calling this method an Online Shop can receive detailed information regarding the status of an installment loan completed by a customer based on the payment identifier.

Content-Typerequiredapplication/json

AuthorizationrequiredBearer <jwt_token>

Bearer <jwt_token>, where the jwt_token is a value returned in an access_token parameter from the Authentication Method Response 

GET /v1/installment/checkout/<order_id> HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Authorization: Basic <base64>

Response​

order_idrequiredstring

An order identifier that is passed in the Request of the given method.

statusrequiredstring

An Order Status. Can take the following values:

  • success - An installment loan process has been completed successfully
  • in_progress - An installment loan is in progress and is not completed yet and if in 45 minutes from the order generation a customer has not completed an installment loan process, the status will change to an error.
  • error - An installment loan process is unsuccessful.

installment_statusrequiredstring

An installment loan Status.

  • success - An installment loan was successfully activated. In this case, order status is also success
  • reject - An installment loan was not approved. In this case, order status is also an error
  • reverse_success - An installment loan is canceled based on the customer’s request or the Merchant canceled the installment loan from a dashboard of the control panel
  • fail - An installment loan was not activated. In this case, the order status will be error
  • unknown - An installment loan will have this status if the installment loan is not completed and the order status is in_progress

ipay_payment_idrequiredstring

A payment ID in the ipay system which is shown on a payment receipt

shop_order_idrequiredstring

A Merchant’s order identifier

payment_methodrequiredstring

A payment method. In the case of the installment loan, the BOG_LOAN value is always returned

{
  "order_id": "{order_id}",
  "status": "success" | "in_progress" | "error",
  "installment_status": "success" | "reject" | "reverse_success" | "fail" | "unknown",
  "ipay_payment_id": "{ipay_payment_id}",
  "shop_order_id": "{shop_order_id}",
  "payment_method": "BOG_LOAN"
}