README.md

list

List all OutboundTransfers

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

API Endpoint: GET /v1/treasury/outbound_transfers

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.treasury.outbound_transfer.list(financial_account="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.treasury.outbound_transfer.list(financial_account="string")

get

Retrieve an OutboundTransfer

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

API Endpoint: GET /v1/treasury/outbound_transfers/{outbound_transfer}

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.treasury.outbound_transfer.get(outbound_transfer="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.treasury.outbound_transfer.get(outbound_transfer="string")

create

Create an OutboundTransfer

Creates an OutboundTransfer.

API Endpoint: POST /v1/treasury/outbound_transfers

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.treasury.outbound_transfer.create(
    amount=123, currency="string", financial_account="string"
)

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.treasury.outbound_transfer.create(
    amount=123, currency="string", financial_account="string"
)

cancel

Cancel an OutboundTransfer

An OutboundTransfer can be canceled if the funds have not yet been paid out.

API Endpoint: POST /v1/treasury/outbound_transfers/{outbound_transfer}/cancel

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.treasury.outbound_transfer.cancel(outbound_transfer="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.treasury.outbound_transfer.cancel(outbound_transfer="string")