API reference
Every route of the Anis Partner API, generated from the contract the gateway publishes. Each page says what the route is for, the permission it needs, how the request is signed, whether Anis signs the answer, the fields it takes and returns, and every refusal it can give.
Your application
| GET | Read your profile/v1/profile | profile:read |
| POST | Suspend your application/v1/application/suspend | None |
| POST | Revoke an application key/v1/keys/{keyId}/revoke | None |
| GET | List your allowed addresses/v1/application/networks | None |
| POST | Allow one more address/v1/application/networks | None |
| POST | Remove an address you added/v1/application/networks/remove | None |
Wallets
| GET | List wallets/v1/wallets | wallets:read |
| GET | Read a wallet/v1/wallets/{walletId} | wallets:read |
Catalogue
| GET | List catalogue categories/v1/wallets/{walletId}/catalog/categories | catalogue:read |
| GET | List subcategories of a category/v1/wallets/{walletId}/catalog/categories/{categoryId}/subcategories | catalogue:read |
| GET | Read a subcategory/v1/wallets/{walletId}/catalog/subcategories/{subcategoryId} | catalogue:read |
| GET | List cards for sale/v1/wallets/{walletId}/catalog/subcategories/{subcategoryId}/cards | catalogue:read |
| GET | Read a catalogue card/v1/wallets/{walletId}/catalog/cards/{cardId} | catalogue:read |
Orders
| POST | Place an order/v1/wallets/{walletId}/orders | orders:create |
| GET | Read an order/v1/orders/{operationId} | orders:read |
Owned cards
| GET | List owned cards/v1/wallets/{walletId}/owned-cards | cards:read |
| GET | Read an owned card/v1/wallets/{walletId}/owned-cards/{soldCardId} | cards:read |
| POST | Reveal a card/v1/wallets/{walletId}/owned-cards/{soldCardId}/reveal | cards:reveal |
| POST | Reveal an invoice/v1/wallets/{walletId}/invoices/{invoiceId}/owned-cards/reveal | cards:reveal |
Diagnostics
| POST | Check your signature/v1/diagnostics/signature | diagnostics:use |
Enrolment
| GET | Read an invitation/v1/enrollments/{invitationId} | None |
| POST | Submit a public key/v1/enrollments/{invitationId}/keys | None |
| POST | Prove you hold the key/v1/enrollments/{invitationId}/proof | None |
| GET | Read enrolment status/v1/enrollments/{invitationId}/status | None |
Anis signing keys
| GET | Anis’s public signing keys/.well-known/partner-signing-keys.json | None |
Meter charges
| GET | Get meter packages/v1/wallets/{walletId}/meter-packages | meter_charges:read |
| GET | Get my meter charges/v1/wallets/{walletId}/meter-charges | meter_charges:read |
| POST | Charge a meter/v1/wallets/{walletId}/meter-charges | meter_charges:create |
| GET | Read a meter charge/v1/meter-charges/{operationId} | meter_charges:read |
Direct recharge
| GET | Get direct recharge products/v1/wallets/{walletId}/direct-recharge-products | direct_recharges:read |
| GET | Read a direct recharge product/v1/wallets/{walletId}/direct-recharge-products/{productId} | direct_recharges:read |
| GET | Get recipient locations/v1/wallets/{walletId}/direct-recharge-products/{productId}/locations | direct_recharges:read |
| GET | Quote a direct recharge product/v1/wallets/{walletId}/direct-recharge-products/{productId}/quote | direct_recharges:read |
| GET | Get my direct recharges/v1/wallets/{walletId}/direct-recharges | direct_recharges:read |
| POST | Request a direct recharge product/v1/wallets/{walletId}/direct-recharges | direct_recharges:create |
| GET | Read a direct recharge/v1/direct-recharges/{operationId} | direct_recharges:read |
| PATCH | Correct a suspended recipient/v1/direct-recharges/{operationId}/recipient | direct_recharges:create |
Webhooks
| GET | Read your webhook endpoint/v1/webhook-endpoint | None |
| PUT | Set your webhook endpoint/v1/webhook-endpoint | None |
| POST | Test your webhook endpoint/v1/webhook-endpoint/test | None |
| GET | Get webhook deliveries/v1/webhook-events | None |
| POST | Redeliver a webhook/v1/webhook-events/{eventId}/redeliver | None |