Skip to content

README.md

Latest commit

 

History

History
113 lines (82 loc) · 8.07 KB

README.md

File metadata and controls

113 lines (82 loc) · 8.07 KB

DigitalWallets.Domains

Overview

Available Operations

  • create - Register a digital wallet domain
  • delete - Remove a digital wallet domain

create

Register a digital wallet domain (Apple Pay only).

Example Usage

from gr4vy import Gr4vy
import os


with Gr4vy(
    merchant_account_id="default",
    bearer_auth=os.getenv("GR4VY_BEARER_AUTH", ""),
) as g_client:

    res = g_client.digital_wallets.domains.create(digital_wallet_id="1808f5e6-b49c-4db9-94fa-22371ea352f5", domain_name="example.com")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
digital_wallet_id str ✔️ The ID of the digital wallet to remove a domain for. 1808f5e6-b49c-4db9-94fa-22371ea352f5
domain_name str ✔️ The domain to add or remove. example.com
merchant_account_id Optional[str] ➖ The ID of the merchant account to use for this request. default
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

Any

Errors

Error Type Status Code Content Type
errors.Error400 400 application/json
errors.Error401 401 application/json
errors.Error403 403 application/json
errors.Error404 404 application/json
errors.Error405 405 application/json
errors.Error409 409 application/json
errors.HTTPValidationError 422 application/json
errors.Error425 425 application/json
errors.Error429 429 application/json
errors.Error500 500 application/json
errors.Error502 502 application/json
errors.Error504 504 application/json
errors.APIError 4XX, 5XX */*

delete

Remove a digital wallet domain (Apple Pay only).

Example Usage

from gr4vy import Gr4vy
import os


with Gr4vy(
    merchant_account_id="default",
    bearer_auth=os.getenv("GR4VY_BEARER_AUTH", ""),
) as g_client:

    g_client.digital_wallets.domains.delete(digital_wallet_id="", domain_name="example.com")

    # Use the SDK ...

Parameters

Parameter Type Required Description Example
digital_wallet_id str ✔️ N/A
domain_name str ✔️ The domain to add or remove. example.com
merchant_account_id Optional[str] ➖ The ID of the merchant account to use for this request. default
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Errors

Error Type Status Code Content Type
errors.Error400 400 application/json
errors.Error401 401 application/json
errors.Error403 403 application/json
errors.Error404 404 application/json
errors.Error405 405 application/json
errors.Error409 409 application/json
errors.HTTPValidationError 422 application/json
errors.Error425 425 application/json
errors.Error429 429 application/json
errors.Error500 500 application/json
errors.Error502 502 application/json
errors.Error504 504 application/json
errors.APIError 4XX, 5XX */*