Skip to main content
Connect to the API environment assigned to your integration. Keep its base URL and credentials together, then append the documented v3 path for each operation.

​
Choose your base URL

​
Live API

Use this base URL for production:
The live API is for real traffic. Do not send live customer data to an endpoint intended for onboarding or validation.
Credentials and base URLs are issued as a matching set. If you have not received a base URL or confirmed your credential scope, contact your Pagsmile integration representative before sending traffic.

​
Configure your client

1

Set the base URL

Store the assigned URL in your client configuration. For live traffic, the shell configuration is:
If Pagsmile has provided a different URL for onboarding or validation, use that exact value with its matching credentials.
2

Append the endpoint path

Append the path exactly as documented. For example, Get Charge Details uses /v3/charges/details. Keep /v3 in the endpoint path rather than adding it to the base URL.
With the live base URL, this prints:
This example only constructs and prints the URL. It does not send an API request.
3

Apply the matching credentials and sign

Use the credentials issued for the selected base URL. Check the endpoint’s Authentication and target section for the supported credential owner and any account-target headers.Generate the signature from the exact host-independent path, query, headers, and raw body you will send. In this example, the signing path is /v3/charges/details; the scheme and hostname are not part of that path.Follow Request signing for the complete signing rules.

​
Environment isolation

Keep each environment’s configuration and request state separate.

​
Before you send a request

Confirm that:
  • The configured base URL is the one supplied for your intended environment.
  • The credentials belong to that base URL and have the scope required by the operation.
  • The outgoing request uses the exact documented path, including /v3.
  • The signature matches the path, query, headers, and raw body actually transmitted.
  • Your nonce store, logs, and secret configuration are separated by environment.

​
Choose the right credential

Your credential determines which operations you can call and how you select an account.
The account-target headers are X-ISPB and X-Account-Number.
  • Always send them together with non-empty values when explicit targeting is required or allowed.
  • The selected account must be active, belong to the authenticated user, and have a valid account hierarchy.
  • When the headers are present, include both exact trimmed values in the canonical headers before calculating the signature.
  • Do not add account-target headers to platform operations or user-owned managed-account operations.
Check each endpoint’s Authentication and target section before calling it.

​
Connection questions

Contact your Pagsmile integration representative to confirm the environment available to you and obtain its matching credentials. Use an alternate URL only when Pagsmile provides it.
Switch to the credentials and configuration assigned to the new environment. Select its nonce store and logs, and sign the exact request you will transmit. Changing the hostname alone does not establish access to another environment.
First confirm the base URL and credential pairing. Then review the endpoint’s credential scope, account-target rules, and request signing requirements. For an API error response, use Error Catalog to choose the next check.

​
Continue your integration

Prepare a signed request

Follow the integration guide for credentials, signing, and response handling.

Choose an API operation

Find the endpoint for your task and check its access requirements.