---
title: "Shopping Credit Payment"
method: POST
path: "/api/v1/payment/shoppingcredit"
tags: ["Shopping Credit Payments"]
---

# Shopping Credit Payment

`POST /api/v1/payment/shoppingcredit`

## Request

- Base URL: `https://api.paylox.io`
- URL: `https://api.paylox.io/api/v1/payment/shoppingcredit`
- Auth: none declared
- TypeScript: <https://skmtc.dev/jetcheckout/apis/jet-checkout/docs/api/v1/payment/shoppingcredit/post.ts> (a function with typed inputs; its response is checked against the schema)

Shopping Credit api you can get payments from your customer

## Request body

- ShoppingCreditRequest
  - `application_key` string, required: It is the key of your application on our environment
  - `order_id` string, required: order_id must be send as unique identifier of your each request. If you send the same value in different requests it would create a chaos, you can't be sure about your payment
  - `amount` number, required: Total amount
  - `shippingPrice` number: Shipping price
  - `currency` string: Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR
  - `bank_code` string, required: Bank EFT Code
  - `installment_count` integer: Its default is without installment, if you want to make installment please send the installment count as string
  - `hash_data` string, required: This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + ORDER_ID + AMOUNT + SECRET_KEY ) )
  - `success_url` string, required: Must be an absolute HTTP(S) URL with a host; invalid destinations return HTTP 422 before payment execution. If process result is success it will be posted this url with your order_id.
  - `fail_url` string, required: Must be an absolute HTTP(S) URL with a host; invalid destinations return HTTP 422 before payment execution. If process failed it will be posted this url with your order_id, response_code and message. You can reach our all response codes from response code api.
  - `callback_api_url` string: This is the url address for Shopping Credit Status Changed Event
  - `customer` ModelsPaymentRequestShoppingCreditCustomer, required
    - `birthDate` string, required: Customer Birth Date
    - `phoneNumber` string, required: Customer Phone Number
    - `nationalIdentityNumber` string, required: Customer TC number
    - `ip_address` string: IP address of client.
    - `email` string: Email of your customer.
  - `basket_items` ModelsPaymentRequestShoppingCreditBasketItem[], required: Content of order. Our api acts like card number.
    - `id` string, required: Item id
    - `name` string, required: Name of item.
    - `brandName` string, required: Item brand name
    - `qty` number, required: Quantiy of item
    - `unitPrice` number, required: Unit Price
    - `category` integer, required: Item category. This must be the one of our ids in the Shopping Credit Item Categories. You can reach the list of categories on the Shopping Credit Item Categories Api.
  - `mode` string: Please send it as 'T' for test purposes, otherwise it will be in production mode.
  - `language` string: 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.
  - `session_id` string: The sessionId value found in the Bank Payment Table service response is expected to be sent.
  - `pre_approved_id` string: Application number returned in pre-approval
  - `virtual_pos_id` string: Virtual Pos Id

## Response `200`

Successful Response

- ShoppingCreditResponse
  - `response_code` string
  - `message` string
  - `suggestion` string
  - `service_resp_code` string
  - `service_resp_message` string
  - `transaction_id` string
  - `redirect_url` string
  - `service_messages` string[]

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/jetcheckout/apis/jet-checkout.md) - [All operations](https://skmtc.dev/jetcheckout/apis/jet-checkout/llms.txt) - [OpenAPI document](https://skmtc.dev/jetcheckout/apis/jet-checkout/revisions/06cdc5bbb97f?raw)