Payments - Session token

Version: 2.0.0 [BETA]

Create external SDK session tokens for a payment.

Request

POST /v2/payments/{payment_id}/create-external-sdk-tokens

cURL

curl --request POST \
  --url https://sandbox.hyperswitch.io/v2/payments/{payment_id}/create-external-sdk-tokens \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{}'

Authorization

Header: api-key (string) — required Publishable keys are a type of keys that can be public and have limited scope of usage.

Path parameters

• payment_id (string) — required The identifier for the payment

Body

• Content-Type: application/json

• The body is of type object.

Response

• Status: 200

• Content-Type: application/json

• Description: Payment session object created or session token was retrieved from wallets

Example response:

Response (200)

{
  "payment_id": "<string>",
  "session_token": [
    {
      "delayed_session_token": true,
      "connector": "<string>",
      "sdk_next_action": {
        "next_action": "post_session_tokens"
      },
      "wallet_name": "google_pay"
    }
  ],
  "vault_details": {
    "vgs": {
      "external_vault_id": "<string>",
      "sdk_env": "<string>"
    }
  }
}

Response fields:

• payment_id (string) — required The identifier for the payment

• session_token (object[]) — required The list of session token object

  • Option 1

  • Option 2

  • Option 3

  • Option 4

  • Option 5

  • Option 6

  • Option 7

  • Option 8

  • Option 9

  • Option 10

  • Option 11

• vault_details (object)

  • Option 1

  • Option 2

Errors

• 400 — Bad request (example status shown in original docs)

Links

• Documentation: https://api-reference.hyperswitch.io/introduction

• Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

• Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

Edit this page: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/payments/payments--session-token.mdx Raise an issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/payments/payments--session-token