---
title: "Card Family Payment"
method: POST
path: "/api/v1/physical/payment/card_family"
tags: ["Physical Device Payments"]
---

# Card Family Payment

`POST /api/v1/physical/payment/card_family`

## Request

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

Physical device payment api you can start payments on your physical devices

## Request body

- PhysicalPaymentCardFamilyRequest
  - `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` string, required: It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342
  - `currency` string: Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR
  - `store_code` string, required: Store Code
  - `campaign_name` string: It is the name of pos campaign you defined in our environment
  - `card_family_id` integer: Card Family Id
  - `installment_count` integer: Its default is without installment, if you want to make installment please send the installment count
  - `document_type` integer: Document Type. Possible values 1:Receipt, 2:Invoice, 3:EInvoice, 4:EArchive, 5:Food, 6:Parking, 7:Prepayment, 8:InvoicePayment, 9:CurrentAccount
  - `callback_api_url` string, required: The json result comes from physical device will be posted to this api url.
  - `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.
  - `sale_items` SaleItem[]: Content of order.
    - `name` string, required: Name of item.
    - `barcode` string, required: Item barcode
    - `qty` integer, required: Quantiy of item
    - `price` number, required: Unit price of item
    - `amount` number, required: Total amount of item
    - `tax_rate` integer, required: Tax rate, acceptable rates are 0, 1, 8 and 18
  - `pay_items` PayItem[]: Payment items.
    - `amount` number, required: Payment amount
    - `payment_type` integer, required: Payment Type. Acceptable Payment Types 1 (Cash), 2 (Foreign Cash), 3 (Credit Card)
    - `installment_no` integer: Payment Installment No
    - `credit_id` integer: Payment Credit Id
    - `definition` string: Payment Definition
    - `reference_code` string: Payment Reference Code
    - `issuer_id` string: Payment Issuer Id
    - `card_number` string: Payment Card Number
    - `acquire_id` string: Payment Acquire Id
  - `customer_info` CustomerInfo
    - `name` string, required: Customer Name
    - `id` string: Customer Id
  - `sales_person` integer: Sales person

## Response `200`

Successful Response

- PhysicalPaymentCardFamilyResponse
  - `response_code` string: You will get 00 for successful payments, 00307 for needs redirection, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api
  - `message` string: Here is the explanation of response code
  - `transaction_id` string: This is the unique id of your payment request in our system. You need to post it to redirect url when redirection needed
  - `pos_order_number` string: Physical pos device order number
  - `devices` PhysicalDeviceInfo[]: Available devices for this payment
    - `device_id` integer: Physical pos device id in Paylox
    - `device_name` string: Physical pos device name in Paylox
    - `device_fiscal_id` string: Physical pos device number in device owner system

## 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)