api.md

Banks

Types:

• BankRetrieveResponse
• BankListResponse
• BankSearchResponse

Methods:

• client.banks.retrieve({ ...params }) -> BankRetrieveResponse
• client.banks.list({ ...params }) -> BankListResponse
• client.banks.search({ ...params }) -> BankSearchResponse

Checkoutsession

Types:

• CheckoutsessionCreateResponse
• CheckoutsessionRetrieveResponse
• CheckoutsessionExpireResponse

Methods:

• client.checkoutsession.create({ ...params }) -> CheckoutsessionCreateResponse
• client.checkoutsession.retrieve({ ...params }) -> CheckoutsessionRetrieveResponse
• client.checkoutsession.expire({ ...params }) -> CheckoutsessionExpireResponse

Customers

Types:

• CustomerCreateResponse
• CustomerRetrieveResponse

Methods:

• client.customers.create({ ...params }) -> CustomerCreateResponse
• client.customers.retrieve({ ...params }) -> CustomerRetrieveResponse

Orders

Types:

• OrderRetrieveResponse
• OrderUpdateResponse

Methods:

• client.orders.retrieve({ ...params }) -> OrderRetrieveResponse
• client.orders.update({ ...params }) -> OrderUpdateResponse

Charges

Types:

• Charge

Methods:

• client.charges.create({ ...params }) -> Charge

Mandates

Types:

• MandateResponse
• MandateRevokeResponse

Methods:

• client.mandates.retrieve({ ...params }) -> MandateResponse
• client.mandates.lookup({ ...params }) -> MandateResponse
• client.mandates.revoke({ ...params }) -> MandateRevokeResponse

Capabilities

Types:

• CapabilityRetrieveResponse

Methods:

• client.capabilities.retrieve({ ...params }) -> CapabilityRetrieveResponse

Refunds

Types:

• RefundResponse
• RefundBatchResponse

Methods:

• client.refunds.create({ ...params }) -> RefundResponse
• client.refunds.batch({ ...params }) -> RefundBatchResponse

Payouts

Types:

• PublicUserPayout
• PayoutListResponse

Methods:

• client.payouts.create({ ...params }) -> PublicUserPayout
• client.payouts.retrieve({ ...params }) -> PublicUserPayout
• client.payouts.list({ ...params }) -> PayoutListResponse

Reports

Types:

• PayoutReport
• ReportCreateResponse
• ReportRetrieveResponse

Methods:

• client.reports.create({ ...params }) -> ReportCreateResponse
• client.reports.retrieve({ ...params }) -> ReportRetrieveResponse
• client.reports.download({ ...params }) -> PayoutReport

Subaccounts

Types:

• Subaccount

Methods:

• client.subaccounts.create({ ...params }) -> Subaccount
• client.subaccounts.retrieve({ ...params }) -> Subaccount

Balance

Types:

• BalanceRetrieveResponse

Methods:

• client.balance.retrieve({ ...params }) -> BalanceRetrieveResponse

Webhooksubscription

Types:

• WebhooksubscriptionCreateResponse
• WebhooksubscriptionUpdateResponse
• WebhooksubscriptionListResponse
• WebhooksubscriptionDeleteResponse
• WebhooksubscriptionPingResponse

Methods:

• client.webhooksubscription.create({ ...params }) -> WebhooksubscriptionCreateResponse
• client.webhooksubscription.update({ ...params }) -> WebhooksubscriptionUpdateResponse
• client.webhooksubscription.list({ ...params }) -> WebhooksubscriptionListResponse
• client.webhooksubscription.delete({ ...params }) -> WebhooksubscriptionDeleteResponse
• client.webhooksubscription.ping({ ...params }) -> WebhooksubscriptionPingResponse