yellowcard-business 0.1.12

Python SDK for the YellowCard B2B API

YellowCard Business SDK

A Python SDK for integrating with the YellowCard B2B API. This SDK provides a simple interface to interact with YellowCard's payment and collection services.

Installation

Install the package using pip:

pip install yellowcard_business

Getting Started

To use the SDK, you'll need your API key and secret key from YellowCard. You can initialize the client as follows:

from yellowcard_business import YellowCard

# Initialize the client
client = YellowCard(
    api_key='your_api_key',
    secret_key='your_secret_key',
    env='sandbox'  # Use 'production' for live environment
)

Features

Payments

Create a Payment

from yellowcard_business.models import CreatePaymentRequest, Sender, Destination, AccountType

payment_data = CreatePaymentRequest(
    partnerId="your_partner_id",
    currency="USD",
    amount=100.00,
    destination=Destination(
        accountNumber="1234567890",
        accountType=AccountType.BANK,
        accountName="John Doe"
    ),
    sender=Sender(
        name="Jane Doe",
        country="NG",
        email="[e-mail]"
    )
)

payment = client.create_payment(payment_data)

Get Payment Details

payment = client.get_payment("payment_id")

Accept/Deny Payment

# Accept a payment
accepted_payment = client.accept_payment("payment_id")

# Deny a payment
denied_payment = client.deny_payment("payment_id")

Channels and Networks

Get Available Channels

# Get all channels
channels = client.get_channels()

# Get channels for a specific country
channels = client.get_channels(country="NG")

Get Networks

# Get all networks
networks = client.get_networks()

# Get networks for a specific country and channel
networks = client.get_networks(country="NG", channel_id="channel_id")

Rates

# Get all rates
rates = client.get_rates()

# Get rates for a specific currency
rates = client.get_rates(currency="USD")

# Get rates with conversion
rates = client.get_rates(currency="USD", convert="NG")

Collections

# Create a collection
collection = client.create_collection({
    "amount": 100.00,
    "currency": "USD"
    # Add other required fields
})

# Get collection details
collection = client.get_collection("collection_id")

# Accept a collection
client.accept_collection("collection_id")

# Deny a collection
client.deny_collection("collection_id")

Error Handling

The SDK will raise exceptions when API calls fail. It's recommended to wrap API calls in try-except blocks:

try:
    payment = client.get_payment("payment_id")
except Exception as e:
    print(f"An error occurred: {str(e)}")

Support

For support and more information about the YellowCard B2B API, please contact our support team or visit our documentation.

License

[Add your license information here]