--- title: "POST /get_smart_token" method: POST path: "/get_smart_token" tags: ["Orders"] --- # POST /get_smart_token `POST /get_smart_token` A secure_smart_token is a unique string of encrypted data values that authenticate PayNearMe orders within your app or website that is running the [Embedded Client](https://apidocs.paynearme.com/devdocs/docs/embedded-client-for-consumers). The button used to invoke the PayNearMe JS Library requires a Smart Token to initialize the timed session within the iframe. Smart Tokens can be configured at the Site level to expire after a set amount of time or can remain the same for the duration of the order’s lifetime.

How you generate Smart Tokens will depend on how you configure orders. If consumers will be making payments at the time of order generation, use the [/create_order](https://apidocs.paynearme.com/devdocs/reference/post_create-order) call. If payments will be made after order generation, use the /get_smart_token call to regenerate an expired token for an existing order. A typical implementation uses the /get_smart_token call after creating orders via bulk upload. To regenerate the Smart Token for a specific order, use one of the following values:

Configuring the Smart Link

The encrypted Smart Link URL (i.e., secure_smart_link) returned in the [/create_order](https://apidocs.paynearme.com/devdocs/reference/post_create-order), [/find_order](https://apidocs.paynearme.com/devdocs/reference/post_find-orders), and [/get_smart_token](https://apidocs.paynearme.com/devdocs/reference/post_get-smart-token) API responses contains all the consumer data passed in with the order and will display all payment types configured for the merchant site. To enforce specific flows or define specific redirect URLs, use the /get_smart_token call to customize the behavior of the Smart Link. For more information on configuring an encrypted Smart Link see [Customizing the Secure Smart Link](https://apidocs.paynearme.com/devdocs/docs/customizing-the-secure-smart-link). Use the following parameters to put the consumer in a specific payment flow in the Embedded Client:To enforce a fixed, uneditable payment amount, include the payment_amount parameter along with the payment_field_fixed=true parameter.

To specify an expiration date for the Smart Link or return URLs for specific outcomes that can occur in the Embedded Client (e.g., errors, link expiration, etc.), use the following parameters:

Guaranteed ACH

Gaming Operators on the [PayNearMe for iGaming](https://apidocs.paynearme.com/devdocs/docs/igaming-overview) platform can use the /get_smart_token call to initiate Guaranteed ACH transactions using Trustly. To initiate a Guaranteed ACH transaction, include the following parameters along with the other required parameters for /get_smart_token calls:
For more information on PayNearMe's Guaranteed ACH solution, see the [Guaranteed ACH](https://apidocs.paynearme.com/devdocs/docs/guaranteed-ach) guide. ## Request body - union — Regenerate an order's Smart Token using the order identifiers, customer identifiers, or orders created by a specific creator identifier. - object - `site_identifier` string, required — Identifies your client site. - `timestamp` string, required — The Unix Epoch time of the call - `version` string, required — The version of the API. This version must match the version associated with your API key pair. - `signature` string, required — The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm. - `flow_debit` boolean — Indicates whether to include a debit card payment flow in the UI. - `flow_credit` boolean — Indicates whether to include a credit card payment flow in the UI. - `flow_ach` boolean — Indicates whether to include the bank account payment flow in the UI. - `flow_retailer` boolean — Indicates whether to include the cash payment flow in the UI. - `flow_apple_pay` boolean — Indicates whether to include the Apple Pay payment flow in the UI. - `flow_google_pay` boolean — Indicates whether to include the Google Pay payment flow in the UI. - `flow_paypal` boolean — Indicates whether to include the PayPal payment flow in the UI. - `flow_venmo` boolean — Indicates whether to include the Venmo payment flow in the UI. - `flow_pin4` boolean — Indicates whether to include the Pin4 disbursement flow in the UI. - `flow_push_debit` boolean — Indicates whether to include the debit disbursement flow in the UI. - `flow_push_ach` boolean — Indicates whether to include the bank account disbursement flow in the UI. - `flow_cash_app` boolean — Indicates whether to include the Cash App payment flow in the UI. - `flow_push_paypal` boolean — Indicates whether to include the PayPal disbursement flow in the UI. - `flow_secure_all` boolean — Indicates whether to display all payment types available for your Merchant site. - `payment_amount` string — Enables clients to add a suggested payment amount for the order. Use with payment_field_fixed=true to enforce a fixed amount that cannot be modified. - `payment_field_fixed` boolean — When true (with payment_amount), the payment amount is fixed and cannot be changed by the consumer. When false, payment_amount is prefilled in the **Payment Amount** field of the Consumer Portal or Embedded Client and may be edited. - `flow_edit_schedule` boolean — Gives the consumer the ability to cancel the Autopay schedule associated with the order. - `flow_tokenize` boolean — Indicates whether to include the tokenize flow in the UI. - `flow_show_all_ppas` boolean — Indicates whether to show all payment methods created for the order, regardless of which browser the consumer used to tokenize the payment methods (i.e., removes cookie restrictions enforced by the different browsers) - `flow_hide_saved_payment_methods` boolean — When set to true, this setting hides existing, previously tokenized payment methods for all actions (i.e., pay, withdrawal, tokenize, and auto_pay). When set to false, this setting shows all previously tokenized payment methods for all actions. When unset or nil, the Embedded Client will hide saved payment methods for the tokenize action and show saved payment methods for the pay and withdrawal actions. - `link_lifetime_seconds` integer — Defines the number of seconds the Smart Link (i.e., secure_smart_link) will be active and accessible before expiring. In the event of expiration, the merchant will need to regenerate the smart token by making another /get_smart_token call. - `flow_pay_url` string — The URL that displays after a successful payment is made. - `flow_no_pay_url` string — The URL that displays when no payment is made. - `flow_add_url` string — The URL that displays after a payment method has been captured, tokenized, and successfully added to a consumer’s account. - `flow_no_add_url` string — The URL that displays when a payment type is not captured and tokenized. - `flow_return_url` string — The URL that displays when the payment or tokenization flow completes. - `flow_expired_url` string — The URL that displays when the consumer attempts to access an expired Smart Link URL. - `flow_error_url` string — The URL that displays when an error occurs in the payment or tokenization flow. - `flow_venmo_return_url` string — The URL that displays after completing a Venmo payment. - `short_order_url` boolean — If set to true, PayNearMe returns a shortened Order Tracking URL in the response. - `flow_trustly` boolean — Indicates whether to include a guaranteed ACH payment method via Trustly. - `ext_customer_enrollment_date` string — Records the date of the consumer's first transaction with the client in YYYY-MM-DD format. - `ext_customer_date_of_birth_pii` string — Records the consumer's birth date in YYYY-MM-DD format. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `ext_customer_tax_id_pii` string — Records the consumer’s Social Security Number or other Tax ID. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `flow_bank_oauth_redirect_url` string — Indicates the URL where consumers should be redirected to when logging into native bank applications that use OAuth login authorization flows. Rather than having to remember and type in a password in a new browser window, OAuth logins enable consumers to log in via the banking app on their phone using saved passwords or biometric authentication (like FaceID or fingerprints). For the Embedded Client, this link should redirect players back to the “Complete Your Payment Details” screen. - `flow_trustly_reconnect` string — Identifies the payment method the client wants to reauthorize for a guaranteed ACH payment. This parameter should only be included when a bank revokes a previously authorized payment method. See the [Handling an Expired Bank Authorization](https://apidocs.paynearme.com/devdocs/docs/guaranteed-ach#handling-an-expired-bank-authorization) for more information. - `pnm_order_identifier` string, required — The unique, PayNearMe-defined identifier for this order - object - `site_identifier` string, required — Identifies your client site. - `timestamp` string, required — The Unix Epoch time of the call - `version` string, required — The version of the API. This version must match the version associated with your API key pair. - `signature` string, required — The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm. - `flow_debit` boolean — Indicates whether to include a debit card payment flow in the UI. - `flow_credit` boolean — Indicates whether to include a credit card payment flow in the UI. - `flow_ach` boolean — Indicates whether to include the bank account payment flow in the UI. - `flow_retailer` boolean — Indicates whether to include the cash payment flow in the UI. - `flow_apple_pay` boolean — Indicates whether to include the Apple Pay payment flow in the UI. - `flow_google_pay` boolean — Indicates whether to include the Google Pay payment flow in the UI. - `flow_paypal` boolean — Indicates whether to include the PayPal payment flow in the UI. - `flow_venmo` boolean — Indicates whether to include the Venmo payment flow in the UI. - `flow_pin4` boolean — Indicates whether to include the Pin4 disbursement flow in the UI. - `flow_push_debit` boolean — Indicates whether to include the debit disbursement flow in the UI. - `flow_push_ach` boolean — Indicates whether to include the bank account disbursement flow in the UI. - `flow_cash_app` boolean — Indicates whether to include the Cash App payment flow in the UI. - `flow_push_paypal` boolean — Indicates whether to include the PayPal disbursement flow in the UI. - `flow_secure_all` boolean — Indicates whether to display all payment types available for your Merchant site. - `payment_amount` string — Enables clients to add a suggested payment amount for the order. Use with payment_field_fixed=true to enforce a fixed amount that cannot be modified. - `payment_field_fixed` boolean — When true (with payment_amount), the payment amount is fixed and cannot be changed by the consumer. When false, payment_amount is prefilled in the **Payment Amount** field of the Consumer Portal or Embedded Client and may be edited. - `flow_edit_schedule` boolean — Gives the consumer the ability to cancel the Autopay schedule associated with the order. - `flow_tokenize` boolean — Indicates whether to include the tokenize flow in the UI. - `flow_show_all_ppas` boolean — Indicates whether to show all payment methods created for the order, regardless of which browser the consumer used to tokenize the payment methods (i.e., removes cookie restrictions enforced by the different browsers) - `flow_hide_saved_payment_methods` boolean — When set to true, this setting hides existing, previously tokenized payment methods for all actions (i.e., pay, withdrawal, tokenize, and auto_pay). When set to false, this setting shows all previously tokenized payment methods for all actions. When unset or nil, the Embedded Client will hide saved payment methods for the tokenize action and show saved payment methods for the pay and withdrawal actions. - `link_lifetime_seconds` integer — Defines the number of seconds the Smart Link (i.e., secure_smart_link) will be active and accessible before expiring. In the event of expiration, the merchant will need to regenerate the smart token by making another /get_smart_token call. - `flow_pay_url` string — The URL that displays after a successful payment is made. - `flow_no_pay_url` string — The URL that displays when no payment is made. - `flow_add_url` string — The URL that displays after a payment method has been captured, tokenized, and successfully added to a consumer’s account. - `flow_no_add_url` string — The URL that displays when a payment type is not captured and tokenized. - `flow_return_url` string — The URL that displays when the payment or tokenization flow completes. - `flow_expired_url` string — The URL that displays when the consumer attempts to access an expired Smart Link URL. - `flow_error_url` string — The URL that displays when an error occurs in the payment or tokenization flow. - `flow_venmo_return_url` string — The URL that displays after completing a Venmo payment. - `short_order_url` boolean — If set to true, PayNearMe returns a shortened Order Tracking URL in the response. - `flow_trustly` boolean — Indicates whether to include a guaranteed ACH payment method via Trustly. - `ext_customer_enrollment_date` string — Records the date of the consumer's first transaction with the client in YYYY-MM-DD format. - `ext_customer_date_of_birth_pii` string — Records the consumer's birth date in YYYY-MM-DD format. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `ext_customer_tax_id_pii` string — Records the consumer’s Social Security Number or other Tax ID. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `flow_bank_oauth_redirect_url` string — Indicates the URL where consumers should be redirected to when logging into native bank applications that use OAuth login authorization flows. Rather than having to remember and type in a password in a new browser window, OAuth logins enable consumers to log in via the banking app on their phone using saved passwords or biometric authentication (like FaceID or fingerprints). For the Embedded Client, this link should redirect players back to the “Complete Your Payment Details” screen. - `flow_trustly_reconnect` string — Identifies the payment method the client wants to reauthorize for a guaranteed ACH payment. This parameter should only be included when a bank revokes a previously authorized payment method. See the [Handling an Expired Bank Authorization](https://apidocs.paynearme.com/devdocs/docs/guaranteed-ach#handling-an-expired-bank-authorization) for more information. - `site_order_identifier` string, required — An arbitrary string that the client uses to refer to an order - object - `site_identifier` string, required — Identifies your client site. - `timestamp` string, required — The Unix Epoch time of the call - `version` string, required — The version of the API. This version must match the version associated with your API key pair. - `signature` string, required — The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm. - `flow_debit` boolean — Indicates whether to include a debit card payment flow in the UI. - `flow_credit` boolean — Indicates whether to include a credit card payment flow in the UI. - `flow_ach` boolean — Indicates whether to include the bank account payment flow in the UI. - `flow_retailer` boolean — Indicates whether to include the cash payment flow in the UI. - `flow_apple_pay` boolean — Indicates whether to include the Apple Pay payment flow in the UI. - `flow_google_pay` boolean — Indicates whether to include the Google Pay payment flow in the UI. - `flow_paypal` boolean — Indicates whether to include the PayPal payment flow in the UI. - `flow_venmo` boolean — Indicates whether to include the Venmo payment flow in the UI. - `flow_pin4` boolean — Indicates whether to include the Pin4 disbursement flow in the UI. - `flow_push_debit` boolean — Indicates whether to include the debit disbursement flow in the UI. - `flow_push_ach` boolean — Indicates whether to include the bank account disbursement flow in the UI. - `flow_cash_app` boolean — Indicates whether to include the Cash App payment flow in the UI. - `flow_push_paypal` boolean — Indicates whether to include the PayPal disbursement flow in the UI. - `flow_secure_all` boolean — Indicates whether to display all payment types available for your Merchant site. - `payment_amount` string — Enables clients to add a suggested payment amount for the order. Use with payment_field_fixed=true to enforce a fixed amount that cannot be modified. - `payment_field_fixed` boolean — When true (with payment_amount), the payment amount is fixed and cannot be changed by the consumer. When false, payment_amount is prefilled in the **Payment Amount** field of the Consumer Portal or Embedded Client and may be edited. - `flow_edit_schedule` boolean — Gives the consumer the ability to cancel the Autopay schedule associated with the order. - `flow_tokenize` boolean — Indicates whether to include the tokenize flow in the UI. - `flow_show_all_ppas` boolean — Indicates whether to show all payment methods created for the order, regardless of which browser the consumer used to tokenize the payment methods (i.e., removes cookie restrictions enforced by the different browsers) - `flow_hide_saved_payment_methods` boolean — When set to true, this setting hides existing, previously tokenized payment methods for all actions (i.e., pay, withdrawal, tokenize, and auto_pay). When set to false, this setting shows all previously tokenized payment methods for all actions. When unset or nil, the Embedded Client will hide saved payment methods for the tokenize action and show saved payment methods for the pay and withdrawal actions. - `link_lifetime_seconds` integer — Defines the number of seconds the Smart Link (i.e., secure_smart_link) will be active and accessible before expiring. In the event of expiration, the merchant will need to regenerate the smart token by making another /get_smart_token call. - `flow_pay_url` string — The URL that displays after a successful payment is made. - `flow_no_pay_url` string — The URL that displays when no payment is made. - `flow_add_url` string — The URL that displays after a payment method has been captured, tokenized, and successfully added to a consumer’s account. - `flow_no_add_url` string — The URL that displays when a payment type is not captured and tokenized. - `flow_return_url` string — The URL that displays when the payment or tokenization flow completes. - `flow_expired_url` string — The URL that displays when the consumer attempts to access an expired Smart Link URL. - `flow_error_url` string — The URL that displays when an error occurs in the payment or tokenization flow. - `flow_venmo_return_url` string — The URL that displays after completing a Venmo payment. - `short_order_url` boolean — If set to true, PayNearMe returns a shortened Order Tracking URL in the response. - `flow_trustly` boolean — Indicates whether to include a guaranteed ACH payment method via Trustly. - `ext_customer_enrollment_date` string — Records the date of the consumer's first transaction with the client in YYYY-MM-DD format. - `ext_customer_date_of_birth_pii` string — Records the consumer's birth date in YYYY-MM-DD format. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `ext_customer_tax_id_pii` string — Records the consumer’s Social Security Number or other Tax ID. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `flow_bank_oauth_redirect_url` string — Indicates the URL where consumers should be redirected to when logging into native bank applications that use OAuth login authorization flows. Rather than having to remember and type in a password in a new browser window, OAuth logins enable consumers to log in via the banking app on their phone using saved passwords or biometric authentication (like FaceID or fingerprints). For the Embedded Client, this link should redirect players back to the “Complete Your Payment Details” screen. - `flow_trustly_reconnect` string — Identifies the payment method the client wants to reauthorize for a guaranteed ACH payment. This parameter should only be included when a bank revokes a previously authorized payment method. See the [Handling an Expired Bank Authorization](https://apidocs.paynearme.com/devdocs/docs/guaranteed-ach#handling-an-expired-bank-authorization) for more information. - `pnm_customer_identifier` string, required — A unique PNM-defined ID for the consumer. - object - `site_identifier` string, required — Identifies your client site. - `timestamp` string, required — The Unix Epoch time of the call - `version` string, required — The version of the API. This version must match the version associated with your API key pair. - `signature` string, required — The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm. - `flow_debit` boolean — Indicates whether to include a debit card payment flow in the UI. - `flow_credit` boolean — Indicates whether to include a credit card payment flow in the UI. - `flow_ach` boolean — Indicates whether to include the bank account payment flow in the UI. - `flow_retailer` boolean — Indicates whether to include the cash payment flow in the UI. - `flow_apple_pay` boolean — Indicates whether to include the Apple Pay payment flow in the UI. - `flow_google_pay` boolean — Indicates whether to include the Google Pay payment flow in the UI. - `flow_paypal` boolean — Indicates whether to include the PayPal payment flow in the UI. - `flow_venmo` boolean — Indicates whether to include the Venmo payment flow in the UI. - `flow_pin4` boolean — Indicates whether to include the Pin4 disbursement flow in the UI. - `flow_push_debit` boolean — Indicates whether to include the debit disbursement flow in the UI. - `flow_push_ach` boolean — Indicates whether to include the bank account disbursement flow in the UI. - `flow_cash_app` boolean — Indicates whether to include the Cash App payment flow in the UI. - `flow_push_paypal` boolean — Indicates whether to include the PayPal disbursement flow in the UI. - `flow_secure_all` boolean — Indicates whether to display all payment types available for your Merchant site. - `payment_amount` string — Enables clients to add a suggested payment amount for the order. Use with payment_field_fixed=true to enforce a fixed amount that cannot be modified. - `payment_field_fixed` boolean — When true (with payment_amount), the payment amount is fixed and cannot be changed by the consumer. When false, payment_amount is prefilled in the **Payment Amount** field of the Consumer Portal or Embedded Client and may be edited. - `flow_edit_schedule` boolean — Gives the consumer the ability to cancel the Autopay schedule associated with the order. - `flow_tokenize` boolean — Indicates whether to include the tokenize flow in the UI. - `flow_show_all_ppas` boolean — Indicates whether to show all payment methods created for the order, regardless of which browser the consumer used to tokenize the payment methods (i.e., removes cookie restrictions enforced by the different browsers) - `flow_hide_saved_payment_methods` boolean — When set to true, this setting hides existing, previously tokenized payment methods for all actions (i.e., pay, withdrawal, tokenize, and auto_pay). When set to false, this setting shows all previously tokenized payment methods for all actions. When unset or nil, the Embedded Client will hide saved payment methods for the tokenize action and show saved payment methods for the pay and withdrawal actions. - `link_lifetime_seconds` integer — Defines the number of seconds the Smart Link (i.e., secure_smart_link) will be active and accessible before expiring. In the event of expiration, the merchant will need to regenerate the smart token by making another /get_smart_token call. - `flow_pay_url` string — The URL that displays after a successful payment is made. - `flow_no_pay_url` string — The URL that displays when no payment is made. - `flow_add_url` string — The URL that displays after a payment method has been captured, tokenized, and successfully added to a consumer’s account. - `flow_no_add_url` string — The URL that displays when a payment type is not captured and tokenized. - `flow_return_url` string — The URL that displays when the payment or tokenization flow completes. - `flow_expired_url` string — The URL that displays when the consumer attempts to access an expired Smart Link URL. - `flow_error_url` string — The URL that displays when an error occurs in the payment or tokenization flow. - `flow_venmo_return_url` string — The URL that displays after completing a Venmo payment. - `short_order_url` boolean — If set to true, PayNearMe returns a shortened Order Tracking URL in the response. - `flow_trustly` boolean — Indicates whether to include a guaranteed ACH payment method via Trustly. - `ext_customer_enrollment_date` string — Records the date of the consumer's first transaction with the client in YYYY-MM-DD format. - `ext_customer_date_of_birth_pii` string — Records the consumer's birth date in YYYY-MM-DD format. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `ext_customer_tax_id_pii` string — Records the consumer’s Social Security Number or other Tax ID. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `flow_bank_oauth_redirect_url` string — Indicates the URL where consumers should be redirected to when logging into native bank applications that use OAuth login authorization flows. Rather than having to remember and type in a password in a new browser window, OAuth logins enable consumers to log in via the banking app on their phone using saved passwords or biometric authentication (like FaceID or fingerprints). For the Embedded Client, this link should redirect players back to the “Complete Your Payment Details” screen. - `flow_trustly_reconnect` string — Identifies the payment method the client wants to reauthorize for a guaranteed ACH payment. This parameter should only be included when a bank revokes a previously authorized payment method. See the [Handling an Expired Bank Authorization](https://apidocs.paynearme.com/devdocs/docs/guaranteed-ach#handling-an-expired-bank-authorization) for more information. - `site_customer_identifier` string, required — A unique, client-defined ID for the consumer. - object - `site_identifier` string, required — Identifies your client site. - `timestamp` string, required — The Unix Epoch time of the call - `version` string, required — The version of the API. This version must match the version associated with your API key pair. - `signature` string, required — The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm. - `flow_debit` boolean — Indicates whether to include a debit card payment flow in the UI. - `flow_credit` boolean — Indicates whether to include a credit card payment flow in the UI. - `flow_ach` boolean — Indicates whether to include the bank account payment flow in the UI. - `flow_retailer` boolean — Indicates whether to include the cash payment flow in the UI. - `flow_apple_pay` boolean — Indicates whether to include the Apple Pay payment flow in the UI. - `flow_google_pay` boolean — Indicates whether to include the Google Pay payment flow in the UI. - `flow_paypal` boolean — Indicates whether to include the PayPal payment flow in the UI. - `flow_venmo` boolean — Indicates whether to include the Venmo payment flow in the UI. - `flow_pin4` boolean — Indicates whether to include the Pin4 disbursement flow in the UI. - `flow_push_debit` boolean — Indicates whether to include the debit disbursement flow in the UI. - `flow_push_ach` boolean — Indicates whether to include the bank account disbursement flow in the UI. - `flow_cash_app` boolean — Indicates whether to include the Cash App payment flow in the UI. - `flow_push_paypal` boolean — Indicates whether to include the PayPal disbursement flow in the UI. - `flow_secure_all` boolean — Indicates whether to display all payment types available for your Merchant site. - `payment_amount` string — Enables clients to add a suggested payment amount for the order. Use with payment_field_fixed=true to enforce a fixed amount that cannot be modified. - `payment_field_fixed` boolean — When true (with payment_amount), the payment amount is fixed and cannot be changed by the consumer. When false, payment_amount is prefilled in the **Payment Amount** field of the Consumer Portal or Embedded Client and may be edited. - `flow_edit_schedule` boolean — Gives the consumer the ability to cancel the Autopay schedule associated with the order. - `flow_tokenize` boolean — Indicates whether to include the tokenize flow in the UI. - `flow_show_all_ppas` boolean — Indicates whether to show all payment methods created for the order, regardless of which browser the consumer used to tokenize the payment methods (i.e., removes cookie restrictions enforced by the different browsers) - `flow_hide_saved_payment_methods` boolean — When set to true, this setting hides existing, previously tokenized payment methods for all actions (i.e., pay, withdrawal, tokenize, and auto_pay). When set to false, this setting shows all previously tokenized payment methods for all actions. When unset or nil, the Embedded Client will hide saved payment methods for the tokenize action and show saved payment methods for the pay and withdrawal actions. - `link_lifetime_seconds` integer — Defines the number of seconds the Smart Link (i.e., secure_smart_link) will be active and accessible before expiring. In the event of expiration, the merchant will need to regenerate the smart token by making another /get_smart_token call. - `flow_pay_url` string — The URL that displays after a successful payment is made. - `flow_no_pay_url` string — The URL that displays when no payment is made. - `flow_add_url` string — The URL that displays after a payment method has been captured, tokenized, and successfully added to a consumer’s account. - `flow_no_add_url` string — The URL that displays when a payment type is not captured and tokenized. - `flow_return_url` string — The URL that displays when the payment or tokenization flow completes. - `flow_expired_url` string — The URL that displays when the consumer attempts to access an expired Smart Link URL. - `flow_error_url` string — The URL that displays when an error occurs in the payment or tokenization flow. - `flow_venmo_return_url` string — The URL that displays after completing a Venmo payment. - `short_order_url` boolean — If set to true, PayNearMe returns a shortened Order Tracking URL in the response. - `flow_trustly` boolean — Indicates whether to include a guaranteed ACH payment method via Trustly. - `ext_customer_enrollment_date` string — Records the date of the consumer's first transaction with the client in YYYY-MM-DD format. - `ext_customer_date_of_birth_pii` string — Records the consumer's birth date in YYYY-MM-DD format. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `ext_customer_tax_id_pii` string — Records the consumer’s Social Security Number or other Tax ID. NOTE: Parameters suffixed with _pii contain personal identifying information (PII). PayNearMe encrypts parameter values containing PII before storing and only returns specific and/or redacted information in the response. - `flow_bank_oauth_redirect_url` string — Indicates the URL where consumers should be redirected to when logging into native bank applications that use OAuth login authorization flows. Rather than having to remember and type in a password in a new browser window, OAuth logins enable consumers to log in via the banking app on their phone using saved passwords or biometric authentication (like FaceID or fingerprints). For the Embedded Client, this link should redirect players back to the “Complete Your Payment Details” screen. - `flow_trustly_reconnect` string — Identifies the payment method the client wants to reauthorize for a guaranteed ACH payment. This parameter should only be included when a bank revokes a previously authorized payment method. See the [Handling an Expired Bank Authorization](https://apidocs.paynearme.com/devdocs/docs/guaranteed-ach#handling-an-expired-bank-authorization) for more information. - `site_creator_identifier` string, required — A unique, client-defined ID for the agent/process that created the order. ## Response `201` Smart Token Regenerated - GetSmartTokenResponse — Provides the results of an Get Smart Token request. - `status` string — The status of the request call. - `orders` OrdersGetSmartTokenResponse[] - `pnm_order_identifier` string — The PayNearMe-created ID for the order. - `site_order_identifier` string — An arbitrary string that the client uses to refer to an order. - `secure_smart_token` string — A unique string of encrypted data values that authenticate PayNearMe orders within your app or website that is running the [Embedded Client](https://paynearme-enterprise-group.readme.io/paynearme-devdocs/docs/overview) - `secure_smart_link` string — The URL of the order using the secure_smart_token (This parameter is only used with Embedded Client integrations). - `order_tracking_url` string — The URL of the order where consumers can access the Consumer Portal to make payments. - `short_order_url` string — The shortened Order Tracking URL. --- [API](https://skmtc.net/paynearme/apis/paynearme-api-v3-0.md) · [All operations](https://skmtc.net/paynearme/apis/paynearme-api-v3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paynearme/paynearme-api-v3-0/revisions/44cba4f8b80f/schema)