Create Checkout Router

The Authorization needs to be in the following format:

Authorization: Token <YOUR_API_KEY>

Body

application/json

amount

integer

required

The total monetary value of the transaction.

business_id

integer

required

The identifier for the business.

card

object

required

Contains information related to the payment card used in the transaction.

description

string

required

A description of the transaction.

device_session_id

string

required

The identifier for the device session.

email_client

string

required

The email address of the client.

id_product

string

required

The identifier for the product.

id_ship

string

required

The identifier for the shipping information.

instance_id_ship

string

required

The instance identifier for the shipping information.

last_name

string

required

The last name of the client.

name

string

required

The first name of the client.

order_id

integer

required

An identifier or reference number for the order.

payment_id

integer

required

The identifier for the payment.

phone_number

string

required

The phone number of the client.

quantity_product

integer

required

The quantity of the product in the transaction.

return_url

string

required

The URL to which the user will be redirected after completing the transaction.

source

string

required

The source of the transaction.

title_ship

string

required

The title or type of shipping.

token_id

string

A token identifier associated with the transaction.

Response

201 - application/json

actions

object[]

An array of actions that can be performed for the transaction, each represented by an object with 'name', 'url', and 'method' properties.

message

string

A message providing additional information about the success or failure of the response.

next_action

object

Details about the next action required for the transaction. If not applicable, an empty object is provided.

payment_id

integer

The unique identifier for the payment associated with the transaction.

provider

string

The payment provider used for the transaction, e.g., 'stripe'.

psp_response

object

The response from the payment service provider (PSP) containing detailed information about the payment transaction.

psp_response.amount

integer

The total amount of the transaction, expressed in the smallest currency unit (e.g., cents or pence).

psp_response.amount_captured

integer

The amount that has been captured or collected from the customer as part of the transaction.

psp_response.amount_refunded

integer

The amount that has been refunded to the customer as part of the transaction.

psp_response.application

string

The identifier of the application associated with the transaction, if applicable.

psp_response.application_fee

string

The application fee, if any, applied to the transaction.

psp_response.application_fee_amount

string

The amount of the application fee, if any, applied to the transaction.

psp_response.balance_transaction

string

The identifier of the balance transaction associated with the payment charge.

psp_response.billing_details

object

Object containing details about the billing information.

psp_response.calculated_statement_descriptor

string

The calculated statement descriptor associated with the transaction.

psp_response.captured

boolean

Indicates whether the payment has been captured (true) or not (false).

psp_response.created

integer

The timestamp representing the creation date and time of the transaction.

psp_response.currency

string

The currency code associated with the transaction.

psp_response.customer

string

The identifier of the customer associated with the transaction.

psp_response.description

string

A description or additional information about the transaction.

psp_response.destination

string

The destination of the transaction, if applicable.

psp_response.dispute

string

The identifier of any dispute associated with the transaction, if applicable.

psp_response.disputed

boolean

Indicates whether the transaction is disputed (true) or not (false).

psp_response.failure_balance_transaction

string

The identifier of the balance transaction in case of failure, if applicable.

psp_response.failure_code

string

The code associated with the failure, if applicable.

psp_response.failure_message

string

A message providing details about the failure, if applicable.

psp_response.fraud_details

object

Details about any fraud associated with the transaction, if applicable.

psp_response.id

string

A unique identifier for the payment transaction within the payment service provider (PSP) system.

psp_response.invoice

string

The identifier of the invoice associated with the transaction, if applicable.

psp_response.livemode

boolean

Indicates whether the transaction was created in live mode (true) or test mode (false).

psp_response.metadata

object

Additional metadata associated with the transaction.

psp_response.object

string

The type of object, representing the nature of the transaction (e.g., 'charge' for a payment charge).

psp_response.on_behalf_of

string

The identifier of the account on behalf of which the transaction is performed, if applicable.

psp_response.order

string

The identifier of the order associated with the transaction, if applicable.

psp_response.outcome

object

Details about the outcome of the payment transaction.

psp_response.paid

boolean

A boolean indicating whether the payment has been successfully paid.

psp_response.payment_intent

string

The unique identifier of the payment intent associated with this payment transaction. This is relevant for payments using payment methods that involve a two-step confirmation process.

psp_response.payment_method

string

The unique identifier of the payment method used for this transaction, such as a credit card or debit card.

psp_response.payment_method_details

object

Details about the payment method used for the transaction, including card details and type.

psp_response.payment_method_details.card

object

Details about the card used for the payment, including brand, checks, country, expiration, and more.

psp_response.payment_method_details.card.amount_authorized

integer

The amount authorized on the card, represented as an integer value.

psp_response.payment_method_details.card.brand

string

The brand or type of the card used for the payment (e.g., Visa, MasterCard).

psp_response.payment_method_details.card.checks

object

Various checks performed on the card details for validation purposes.

psp_response.payment_method_details.card.country

string

The country where the card was issued.

psp_response.payment_method_details.card.exp_month

integer

The expiration month of the card.

psp_response.payment_method_details.card.exp_year

integer

The expiration year of the card.

psp_response.payment_method_details.card.extended_authorization

object

Information about extended authorization status.

psp_response.payment_method_details.card.fingerprint

string

A unique identifier (fingerprint) for the card.

psp_response.payment_method_details.card.funding

string

The funding source of the card, such as 'credit'.

psp_response.payment_method_details.card.incremental_authorization

object

Information about incremental authorization status.

psp_response.payment_method_details.card.installments

string

The number of installments for the payment, if applicable.

psp_response.payment_method_details.card.last4

string

The last four digits of the card number.

psp_response.payment_method_details.card.mandate

string

The mandate associated with the payment, if applicable.

psp_response.payment_method_details.card.multicapture

object

Information about multicapture status.

psp_response.payment_method_details.card.network

string

The card network, such as Visa.

psp_response.payment_method_details.card.network_token

object

Information about the usage status of the network token.

psp_response.payment_method_details.card.overcapture

object

Information about overcapture status.

psp_response.payment_method_details.card.three_d_secure

string

The status of 3D Secure authentication, if applicable.

psp_response.payment_method_details.card.wallet

string

The type of wallet used for the payment, if applicable.

psp_response.payment_method_details.type

string

The type of payment method, such as 'card'.

psp_response.radar_options

object

Options related to Stripe Radar, which provides advanced fraud protection.

psp_response.receipt_email

string

The email address to which the receipt for the transaction was sent, or null if no receipt was sent.

psp_response.receipt_number

string

The receipt number associated with the transaction, or null if no receipt number is available.

psp_response.receipt_url

string

The URL to view the receipt for the payment, or null if no receipt is available.

psp_response.refunded

boolean

A boolean indicating whether the payment has been refunded.

psp_response.review

string

The status of the payment review, or null if no review is in progress.

psp_response.shipping

object

Information about the shipping address associated with the transaction.

psp_response.source

string

The ID of the payment source. If not applicable or available, set to null.

psp_response.source_transfer

string

The ID of the transfer made from the payment source. If not applicable or available, set to null.

psp_response.statement_descriptor

string

A custom statement descriptor for the payment. If not applicable or available, set to null.

psp_response.statement_descriptor_suffix

string

A custom statement descriptor suffix for the payment. If not applicable or available, set to null.

psp_response.status

string

The status of the payment transaction, e.g., 'succeeded'.

psp_response.transfer_data

string

Information about the transfer associated with the payment. If not applicable or available, set to null.

psp_response.transfer_group

string

The ID of the transfer group. If not applicable or available, set to null.

status

string

The HTTP status code indicating the success or failure of the response.

transaction_id

integer

The unique identifier for the transaction.

transaction_status

string

The status of the transaction, e.g., 'Success'.

Tonder API

API Reference

Create Checkout Router

Body

Response