Update Checkout Session

patch

https://api-sandbox.y.uno/v1/checkout/sessions/{checkout_session}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Update an existing checkout session with this endpoint. Only fields you send will be updated.

Path Params

checkout_session

string

required

Body Params

customer_id

string

The unique identifier of the customer, created using the Create Customer endpoint (UUID, 36 chars).

merchant_order_id

string

required

The unique identifier of the customer's order (MAX 255; MIN 3).

payment_description

string

required

The description of the payment (MAX 255; MIN 3).

callback_url

string

The URL where we will redirect your customer after making the purchase. Required for alternative payment methods with redirection. (MAX 526; MIN 3)

country

string

enum

required

The customer's country (MAX 2; MIN 2; ISO 3166-1).

account_id

string

required

Defaults to {{account_id}}

The unique identifier of the account. You find this information on the Yuno dashboard (UUID, 36 chars).

amount

object

Specifies the payment amount object, with the value and currency.

alternative_amount

object

Alternative currency representation of the transaction amount.

metadata

array of objects

Specifies a list of metadata objects. You can add up to 120 metadata objects.

metadata

workflow

string

enum

Checkout workflow type.

Allowed:

installments

object

The object to send the installment plan created in Yuno to show your customers and let them choose from. This optional field is used in case a particular installments plan needs to be used in the session. if not sent, we will display the installment plan created for the account for each scenario, if any.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

401401

403403