Getting Started with Payments
Introduction
Use a single API that orchestrates the payment flow to include FraudSight, 3DS and Token creation.
Authentication
Set your headers
Authorization: {your_credentials}
Content-Type: application/json
WP-Api-Version: 2024-06-01
Replace {your_credentials} with your base64-encoded Basic Auth username and password.
DNS whitelisting
Whitelist the following URLs:
https://try.access.worldpay.com/https://access.worldpay.com/
Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.
API collection
A full set of API examples based on different scenarios.
This API also includes Payment Queries functionality to retrieve and query payment information.
Install the Package
The package is compatible with Python versions 3.7+.
Install the package from PyPi using the following pip command:
pip install hamza-payments-query-sdk==1.0.0
You can also view the package at: https://pypi.python.org/pypi/hamza-payments-query-sdk/1.0.0
Test the SDK
You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:
Navigate to the root directory of the SDK and run the following commands
pip install -r test-requirements.txt pytest
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| environment | Environment |
The API environment. Default: Environment.PRODUCTION |
| http_client_instance | HttpClient |
The Http Client passed from the sdk user for making requests |
| override_http_client_configuration | bool |
The value which determines to override properties of the passed Http Client from the sdk user |
| http_call_back | HttpCallBack |
The callback value that is invoked before and after an HTTP call is made to an endpoint |
| timeout | float |
The value to use for connection timeout. Default: 60 |
| max_retries | int |
The number of times to retry an endpoint call if it fails. Default: 0 |
| backoff_factor | float |
A backoff factor to apply between attempts after the second try. Default: 2 |
| retry_statuses | Array of int |
The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
| retry_methods | Array of string |
The http methods on which retry is to be done. Default: ['GET', 'PUT'] |
| proxy_settings | ProxySettings |
Optional proxy configuration to route HTTP requests through a proxy server. |
| basic_auth_credentials | BasicAuthCredentials |
The credential object for Basic Authentication |
The API client can be initialized as follows:
from payments.configuration import Environment
from payments.http.auth.basic_auth import BasicAuthCredentials
from payments.payments_client import PaymentsClient
client = PaymentsClient(
basic_auth_credentials=BasicAuthCredentials(
username='BasicAuthUserName',
password='BasicAuthPassword'
),
environment=Environment.PRODUCTION
)
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| production | Default Try |
| environment2 | Live |
Authorization
This API uses the following authentication schemes.
List of APIs
SDK Infrastructure
Configuration
HTTP
Utilities
Metadata
Release files for hamza-payments-query-sdk 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hamza_payments_query_sdk-1.0.0.tar.gz | 98.1 kB | Without provenance | Details for hamza_payments_query_sdk-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hamza_payments_query_sdk-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for hamza_payments_query_sdk-1.0.0-py3-none-any.whl |
Total release size: 369.9 kB
Release files / hamza_payments_query_sdk-1.0.0.tar.gz
| Download URL | hamza_payments_query_sdk-1.0.0.tar.gz |
|---|---|
| Size | 98.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f36e63a5a92b3662c45af27124d34062c41c6aaa1fade00b7f95fa89277f93a7
|
|
BLAKE2b-256 checksum How to use checksums |
efe64c7548c7127fa4ecf6cac04e0851cb1021c63cf1499cc6145cafa729c8d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Release files / hamza_payments_query_sdk-1.0.0-py3-none-any.whl
| Download URL | hamza_payments_query_sdk-1.0.0-py3-none-any.whl |
|---|---|
| Size | 271.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a3f01de4d82e9fa750e008307421581855d184400242331e5eab997b54b64d71
|
|
BLAKE2b-256 checksum How to use checksums |
a7814212322b498d8fc61a82de25d97b597e844c417c7e822c0b7d48abda88a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Security for hamza-payments-query-sdk 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.