FAQ
Answers to common questions about the Buckaroo Python SDK.
Something not working? See Troubleshooting.
Getting started
Should I use the SDK or a plugin?
Use a plugin if your store runs on a supported e-commerce platform. It needs no development. See Plugins and apps.
Use the SDK for a custom application or a platform without a Buckaroo plugin.
Does the SDK cost anything?
No. The SDK is free and open source under the MIT license. Transactions are charged according to your Buckaroo contract.
Which Python versions are supported?
The current requirements are on the Python SDK page and on PyPI.
Where do I find my store key and secret key?
In Plaza under Settings → API keys. See Configuration.
Does the SDK work with Django, Flask and FastAPI?
Yes. The SDK does not depend on a web framework. The push message example uses Flask, and only needs the Authorization header, the URL and the raw request body, which every framework provides. See Push messages.
Can I use the SDK in the browser?
No. The SDK runs on your server only, because it signs requests with your secret key. To collect card data in the browser, use the JS Client Side Encryption SDK or Hosted Fields together with the SDK.
Payments
Which payment methods can I use?
The Buckaroo payment methods, provided the method is active for your store in Plaza. payments.get_available_methods() returns the service codes the SDK knows, and Payment methods has the details for each method.
Why do field names differ from the API reference?
The API reference describes the raw JSON request and uses PascalCase. The SDK builds that request for you and takes snake_case field names, such as return_url. Service parameters keep the names from the API reference. See Payments.
Why do I need four return URLs?
Buckaroo can send the customer to a different page after a success, a cancellation, an error and a rejection, and the SDK requires all four. They can all point to the same page.
How do I know whether a payment succeeded?
From the push message that Buckaroo sends to your push URL when the status changes. Do not rely on the customer returning to your store. See Push messages.
Can I issue refunds?
Yes, in full or in part, with the transaction key of the original payment. See Order management.
Testing and support
How do I test without real payments?
Create the client with mode="test". All requests then go to the Buckaroo test environment. See Test and go live.
Where can I find more examples?
In the examples folder of the repository, and in the README for the additional services.
Where do I report a bug or request a feature?
Open an issue in the repository. Pull requests are welcome too. Read the contribution guidelines first.
How do I know when a new version is released?
Watch the releases page on GitHub. The changelog lists what changed in each version.
Updated about 2 hours ago