Bluesnap

At BlueSnap, we look at payments a little differently. Our Payment Orchestration Platform helps businesses accept payments globally and is designed to increase revenue and reduces costs. We provide a comprehensive back-end solutions that simplifies the complexity of payments, managing the full process from start to finish.

BlueSnap supports payments through multiple sales channels such as online and mobile sales, marketplaces, subscriptions, invoice payments and manual orders through a virtual terminal. And for businesses looking for embedded payments, we offer white-labeled payments for platforms with automated underwriting and onboarding that supports marketplaces and split payments.

And with one integration and contract, businesses can sell in over 200 geographies with access to local acquiring in 47 countries, 110+ currencies and 100+ global payment types, including popular eWallets, automated accounts receivable, world-class fraud protection and chargeback management, built-in solutions for regulation and tax compliance, and unified global reporting to help businesses grow.

With a US headquarters in Waltham, MA, and EU headquarters in Dublin, Ireland, BlueSnap is backed by world-class private equity investors including Great Hill Partners and Parthenon Capital Partners.

Learn more at BlueSnap.com

Requirements

Python >=3.7

Installation

Getting Started

from pprint import pprint
from blue_snap_python_sdk import BlueSnap, ApiException

bluesnap = BlueSnap(
    username="YOUR_USERNAME",
    password="YOUR_PASSWORD",
    sec1="YOUR_API_KEY",
)

try:
    # Create Debit Agreement
    bluesnap.agreement.create_debit_for_aus_can(
        region="ca",
        type="onetime",
        planid="string_example",
        overriderecurringchargeamount="string_example",
    )
except ApiException as e:
    print("Exception when calling AgreementApi.create_debit_for_aus_can: %s\n" % e)
    pprint(e.body)
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)

Async

async support is available by prepending a to any method.

import asyncio
from pprint import pprint
from blue_snap_python_sdk import BlueSnap, ApiException

bluesnap = BlueSnap(
    username="YOUR_USERNAME",
    password="YOUR_PASSWORD",
    sec1="YOUR_API_KEY",
)


async def main():
    try:
        # Create Debit Agreement
        await bluesnap.agreement.acreate_debit_for_aus_can(
            region="ca",
            type="onetime",
            planid="string_example",
            overriderecurringchargeamount="string_example",
        )
    except ApiException as e:
        print("Exception when calling AgreementApi.create_debit_for_aus_can: %s\n" % e)
        pprint(e.body)
        pprint(e.headers)
        pprint(e.status)
        pprint(e.reason)
        pprint(e.round_trip_time)


asyncio.run(main())

Raw HTTP Response

To access raw HTTP response values, use the .raw namespace.

from pprint import pprint
from blue_snap_python_sdk import BlueSnap, ApiException

bluesnap = BlueSnap(
    username="YOUR_USERNAME",
    password="YOUR_PASSWORD",
    sec1="YOUR_API_KEY",
)

try:
    # Create Debit Agreement
    create_debit_for_aus_can_response = bluesnap.agreement.raw.create_debit_for_aus_can(
        region="ca",
        type="onetime",
        planid="string_example",
        overriderecurringchargeamount="string_example",
    )
    pprint(create_debit_for_aus_can_response.headers)
    pprint(create_debit_for_aus_can_response.status)
    pprint(create_debit_for_aus_can_response.round_trip_time)
except ApiException as e:
    print("Exception when calling AgreementApi.create_debit_for_aus_can: %s\n" % e)
    pprint(e.body)
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)

Reference

`bluesnap.agreement.create_debit_for_aus_can`

for Australia and Canada

🛠️ Usage

bluesnap.agreement.create_debit_for_aus_can(
    region="ca",
    type="onetime",
    planid="string_example",
    overriderecurringchargeamount="string_example",
)

⚙️ Parameters

region: `str`

Represents the country. Possible Values: au, ca

type: `str`

Represents the mandate type. Possible Values: onetime,recurring, ondemand

planid: `str`

SKU number

overriderecurringchargeamount: `str`

the amount which overrides recurring charge

🌐 Endpoint

/agreements/debit/{region}/{type} post

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
.vscode		.vscode
blue_snap_python_sdk		blue_snap_python_sdk
test		test
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
header.png		header.png
pyproject.toml		pyproject.toml
setup.cfg		setup.cfg
setup.py		setup.py

License

konfig-sdks/blue-snap-python-sdk

Folders and files

Latest commit

History

Repository files navigation

Bluesnap

Table of Contents

Requirements

Installation

Getting Started

Async

Raw HTTP Response

Reference

bluesnap.agreement.create_debit_for_aus_can

🛠️ Usage

⚙️ Parameters

region: str

type: str

planid: str

overriderecurringchargeamount: str

🌐 Endpoint

bluesnap.agreement.get_debit

🛠️ Usage

⚙️ Parameters

agreement_id: str

🌐 Endpoint

bluesnap.authorization.create_transaction

🛠️ Usage

⚙️ Parameters

amount: Union[int, float]

soft_descriptor: str

card_holder_info: AuthorizationCreateTransactionRequestCardHolderInfo

currency: str

credit_card: AuthorizationCreateTransactionRequestCreditCard

card_transaction_type: str

⚙️ Request Body

🌐 Endpoint

bluesnap.plan.create_recurring_plan

🛠️ Usage

⚙️ Parameters

charge_frequency: str

grace_period_days: int

trial_period_days: int

initial_charge_amount: int

name: str

currency: str

max_number_of_charges: int

recurring_charge_amount: Union[int, float]

charge_on_plan_switch: bool

⚙️ Request Body

🌐 Endpoint

bluesnap.plan.get_all

🛠️ Usage

⚙️ Parameters

pagesize: str

after: str

gettotal: bool

fulldescription: bool

🌐 Endpoint

bluesnap.plan.get_specific

🛠️ Usage

⚙️ Parameters

plan_id: int

🌐 Endpoint

bluesnap.plan.update_recurring_plan

🛠️ Usage

⚙️ Parameters

plan_id: int

charge_frequency: str

trial_period_days: str

initial_charge_amount: str

name: str

currency: str

recurring_charge_amount: str

⚙️ Request Body

🌐 Endpoint

bluesnap.reversal.auth_transaction

🛠️ Usage

⚙️ Parameters

`bluesnap.agreement.create_debit_for_aus_can`

region: `str`

type: `str`

planid: `str`

overriderecurringchargeamount: `str`

`bluesnap.agreement.get_debit`

agreement_id: `str`

`bluesnap.authorization.create_transaction`

amount: `Union[int, float]`

soft_descriptor: `str`

card_holder_info: `AuthorizationCreateTransactionRequestCardHolderInfo`

currency: `str`

credit_card: `AuthorizationCreateTransactionRequestCreditCard`

card_transaction_type: `str`

`bluesnap.plan.create_recurring_plan`

charge_frequency: `str`

grace_period_days: `int`

trial_period_days: `int`

initial_charge_amount: `int`

name: `str`

currency: `str`

max_number_of_charges: `int`

recurring_charge_amount: `Union[int, float]`

charge_on_plan_switch: `bool`

`bluesnap.plan.get_all`

pagesize: `str`

after: `str`

gettotal: `bool`

fulldescription: `bool`

`bluesnap.plan.get_specific`

plan_id: `int`

`bluesnap.plan.update_recurring_plan`

plan_id: `int`

charge_frequency: `str`

trial_period_days: `str`

initial_charge_amount: `str`

name: `str`

currency: `str`

recurring_charge_amount: `str`

`bluesnap.reversal.auth_transaction`

card_transaction_type: `str`

transaction_id: `int`

`bluesnap.shopper.create_vaulted_shopper`

payment_sources: `ShopperCreateVaultedShopperRequestPaymentSources`

first_name: `str`

last_name: `str`

`bluesnap.shopper.delete_vaulted_shopper`

vaulted_shopper_id: `str`

`bluesnap.shopper.get`

vaulted_shopper_id: `str`

`bluesnap.shopper.update_vaulted_shopper`

vaulted_shopper_id: `str`

payment_sources: `ShopperUpdateVaultedShopperRequestPaymentSources`

first_name: `str`

last_name: `str`

`bluesnap.subscription.create_merchant_managed_charge`

subscription_id: `int`

amount: `Union[int, float]`

currency: `str`

merchant_transaction_id: `str`

tax_reference: `str`

`bluesnap.subscription.create_merchant_managed_subscription`

amount: `Union[int, float]`

currency: `str`

payer_info: `SubscriptionCreateMerchantManagedSubscriptionRequestPayerInfo`

payment_source: `SubscriptionCreateMerchantManagedSubscriptionRequestPaymentSource`

`bluesnap.subscription.create_new`

payer_info: `SubscriptionCreateNewRequestPayerInfo`

payment_source: `SubscriptionCreateNewRequestPaymentSource`

plan_id: `int`

`bluesnap.subscription.get_specific`

subscription_id: `int`

`bluesnap.subscription.get_switch_charge_amount`