Our API Docs just got a new look!

Security aspects

Security considerations

Environments

All the integration must be performed on our Staging environment, where you can perform your tests freely without risks of any kind.

When you sign up with us, we will generate you an account on our STG environment where you will be able to:

  • See the transactions created

  • Approve and cancel transactions

  • Retrieve your API Keys

  • Whitelist your IPs, and more

Endpoint domains

Each environment has its own domain. The path of the endpoints doesn't change.

Environment
Domain

Testing

https://api-stg.directa24.com/

Production

https://api.directa24.com/

Notes

  • You will use the STG endpoints to integrate.

  • The STG and PROD environments are not communicated in any way.

  • No transaction created on the STG environment will be reflected on the PROD environment or vice versa.

  • The API Keys and configurations between environments are also different.

API Keys

In order to authenticate, our Cashouts APIs uses API Keys in all of the requests to authenticate. Your API Keys can be retrieved from the Merchant Panel by going to Settings ➡️ API Access ➡️ Cashout Credentials.

The API Keys between the STG and PROD environments are different.

These are the three credentials you will need:

  • Your user: API Key

  • Your password: API Passphrase

  • Your secret key to generate the signatures: API Signature

Authentication to the API is performed via HTTP Basic Auth. You must provide your API Keys in all requests as the basic auth username and password.

Your user and password keys must be sent in all the API calls using the API Key and API Passphrase fields on the body of the request.

Your API Keys, along with your IP Addresses are your way to authenticate yourself, therefore, do not share your credentials in publicly accessible areas such as GitHub, client-side code and so forth.

Headers

All requests sent through Cashouts v3 API must have the following headers.

Header
Format
Mandatory
Description

Payload-Signature

String

Yes

HMAC256 of the whole JSON Payload using your API Signature

Content-Type

String

Yes

application/json

User-Agent

String

Yes

Server client user agent

IP Whitelisting

For security purposes, you need to whitelist the IPs from where you will call our API.

In order to whitelist your IPs and make the process as smoother as possible, you should go to Settings -> API Access and add the list of IPs you will possibly use under the Cashouts IP Address section.

Reach out to [email protected] if you need to whitelist our servers IPs on your firewall.


Best practices

Last updated

Was this helpful?