Getting Started
Create your Alfred Account
We only need a bit of information for you to start experimenting with our APIs. First, you need to create account in our dashboard and generate an API key pair to gain access to our free payments rail playground. Any transfers made in the test environment will never hit the actual testnet (blockchain network) or incur any fees.
Postman Collection
The best place to start is by downloading our Postman Collection. It covers all our available endpoints for all our API products. Once downloaded you only need to update the variables above with your own API key and secret and you are good to go.
Environment Authentication - Variables & Headers
In order for you to authenticate your calls, set up the environment with the correct variables. In the table below are the environment variable names you'll need to have to be able to utilize our APIs. The variable names are case sensitive.
Environment Variable | Description |
---|---|
URL_BASE (Sandbox) | https://penny-api-restricted-dev.alfredpay.io/api/v1/third-party-service/penny |
URL_BASE (Production) | https://api-service-co.alfredpay.app/api/v1/third-party-service/penny |
apiKey | Generated in your Sandbox account |
apiSecret | Generated in your Sandbox account |
Updated about 2 months ago