Readme
|travis|_ |coveralls|_
.. |travis| image:: https://travis-ci.com/emesik/revolut-python.svg .. _travis: https://travis-ci.com/emesik/revolut-python
.. |coveralls| image:: https://coveralls.io/repos/github/emesik/revolut-python/badge.svg .. _coveralls: https://coveralls.io/github/emesik/revolut-python
A Python wrapper for Revolut API, Python 3.x compatible.
Release 0.10.1, a working beta.
Notes for 0.10.x ^^^^^^^^^^^^^^^^
business and merchant submodulesMerchantClient throws exceptions on failuresMerchantClient.update_orderNotes for 0.9.x ^^^^^^^^^^^^^^^
revolut.merchant and MerchantClient within, which supports very basic Merchant
API functionality (creating and retrieving simple orders)revolut.Client class has been renamed to revolut.business.BusinessClient; the old
import will remain valid in 0.9.x, however it will issue warning and the resulting object
will fail on type checks, like isinstanceClient, Transaction, etc. to the revolut.business
submodule; top level import is deprecated, like above.The module supports most of Business API features and some basic elements of the Merchant API.
Business API ^^^^^^^^^^^^
As listed in Revolut Business API docs_:
.. _Revolut Business API docs: https://developer.revolut.com/docs/api-reference/business/
+------------------------------------+ | Accounts | +------------------------------+-----+ | Get Accounts | yes | +------------------------------+-----+ | Get Account | yes | +------------------------------+-----+ | Get Account Details | yes | +------------------------------+-----+ | Counterparties | +------------------------------+-----+ | Add Revolut Counterparty | yes | +------------------------------+-----+ | Add non-Revolut Counterparty | yes | +------------------------------+-----+ | Delete Counterparty | yes | +------------------------------+-----+ | Get Counterparty | yes | +------------------------------+-----+ | Get Counterparties | yes | +------------------------------+-----+ | Payments | +------------------------------+-----+ | Transfer | yes | +------------------------------+-----+ | Create Payment | yes | +------------------------------+-----+ | Schedule Payment | no | +------------------------------+-----+ | Check Payment Status | yes | +------------------------------+-----+ | Cancel Payment | no | +------------------------------+-----+ | Get Transactions | yes | +------------------------------+-----+
Merchant API ^^^^^^^^^^^^
As described in Revolut Merchant API docs_:
.. _Revolut Merchant API docs: https://developer.revolut.com/docs/api-reference/merchant/
+------------------------------+---------------------------------------------+
| Orders | |
+------------------------------+---------------------------------------------+
| Create an order | yes, with capture_mode = AUTOMATIC only |
+------------------------------+---------------------------------------------+
| Retrieve an order list | yes |
+------------------------------+---------------------------------------------+
| Retrieve an order | yes |
+------------------------------+---------------------------------------------+
| Update an order | partially |
+------------------------------+---------------------------------------------+
| Capture an order | no |
+------------------------------+---------------------------------------------+
| Cancel an order | no |
+------------------------------+---------------------------------------------+
| Refund an order | no |
+------------------------------+---------------------------------------------+
| Confirm an order | no |
+------------------------------+---------------------------------------------+
| Customers | no |
+------------------------------+---------------------------------------------+
| Webhooks | |
+------------------------------+---------------------------------------------+
| Retrieve all webhooks | no |
+------------------------------+---------------------------------------------+
| Set a webhook URL | yes |
+------------------------------+---------------------------------------------+
| Retrieve webhook details | no |
+------------------------------+---------------------------------------------+
| Update webhook details | no |
+------------------------------+---------------------------------------------+
| Delete a webhook | no |
+------------------------------+---------------------------------------------+
| Other | no |
+------------------------------+---------------------------------------------+
In September 2019 Revolut introduced much more complex authorization system based on OAuth2. Since version 0.6 this module supports only the new authorization model and old access keys become obsolete.
The flow ^^^^^^^^
This description should help you get through the auth mess. It assumes you want to run the module in a non-interactive way (e.g. as a backend for a web service). Mobile applications will require some additional research on your side.
$ revolut_genkey.sh to generate key pair. Answer questions about your organization.prvkey.pem and pubkey.pem. Store them in a safe place.
The script will also print the contents of pubkey.pem to the console. This is your
X509 public key.client_id
and iss values needed in further steps.auth_code.$ revolut_getjwt.py prvkey.pem <iss> <client_id>. The output will be your jwt.$ revolut_gettokens.py <auth_code> <client_id> <jwt>. The script will return
access_token (with expiration time) and refresh_token.
(If you do it too slowly, the auth code expires and you get "unauthorized_client" error.
Return to step 8.)Now you're almost done, with some pieces of data on your hand. There are two ways to continue:
revolut.session.TemporarySession with the access_token and use it until
the token expires.revolut.session.RenewableSession with refresh_token, client_id and
jwt. It will be more durable, creating fresh access_token each time.However, it seems that after 90 days your API access expires anyway and you'd have to click Refresh access in the panel and restart the above process from point 8. Or whatever the EU shitheads invented in PSD2.
Released under the BSD 3-Clause License. See LICENSE.txt_.
Copyright (c) 2018-2022:
.. _LICENSE.txt: LICENSE.txt
FAQs
Revolut API client for Python
We found that revolut-python demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.