Async Apple Pay Module

This wrapper class enables asynchronous interaction with the Paystack Apple Pay API. The Apple Pay API allows you to register your application’s top-level domain or subdomain, enabling customers to make secure payment processing using Apple Pay on IOS and Safari.

To access the Apple Pay API methods, you need to call the apple_pay instance method from AsyncPayStackBase.

See how to call the instance here: Asynchronous Paystack Wrapper

class AsyncApplePayClientAPI(secret_key: str = None)

Paystack Apple Pay API Reference: Apple Pay

async list_domains(use_cursor: bool | None = False, next_page: int | None = None, previous_page: int | None = None)→ PayStackResponse

List all domains registered with the Apple Pay API.

Parameters:

  • use_cursor (bool, optional) – Use cursor for pagination (default: False).

  • next_page (int, optional) – Next page.

  • previous_page (int, optional) – Previous page.

Returns:

The response from the API.

Return type:

PayStackResponse object

async register_domain(domain_name: str)→ PayStackResponse

Register a domain with the Apple Pay API.

Parameters:

domain_name (str) – The domain name.

Returns:

The response from the API.

Return type:

PayStackResponse object

async unregister_domain(domain_name: str)→ PayStackResponse

Unregister a domain with the Apple Pay API.

Parameters:

domain_name (str) – The domain name.

Returns:

The response from the API.

Return type:

PayStackResponse object

Important

The register_domain() method can only be called with one domain or subdomain at a time.

Apple Pay Access

  1. Requirement: To use the Apple Pay functionality, you must have access to the Apple Pay endpoint.

  2. Verification: If you’re unsure about your access, please contact Paystack customer service for verification.

  3. Testing Environment: Apple Pay might not be available on your testing environment. If you’re using a testing environment and don’t see the Apple Pay channel as an option, switch to a live environment and follow these instructions: https://paystack.com/docs/payments/apple-pay/