HSRCPAY Dökümantasyon
API v1

Confirm checkout session

Submits payment method and payer data for the tokenized session.

POST
/checkout-sessions/token/{token}/confirm

Authorization

bearerAuth
AuthorizationBearer <token>

Use Authorization: Bearer <token>. The same header supports: (1) JWT access token from the configured auth provider; (2) secret API key whose value contains sk_ within the first 32 characters (e.g. sk_live_…, sk_test_…); (3) publishable key containing pk_. Sandbox keys typically include _test_ in the string; the server resolves repositories from that.

In: header

Path Parameters

token*Session token

Request Body

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.hsrcpay.com/v1/checkout-sessions/token/string/confirm" \  -H "Content-Type: application/json" \  -d '{    "payment_method": {      "type": null,      "data": {        "name": "string",        "pan": "string",        "month": "string",        "year": "string",        "cvv": "string"      }    },    "payer": {      "email": "user@example.com",      "shipping_same_as_billing": false    },    "payer_identity": {      "ip_address": null,      "user_agent": null,      "ip_address_details": null    }  }'
{
  "message": "success",
  "success": true,
  "data": {
    "object": "checkout_session",
    "id": "string",
    "account_id": "string",
    "payment_link_id": "string",
    "business_logo_url": "string",
    "business_name": "string",
    "customer_input_preset": "string",
    "status": "PENDING",
    "currency": "USD",
    "amount_mode": "FIXED",
    "fixed_amount": "string",
    "customer_input_min": "string",
    "customer_input_max": "string",
    "customer_entered_amount": "string",
    "final_amount": "string",
    "collect_address": "NONE",
    "collect_name": true,
    "collect_phone": true,
    "after_completion_type": "HOSTED_PAGE",
    "after_completion_url": "string",
    "after_completion_message": "string",
    "custom_fields_schema": [
      {
        "key": "string",
        "label": "string",
        "type": "TEXT",
        "required": true,
        "placeholder": "string",
        "property1": null,
        "property2": null
      }
    ],
    "custom_fields_values": {
      "property1": "string",
      "property2": "string"
    },
    "payer_name": "string",
    "payer_email": "string",
    "payer_phone": "string",
    "payer_ip_address": "string",
    "payer_user_agent": "string",
    "payer_locale": "string",
    "billing_address": {
      "country": "string",
      "city": "string",
      "state": "string",
      "line1": "string",
      "line2": "string",
      "zip": "string",
      "property1": null,
      "property2": null
    },
    "shipping_address": {
      "country": "string",
      "city": "string",
      "state": "string",
      "line1": "string",
      "line2": "string",
      "zip": "string",
      "property1": null,
      "property2": null
    },
    "customer_id": "string",
    "payment_id": "string",
    "expires_at": null,
    "completed_at": null,
    "cancelled_at": null,
    "created_at": null,
    "updated_at": null,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "line_items": [
      {
        "object": "checkout_session_line_item",
        "id": "string",
        "checkout_session_id": "string",
        "source_type": "CUSTOM",
        "product_id": "string",
        "price_id": "string",
        "name": "string",
        "description": "string",
        "unit_amount": "string",
        "currency": "USD",
        "quantity": 0,
        "subtotal": "string",
        "display_order": 0,
        "created_at": null,
        "property1": null,
        "property2": null
      }
    ],
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}