How Do I Get Started With the PayAny API?

The PayAny API lets your own systems read balances and history, create deposit and withdrawal orders, place exchange orders and read your rates. Keys and permissions are self-served under API Management.

Before you start

• Complete identity verification. API keys are only issued to verified accounts.
• Read the API documentation for the endpoints, request signing and response format.

Two key types

• HMAC — PayAny gives you an API Key and a Secret Key. The secret is shown once, when the key is created, so store it then.
• Ed25519 or RSA — you generate a key pair yourself, upload the public key (PEM format) to PayAny, and sign requests with your private key. PayAny never sees the private key.

Permissions and IP binding

Each key carries the permissions you give it. To protect your funds, a key with no IP address bound can only read: enabling deposits, withdrawals or exchange orders requires binding the key to specific IP addresses. Each key can carry up to 50 addresses, one per line.

Validity

A key with no IP address bound is valid for 90 days and is then deleted; you are warned 7 days before. Bind an IP address to keep a key indefinitely. Each account can hold up to 50 keys.

Deleting a key

Deletion is immediate and permanent. Any system using the key loses access, and orders or data retrieval through it stop at once. Create a new key and update your system before deleting the old one.

Keep keys safe

Treat keys like your password. A leaked key can be used to move your money. Never share a key with anyone, including PayAny staff.