api.md

Applications

Company

Types:

from rain_sdk.types.applications import (
    IssuingApplication,
    IssuingApplicationPerson,
    IssuingCompany,
    PhysicalAddress,
    CompanyRetrieveResponse,
)

Methods:

• client.applications.company.create(**params) -> IssuingCompany
• client.applications.company.retrieve(company_id) -> CompanyRetrieveResponse
• client.applications.company.update(company_id, **params) -> IssuingCompany
• client.applications.company.reapply(company_id, **params) -> IssuingCompany
• client.applications.company.upload_document(company_id, **params) -> None

Ubo

Methods:

• client.applications.company.ubo.update(ubo_id, *, company_id, **params) -> IssuingCompany
• client.applications.company.ubo.upload_document(company_id, **params) -> None

Document

Methods:

• client.applications.company.ubo.document.upload(ubo_id, *, company_id, **params) -> None

User

Types:

from rain_sdk.types.applications import IssuingUser, UserRetrieveResponse

Methods:

• client.applications.user.create(**params) -> IssuingUser
• client.applications.user.retrieve(user_id) -> UserRetrieveResponse
• client.applications.user.update(user_id, **params) -> IssuingUser
• client.applications.user.initiate(**params) -> IssuingUser
• client.applications.user.reapply(user_id, **params) -> IssuingUser
• client.applications.user.upload_document(user_id, **params) -> None

Balances

Types:

from rain_sdk.types import BalanceRetrieveResponse

Methods:

• client.balances.retrieve() -> BalanceRetrieveResponse

Cards

Types:

from rain_sdk.types import (
    IssuingCard,
    IssuingCardLimit,
    IssuingCardStatus,
    CardListResponse,
    CardRetrieveSecretsResponse,
)

Methods:

• client.cards.retrieve(card_id) -> IssuingCard
• client.cards.update(card_id, **params) -> IssuingCard
• client.cards.list(**params) -> CardListResponse
• client.cards.retrieve_secrets(card_id) -> CardRetrieveSecretsResponse

Pin

Types:

from rain_sdk.types.cards import PinRetrieveResponse

Methods:

• client.cards.pin.retrieve(card_id) -> PinRetrieveResponse
• client.cards.pin.update(card_id, **params) -> None

Companies

Types:

from rain_sdk.types import (
    IssuingChargeCreateBody,
    IssuingChargeCreateResponse,
    IssuingContract,
    CompanyListResponse,
    CompanyInitiatePaymentResponse,
    CompanyRetrieveBalancesResponse,
    CompanyRetrieveContractsResponse,
)

Methods:

• client.companies.retrieve(company_id) -> IssuingCompany
• client.companies.update(company_id, **params) -> IssuingCompany
• client.companies.list(**params) -> CompanyListResponse
• client.companies.charge(company_id, **params) -> IssuingChargeCreateResponse
• client.companies.create_user(company_id, **params) -> IssuingUser
• client.companies.initiate_payment(company_id, **params) -> CompanyInitiatePaymentResponse
• client.companies.retrieve_balances(company_id) -> CompanyRetrieveBalancesResponse
• client.companies.retrieve_contracts(company_id) -> CompanyRetrieveContractsResponse

Signatures

Types:

from rain_sdk.types.companies import IssuingSignature

Methods:

• client.companies.signatures.retrieve_payment_signature(company_id, **params) -> IssuingSignature
• client.companies.signatures.retrieve_withdrawal_signature(company_id, **params) -> IssuingSignature

Contracts

Types:

from rain_sdk.types import ContractListResponse

Methods:

• client.contracts.list() -> ContractListResponse

Disputes

Types:

from rain_sdk.types import IssuingDispute, DisputeListResponse

Methods:

• client.disputes.retrieve(dispute_id) -> IssuingDispute
• client.disputes.update(dispute_id, **params) -> None
• client.disputes.list(**params) -> DisputeListResponse

Evidence

Methods:

• client.disputes.evidence.list(dispute_id) -> BinaryAPIResponse
• client.disputes.evidence.upload(dispute_id, **params) -> None

Keys

Types:

from rain_sdk.types import KeyCreateResponse

Methods:

• client.keys.create(**params) -> KeyCreateResponse
• client.keys.delete(key_id) -> None

Payments

Types:

from rain_sdk.types import PaymentInitiateResponse

Methods:

• client.payments.initiate(**params) -> PaymentInitiateResponse

Signatures

Methods:

• client.signatures.retrieve_payment_signature(**params) -> IssuingSignature
• client.signatures.retrieve_withdrawal_signature(**params) -> IssuingSignature

Transactions

Types:

from rain_sdk.types import IssuingTransaction, TransactionListResponse

Methods:

• client.transactions.retrieve(transaction_id) -> IssuingTransaction
• client.transactions.update(transaction_id, **params) -> None
• client.transactions.list(**params) -> TransactionListResponse
• client.transactions.create_dispute(transaction_id, **params) -> IssuingDispute

Receipt

Methods:

• client.transactions.receipt.retrieve(transaction_id) -> BinaryAPIResponse
• client.transactions.receipt.upload(transaction_id, **params) -> None

Users

Types:

from rain_sdk.types import (
    UserListResponse,
    UserInitiatePaymentResponse,
    UserRetrieveBalancesResponse,
    UserRetrieveContractsResponse,
)

Methods:

• client.users.create(**params) -> IssuingUser
• client.users.retrieve(user_id) -> IssuingUser
• client.users.update(user_id, **params) -> IssuingUser
• client.users.list(**params) -> UserListResponse
• client.users.delete(user_id) -> None
• client.users.create_card(user_id, **params) -> IssuingCard
• client.users.create_charge(user_id, **params) -> IssuingChargeCreateResponse
• client.users.initiate_payment(user_id, **params) -> UserInitiatePaymentResponse
• client.users.retrieve_balances(user_id) -> UserRetrieveBalancesResponse
• client.users.retrieve_contracts(user_id) -> UserRetrieveContractsResponse

Signatures

Methods:

• client.users.signatures.retrieve_payment_signature(user_id, **params) -> IssuingSignature
• client.users.signatures.retrieve_withdrawal_signature(user_id, **params) -> IssuingSignature