Skip to content

Entities

PaymentRequestId module-attribute 

PaymentRequestId = NewType('PaymentRequestId', UUID)

BankTransferAccount dataclass 

BankTransferAccount(
    bank_transfer_account_id,
    bank_transfer_account_info,
    bank_transfer_account_type,
)

Represents a bank account to which a bank transfer can be made (ex: BankAccountInfo in Canada).

bank_transfer_account_id instance-attribute 

bank_transfer_account_id

bank_transfer_account_info instance-attribute 

bank_transfer_account_info

bank_transfer_account_type instance-attribute 

bank_transfer_account_type

PayoutBankTransferTransaction dataclass 

PayoutBankTransferTransaction(
    bank_transfer_id,
    external_transfer_id,
    external_transaction_id,
    is_submitted,
    amount,
    currency,
)

Represents the result of initiating a payout bank transfer.

amount instance-attribute 

amount

bank_transfer_id instance-attribute 

bank_transfer_id

currency instance-attribute 

currency

external_transaction_id instance-attribute 

external_transaction_id

external_transfer_id instance-attribute 

external_transfer_id

is_submitted instance-attribute 

is_submitted

RecipientAddress dataclass 

RecipientAddress(street, postal_code, city, country)

Represents the address of a recipient (user or company).

city instance-attribute 

city

country instance-attribute 

country

postal_code instance-attribute 

postal_code

street instance-attribute 

street

RecipientUser dataclass 

RecipientUser(profile_id, first_name, last_name, address)

Represents an individual recipient for a payout.

address instance-attribute 

address

first_name instance-attribute 

first_name

last_name instance-attribute 

last_name

profile_id instance-attribute 

profile_id