TransactionByDevice

post

https://restapi.payplus.co.il/api/v1.0/Device/TransactionByDevice

Body Params

device_uid

string

required

Unique Device Identifier (UID) from the PayPlus system

cashier_uid

string

unique identifier (UID) associated with a cashier account from the PayPlus system

charge_method

integer

enum

required

Defaults to 1

Use this parameter to define the appropriate transaction action based on the customer's request and system requirements

0 - Check (J2)
1 - Charge (J4)
2 - Approval (J5)
4 - Refund (J4)

Allowed:

callback_url

string

nullable (We will send you webhook once the transaction approved). Example: https://www.domain.com/callback/

create_token

boolean

nullable (In case you have tokenization permission, you can decide if you would like to return the token of the customer for future charges)

initial_invoice

boolean

nullable (In case you have invoice company and it's activated in your payment page, you can decide if for spesfic transaction invoice will be initial or not, to use default please don't send this parameter at all)

custom_invoice_name

string

nullable (In case you have integrated invoice company you can decide if the invoice customer name will be different then the "customer_name" parameter in customer object)

amount

number

required

currency_code

string

required

credit_terms

integer

enum

required

1-regular OR 6-credit OR 8-payment

Allowed:

paying_vat

boolean

nullable (In case you would like to that invoice / document will be with VAT or without VAT, This parameter is not required)

customer_uid

string

To allocate the payment to specific customer

products

array of objects

nullable if send in item "product_uid" we will use this product or send error, if send "name" and not "product_uid" we will create new product with this name. more option to send if ("name" && !product_uid): vat_type, barcode, value,price.last option we will use default product.

products

payments

object

extra_info

string

minimize_app

boolean

customer

object

Headers

api-key

string

required

API Key

secret-key

string

required

Secret Key

Responses

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400