v1

latestOpenAPI 3.1.02026-07-266133267.6 KB

Updating a payin

Update a payin without confirming

put/v3/payin/{id}

idstring required

ID of the already created payin

customerstring

ID of the customer for the checkout session

success_urlstring

URL where the customer is directed to after a successful payment

cancel_urlstring

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

transaction_documentsstring json

Supporting documents for the transaction

metadatastring json

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

reference_idstring

Your unique identifier for the session

statement_descriptorstring

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_detailsstring json

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

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

200

statusstring

Indicates whether the payin creation request succeeded.

messagestring

Response message or additional context regarding the payin request.