v1
latestOpenAPI 3.1.02026-07-266133267.6 KBCreate a payin
Creates a payin object.
Request body
Invoice currency for the checkout session (in uppercase, iso-4217 standard). By default, the invoice currency is the holding currency for the transaction.
Amount in cents. For example if you want to charge $10.12 pass 1012 as the value. For decimal handling for various currencies, refer to <a href="/API-Reference/appendix/Decimal-Currencies" target="_blank"> the guide here</a>
ID of the customer for the checkout session
URL where the customer is directed to after a successful payment
The URL the customer will be directed to if they decide to cancel payment and return to your website.
A short description to be displayed on the Tazapay hosted checkout screen
Supporting documents for the transaction
Set of key-value pairs that can be attached to the object (JSON string format)
Your unique identifier for the session
Set to true to confirm this payin immediately. The parameter defaults to false. When creating and confirming a payin at the same time, you can also provide the parameters in the confirm API
Configure the description of the payment on your customer's statements. It must contain at least one letter and be 1-22 characters long
Pass the data specific to a payment method to confirm a payin and create a payment attempt
Session ID retrieved from the <a href="/API-Reference/tazapay-api/javascript-sdk/integrate-with-risk-sdk"> risk SDK</a>
Example request
{
"metadata": "{\"key1\": \"value1\", \"key2\": \"value2\"}"
}Response
200
Indicates whether the payin creation request succeeded.
Response message or additional context regarding the payin request.