Update Checkout

To update the checkout

PUT /v3/checkout/{id}

Update Checkout

cURL

curl --request PUT \
  --url https://service-sandbox.tazapay.com/v3/checkout/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
'

200

{
  "status": "success",
  "message": "checkout session updated successfully",
  "data": {
    "id": "chk_cirsp2sl4ar024j0akj0",
    "object": "checkout",
    "invoice_currency": "USD",
    "amount": 100000,
    "amount_paid": 0,
    "customer_details": {
      "country": "SG",
      "email": "[e-mail]",
      "name": "Andrea Lark",
      "phone": {
        "calling_code": "65",
        "number": "87654321"
      }
    },
    "customer": "cus_afobaifawnf",
    "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"
      }
    },
    "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"
      }
    },
    "success_url": "https://mystore.com/success_page",
    "cancel_url": "https://mystore.com/try_again",
    "webhook_url": "https://mystore.com/internal/webhook",
    "payment_methods": [
      "paynow_sgd",
      "card"
    ],
    "transaction_description": "1 x trousers",
    "expires_at": "2023-07-21T14:01:04.576356Z",
    "created_at": "2023-07-19T11:44:11.722049185Z",
    "url": "https://checkout.tazapay.com/transaction=ajfuibfainfaonfa",
    "payment_status": "unpaid",
    "payment_status_description": null,
    "status": "active",
    "payin": "chk_cirsp2sl4ar024j0akj0",
    "payment_attempts": [],
    "latest_payment_attempt": "",
    "partially_paid": false,
    "paid_in_excess": false,
    "transaction_documents": [],
    "reference_id": "mystore_order_00001",
    "metadata": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    }
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Checkout id

Body

application/json

metadata · string<json>

items · array

List of items in the invoice

Response

200 - application/json

200

status · string

Indicates the status of the API response.

message · string

Describes the result of the checkout session creation.

data · object

Contains all details related to the created checkout session.

Show child attributes