> ## Documentation Index > Fetch the complete documentation index at: https://docs.pesaswap.io/llms.txt > Use this file to discover all available pages before exploring further. # Payments - Session token > Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by Pesaswap's SDK to initiate these wallets' SDK. ## OpenAPI ````yaml openapi_spec post /payments/session_tokens openapi: 3.0.3 info: title: Pesaswap - API Documentation description: > ## Get started Pesaswap provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. We have a testing environment referred to "sandbox", which you can setup to test API calls without affecting production data. Currently, our sandbox environment is live while our production environment is under development and will be available soon. You can sign up on our Dashboard to get API keys to access Pesaswap API. ### Environment Use the following base URLs when making requests to the APIs: | Environment | Base URL | |---------------|------------------------------------| | Sandbox | | | Production | | ## Authentication When you sign up on our [dashboard](https://app.pesaswap.io) and create a merchant account, you are given a secret key (also referred as api-key) and a publishable key. You may authenticate all API requests with Pesaswap server by providing the appropriate key in the request Authorization header. | Key | Description | |-----------------|-----------------------------------------------------------------------------------------------| | api-key | Private key. Used to authenticate all API requests from your merchant server | | publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client | Never share your secret api keys. Keep them guarded and secure. contact: name: Pesaswap Support url: https://pesaswap.io email: support@pesaswap.io license: name: Apache-2.0 version: 0.1.0 servers: - url: https://api.sandbox.pesaswap.io description: Sandbox Environment - url: https://api.pesaswap.io description: Production Environment security: [] tags: - name: Merchant Account description: Create and manage merchant accounts - name: Profile description: Create and manage profiles - name: Merchant Connector Account description: Create and manage merchant connector accounts - name: Payments description: Create and manage one-time payments, recurring payments and mandates - name: Refunds description: Create and manage refunds for successful payments - name: Mandates description: Manage mandates - name: Customers description: Create and manage customers - name: Payment Methods description: Create and manage payment methods of customers - name: Disputes description: Manage disputes - name: API Key description: Create and manage API Keys - name: Payouts description: Create and manage payouts - name: payment link description: Create payment link - name: Routing description: Create and manage routing configurations - name: Event description: Manage events paths: /payments/session_tokens: post: tags: - Payments summary: Payments - Session token description: >- Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by Pesaswap's SDK to initiate these wallets' SDK. operationId: Create Session tokens for a Payment requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentsSessionRequest' required: true responses: '200': description: >- Payment session object created or session token was retrieved from wallets content: application/json: schema: $ref: '#/components/schemas/PaymentsSessionResponse' '400': description: Missing mandatory fields security: - publishable_key: [] components: schemas: PaymentsSessionRequest: type: object required: - payment_id - client_secret - wallets properties: payment_id: type: string description: The identifier for the payment client_secret: type: string description: >- This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK wallets: type: array items: $ref: '#/components/schemas/PaymentMethodType' description: The list of the supported wallets merchant_connector_details: allOf: - $ref: '#/components/schemas/MerchantConnectorDetailsWrap' nullable: true PaymentsSessionResponse: type: object required: - payment_id - client_secret - session_token properties: payment_id: type: string description: The identifier for the payment client_secret: type: string description: >- This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK session_token: type: array items: $ref: '#/components/schemas/SessionToken' description: The list of session token object PaymentMethodType: type: string description: >- Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets. enum: - ach - affirm - afterpay_clearpay - alfamart - ali_pay - ali_pay_hk - alma - amazon_pay - apple_pay - atome - bacs - bancontact_card - becs - benefit - bizum - blik - boleto - bca_bank_transfer - bni_va - bri_va - card_redirect - cimb_va - classic - credit - crypto_currency - cashapp - dana - danamon_va - debit - duit_now - efecty - eps - fps - evoucher - giropay - givex - google_pay - go_pay - gcash - ideal - interac - indomaret - klarna - kakao_pay - local_bank_redirect - mandiri_va - knet - mb_way - mobile_pay - momo - momo_atm - multibanco - online_banking_thailand - online_banking_czech_republic - online_banking_finland - online_banking_fpx - online_banking_poland - online_banking_slovakia - oxxo - pago_efectivo - permata_bank_transfer - open_banking_uk - pay_bright - paypal - paze - pix - pay_safe_card - przelewy24 - prompt_pay - pse - red_compra - red_pagos - samsung_pay - sepa - sofort - swish - touch_n_go - trustly - twint - upi_collect - upi_intent - vipps - viet_qr - venmo - walley - we_chat_pay - seven_eleven - lawson - mini_stop - family_mart - seicomart - pay_easy - local_bank_transfer - mifinity - open_banking_pis - m_pesa_express - direct_carrier_billing MerchantConnectorDetailsWrap: type: object description: Merchant connector details used to make payments. required: - creds_identifier properties: creds_identifier: type: string description: >- Creds Identifier is to uniquely identify the credentials. Do not send any sensitive info, like encoded_data in this field. And do not send the string "null". encoded_data: allOf: - $ref: '#/components/schemas/MerchantConnectorDetails' nullable: true SessionToken: oneOf: - allOf: - $ref: '#/components/schemas/GpaySessionTokenResponse' - type: object required: - wallet_name properties: wallet_name: type: string enum: - google_pay - allOf: - $ref: '#/components/schemas/SamsungPaySessionTokenResponse' - type: object required: - wallet_name properties: wallet_name: type: string enum: - samsung_pay - allOf: - $ref: '#/components/schemas/KlarnaSessionTokenResponse' - type: object required: - wallet_name properties: wallet_name: type: string enum: - klarna - allOf: - $ref: '#/components/schemas/PaypalSessionTokenResponse' - type: object required: - wallet_name properties: wallet_name: type: string enum: - paypal - allOf: - $ref: '#/components/schemas/ApplepaySessionTokenResponse' - type: object required: - wallet_name properties: wallet_name: type: string enum: - apple_pay - allOf: - $ref: '#/components/schemas/OpenBankingSessionToken' - type: object required: - wallet_name properties: wallet_name: type: string enum: - open_banking - allOf: - $ref: '#/components/schemas/PazeSessionTokenResponse' - type: object required: - wallet_name properties: wallet_name: type: string enum: - paze - allOf: - $ref: '#/components/schemas/ClickToPaySessionResponse' - type: object required: - wallet_name properties: wallet_name: type: string enum: - click_to_pay - type: object required: - wallet_name properties: wallet_name: type: string enum: - no_session_token_received discriminator: propertyName: wallet_name MerchantConnectorDetails: type: object properties: connector_account_details: type: object description: >- Account details of the Connector. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Useful for storing additional, structured information on an object. nullable: true metadata: type: object description: >- Metadata is useful for storing additional, unstructured information on an object. nullable: true GpaySessionTokenResponse: oneOf: - $ref: '#/components/schemas/GooglePayThirdPartySdk' - $ref: '#/components/schemas/GooglePaySessionResponse' SamsungPaySessionTokenResponse: type: object required: - version - service_id - order_number - merchant - amount - protocol - allowed_brands properties: version: type: string description: Samsung Pay API version service_id: type: string description: Samsung Pay service ID to which session call needs to be made order_number: type: string description: Order number of the transaction merchant: $ref: '#/components/schemas/SamsungPayMerchantPaymentInformation' amount: $ref: '#/components/schemas/SamsungPayAmountDetails' protocol: $ref: '#/components/schemas/SamsungPayProtocolType' allowed_brands: type: array items: type: string description: List of supported card brands KlarnaSessionTokenResponse: type: object required: - session_token - session_id properties: session_token: type: string description: The session token for Klarna session_id: type: string description: The identifier for the session PaypalSessionTokenResponse: type: object required: - connector - session_token - sdk_next_action properties: connector: type: string description: Name of the connector session_token: type: string description: The session token for PayPal sdk_next_action: $ref: '#/components/schemas/SdkNextAction' ApplepaySessionTokenResponse: type: object required: - connector - delayed_session_token - sdk_next_action properties: session_token_data: allOf: - $ref: '#/components/schemas/ApplePaySessionResponse' nullable: true payment_request_data: allOf: - $ref: '#/components/schemas/ApplePayPaymentRequest' nullable: true connector: type: string description: The session token is w.r.t this connector delayed_session_token: type: boolean description: Identifier for the delayed session response sdk_next_action: $ref: '#/components/schemas/SdkNextAction' connector_reference_id: type: string description: The connector transaction id nullable: true connector_sdk_public_key: type: string description: The public key id is to invoke third party sdk nullable: true connector_merchant_id: type: string description: The connector merchant id nullable: true OpenBankingSessionToken: type: object required: - open_banking_session_token properties: open_banking_session_token: type: string description: The session token for OpenBanking Connectors PazeSessionTokenResponse: type: object required: - client_id - client_name - client_profile_id - transaction_currency_code - transaction_amount properties: client_id: type: string description: Paze Client ID client_name: type: string description: Client Name to be displayed on the Paze screen client_profile_id: type: string description: Paze Client Profile ID transaction_currency_code: $ref: '#/components/schemas/Currency' transaction_amount: type: string description: The transaction amount example: '38.02' email_address: type: string description: Email Address example: johntest@test.com nullable: true maxLength: 255 ClickToPaySessionResponse: type: object required: - dpa_id - dpa_name - locale - card_brands - acquirer_bin - acquirer_merchant_id - merchant_category_code - merchant_country_code - transaction_amount - transaction_currency_code properties: dpa_id: type: string dpa_name: type: string locale: type: string card_brands: type: array items: type: string acquirer_bin: type: string acquirer_merchant_id: type: string merchant_category_code: type: string merchant_country_code: type: string transaction_amount: type: string example: '38.02' transaction_currency_code: $ref: '#/components/schemas/Currency' phone_number: type: string example: '9123456789' nullable: true maxLength: 255 email: type: string example: johntest@test.com nullable: true maxLength: 255 phone_country_code: type: string nullable: true GooglePayThirdPartySdk: type: object required: - delayed_session_token - connector - sdk_next_action properties: delayed_session_token: type: boolean description: Identifier for the delayed session response connector: type: string description: The name of the connector sdk_next_action: $ref: '#/components/schemas/SdkNextAction' GooglePaySessionResponse: type: object required: - merchant_info - shipping_address_required - email_required - shipping_address_parameters - allowed_payment_methods - transaction_info - delayed_session_token - connector - sdk_next_action properties: merchant_info: $ref: '#/components/schemas/GpayMerchantInfo' shipping_address_required: type: boolean description: Is shipping address required email_required: type: boolean description: Is email required shipping_address_parameters: $ref: '#/components/schemas/GpayShippingAddressParameters' allowed_payment_methods: type: array items: $ref: '#/components/schemas/GpayAllowedPaymentMethods' description: List of the allowed payment meythods transaction_info: $ref: '#/components/schemas/GpayTransactionInfo' delayed_session_token: type: boolean description: Identifier for the delayed session response connector: type: string description: The name of the connector sdk_next_action: $ref: '#/components/schemas/SdkNextAction' secrets: allOf: - $ref: '#/components/schemas/SecretInfoToInitiateSdk' nullable: true SamsungPayMerchantPaymentInformation: type: object required: - name - country_code properties: name: type: string description: Merchant name, this will be displayed on the Samsung Pay screen url: type: string description: Merchant domain that process payments, required for web payments nullable: true country_code: $ref: '#/components/schemas/CountryAlpha2' SamsungPayAmountDetails: type: object required: - option - currency_code - total properties: option: $ref: '#/components/schemas/SamsungPayAmountFormat' currency_code: $ref: '#/components/schemas/Currency' total: type: string description: The total amount of the transaction example: '38.02' SamsungPayProtocolType: type: string enum: - PROTOCOL3DS SdkNextAction: type: object required: - next_action properties: next_action: $ref: '#/components/schemas/NextActionCall' ApplePaySessionResponse: oneOf: - $ref: '#/components/schemas/ThirdPartySdkSessionResponse' - $ref: '#/components/schemas/NoThirdPartySdkSessionResponse' - type: object default: null nullable: true ApplePayPaymentRequest: type: object required: - country_code - currency_code - total properties: country_code: $ref: '#/components/schemas/CountryAlpha2' currency_code: $ref: '#/components/schemas/Currency' total: $ref: '#/components/schemas/AmountInfo' merchant_capabilities: type: array items: type: string description: >- The list of merchant capabilities(ex: whether capable of 3ds or no-3ds) nullable: true supported_networks: type: array items: type: string description: The list of supported networks nullable: true merchant_identifier: type: string nullable: true required_billing_contact_fields: allOf: - $ref: '#/components/schemas/ApplePayBillingContactFields' nullable: true required_shipping_contact_fields: allOf: - $ref: '#/components/schemas/ApplePayShippingContactFields' nullable: true recurring_payment_request: allOf: - $ref: '#/components/schemas/ApplePayRecurringPaymentRequest' nullable: true Currency: type: string description: >- The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar. enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL GpayMerchantInfo: type: object required: - merchant_name properties: merchant_id: type: string description: >- The merchant Identifier that needs to be passed while invoking Gpay SDK nullable: true merchant_name: type: string description: The name of the merchant that needs to be displayed on Gpay PopUp GpayShippingAddressParameters: type: object required: - phone_number_required properties: phone_number_required: type: boolean description: Is shipping phone number required GpayAllowedPaymentMethods: type: object required: - type - parameters - tokenization_specification properties: type: type: string description: The type of payment method parameters: $ref: '#/components/schemas/GpayAllowedMethodsParameters' tokenization_specification: $ref: '#/components/schemas/GpayTokenizationSpecification' GpayTransactionInfo: type: object required: - country_code - currency_code - total_price_status - total_price properties: country_code: $ref: '#/components/schemas/CountryAlpha2' currency_code: $ref: '#/components/schemas/Currency' total_price_status: type: string description: 'The total price status (ex: ''FINAL'')' total_price: type: string description: The total price example: '38.02' SecretInfoToInitiateSdk: type: object required: - display - payment properties: display: type: string payment: type: string CountryAlpha2: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - US SamsungPayAmountFormat: type: string enum: - FORMAT_TOTAL_PRICE_ONLY - FORMAT_TOTAL_ESTIMATED_AMOUNT NextActionCall: type: string enum: - post_session_tokens - confirm - sync - complete_authorize ThirdPartySdkSessionResponse: type: object required: - secrets properties: secrets: $ref: '#/components/schemas/SecretInfoToInitiateSdk' NoThirdPartySdkSessionResponse: type: object required: - epoch_timestamp - expires_at - merchant_session_identifier - nonce - merchant_identifier - domain_name - display_name - signature - operational_analytics_identifier - retries - psp_id properties: epoch_timestamp: type: integer format: int64 description: Timestamp at which session is requested minimum: 0 expires_at: type: integer format: int64 description: Timestamp at which session expires minimum: 0 merchant_session_identifier: type: string description: The identifier for the merchant session nonce: type: string description: Apple pay generated unique ID (UUID) value merchant_identifier: type: string description: The identifier for the merchant domain_name: type: string description: The domain name of the merchant which is registered in Apple Pay display_name: type: string description: The name to be displayed on Apple Pay button signature: type: string description: A string which represents the properties of a payment operational_analytics_identifier: type: string description: The identifier for the operational analytics retries: type: integer format: int32 description: The number of retries to get the session response minimum: 0 psp_id: type: string description: The identifier for the connector transaction AmountInfo: type: object required: - label - amount properties: label: type: string description: The label must be the name of the merchant. type: type: string description: >- A value that indicates whether the line item(Ex: total, tax, discount, or grand total) is final or pending. nullable: true amount: type: string description: 'The total amount for the payment in majot unit string (Ex: 38.02)' example: '38.02' ApplePayBillingContactFields: type: array items: $ref: '#/components/schemas/ApplePayAddressParameters' ApplePayShippingContactFields: type: array items: $ref: '#/components/schemas/ApplePayAddressParameters' ApplePayRecurringPaymentRequest: type: object required: - payment_description - regular_billing - management_u_r_l properties: payment_description: type: string description: >- A description of the recurring payment that Apple Pay displays to the user in the payment sheet regular_billing: $ref: '#/components/schemas/ApplePayRegularBillingRequest' billing_agreement: type: string description: >- A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment nullable: true management_u_r_l: type: string description: >- A URL to a web page where the user can update or delete the payment method for the recurring payment example: https://pesaswap.io GpayAllowedMethodsParameters: type: object required: - allowed_auth_methods - allowed_card_networks properties: allowed_auth_methods: type: array items: type: string description: 'The list of allowed auth methods (ex: 3DS, No3DS, PAN_ONLY etc)' allowed_card_networks: type: array items: type: string description: 'The list of allowed card networks (ex: AMEX,JCB etc)' billing_address_required: type: boolean description: Is billing address required nullable: true billing_address_parameters: allOf: - $ref: '#/components/schemas/GpayBillingAddressParameters' nullable: true assurance_details_required: type: boolean description: Whether assurance details are required nullable: true GpayTokenizationSpecification: type: object required: - type - parameters properties: type: type: string description: 'The token specification type(ex: PAYMENT_GATEWAY)' parameters: $ref: '#/components/schemas/GpayTokenParameters' ApplePayAddressParameters: type: string enum: - postalAddress - phone - email ApplePayRegularBillingRequest: type: object required: - amount - label - payment_timing properties: amount: type: string description: The amount of the recurring payment example: '38.02' label: type: string description: >- The label that Apple Pay displays to the user in the payment sheet with the recurring details payment_timing: $ref: '#/components/schemas/ApplePayPaymentTiming' recurring_payment_start_date: type: string format: date-time description: The date of the first payment nullable: true recurring_payment_end_date: type: string format: date-time description: The date of the final payment nullable: true recurring_payment_interval_unit: allOf: - $ref: '#/components/schemas/RecurringPaymentIntervalUnit' nullable: true recurring_payment_interval_count: type: integer format: int32 description: The number of interval units that make up the total payment interval nullable: true GpayBillingAddressParameters: type: object required: - phone_number_required - format properties: phone_number_required: type: boolean description: Is billing phone number required format: $ref: '#/components/schemas/GpayBillingAddressFormat' GpayTokenParameters: type: object required: - gateway properties: gateway: type: string description: The name of the connector gateway_merchant_id: type: string description: The merchant ID registered in the connector associated nullable: true stripe:version: type: string nullable: true stripe:publishableKey: type: string nullable: true ApplePayPaymentTiming: type: string enum: - immediate - recurring RecurringPaymentIntervalUnit: type: string enum: - year - month - day - hour - minute GpayBillingAddressFormat: type: string enum: - FULL - MIN securitySchemes: publishable_key: type: apiKey in: header name: api-key description: >- Publishable keys are a type of keys that can be public and have limited scope of usage. ````