TensorRail API (1.0)

The primary amount for the payment, provided in the lowest denomination of the specified currency (e.g., 6540 for $65.40 USD). This field is mandatory for creating a payment.

Total tax amount applicable to the order, in the lowest denomination of the currency.

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

The amount to be captured from the user's payment method, in the lowest denomination. If not provided, and capture_method is automatic, the full payment amount will be captured. If capture_method is manual, this can be specified in the /capture call. Must be less than or equal to the authorized amount.

The shipping cost for the payment. This is required for tax calculation in some regions.

Optional. A merchant-provided unique identifier for the payment, up to 64 characters (e.g., "pay_examplexxxxxxxxxxxxxxxxxxx"). If provided, it ensures idempotency for the payment creation request. If omitted, TensorRail generates a unique ID for the payment (a 4-character prefix plus 20 generated characters, so 24 in total).

Processor identifier assigned by TensorRail. Routing is managed for your account; you do not select a processor.

Specifies how the payment is captured.

• automatic: Funds are captured immediately after successful authorization. This is the default behavior if the field is omitted.
• manual: Funds are authorized but not captured. A separate request to the /payments/{payment_id}/capture endpoint is required to capture the funds.

Specifies the type of cardholder authentication to be applied for a payment.

• ThreeDs: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.
• NoThreeDs: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.

Note: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.

If set to true, TensorRail attempts to confirm and authorize the payment immediately after creation, provided sufficient payment method details are included. If false or omitted (default is false), the payment is created with a status such as requires_payment_method or requires_confirmation, and a separate POST /payments/{payment_id}/confirm call is necessary to proceed with authorization.

Passing this object creates a new customer or attaches an existing customer to the payment

The identifier for the customer

Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. When making a recurring payment by passing a mandate_id, this parameter is mandatory

An arbitrary string attached to the payment. Often useful for displaying to users or for your own internal record-keeping.

The URL to redirect the customer to after they complete the payment process or authentication. This is crucial for flows that involve off-site redirection (e.g., 3DS, some bank redirects, wallet payments).

Specifies how the payment method can be used for future payments.

• off_session: The payment method can be used for future payments when the customer is not present.
• on_session: The payment method is intended for use only when the customer is present during checkout. If omitted, defaults to on_session.

The payment method information provided for making a payment

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

As TensorRail tokenises the sensitive details about the payments method, it provides the payment_token as a reference to a stored payment method, ensuring that the sensitive details are not exposed in any manner.

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. To be deprecated soon, use billing_descriptor instead.

Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. To be deprecated soon, use billing_descriptor instead.

Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount

Passing this object during payments creates a mandate. The mandate_type sub object is passed by the server.

This "CustomerAcceptance" object is passed during Payments-Confirm request, it enlists the type, time, and mode of acceptance properties related to an acceptance done by the customer. The customer_acceptance sub object is usually passed by the SDK or client.

A unique identifier to link the payment to a mandate. To do Recurring payments after a mandate has been created, pass the mandate_id instead of payment_method_data

Browser information to be used for 3DS 2.0

To indicate the type of payment experience that the customer would go through

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Business label of the merchant for this payment. To be deprecated soon. Pass the profile_id instead

Merchant connector details used to make payments.

Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

Some payment methods need extra information alongside the payment. Find the specific details in the child attributes below.

Whether to generate the payment link for this payment or not (if applicable)

Configure a custom payment link for the particular payment

Custom payment link config id set at business profile, send only if business_specific_configs is configured

The business profile to be used for this payment, if not passed the default business profile associated with the merchant account will be used. It is mandatory in case multiple business profiles have been set up.

Details of surcharge applied on this payment, if applicable

The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.

Request an incremental authorization, i.e., increase the authorized amount on a confirmed payment before you capture it.

Will be used to expire client secret after certain amount of time to be supplied in seconds (900) for 15 mins

Additional data related to some frm(Fraud Risk Management) connectors

Whether to perform external authentication (if applicable)

Details required for recurring payment

Optional boolean value to extent authorization period of this payment

capture method must be manual or manual_multiple

Your unique identifier for this payment or order. This ID helps you reconcile payments on your system. If provided, it is passed to the connector if supported.

Whether to calculate tax for this payment intent

SCA Exemptions types available for authentication

Indicates if 3ds challenge is forced

Indicates if 3DS method data was successfully completed or not

Indicates if the redirection has to open in the iframe

If enabled, provides whole connector response

Describes the channel through which the payment was initiated.

Total amount of the discount you have applied to the order or transaction.

This Unit struct represents MinorUnit in which core amount works

This Unit struct represents MinorUnit in which core amount works

Date the payer placed the order.

Allow partial authorization for this payment

Boolean indicating whether to enable overcapture for this payment

Boolean flag indicating whether this payment method is stored and has been previously used for payments

Specifies the category of a Merchant Initiated Transaction (MIT). In the case of MIT, mit_category tells what kind of MIT is being processed. In the case of CIT, it tells the future intended MIT type.

Billing Descriptor information to be sent to the payment gateway

The type of tokenization to use for the payment method

Information identifying partner and merchant application initiating the request

Installment payment options grouped by payment method. When provided, the payment is treated as an installment payment.

The primary amount for the payment, provided in the lowest denomination of the specified currency (e.g., 6540 for $65.40 USD). This field is mandatory for creating a payment.

Total tax amount applicable to the order, in the lowest denomination of the currency.

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

The amount to be captured from the user's payment method, in the lowest denomination. If not provided, and capture_method is automatic, the full payment amount will be captured. If capture_method is manual, this can be specified in the /capture call. Must be less than or equal to the authorized amount.

The shipping cost for the payment. This is required for tax calculation in some regions.

Optional. A merchant-provided unique identifier for the payment, up to 64 characters (e.g., "pay_examplexxxxxxxxxxxxxxxxxxx"). If provided, it ensures idempotency for the payment creation request. If omitted, TensorRail generates a unique ID for the payment (a 4-character prefix plus 20 generated characters, so 24 in total).

Processor identifier assigned by TensorRail. Routing is managed for your account; you do not select a processor.

Specifies how the payment is captured.

• automatic: Funds are captured immediately after successful authorization. This is the default behavior if the field is omitted.
• manual: Funds are authorized but not captured. A separate request to the /payments/{payment_id}/capture endpoint is required to capture the funds.

Specifies the type of cardholder authentication to be applied for a payment.

• ThreeDs: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.
• NoThreeDs: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.

Note: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.

If set to true, TensorRail attempts to confirm and authorize the payment immediately after creation, provided sufficient payment method details are included. If false or omitted (default is false), the payment is created with a status such as requires_payment_method or requires_confirmation, and a separate POST /payments/{payment_id}/confirm call is necessary to proceed with authorization.

Passing this object creates a new customer or attaches an existing customer to the payment

The identifier for the customer

Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. When making a recurring payment by passing a mandate_id, this parameter is mandatory

An arbitrary string attached to the payment. Often useful for displaying to users or for your own internal record-keeping.

The URL to redirect the customer to after they complete the payment process or authentication. This is crucial for flows that involve off-site redirection (e.g., 3DS, some bank redirects, wallet payments).

Specifies how the payment method can be used for future payments.

• off_session: The payment method can be used for future payments when the customer is not present.
• on_session: The payment method is intended for use only when the customer is present during checkout. If omitted, defaults to on_session.

The payment method information provided for making a payment

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

As TensorRail tokenises the sensitive details about the payments method, it provides the payment_token as a reference to a stored payment method, ensuring that the sensitive details are not exposed in any manner.

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. To be deprecated soon, use billing_descriptor instead.

Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. To be deprecated soon, use billing_descriptor instead.

Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount

Passing this object during payments creates a mandate. The mandate_type sub object is passed by the server.

This "CustomerAcceptance" object is passed during Payments-Confirm request, it enlists the type, time, and mode of acceptance properties related to an acceptance done by the customer. The customer_acceptance sub object is usually passed by the SDK or client.

Browser information to be used for 3DS 2.0

To indicate the type of payment experience that the customer would go through

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Merchant connector details used to make payments.

Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent

Denotes the retry action

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

Some payment methods need extra information alongside the payment. Find the specific details in the child attributes below.

Whether to generate the payment link for this payment or not (if applicable)

Configure a custom payment link for the particular payment

Custom payment link config id set at business profile, send only if business_specific_configs is configured

Details of surcharge applied on this payment, if applicable

The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.

Request an incremental authorization, i.e., increase the authorized amount on a confirmed payment before you capture it.

Will be used to expire client secret after certain amount of time to be supplied in seconds (900) for 15 mins

Additional data related to some frm(Fraud Risk Management) connectors

Whether to perform external authentication (if applicable)

Details required for recurring payment

Optional boolean value to extent authorization period of this payment

capture method must be manual or manual_multiple

Your unique identifier for this payment or order. This ID helps you reconcile payments on your system. If provided, it is passed to the connector if supported.

Whether to calculate tax for this payment intent

SCA Exemptions types available for authentication

Indicates if 3ds challenge is forced

Indicates if 3DS method data was successfully completed or not

Indicates if the redirection has to open in the iframe

If enabled, provides whole connector response

Describes the channel through which the payment was initiated.

Total amount of the discount you have applied to the order or transaction.

This Unit struct represents MinorUnit in which core amount works

This Unit struct represents MinorUnit in which core amount works

Date the payer placed the order.

Allow partial authorization for this payment

Boolean indicating whether to enable overcapture for this payment

Boolean flag indicating whether this payment method is stored and has been previously used for payments

Specifies the category of a Merchant Initiated Transaction (MIT). In the case of MIT, mit_category tells what kind of MIT is being processed. In the case of CIT, it tells the future intended MIT type.

Billing Descriptor information to be sent to the payment gateway

The type of tokenization to use for the payment method

Information identifying partner and merchant application initiating the request

Installment payment options grouped by payment method. When provided, the payment is treated as an installment payment.

The reason for the payment cancel

Merchant connector details used to make payments.

The primary amount for the payment, provided in the lowest denomination of the specified currency (e.g., 6540 for $65.40 USD). This field is mandatory for creating a payment.

Total tax amount applicable to the order, in the lowest denomination of the currency.

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

The amount to be captured from the user's payment method, in the lowest denomination. If not provided, and capture_method is automatic, the full payment amount will be captured. If capture_method is manual, this can be specified in the /capture call. Must be less than or equal to the authorized amount.

The shipping cost for the payment. This is required for tax calculation in some regions.

Optional. A merchant-provided unique identifier for the payment, up to 64 characters (e.g., "pay_examplexxxxxxxxxxxxxxxxxxx"). If provided, it ensures idempotency for the payment creation request. If omitted, TensorRail generates a unique ID for the payment (a 4-character prefix plus 20 generated characters, so 24 in total).

Processor identifier assigned by TensorRail. Routing is managed for your account; you do not select a processor.

Specifies how the payment is captured.

• automatic: Funds are captured immediately after successful authorization. This is the default behavior if the field is omitted.
• manual: Funds are authorized but not captured. A separate request to the /payments/{payment_id}/capture endpoint is required to capture the funds.

Specifies the type of cardholder authentication to be applied for a payment.

• ThreeDs: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.
• NoThreeDs: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.

Note: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.

If set to true, TensorRail attempts to confirm and authorize the payment immediately after creation, provided sufficient payment method details are included. If false or omitted (default is false), the payment is created with a status such as requires_payment_method or requires_confirmation, and a separate POST /payments/{payment_id}/confirm call is necessary to proceed with authorization.

Passing this object creates a new customer or attaches an existing customer to the payment

The identifier for the customer

Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. When making a recurring payment by passing a mandate_id, this parameter is mandatory

An arbitrary string attached to the payment. Often useful for displaying to users or for your own internal record-keeping.

The URL to redirect the customer to after they complete the payment process or authentication. This is crucial for flows that involve off-site redirection (e.g., 3DS, some bank redirects, wallet payments).

Specifies how the payment method can be used for future payments.

• off_session: The payment method can be used for future payments when the customer is not present.
• on_session: The payment method is intended for use only when the customer is present during checkout. If omitted, defaults to on_session.

The payment method information provided for making a payment

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

As TensorRail tokenises the sensitive details about the payments method, it provides the payment_token as a reference to a stored payment method, ensuring that the sensitive details are not exposed in any manner.

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. To be deprecated soon, use billing_descriptor instead.

Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. To be deprecated soon, use billing_descriptor instead.

Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount

Client-side confirmation token. Publishable-key only, and optional. Send client_secret only when confirming the payment from the client side with a publishable API key. When confirming server-side with a secret API key, DO NOT send client_secret — the request is rejected if it is present. (FIX 3: annotation reconciled to runtime reality — secret-key confirm must not carry client_secret.)

Passing this object during payments creates a mandate. The mandate_type sub object is passed by the server.

This "CustomerAcceptance" object is passed during Payments-Confirm request, it enlists the type, time, and mode of acceptance properties related to an acceptance done by the customer. The customer_acceptance sub object is usually passed by the SDK or client.

A unique identifier to link the payment to a mandate. To do Recurring payments after a mandate has been created, pass the mandate_id instead of payment_method_data

Browser information to be used for 3DS 2.0

To indicate the type of payment experience that the customer would go through

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Merchant connector details used to make payments.

Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent

Denotes the retry action

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

Some payment methods need extra information alongside the payment. Find the specific details in the child attributes below.

Whether to generate the payment link for this payment or not (if applicable)

Configure a custom payment link for the particular payment

Custom payment link config id set at business profile, send only if business_specific_configs is configured

The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.

Request an incremental authorization, i.e., increase the authorized amount on a confirmed payment before you capture it.

Will be used to expire client secret after certain amount of time to be supplied in seconds (900) for 15 mins

Additional data related to some frm(Fraud Risk Management) connectors

Whether to perform external authentication (if applicable)

Details required for recurring payment

Optional boolean value to extent authorization period of this payment

capture method must be manual or manual_multiple

Your unique identifier for this payment or order. This ID helps you reconcile payments on your system. If provided, it is passed to the connector if supported.

Whether to calculate tax for this payment intent

SCA Exemptions types available for authentication

Indicates if 3ds challenge is forced

Indicates if 3DS method data was successfully completed or not

Indicates if the redirection has to open in the iframe

If enabled, provides whole connector response

Describes the channel through which the payment was initiated.

Total amount of the discount you have applied to the order or transaction.

This Unit struct represents MinorUnit in which core amount works

This Unit struct represents MinorUnit in which core amount works

Date the payer placed the order.

Allow partial authorization for this payment

Boolean flag indicating whether this payment method is stored and has been previously used for payments

Specifies the category of a Merchant Initiated Transaction (MIT). In the case of MIT, mit_category tells what kind of MIT is being processed. In the case of CIT, it tells the future intended MIT type.

Billing Descriptor information to be sent to the payment gateway

The type of tokenization to use for the payment method

Information identifying partner and merchant application initiating the request

Installment payment options grouped by payment method. When provided, the payment is treated as an installment payment.

Token used for client side verification

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Payment method data request for eligibility check

The identifier for the customer object. If not provided the customer ID will be autogenerated.

The customer's name

The customer's email address

The customer's phone number

An arbitrary string that you can attach to a customer object.

The country code for the customer phone number

Address details

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

Customer's tax registration ID