Skip to main content

Understand API Credentials

Learn about the types of API keys and where to find them.

Updated this week

To connect with dLocal’s APIs securely, valid credentials must be used to authenticate requests. The required credentials depend on the product and the API version.

Each environment, whether a sandbox or a live environment, has its own set of credentials.

Credential types

Credential type

Used for

Authentication method

Credentials

API Credentials

Payins and Payouts (v2)

API Key Pair + Secret

x-login, x-trans-key, x-secret-key

OAuth Credentials

Payouts (v3)

OAuth 2.0

How authentication works

client_id, client_secret

  • API credentials are used in headers and require signing with the x-secret-key.

  • OAuth credentials are used to generate access tokens when working with Payouts v3.

Where to find credentials

All credentials are available in the dLocal Merchant Dashboard.

  1. Go to SettingsIntegrations

  2. Depending on your integration, you’ll see:

  • For Payins and Payouts (v2)

    • x-login

    • x-trans-key

    • x-secret-key

  • For Payouts (v3)

    • client_id

    • client_secret

These values are used to authenticate requests or generate OAuth tokens.

Can’t find your credentials? Contact your Technical Account Manager or email [email protected].

API credentials detail

API Credentials

Credentials

Type

Description

x-login

String

Sent as a header to identify the merchant making the request.

x-trans-key

String

Sent as a header along with x-login to authenticate the request.

Secret key

String

Used to generate the signature for the Authorization header in API requests.

Smartfields API key

String

Used in the tokenization process; acts as the merchant ID for identification. Only for Smart Fields integration.

OAuth Credentials

Credentials

Type

Description

client_id

String

Unique identifier assigned to your application. Used when requesting an access token.

client_secret

String

Secret associated with your client_id. Used for secure token exchange.

Best practices

  • Keep all credentials secure. Do not expose them in frontend code or public repositories.

  • Use the appropriate credentials for each environment.

Did this answer your question?