--- title: "Updating a payin" method: PUT path: "/v3/payin/{id}" --- # Updating a payin `PUT /v3/payin/{id}` Update a payin without confirming ## Path parameters - `id` string, required ## Request body - object - `customer_details` CustomerDetails — Details about the customer - `name` string, required — Name of the customer - `email` string, required — Email address of the customer - `country` string, required — ISO 3166 standard alpha-2 code. eg: SG, IN, US, etc. - `phone` Phone — Phone contact details - `calling_code` string — Calling country code (for example, '1' for United States, '91' for India) - `number` string — Phone Number - `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` ShippingDetails — Shipping details including recipient name, address and phone - `name` string — Name of the recipient - `address` Address — Address details - `line1` string — Address Line 1 - `line2` string — Address Line 2 - `city` string — Address city - `state` string — Address state - `country` string — Address country (ISO 3166-1 alpha-2 country code) - `postal_code` string — Postal Code - `phone` Phone — Phone contact details - `calling_code` string — Calling country code (for example, '1' for United States, '91' for India) - `number` string — Phone Number - `label` string — Denotes the type of address (Example - home, work) - `billing_details` BillingDetails — Billing details including name, address and phone - `name` string — Name of the billing contact - `address` Address — Address details - `line1` string — Address Line 1 - `line2` string — Address Line 2 - `city` string — Address city - `state` string — Address state - `country` string — Address country (ISO 3166-1 alpha-2 country code) - `postal_code` string — Postal Code - `phone` Phone — Phone contact details - `calling_code` string — Calling country code (for example, '1' for United States, '91' for India) - `number` string — Phone Number - `label` string — Denotes the type of address (Example - home, work) - `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) - `reference_id` string — Your unique identifier for the session - `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 ## Response `200` 200 - object - `status` string — Indicates whether the payin creation request succeeded. - `message` string — Response message or additional context regarding the payin request. - `data` PayinData — Contains detailed information about a payin object. - `amount` integer — Total amount of the payin in cents. - `amount_paid` integer — Amount already paid by the customer toward this payin. - `billing_details` BillingDetails — Billing details including name, address and phone - `name` string — Name of the billing contact - `address` Address — Address details - `line1` string — Address Line 1 - `line2` string — Address Line 2 - `city` string — Address city - `state` string — Address state - `country` string — Address country (ISO 3166-1 alpha-2 country code) - `postal_code` string — Postal Code - `phone` Phone — Phone contact details - `calling_code` string — Calling country code (for example, '1' for United States, '91' for India) - `number` string — Phone Number - `label` string — Denotes the type of address (Example - home, work) - `cancel_url` string — URL to which the customer is redirected if they cancel the payment process. - `cancelled_at` string — Timestamp when the payin was cancelled, if applicable. - `client_token` string — Client authentication token used to confirm or validate this payin session. - `confirm` boolean — Indicates whether this payin requires explicit confirmation from the client before processing. - `created_at` string — ISO 8601 timestamp marking when the payin was created. - `customer` string — Unique identifier of the customer associated with the payin. - `customer_details` CustomerDetails — Details about the customer - `name` string, required — Name of the customer - `email` string, required — Email address of the customer - `country` string, required — ISO 3166 standard alpha-2 code. eg: SG, IN, US, etc. - `phone` Phone — Phone contact details - `calling_code` string — Calling country code (for example, '1' for United States, '91' for India) - `number` string — Phone Number - `form` string — Form data associated with the payin session. - `holding_currency` string — Currency used to hold the funds before conversion or settlement. - `id` string — Unique identifier assigned to this payin object. - `invoice_currency` string — Currency of the associated invoice. - `items` unknown[] — List of items or line-items associated with this payin (if applicable). - unknown - `latest_payment_attempt` string — Identifier of the most recent payment attempt related to this payin. - `latest_payment_attempt_data` object — Detailed data of the latest payment attempt if available. - `metadata` Metadata, nullable — Custom metadata key-value pairs attached to the object - `object` string — Object type identifier; always 'payin' for this endpoint. - `paid_in_excess` boolean — Indicates whether an amount greater than the invoiced total was received. - `partially_paid` boolean — Indicates whether the payin amount has been partially received. - `payment_attempts` unknown[] — List of all payment attempts made for this payin. - unknown - `payment_method_details` object — Information related to the selected payment method used by the payer. - `reference_id` string — External reference ID provided by the merchant for tracking purposes. - `shipping_details` ShippingDetails — Shipping details including recipient name, address and phone - `name` string — Name of the recipient - `address` Address — Address details - `line1` string — Address Line 1 - `line2` string — Address Line 2 - `city` string — Address city - `state` string — Address state - `country` string — Address country (ISO 3166-1 alpha-2 country code) - `postal_code` string — Postal Code - `phone` Phone — Phone contact details - `calling_code` string — Calling country code (for example, '1' for United States, '91' for India) - `number` string — Phone Number - `label` string — Denotes the type of address (Example - home, work) - `statement_descriptor` string — Text that appears on the customer's payment statement. - `status` string — Current status of the payin. - `status_description` string — Additional descriptive text regarding the status. - `success_url` string — URL where the customer is redirected after successful payment completion. - `transaction_data` unknown[] — List of transaction data entries associated with the payin. - unknown - `transaction_description` string — Description or label for the transaction purpose. - `transaction_documents` unknown[] — List of documents linked to the payin transaction. - unknown - `webhook_url` string — Merchant webhook endpoint for asynchronous payin updates. - `on_behalf_of` string — ID of the entity on whose behalf the payin was created. Automatically inherited from the associated checkout session when applicable. The entity must belong to the merchant account. --- [API](https://skmtc.net/tazapay/apis/sandbox.md) · [All operations](https://skmtc.net/tazapay/apis/sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tazapay/sandbox/versions/bf5f4b8f6f5d/schema)