Skip to main content
A payin refers to the process through which a merchant collects payments through Tazapay’s cross-border payment platform. This can be done through various methods such as credit/debit cards, local payment methods, bank transfers, or e-wallets, depending on the supported payment options in the region.

​
Object Structure

JSON
{
  "amount": 100,
  "amount_paid": 0,
  "billing_details": {
          "address": {
              "city": "Singapore",
              "country": "SG",
              "line1": "1st Street",
              "line2": "2nd Avenue",
              "postal_code": "43004",
              "state": "Singapore"
            },
          "label": "Home",
          "name": "Andrea Lark",
          "phone": {
              "calling_code": "65",
              "number": "87654321"
            }
        },
  "cancel_url": "https://mystore.com/try_again",
  "cancelled_at": null,
  "client_token": "JsU19R_Li9cwVksJGUfAajZ3r2A9ArU7Qk3j5r0cpVg=",
  "confirm": false,
  "created_at": "2024-10-07T07:10:21.894488Z",
  "customer": "cus_crtqrhth90j0121gpt50",
  "customer_details": {
          "country": "SG",
          "email": "[email protected]",
          "name": "Andrea Lark",
          "phone": {
              "calling_code": "65",
              "number": "87654321"
            }
        },
  "holding_currency": "INR",
  "id": "pay_cs1oina7a5ng2a3ng12g",
  "invoice_currency": "INR",
  "items": [],
  "latest_payment_attempt": "",
  "latest_payment_attempt_data": null,
  "metadata": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        },
  "object": "payin",
  "paid_in_excess": false,
  "partially_paid": false,
  "payment_attempts": [],
  "payment_method_details": {
          "paynow_sgd": {},
          "type": "paynow_sgd"
        },
  "reference_id": "123",
  "shipping_details": {
          "address": {
              "city": "Singapore",
              "country": "SG",
              "line1": "1st Street",
              "line2": "2nd Avenue",
              "postal_code": "43004",
              "state": "Singapore"
            },
          "label": "Home",
          "name": "Andrea Lark",
          "phone": {
              "calling_code": "65",
              "number": "87654321"
            }
        },
  "statement_descriptor": "tzp*string",
  "status": "requires_payment_method",
  "status_description": "",
  "success_url": "https://mystore.com/success_page",
  "transaction_data": [],
  "transaction_description": "test",
  "transaction_documents": [],
  "webhook_url": "https://mystore.com/internal/webhook"
}

​
Object Parameters

​
Payin

FieldSubfieldTypeDescription
amountnumberThe total amount of the payin transaction.
amount_paidnumberThe amount that has already been paid.
billing_detailsobjectThe billing information for the transaction.
addressobjectThe address associated with the billing details. Address Object
labelstringA label for the billing address (e.g., Home, Office).
namestringThe name associated with the billing details.
phoneobjectThe phone details associated with the billing address. (See Phone Table).
cancel_urlstringThe URL to redirect the user to if the transaction is canceled.
cancelled_atstring(ISO timestamp)The timestamp when the transaction was canceled, if applicable.
client_tokenstringThe client token associated with the payin.
confirmbooleanIndicates if the transaction is confirmed.
created_atstring (ISO timestamp)The timestamp when the transaction was created.
customerstringThe unique identifier for the customer.
customer_detailsobjectThe customer details related to the transaction.
countrystringThe country of the customer.
emailstringThe email address of the customer.
namestringThe name of the customer.
phoneobjectThe phone details of the customer. Phone Object.
holding_currencystringThe holding currency used for the transaction (e.g., INR).
idstringThe unique Tazapay identifier for the payin transaction.
invoice_currencystringThe invoice currency for the transaction.
itemsarrayThe list of items related to the transaction.
latest_payment_attemptstringThe Tazapay ID of the latest payment attempt.
latest_payment_attempt_dataobject/nullData related to the latest payment attempt, if available.
metadataobjectSet of key-value pairs attached to the transaction.
objectstringThe type of object, which is “payin”.
paid_in_excessbooleanIndicates if the payment was made in excess.
partially_paidbooleanIndicates if the payment was partially paid.
payment_attemptsarrayThe list of payment attempts for this transaction.
payment_method_detailsobjectThe details of the payment method used.
paynow_sgdobjectDetails of the paynow_sgd payment method
typestringThe type of payment method used (e.g., paynow_sgd).
reference_idstringThe reference ID for the transaction.
shipping_detailsobjectShipping information for the transaction.
addressobjectThe address associated with the shipping details. Address object
labelstringA label for the shipping address (e.g., Home, Office).
namestringThe name associated with the shipping details.
phoneobjectThe phone details associated with the shipping address. Phone Object
statement_descriptorstringThe descriptor to appear on the customer’s statement.
statusstringThe current status of the transaction (e.g., requires_payment_method).
status_descriptionstringA description of the transaction status, if available.
success_urlstringThe URL to redirect the user to upon a successful transaction.
transaction_dataarrayAdditional data related to the transaction.
transaction_descriptionstringA description of the transaction.
transaction_documentsarrayList of transaction-related documents.
webhook_urlstringThe URL for webhook notifications related to this transaction.