Skip to main content

Start payment (with Intent)

Start a new payment using Readers SDK with payment intent for Caja POS.

Path Parameters
uuid uuid — REQUIRED

Payment intent identifier

Request Body — REQUIRED

Data to start a new payment with intent for Caja POS

source string
context object — REQUIRED
device object
serial string
ksn string
track2 string
application_version string

Version of the installed application

application_name string

Name of the installed application

operating_system_version string

Version of the operating system

sdk_version string

Version of the SDK being used

fingerprint_id string

Device fingerprint identifier

billing_info object — REQUIRED
description string — REQUIRED
tip object
amount number
card_type string
payment_method object — REQUIRED
card_data object
bin string — REQUIRED
aid string
metadata object

Any generic object can be provided, except arrays.

point_of_sale_id uuid — REQUIRED

Point of sale identifier (required for Caja POS)

Responses
200

Successful response

Schema — OPTIONAL
data object — OPTIONAL
attributes object — OPTIONAL
transaction_data object — OPTIONAL
time_zone string — OPTIONAL
money object — OPTIONAL
amount number — OPTIONAL
currency object — OPTIONAL
numericCode string — OPTIONAL
alphabeticCode string — OPTIONAL
symbol string — OPTIONAL
cancel_data object — OPTIONAL
parent_ref_number string — OPTIONAL
refund_data object — OPTIONAL
parent_ref_number string — OPTIONAL
confirmation object — OPTIONAL
additional_card_data object — OPTIONAL
brand string — OPTIONAL
card_type string — OPTIONAL
establishment object — OPTIONAL
address object — OPTIONAL
address_line1 string — OPTIONAL
address_line2 string — OPTIONAL
city string — OPTIONAL
country_code string — OPTIONAL
postal_code string — OPTIONAL
state string — OPTIONAL
business_category_code string — OPTIONAL
doc_number string — OPTIONAL
doc_type string — OPTIONAL
email string — OPTIONAL
establishment_type string — OPTIONAL
legal_name string — OPTIONAL
phone_number string — OPTIONAL
trade_name string — OPTIONAL
intermediary object — OPTIONAL
address object — OPTIONAL
address_line1 string — OPTIONAL
address_line2 string — OPTIONAL
city string — OPTIONAL
country_code string — OPTIONAL
postal_code string — OPTIONAL
state string — OPTIONAL
business_category_code string — OPTIONAL
doc_number string — OPTIONAL
doc_type string — OPTIONAL
email string — OPTIONAL
establishment_type string — OPTIONAL
legal_name string — OPTIONAL
phone_number string — OPTIONAL
trade_name string — OPTIONAL
merchant object — OPTIONAL
merchant_id string — OPTIONAL
merchant_type string — OPTIONAL
merchant_name string — OPTIONAL
ref_number string — OPTIONAL

Reference number para refund/anulacion

taxes number — OPTIONAL
terminalId string — OPTIONAL
ticket_number string — OPTIONAL
204

No content

400

Error response

Schema — OPTIONAL
app_name string — OPTIONAL
app_version string — OPTIONAL
status_code number — OPTIONAL
message string — OPTIONAL
message_code string — OPTIONAL
error_code string — OPTIONAL
validations object[] — OPTIONAL
property_name string — OPTIONAL
error_message string — OPTIONAL
error_code string — OPTIONAL
attempted_value string — OPTIONAL
422

Error response

Schema — OPTIONAL
app_name string — OPTIONAL
app_version string — OPTIONAL
status_code number — OPTIONAL
message string — OPTIONAL
message_code string — OPTIONAL
error_code string — OPTIONAL
validations object[] — OPTIONAL
property_name string — OPTIONAL
error_message string — OPTIONAL
error_code string — OPTIONAL
attempted_value string — OPTIONAL