Skip to main content
POST
Create a payin
After the payin is created, provide payment method details and confirm the payin. When you use confirm = true during creation, you create and confirm the payin in the same API call. You MUST use the parameters in confirm API when you supply confirm = true

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
invoice_currency
string
default:""
required

Invoice currency for the checkout session (in uppercase, iso-4217 standard). By default, the invoice currency is the holding currency for the transaction.

amount
integer<int32>
default:""
required

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 the guide here

transaction_description
string
default:""
required

A short description to be displayed on the Tazapay hosted checkout screen

customer_details
object

Details about the customer

customer
string

ID of the customer for the checkout session

success_url
string

URL where the customer is directed to after a successful payment

cancel_url
string

The URL the customer will be directed to if they decide to cancel payment and return to your website.

shipping_details
object

Shipping details including recipient name, address and phone

billing_details
object

Billing details including name, address and phone

transaction_documents
string<json>

Supporting documents for the transaction

metadata
string<json>

Set of key-value pairs that can be attached to the object (JSON string format)

Example:

"{\"key1\": \"value1\", \"key2\": \"value2\"}"

reference_id
string

Your unique identifier for the session

confirm
boolean
default:false

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

statement_descriptor
string

Configure the description of the payment on your customer's statements. It must contain at least one letter and be 1-22 characters long

payment_method_details
string<json>

Pass the data specific to a payment method to confirm a payin and create a payment attempt

session_id
string

Session ID retrieved from the risk SDK

Response

200 - application/json

200

status
string

Indicates whether the payin creation request succeeded.

message
string

Response message or additional context regarding the payin request.

data
object

Contains detailed information about a payin object.