Getting started

What you need for your first API request and what the API can do today.

Plutera accepts payments for merchants and routes them to payment providers. The merchant's server talks to the API. This documentation describes only what has been released and checked against a running server.

#The basics

• The API has one address for the test and live environments: https://api.plutera.io. Every endpoint starts with /api/v1. HTTPS only.
• Call the API from your server. There are no CORS headers on purpose: an API key must never end up in the code of a web page or an app.
• Requests and responses are JSON in UTF-8.
• Every request carries an API key. The key identifies the merchant and the environment.
• Amounts are integers of minor currency units, written as strings.
• Every response has a request ID to quote to support.

#Your first request

1. Get a test key from your Plutera administrator. How keys work and where they are issued: Authentication.

2. Put the key in an environment variable on your server. The commands in this documentation read it from there.

   export PLUTERA_API_KEY='the key you were given'

3. Check the key:

   curl -sS https://api.plutera.io/api/v1/me \
     -H "Authorization: Bearer $PLUTERA_API_KEY"

   The response contains the merchant, the environment and the public part of the key: fields and an example response. If you get an error, its body names the cause: Errors.

#What the API can do today

Both endpoints only read. Creating a payment, reading its state and notifications to the merchant are not released yet: their paths are reserved. An endpoint appears in the reference and in the changelog on the day it is released, not earlier.