mirror of
https://github.com/stoatchat/rust-mollie-sdk.git
synced 2026-07-01 05:09:43 -04:00
init
This commit is contained in:
@@ -0,0 +1,3 @@
|
||||
/target/
|
||||
**/*.rs.bk
|
||||
Cargo.lock
|
||||
@@ -0,0 +1,23 @@
|
||||
# OpenAPI Generator Ignore
|
||||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
||||
|
||||
# Use this file to prevent files from being overwritten by the generator.
|
||||
# The patterns follow closely to .gitignore or .dockerignore.
|
||||
|
||||
# As an example, the C# client generator defines ApiClient.cs.
|
||||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
||||
#ApiClient.cs
|
||||
|
||||
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||
#foo/*/qux
|
||||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||
|
||||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||
#foo/**/qux
|
||||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||
|
||||
# You can also negate patterns with an exclamation (!).
|
||||
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||
#docs/*.md
|
||||
# Then explicitly reverse the ignore rule for a single file:
|
||||
#!docs/README.md
|
||||
@@ -0,0 +1,761 @@
|
||||
.gitignore
|
||||
.travis.yml
|
||||
Cargo.toml
|
||||
README.md
|
||||
docs/Address.md
|
||||
docs/Amount.md
|
||||
docs/AmountNullable.md
|
||||
docs/BalanceReportGrouping.md
|
||||
docs/BalanceStatus.md
|
||||
docs/BalanceTransactionType.md
|
||||
docs/BalanceTransferCategory.md
|
||||
docs/BalanceTransferCategoryResponse.md
|
||||
docs/BalanceTransferDestinationType.md
|
||||
docs/BalanceTransferFrequency.md
|
||||
docs/BalanceTransferPartyType.md
|
||||
docs/BalanceTransferPartyTypeResponse.md
|
||||
docs/BalanceTransferStatus.md
|
||||
docs/BalanceTransferStatusReason.md
|
||||
docs/BalanceTransferStatusReasonResponse.md
|
||||
docs/BalanceTransfersApiApi.md
|
||||
docs/BalancesApiApi.md
|
||||
docs/BillingAddress.md
|
||||
docs/CancelPaymentRequest.md
|
||||
docs/CapabilitiesApiApi.md
|
||||
docs/CapabilityRequirementStatus.md
|
||||
docs/CapabilityStatus.md
|
||||
docs/CapabilityStatusReason.md
|
||||
docs/CaptureMode.md
|
||||
docs/CaptureModeResponse.md
|
||||
docs/CaptureResponse.md
|
||||
docs/CaptureStatus.md
|
||||
docs/CapturesApiApi.md
|
||||
docs/ChargebacksApiApi.md
|
||||
docs/ClientLinksApiApi.md
|
||||
docs/ClientsApiApi.md
|
||||
docs/ComponentsSubTotals.md
|
||||
docs/CreatePaymentLinkRequest.md
|
||||
docs/CreatePaymentLinkRequestApplicationFee.md
|
||||
docs/CreatePaymentLinkRequestLinks.md
|
||||
docs/CreateWebhook.md
|
||||
docs/CreateWebhookRequest.md
|
||||
docs/Currencies.md
|
||||
docs/CustomerResponse.md
|
||||
docs/CustomersApiApi.md
|
||||
docs/DelayedRoutingApiApi.md
|
||||
docs/DeleteValuesSalesInvoice.md
|
||||
docs/DeleteWebhookRequest.md
|
||||
docs/EnableMethodIssuer200Response.md
|
||||
docs/EnableMethodIssuerRequest.md
|
||||
docs/EntityBalance.md
|
||||
docs/EntityBalanceLinks.md
|
||||
docs/EntityBalanceReport.md
|
||||
docs/EntityBalanceReportTotals.md
|
||||
docs/EntityBalanceReportTotalsAvailableBalance.md
|
||||
docs/EntityBalanceReportTotalsOpen.md
|
||||
docs/EntityBalanceReportTotalsPayments.md
|
||||
docs/EntityBalanceReportTotalsPendingBalance.md
|
||||
docs/EntityBalanceTransaction.md
|
||||
docs/EntityBalanceTransactionContext.md
|
||||
docs/EntityBalanceTransactionContextApplicationFee.md
|
||||
docs/EntityBalanceTransactionContextCapture.md
|
||||
docs/EntityBalanceTransactionContextChargeback.md
|
||||
docs/EntityBalanceTransactionContextInvoiceCompensation.md
|
||||
docs/EntityBalanceTransactionContextManagedFee.md
|
||||
docs/EntityBalanceTransactionContextOutgoingTransfer.md
|
||||
docs/EntityBalanceTransactionContextPayment.md
|
||||
docs/EntityBalanceTransactionContextPaymentCommission.md
|
||||
docs/EntityBalanceTransactionContextPostPaymentSplitPayment.md
|
||||
docs/EntityBalanceTransactionContextRefund.md
|
||||
docs/EntityBalanceTransactionContextReturnedTransfer.md
|
||||
docs/EntityBalanceTransactionContextSplitPayment.md
|
||||
docs/EntityBalanceTransfer.md
|
||||
docs/EntityBalanceTransferDestination.md
|
||||
docs/EntityBalanceTransferParty.md
|
||||
docs/EntityBalanceTransferPartyResponse.md
|
||||
docs/EntityBalanceTransferResponse.md
|
||||
docs/EntityBalanceTransferResponseStatusReason.md
|
||||
docs/EntityBalanceTransferStatusReason.md
|
||||
docs/EntityCapability.md
|
||||
docs/EntityCapabilityRequirement.md
|
||||
docs/EntityCapabilityRequirementLinks.md
|
||||
docs/EntityCapabilityRequirementLinksDashboard.md
|
||||
docs/EntityCapture.md
|
||||
docs/EntityCaptureLinks.md
|
||||
docs/EntityCaptureResponse.md
|
||||
docs/EntityChargeback.md
|
||||
docs/EntityChargebackReason.md
|
||||
docs/EntityClient.md
|
||||
docs/EntityClientCommission.md
|
||||
docs/EntityClientLink.md
|
||||
docs/EntityClientLinkAddress.md
|
||||
docs/EntityClientLinkLinks.md
|
||||
docs/EntityClientLinkOwner.md
|
||||
docs/EntityClientLinkResponse.md
|
||||
docs/EntityClientLinks.md
|
||||
docs/EntityCustomer.md
|
||||
docs/EntityCustomerLinks.md
|
||||
docs/EntityCustomerResponse.md
|
||||
docs/EntityEvent.md
|
||||
docs/EntityEventLinks.md
|
||||
docs/EntityInvoice.md
|
||||
docs/EntityInvoiceLinesInner.md
|
||||
docs/EntityInvoiceLinks.md
|
||||
docs/EntityMandate.md
|
||||
docs/EntityMandateDetails.md
|
||||
docs/EntityMandateLinks.md
|
||||
docs/EntityMandateResponse.md
|
||||
docs/EntityMandateResponseDetails.md
|
||||
docs/EntityMethod.md
|
||||
docs/EntityMethodAll.md
|
||||
docs/EntityMethodAllAllOfPricing.md
|
||||
docs/EntityMethodImage.md
|
||||
docs/EntityMethodIssuersInner.md
|
||||
docs/EntityMethodIssuersInnerImage.md
|
||||
docs/EntityMethodLinks.md
|
||||
docs/EntityOnboardingStatus.md
|
||||
docs/EntityOnboardingStatusLinks.md
|
||||
docs/EntityOrganization.md
|
||||
docs/EntityOrganizationLinks.md
|
||||
docs/EntityPayment.md
|
||||
docs/EntityPaymentApplicationFee.md
|
||||
docs/EntityPaymentBillingAddress.md
|
||||
docs/EntityPaymentDetails.md
|
||||
docs/EntityPaymentDetailsQrCode.md
|
||||
docs/EntityPaymentDetailsReceipt.md
|
||||
docs/EntityPaymentLinesInner.md
|
||||
docs/EntityPaymentLink.md
|
||||
docs/EntityPaymentLinks.md
|
||||
docs/EntityPaymentResponse.md
|
||||
docs/EntityPaymentResponseDetails.md
|
||||
docs/EntityPaymentResponseDetailsReceipt.md
|
||||
docs/EntityPaymentResponseLinesInner.md
|
||||
docs/EntityPaymentRoute.md
|
||||
docs/EntityPaymentRouteDestination.md
|
||||
docs/EntityPaymentRouteLinks.md
|
||||
docs/EntityPaymentRouteResponse.md
|
||||
docs/EntityPaymentRouteResponseDestination.md
|
||||
docs/EntityPermission.md
|
||||
docs/EntityProfile.md
|
||||
docs/EntityProfileLinks.md
|
||||
docs/EntityProfileResponse.md
|
||||
docs/EntityProfileResponseReview.md
|
||||
docs/EntityProfileReview.md
|
||||
docs/EntityRefund.md
|
||||
docs/EntityRefundExternalReference.md
|
||||
docs/EntityRefundLinks.md
|
||||
docs/EntityRefundResponse.md
|
||||
docs/EntityRefundResponseExternalReference.md
|
||||
docs/EntityRefundRoutingReversalsInner.md
|
||||
docs/EntityRefundRoutingReversalsInnerSource.md
|
||||
docs/EntityRoute.md
|
||||
docs/EntityRouteDestination.md
|
||||
docs/EntitySalesInvoice.md
|
||||
docs/EntitySalesInvoiceLinks.md
|
||||
docs/EntitySalesInvoiceResponse.md
|
||||
docs/EntitySettlement.md
|
||||
docs/EntitySettlementLinks.md
|
||||
docs/EntitySettlementPeriodsValueValue.md
|
||||
docs/EntitySettlementPeriodsValueValueCostsInner.md
|
||||
docs/EntitySettlementPeriodsValueValueCostsInnerRate.md
|
||||
docs/EntitySettlementPeriodsValueValueRevenueInner.md
|
||||
docs/EntitySubscription.md
|
||||
docs/EntitySubscriptionApplicationFee.md
|
||||
docs/EntitySubscriptionLinks.md
|
||||
docs/EntityTerminal.md
|
||||
docs/EntityWebhook.md
|
||||
docs/EntityWebhookEvent.md
|
||||
docs/EntityWebhookEventEmbedded.md
|
||||
docs/EntityWebhookEventEmbeddedEntity.md
|
||||
docs/EntityWebhookEventLinks.md
|
||||
docs/EntityWebhookLinks.md
|
||||
docs/ErrorResponse.md
|
||||
docs/ErrorResponseLinks.md
|
||||
docs/ErrorResponseLinksDocumentation.md
|
||||
docs/ExtraParameterParameters.md
|
||||
docs/ExtraParameterParametersCompany.md
|
||||
docs/GetCustomer200Response.md
|
||||
docs/GetPartnerStatus200Response.md
|
||||
docs/GetPartnerStatus200ResponseLinks.md
|
||||
docs/GetPartnerStatus200ResponseUserAgentTokensInner.md
|
||||
docs/Giftcard.md
|
||||
docs/InvoiceStatus.md
|
||||
docs/InvoicesApiApi.md
|
||||
docs/LineCategories.md
|
||||
docs/LineCategoriesResponse.md
|
||||
docs/ListAllMethods200Response.md
|
||||
docs/ListAllMethods200ResponseEmbedded.md
|
||||
docs/ListAllSubscriptions200Response.md
|
||||
docs/ListAllSubscriptions200ResponseEmbedded.md
|
||||
docs/ListBalanceTransactions200Response.md
|
||||
docs/ListBalanceTransactions200ResponseEmbedded.md
|
||||
docs/ListBalances200Response.md
|
||||
docs/ListBalances200ResponseEmbedded.md
|
||||
docs/ListCapabilities200Response.md
|
||||
docs/ListCapabilities200ResponseEmbedded.md
|
||||
docs/ListCapabilities200ResponseLinks.md
|
||||
docs/ListCapabilities200ResponseLinksDocumentation.md
|
||||
docs/ListClients200Response.md
|
||||
docs/ListClients200ResponseEmbedded.md
|
||||
docs/ListClients200ResponseEmbeddedClientsInner.md
|
||||
docs/ListClients200ResponseEmbeddedClientsInnerAllOfEmbedded.md
|
||||
docs/ListConnectBalanceTransfers200Response.md
|
||||
docs/ListConnectBalanceTransfers200ResponseEmbedded.md
|
||||
docs/ListCustomers200Response.md
|
||||
docs/ListCustomers200ResponseEmbedded.md
|
||||
docs/ListInvoices200Response.md
|
||||
docs/ListInvoices200ResponseEmbedded.md
|
||||
docs/ListLinks.md
|
||||
docs/ListMandates200Response.md
|
||||
docs/ListMandates200ResponseEmbedded.md
|
||||
docs/ListMethods200Response.md
|
||||
docs/ListMethods200ResponseEmbedded.md
|
||||
docs/ListMethods200ResponseLinks.md
|
||||
docs/ListPaymentLinks200Response.md
|
||||
docs/ListPaymentLinks200ResponseEmbedded.md
|
||||
docs/ListPermissions200Response.md
|
||||
docs/ListPermissions200ResponseEmbedded.md
|
||||
docs/ListPermissions200ResponseLinks.md
|
||||
docs/ListProfiles200Response.md
|
||||
docs/ListProfiles200ResponseEmbedded.md
|
||||
docs/ListSalesInvoices200Response.md
|
||||
docs/ListSalesInvoices200ResponseEmbedded.md
|
||||
docs/ListSettlementCaptures200Response.md
|
||||
docs/ListSettlementCaptures200ResponseEmbedded.md
|
||||
docs/ListSettlementChargebacks200Response.md
|
||||
docs/ListSettlementChargebacks200ResponseEmbedded.md
|
||||
docs/ListSettlementPayments200Response.md
|
||||
docs/ListSettlementPayments200ResponseEmbedded.md
|
||||
docs/ListSettlementRefunds200Response.md
|
||||
docs/ListSettlementRefunds200ResponseEmbedded.md
|
||||
docs/ListSettlements200Response.md
|
||||
docs/ListSettlements200ResponseEmbedded.md
|
||||
docs/ListSubscriptions200Response.md
|
||||
docs/ListSubscriptions200ResponseEmbedded.md
|
||||
docs/ListTerminals200Response.md
|
||||
docs/ListTerminals200ResponseEmbedded.md
|
||||
docs/ListWebhooks200Response.md
|
||||
docs/ListWebhooks200ResponseEmbedded.md
|
||||
docs/Locale.md
|
||||
docs/LocaleResponse.md
|
||||
docs/MandateDetailsCardLabel.md
|
||||
docs/MandateDetailsCardLabelResponse.md
|
||||
docs/MandateMethod.md
|
||||
docs/MandateMethodResponse.md
|
||||
docs/MandateRequest.md
|
||||
docs/MandateResponse.md
|
||||
docs/MandateStatus.md
|
||||
docs/MandatesApiApi.md
|
||||
docs/Metadata.md
|
||||
docs/Method.md
|
||||
docs/MethodIssuerStatus.md
|
||||
docs/MethodResponse.md
|
||||
docs/MethodStatus.md
|
||||
docs/MethodsApiApi.md
|
||||
docs/Mode.md
|
||||
docs/OnboardingApiApi.md
|
||||
docs/OnboardingStatus.md
|
||||
docs/OrganizationVatRegulation.md
|
||||
docs/OrganizationsApiApi.md
|
||||
docs/PaymentAddress.md
|
||||
docs/PaymentDetailsCardAudition.md
|
||||
docs/PaymentDetailsCardAuditionResponse.md
|
||||
docs/PaymentDetailsCardFunding.md
|
||||
docs/PaymentDetailsCardFundingResponse.md
|
||||
docs/PaymentDetailsCardLabel.md
|
||||
docs/PaymentDetailsCardLabelResponse.md
|
||||
docs/PaymentDetailsCardSecurity.md
|
||||
docs/PaymentDetailsCardSecurityResponse.md
|
||||
docs/PaymentDetailsFailureReason.md
|
||||
docs/PaymentDetailsFailureReasonResponse.md
|
||||
docs/PaymentDetailsFeeRegion.md
|
||||
docs/PaymentDetailsFeeRegionResponse.md
|
||||
docs/PaymentDetailsReceiptCardReadMethod.md
|
||||
docs/PaymentDetailsReceiptCardReadMethodResponse.md
|
||||
docs/PaymentDetailsReceiptCardVerificationMethod.md
|
||||
docs/PaymentDetailsReceiptCardVerificationMethodResponse.md
|
||||
docs/PaymentDetailsSellerProtection.md
|
||||
docs/PaymentDetailsSellerProtectionResponse.md
|
||||
docs/PaymentDetailsWallet.md
|
||||
docs/PaymentDetailsWalletResponse.md
|
||||
docs/PaymentLineItem.md
|
||||
docs/PaymentLineItemResponse.md
|
||||
docs/PaymentLineType.md
|
||||
docs/PaymentLineTypeResponse.md
|
||||
docs/PaymentLinkResponse.md
|
||||
docs/PaymentLinkSequenceType.md
|
||||
docs/PaymentLinkSequenceTypeResponse.md
|
||||
docs/PaymentLinksApiApi.md
|
||||
docs/PaymentListRoutes200Response.md
|
||||
docs/PaymentListRoutes200ResponseEmbedded.md
|
||||
docs/PaymentListRoutes200ResponseLinks.md
|
||||
docs/PaymentMethod.md
|
||||
docs/PaymentRequest.md
|
||||
docs/PaymentResponse.md
|
||||
docs/PaymentStatus.md
|
||||
docs/PaymentsApiApi.md
|
||||
docs/PermissionsApiApi.md
|
||||
docs/ProfileReviewStatus.md
|
||||
docs/ProfileReviewStatusResponse.md
|
||||
docs/ProfileStatus.md
|
||||
docs/ProfilesApiApi.md
|
||||
docs/ProfilesProfileIdMethodsIdProfileIdParameter.md
|
||||
docs/RecurringLineItem.md
|
||||
docs/RefundExternalReferenceType.md
|
||||
docs/RefundExternalReferenceTypeResponse.md
|
||||
docs/RefundRequest.md
|
||||
docs/RefundRoutingReversalsSourceType.md
|
||||
docs/RefundStatus.md
|
||||
docs/RefundsApiApi.md
|
||||
docs/ReleaseAuthorizationRequest.md
|
||||
docs/RequestApplePayPaymentSessionRequest.md
|
||||
docs/RouteCreateRequest.md
|
||||
docs/RouteCreateRequestDestination.md
|
||||
docs/RouteCreateResponse.md
|
||||
docs/RouteDestinationType.md
|
||||
docs/RouteDestinationTypeResponse.md
|
||||
docs/RouteGetResponse.md
|
||||
docs/SalesInvoiceDiscount.md
|
||||
docs/SalesInvoiceDiscountResponse.md
|
||||
docs/SalesInvoiceDiscountType.md
|
||||
docs/SalesInvoiceDiscountTypeResponse.md
|
||||
docs/SalesInvoiceEmailDetails.md
|
||||
docs/SalesInvoiceLineItem.md
|
||||
docs/SalesInvoiceLineItemResponse.md
|
||||
docs/SalesInvoicePaymentDetails.md
|
||||
docs/SalesInvoicePaymentDetailsResponse.md
|
||||
docs/SalesInvoicePaymentDetailsSource.md
|
||||
docs/SalesInvoicePaymentDetailsSourceResponse.md
|
||||
docs/SalesInvoicePaymentTerm.md
|
||||
docs/SalesInvoicePaymentTermResponse.md
|
||||
docs/SalesInvoiceRecipient.md
|
||||
docs/SalesInvoiceRecipientLocale.md
|
||||
docs/SalesInvoiceRecipientLocaleResponse.md
|
||||
docs/SalesInvoiceRecipientResponse.md
|
||||
docs/SalesInvoiceRecipientType.md
|
||||
docs/SalesInvoiceRecipientTypeResponse.md
|
||||
docs/SalesInvoiceStatus.md
|
||||
docs/SalesInvoiceStatusResponse.md
|
||||
docs/SalesInvoiceVatMode.md
|
||||
docs/SalesInvoiceVatModeResponse.md
|
||||
docs/SalesInvoiceVatScheme.md
|
||||
docs/SalesInvoiceVatSchemeResponse.md
|
||||
docs/SalesInvoicesApiApi.md
|
||||
docs/SequenceType.md
|
||||
docs/SequenceTypeResponse.md
|
||||
docs/SettlementStatus.md
|
||||
docs/SettlementsApiApi.md
|
||||
docs/StatusReason.md
|
||||
docs/SubGroup.md
|
||||
docs/SubTotals.md
|
||||
docs/SubmitOnboardingDataRequest.md
|
||||
docs/SubmitOnboardingDataRequestOrganization.md
|
||||
docs/SubmitOnboardingDataRequestProfile.md
|
||||
docs/SubscriptionMethod.md
|
||||
docs/SubscriptionMethodResponse.md
|
||||
docs/SubscriptionRequest.md
|
||||
docs/SubscriptionResponse.md
|
||||
docs/SubscriptionStatus.md
|
||||
docs/SubscriptionsApiApi.md
|
||||
docs/TerminalBrand.md
|
||||
docs/TerminalModel.md
|
||||
docs/TerminalStatus.md
|
||||
docs/TerminalsApiApi.md
|
||||
docs/UpdatePaymentLinkRequest.md
|
||||
docs/UpdatePaymentRequest.md
|
||||
docs/UpdateProfileRequest.md
|
||||
docs/UpdateSubscriptionRequest.md
|
||||
docs/UpdateValuesSalesInvoice.md
|
||||
docs/UpdateWebhookRequest.md
|
||||
docs/Url.md
|
||||
docs/UrlNullable.md
|
||||
docs/Voucher.md
|
||||
docs/VoucherContractor.md
|
||||
docs/VoucherImage.md
|
||||
docs/WalletsApiApi.md
|
||||
docs/WebhookEventTypes.md
|
||||
docs/WebhookEventTypesResponse.md
|
||||
docs/WebhookEventsApiApi.md
|
||||
docs/WebhookStatus.md
|
||||
docs/WebhooksApiApi.md
|
||||
git_push.sh
|
||||
src/apis/balance_transfers_api_api.rs
|
||||
src/apis/balances_api_api.rs
|
||||
src/apis/capabilities_api_api.rs
|
||||
src/apis/captures_api_api.rs
|
||||
src/apis/chargebacks_api_api.rs
|
||||
src/apis/client_links_api_api.rs
|
||||
src/apis/clients_api_api.rs
|
||||
src/apis/configuration.rs
|
||||
src/apis/customers_api_api.rs
|
||||
src/apis/delayed_routing_api_api.rs
|
||||
src/apis/invoices_api_api.rs
|
||||
src/apis/mandates_api_api.rs
|
||||
src/apis/methods_api_api.rs
|
||||
src/apis/mod.rs
|
||||
src/apis/onboarding_api_api.rs
|
||||
src/apis/organizations_api_api.rs
|
||||
src/apis/payment_links_api_api.rs
|
||||
src/apis/payments_api_api.rs
|
||||
src/apis/permissions_api_api.rs
|
||||
src/apis/profiles_api_api.rs
|
||||
src/apis/refunds_api_api.rs
|
||||
src/apis/sales_invoices_api_api.rs
|
||||
src/apis/settlements_api_api.rs
|
||||
src/apis/subscriptions_api_api.rs
|
||||
src/apis/terminals_api_api.rs
|
||||
src/apis/wallets_api_api.rs
|
||||
src/apis/webhook_events_api_api.rs
|
||||
src/apis/webhooks_api_api.rs
|
||||
src/lib.rs
|
||||
src/models/_profiles__profile_id__methods__id__profile_id_parameter.rs
|
||||
src/models/address.rs
|
||||
src/models/amount.rs
|
||||
src/models/amount_nullable.rs
|
||||
src/models/balance_report_grouping.rs
|
||||
src/models/balance_status.rs
|
||||
src/models/balance_transaction_type.rs
|
||||
src/models/balance_transfer_category.rs
|
||||
src/models/balance_transfer_category_response.rs
|
||||
src/models/balance_transfer_destination_type.rs
|
||||
src/models/balance_transfer_frequency.rs
|
||||
src/models/balance_transfer_party_type.rs
|
||||
src/models/balance_transfer_party_type_response.rs
|
||||
src/models/balance_transfer_status.rs
|
||||
src/models/balance_transfer_status_reason.rs
|
||||
src/models/balance_transfer_status_reason_response.rs
|
||||
src/models/billing_address.rs
|
||||
src/models/cancel_payment_request.rs
|
||||
src/models/capability_requirement_status.rs
|
||||
src/models/capability_status.rs
|
||||
src/models/capability_status_reason.rs
|
||||
src/models/capture_mode.rs
|
||||
src/models/capture_mode_response.rs
|
||||
src/models/capture_response.rs
|
||||
src/models/capture_status.rs
|
||||
src/models/components_sub_totals.rs
|
||||
src/models/create_payment_link_request.rs
|
||||
src/models/create_payment_link_request__links.rs
|
||||
src/models/create_payment_link_request_application_fee.rs
|
||||
src/models/create_webhook.rs
|
||||
src/models/create_webhook_request.rs
|
||||
src/models/currencies.rs
|
||||
src/models/customer_response.rs
|
||||
src/models/delete_values_sales_invoice.rs
|
||||
src/models/delete_webhook_request.rs
|
||||
src/models/enable_method_issuer_200_response.rs
|
||||
src/models/enable_method_issuer_request.rs
|
||||
src/models/entity_balance.rs
|
||||
src/models/entity_balance__links.rs
|
||||
src/models/entity_balance_report.rs
|
||||
src/models/entity_balance_report_totals.rs
|
||||
src/models/entity_balance_report_totals_available_balance.rs
|
||||
src/models/entity_balance_report_totals_open.rs
|
||||
src/models/entity_balance_report_totals_payments.rs
|
||||
src/models/entity_balance_report_totals_pending_balance.rs
|
||||
src/models/entity_balance_transaction.rs
|
||||
src/models/entity_balance_transaction_context.rs
|
||||
src/models/entity_balance_transaction_context_application_fee.rs
|
||||
src/models/entity_balance_transaction_context_capture.rs
|
||||
src/models/entity_balance_transaction_context_chargeback.rs
|
||||
src/models/entity_balance_transaction_context_invoice_compensation.rs
|
||||
src/models/entity_balance_transaction_context_managed_fee.rs
|
||||
src/models/entity_balance_transaction_context_outgoing_transfer.rs
|
||||
src/models/entity_balance_transaction_context_payment.rs
|
||||
src/models/entity_balance_transaction_context_payment_commission.rs
|
||||
src/models/entity_balance_transaction_context_post_payment_split_payment.rs
|
||||
src/models/entity_balance_transaction_context_refund.rs
|
||||
src/models/entity_balance_transaction_context_returned_transfer.rs
|
||||
src/models/entity_balance_transaction_context_split_payment.rs
|
||||
src/models/entity_balance_transfer.rs
|
||||
src/models/entity_balance_transfer_destination.rs
|
||||
src/models/entity_balance_transfer_party.rs
|
||||
src/models/entity_balance_transfer_party_response.rs
|
||||
src/models/entity_balance_transfer_response.rs
|
||||
src/models/entity_balance_transfer_response_status_reason.rs
|
||||
src/models/entity_balance_transfer_status_reason.rs
|
||||
src/models/entity_capability.rs
|
||||
src/models/entity_capability_requirement.rs
|
||||
src/models/entity_capability_requirement__links.rs
|
||||
src/models/entity_capability_requirement__links_dashboard.rs
|
||||
src/models/entity_capture.rs
|
||||
src/models/entity_capture__links.rs
|
||||
src/models/entity_capture_response.rs
|
||||
src/models/entity_chargeback.rs
|
||||
src/models/entity_chargeback_reason.rs
|
||||
src/models/entity_client.rs
|
||||
src/models/entity_client__links.rs
|
||||
src/models/entity_client_commission.rs
|
||||
src/models/entity_client_link.rs
|
||||
src/models/entity_client_link__links.rs
|
||||
src/models/entity_client_link_address.rs
|
||||
src/models/entity_client_link_owner.rs
|
||||
src/models/entity_client_link_response.rs
|
||||
src/models/entity_customer.rs
|
||||
src/models/entity_customer__links.rs
|
||||
src/models/entity_customer_response.rs
|
||||
src/models/entity_event.rs
|
||||
src/models/entity_event__links.rs
|
||||
src/models/entity_invoice.rs
|
||||
src/models/entity_invoice__links.rs
|
||||
src/models/entity_invoice_lines_inner.rs
|
||||
src/models/entity_mandate.rs
|
||||
src/models/entity_mandate__links.rs
|
||||
src/models/entity_mandate_details.rs
|
||||
src/models/entity_mandate_response.rs
|
||||
src/models/entity_mandate_response_details.rs
|
||||
src/models/entity_method.rs
|
||||
src/models/entity_method__links.rs
|
||||
src/models/entity_method_all.rs
|
||||
src/models/entity_method_all_all_of_pricing.rs
|
||||
src/models/entity_method_image.rs
|
||||
src/models/entity_method_issuers_inner.rs
|
||||
src/models/entity_method_issuers_inner_image.rs
|
||||
src/models/entity_onboarding_status.rs
|
||||
src/models/entity_onboarding_status__links.rs
|
||||
src/models/entity_organization.rs
|
||||
src/models/entity_organization__links.rs
|
||||
src/models/entity_payment.rs
|
||||
src/models/entity_payment__links.rs
|
||||
src/models/entity_payment_application_fee.rs
|
||||
src/models/entity_payment_billing_address.rs
|
||||
src/models/entity_payment_details.rs
|
||||
src/models/entity_payment_details_qr_code.rs
|
||||
src/models/entity_payment_details_receipt.rs
|
||||
src/models/entity_payment_lines_inner.rs
|
||||
src/models/entity_payment_link.rs
|
||||
src/models/entity_payment_response.rs
|
||||
src/models/entity_payment_response_details.rs
|
||||
src/models/entity_payment_response_details_receipt.rs
|
||||
src/models/entity_payment_response_lines_inner.rs
|
||||
src/models/entity_payment_route.rs
|
||||
src/models/entity_payment_route__links.rs
|
||||
src/models/entity_payment_route_destination.rs
|
||||
src/models/entity_payment_route_response.rs
|
||||
src/models/entity_payment_route_response_destination.rs
|
||||
src/models/entity_permission.rs
|
||||
src/models/entity_profile.rs
|
||||
src/models/entity_profile__links.rs
|
||||
src/models/entity_profile_response.rs
|
||||
src/models/entity_profile_response_review.rs
|
||||
src/models/entity_profile_review.rs
|
||||
src/models/entity_refund.rs
|
||||
src/models/entity_refund__links.rs
|
||||
src/models/entity_refund_external_reference.rs
|
||||
src/models/entity_refund_response.rs
|
||||
src/models/entity_refund_response_external_reference.rs
|
||||
src/models/entity_refund_routing_reversals_inner.rs
|
||||
src/models/entity_refund_routing_reversals_inner_source.rs
|
||||
src/models/entity_route.rs
|
||||
src/models/entity_route_destination.rs
|
||||
src/models/entity_sales_invoice.rs
|
||||
src/models/entity_sales_invoice__links.rs
|
||||
src/models/entity_sales_invoice_response.rs
|
||||
src/models/entity_settlement.rs
|
||||
src/models/entity_settlement__links.rs
|
||||
src/models/entity_settlement_periods_value_value.rs
|
||||
src/models/entity_settlement_periods_value_value_costs_inner.rs
|
||||
src/models/entity_settlement_periods_value_value_costs_inner_rate.rs
|
||||
src/models/entity_settlement_periods_value_value_revenue_inner.rs
|
||||
src/models/entity_subscription.rs
|
||||
src/models/entity_subscription__links.rs
|
||||
src/models/entity_subscription_application_fee.rs
|
||||
src/models/entity_terminal.rs
|
||||
src/models/entity_webhook.rs
|
||||
src/models/entity_webhook__links.rs
|
||||
src/models/entity_webhook_event.rs
|
||||
src/models/entity_webhook_event__embedded.rs
|
||||
src/models/entity_webhook_event__embedded_entity.rs
|
||||
src/models/entity_webhook_event__links.rs
|
||||
src/models/error_response.rs
|
||||
src/models/error_response__links.rs
|
||||
src/models/error_response__links_documentation.rs
|
||||
src/models/extra_parameter_parameters.rs
|
||||
src/models/extra_parameter_parameters_company.rs
|
||||
src/models/get_customer_200_response.rs
|
||||
src/models/get_partner_status_200_response.rs
|
||||
src/models/get_partner_status_200_response__links.rs
|
||||
src/models/get_partner_status_200_response_user_agent_tokens_inner.rs
|
||||
src/models/giftcard.rs
|
||||
src/models/invoice_status.rs
|
||||
src/models/line_categories.rs
|
||||
src/models/line_categories_response.rs
|
||||
src/models/list_all_methods_200_response.rs
|
||||
src/models/list_all_methods_200_response__embedded.rs
|
||||
src/models/list_all_subscriptions_200_response.rs
|
||||
src/models/list_all_subscriptions_200_response__embedded.rs
|
||||
src/models/list_balance_transactions_200_response.rs
|
||||
src/models/list_balance_transactions_200_response__embedded.rs
|
||||
src/models/list_balances_200_response.rs
|
||||
src/models/list_balances_200_response__embedded.rs
|
||||
src/models/list_capabilities_200_response.rs
|
||||
src/models/list_capabilities_200_response__embedded.rs
|
||||
src/models/list_capabilities_200_response__links.rs
|
||||
src/models/list_capabilities_200_response__links_documentation.rs
|
||||
src/models/list_clients_200_response.rs
|
||||
src/models/list_clients_200_response__embedded.rs
|
||||
src/models/list_clients_200_response__embedded_clients_inner.rs
|
||||
src/models/list_clients_200_response__embedded_clients_inner_all_of__embedded.rs
|
||||
src/models/list_connect_balance_transfers_200_response.rs
|
||||
src/models/list_connect_balance_transfers_200_response__embedded.rs
|
||||
src/models/list_customers_200_response.rs
|
||||
src/models/list_customers_200_response__embedded.rs
|
||||
src/models/list_invoices_200_response.rs
|
||||
src/models/list_invoices_200_response__embedded.rs
|
||||
src/models/list_links.rs
|
||||
src/models/list_mandates_200_response.rs
|
||||
src/models/list_mandates_200_response__embedded.rs
|
||||
src/models/list_methods_200_response.rs
|
||||
src/models/list_methods_200_response__embedded.rs
|
||||
src/models/list_methods_200_response__links.rs
|
||||
src/models/list_payment_links_200_response.rs
|
||||
src/models/list_payment_links_200_response__embedded.rs
|
||||
src/models/list_permissions_200_response.rs
|
||||
src/models/list_permissions_200_response__embedded.rs
|
||||
src/models/list_permissions_200_response__links.rs
|
||||
src/models/list_profiles_200_response.rs
|
||||
src/models/list_profiles_200_response__embedded.rs
|
||||
src/models/list_sales_invoices_200_response.rs
|
||||
src/models/list_sales_invoices_200_response__embedded.rs
|
||||
src/models/list_settlement_captures_200_response.rs
|
||||
src/models/list_settlement_captures_200_response__embedded.rs
|
||||
src/models/list_settlement_chargebacks_200_response.rs
|
||||
src/models/list_settlement_chargebacks_200_response__embedded.rs
|
||||
src/models/list_settlement_payments_200_response.rs
|
||||
src/models/list_settlement_payments_200_response__embedded.rs
|
||||
src/models/list_settlement_refunds_200_response.rs
|
||||
src/models/list_settlement_refunds_200_response__embedded.rs
|
||||
src/models/list_settlements_200_response.rs
|
||||
src/models/list_settlements_200_response__embedded.rs
|
||||
src/models/list_subscriptions_200_response.rs
|
||||
src/models/list_subscriptions_200_response__embedded.rs
|
||||
src/models/list_terminals_200_response.rs
|
||||
src/models/list_terminals_200_response__embedded.rs
|
||||
src/models/list_webhooks_200_response.rs
|
||||
src/models/list_webhooks_200_response__embedded.rs
|
||||
src/models/locale.rs
|
||||
src/models/locale_response.rs
|
||||
src/models/mandate_details_card_label.rs
|
||||
src/models/mandate_details_card_label_response.rs
|
||||
src/models/mandate_method.rs
|
||||
src/models/mandate_method_response.rs
|
||||
src/models/mandate_request.rs
|
||||
src/models/mandate_response.rs
|
||||
src/models/mandate_status.rs
|
||||
src/models/metadata.rs
|
||||
src/models/method.rs
|
||||
src/models/method_issuer_status.rs
|
||||
src/models/method_response.rs
|
||||
src/models/method_status.rs
|
||||
src/models/mod.rs
|
||||
src/models/mode.rs
|
||||
src/models/onboarding_status.rs
|
||||
src/models/organization_vat_regulation.rs
|
||||
src/models/payment_address.rs
|
||||
src/models/payment_details_card_audition.rs
|
||||
src/models/payment_details_card_audition_response.rs
|
||||
src/models/payment_details_card_funding.rs
|
||||
src/models/payment_details_card_funding_response.rs
|
||||
src/models/payment_details_card_label.rs
|
||||
src/models/payment_details_card_label_response.rs
|
||||
src/models/payment_details_card_security.rs
|
||||
src/models/payment_details_card_security_response.rs
|
||||
src/models/payment_details_failure_reason.rs
|
||||
src/models/payment_details_failure_reason_response.rs
|
||||
src/models/payment_details_fee_region.rs
|
||||
src/models/payment_details_fee_region_response.rs
|
||||
src/models/payment_details_receipt_card_read_method.rs
|
||||
src/models/payment_details_receipt_card_read_method_response.rs
|
||||
src/models/payment_details_receipt_card_verification_method.rs
|
||||
src/models/payment_details_receipt_card_verification_method_response.rs
|
||||
src/models/payment_details_seller_protection.rs
|
||||
src/models/payment_details_seller_protection_response.rs
|
||||
src/models/payment_details_wallet.rs
|
||||
src/models/payment_details_wallet_response.rs
|
||||
src/models/payment_line_item.rs
|
||||
src/models/payment_line_item_response.rs
|
||||
src/models/payment_line_type.rs
|
||||
src/models/payment_line_type_response.rs
|
||||
src/models/payment_link_response.rs
|
||||
src/models/payment_link_sequence_type.rs
|
||||
src/models/payment_link_sequence_type_response.rs
|
||||
src/models/payment_list_routes_200_response.rs
|
||||
src/models/payment_list_routes_200_response__embedded.rs
|
||||
src/models/payment_list_routes_200_response__links.rs
|
||||
src/models/payment_method.rs
|
||||
src/models/payment_request.rs
|
||||
src/models/payment_response.rs
|
||||
src/models/payment_status.rs
|
||||
src/models/profile_review_status.rs
|
||||
src/models/profile_review_status_response.rs
|
||||
src/models/profile_status.rs
|
||||
src/models/recurring_line_item.rs
|
||||
src/models/refund_external_reference_type.rs
|
||||
src/models/refund_external_reference_type_response.rs
|
||||
src/models/refund_request.rs
|
||||
src/models/refund_routing_reversals_source_type.rs
|
||||
src/models/refund_status.rs
|
||||
src/models/release_authorization_request.rs
|
||||
src/models/request_apple_pay_payment_session_request.rs
|
||||
src/models/route_create_request.rs
|
||||
src/models/route_create_request_destination.rs
|
||||
src/models/route_create_response.rs
|
||||
src/models/route_destination_type.rs
|
||||
src/models/route_destination_type_response.rs
|
||||
src/models/route_get_response.rs
|
||||
src/models/sales_invoice_discount.rs
|
||||
src/models/sales_invoice_discount_response.rs
|
||||
src/models/sales_invoice_discount_type.rs
|
||||
src/models/sales_invoice_discount_type_response.rs
|
||||
src/models/sales_invoice_email_details.rs
|
||||
src/models/sales_invoice_line_item.rs
|
||||
src/models/sales_invoice_line_item_response.rs
|
||||
src/models/sales_invoice_payment_details.rs
|
||||
src/models/sales_invoice_payment_details_response.rs
|
||||
src/models/sales_invoice_payment_details_source.rs
|
||||
src/models/sales_invoice_payment_details_source_response.rs
|
||||
src/models/sales_invoice_payment_term.rs
|
||||
src/models/sales_invoice_payment_term_response.rs
|
||||
src/models/sales_invoice_recipient.rs
|
||||
src/models/sales_invoice_recipient_locale.rs
|
||||
src/models/sales_invoice_recipient_locale_response.rs
|
||||
src/models/sales_invoice_recipient_response.rs
|
||||
src/models/sales_invoice_recipient_type.rs
|
||||
src/models/sales_invoice_recipient_type_response.rs
|
||||
src/models/sales_invoice_status.rs
|
||||
src/models/sales_invoice_status_response.rs
|
||||
src/models/sales_invoice_vat_mode.rs
|
||||
src/models/sales_invoice_vat_mode_response.rs
|
||||
src/models/sales_invoice_vat_scheme.rs
|
||||
src/models/sales_invoice_vat_scheme_response.rs
|
||||
src/models/sequence_type.rs
|
||||
src/models/sequence_type_response.rs
|
||||
src/models/settlement_status.rs
|
||||
src/models/status_reason.rs
|
||||
src/models/sub_group.rs
|
||||
src/models/sub_totals.rs
|
||||
src/models/submit_onboarding_data_request.rs
|
||||
src/models/submit_onboarding_data_request_organization.rs
|
||||
src/models/submit_onboarding_data_request_profile.rs
|
||||
src/models/subscription_method.rs
|
||||
src/models/subscription_method_response.rs
|
||||
src/models/subscription_request.rs
|
||||
src/models/subscription_response.rs
|
||||
src/models/subscription_status.rs
|
||||
src/models/terminal_brand.rs
|
||||
src/models/terminal_model.rs
|
||||
src/models/terminal_status.rs
|
||||
src/models/update_payment_link_request.rs
|
||||
src/models/update_payment_request.rs
|
||||
src/models/update_profile_request.rs
|
||||
src/models/update_subscription_request.rs
|
||||
src/models/update_values_sales_invoice.rs
|
||||
src/models/update_webhook_request.rs
|
||||
src/models/url.rs
|
||||
src/models/url_nullable.rs
|
||||
src/models/voucher.rs
|
||||
src/models/voucher_contractor.rs
|
||||
src/models/voucher_image.rs
|
||||
src/models/webhook_event_types.rs
|
||||
src/models/webhook_event_types_response.rs
|
||||
src/models/webhook_status.rs
|
||||
@@ -0,0 +1 @@
|
||||
7.16.0
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
[package]
|
||||
name = "mollie"
|
||||
version = "1.0.0"
|
||||
authors = ["Zomatree <me@zomatree.live>"]
|
||||
description = "Mollie.com API wrapper for Rust"
|
||||
license = "MIT"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
serde = { version = "^1.0", features = ["derive"] }
|
||||
serde_with = { version = "^3.8", default-features = false, features = ["base64", "std", "macros"] }
|
||||
serde_json = "^1.0"
|
||||
serde_repr = "^0.1"
|
||||
url = "^2.5"
|
||||
reqwest = { version = "^0.12", default-features = false, features = ["json", "multipart"] }
|
||||
|
||||
[features]
|
||||
default = ["native-tls"]
|
||||
native-tls = ["reqwest/native-tls"]
|
||||
rustls-tls = ["reqwest/rustls-tls"]
|
||||
@@ -0,0 +1,493 @@
|
||||
# Rust API client for mollie
|
||||
|
||||
Mollie.com API wrapper for Rust
|
||||
|
||||
## Overview
|
||||
|
||||
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
|
||||
|
||||
- API version: 1.0.0
|
||||
- Package version: 1.0.0
|
||||
- Generator version: 7.16.0
|
||||
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
|
||||
|
||||
## Installation
|
||||
|
||||
Put the package under your project folder in a directory named `mollie` and add the following to `Cargo.toml` under `[dependencies]`:
|
||||
|
||||
```
|
||||
mollie = { git = "https://github.com/stoatchat/mollie-rs" }
|
||||
```
|
||||
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*BalanceTransfersApiApi* | [**create_connect_balance_transfer**](docs/BalanceTransfersApiApi.md#create_connect_balance_transfer) | **POST** /connect/balance-transfers | Create a Connect balance transfer
|
||||
*BalanceTransfersApiApi* | [**get_connect_balance_transfer**](docs/BalanceTransfersApiApi.md#get_connect_balance_transfer) | **GET** /connect/balance-transfers/{id} | Get a Connect balance transfer
|
||||
*BalanceTransfersApiApi* | [**list_connect_balance_transfers**](docs/BalanceTransfersApiApi.md#list_connect_balance_transfers) | **GET** /connect/balance-transfers | List all Connect balance transfers
|
||||
*BalancesApiApi* | [**get_balance**](docs/BalancesApiApi.md#get_balance) | **GET** /balances/{id} | Get balance
|
||||
*BalancesApiApi* | [**get_balance_report**](docs/BalancesApiApi.md#get_balance_report) | **GET** /balances/{balanceId}/report | Get balance report
|
||||
*BalancesApiApi* | [**get_primary_balance**](docs/BalancesApiApi.md#get_primary_balance) | **GET** /balances/primary | Get primary balance
|
||||
*BalancesApiApi* | [**list_balance_transactions**](docs/BalancesApiApi.md#list_balance_transactions) | **GET** /balances/{balanceId}/transactions | List balance transactions
|
||||
*BalancesApiApi* | [**list_balances**](docs/BalancesApiApi.md#list_balances) | **GET** /balances | List balances
|
||||
*CapabilitiesApiApi* | [**list_capabilities**](docs/CapabilitiesApiApi.md#list_capabilities) | **GET** /capabilities | List capabilities
|
||||
*CapturesApiApi* | [**create_capture**](docs/CapturesApiApi.md#create_capture) | **POST** /payments/{paymentId}/captures | Create capture
|
||||
*CapturesApiApi* | [**get_capture**](docs/CapturesApiApi.md#get_capture) | **GET** /payments/{paymentId}/captures/{captureId} | Get capture
|
||||
*CapturesApiApi* | [**list_captures**](docs/CapturesApiApi.md#list_captures) | **GET** /payments/{paymentId}/captures | List captures
|
||||
*ChargebacksApiApi* | [**get_chargeback**](docs/ChargebacksApiApi.md#get_chargeback) | **GET** /payments/{paymentId}/chargebacks/{chargebackId} | Get payment chargeback
|
||||
*ChargebacksApiApi* | [**list_all_chargebacks**](docs/ChargebacksApiApi.md#list_all_chargebacks) | **GET** /chargebacks | List all chargebacks
|
||||
*ChargebacksApiApi* | [**list_chargebacks**](docs/ChargebacksApiApi.md#list_chargebacks) | **GET** /payments/{paymentId}/chargebacks | List payment chargebacks
|
||||
*ClientLinksApiApi* | [**create_client_link**](docs/ClientLinksApiApi.md#create_client_link) | **POST** /client-links | Create client link
|
||||
*ClientsApiApi* | [**get_client**](docs/ClientsApiApi.md#get_client) | **GET** /clients/{id} | Get client
|
||||
*ClientsApiApi* | [**list_clients**](docs/ClientsApiApi.md#list_clients) | **GET** /clients | List clients
|
||||
*CustomersApiApi* | [**create_customer**](docs/CustomersApiApi.md#create_customer) | **POST** /customers | Create customer
|
||||
*CustomersApiApi* | [**create_customer_payment**](docs/CustomersApiApi.md#create_customer_payment) | **POST** /customers/{customerId}/payments | Create customer payment
|
||||
*CustomersApiApi* | [**delete_customer**](docs/CustomersApiApi.md#delete_customer) | **DELETE** /customers/{customerId} | Delete customer
|
||||
*CustomersApiApi* | [**get_customer**](docs/CustomersApiApi.md#get_customer) | **GET** /customers/{customerId} | Get customer
|
||||
*CustomersApiApi* | [**list_customer_payments**](docs/CustomersApiApi.md#list_customer_payments) | **GET** /customers/{customerId}/payments | List customer payments
|
||||
*CustomersApiApi* | [**list_customers**](docs/CustomersApiApi.md#list_customers) | **GET** /customers | List customers
|
||||
*CustomersApiApi* | [**update_customer**](docs/CustomersApiApi.md#update_customer) | **PATCH** /customers/{customerId} | Update customer
|
||||
*DelayedRoutingApiApi* | [**payment_create_route**](docs/DelayedRoutingApiApi.md#payment_create_route) | **POST** /payments/{paymentId}/routes | Create a delayed route
|
||||
*DelayedRoutingApiApi* | [**payment_list_routes**](docs/DelayedRoutingApiApi.md#payment_list_routes) | **GET** /payments/{paymentId}/routes | List payment routes
|
||||
*InvoicesApiApi* | [**get_invoice**](docs/InvoicesApiApi.md#get_invoice) | **GET** /invoices/{id} | Get invoice
|
||||
*InvoicesApiApi* | [**list_invoices**](docs/InvoicesApiApi.md#list_invoices) | **GET** /invoices | List invoices
|
||||
*MandatesApiApi* | [**create_mandate**](docs/MandatesApiApi.md#create_mandate) | **POST** /customers/{customerId}/mandates | Create mandate
|
||||
*MandatesApiApi* | [**get_mandate**](docs/MandatesApiApi.md#get_mandate) | **GET** /customers/{customerId}/mandates/{mandateId} | Get mandate
|
||||
*MandatesApiApi* | [**list_mandates**](docs/MandatesApiApi.md#list_mandates) | **GET** /customers/{customerId}/mandates | List mandates
|
||||
*MandatesApiApi* | [**revoke_mandate**](docs/MandatesApiApi.md#revoke_mandate) | **DELETE** /customers/{customerId}/mandates/{mandateId} | Revoke mandate
|
||||
*MethodsApiApi* | [**disable_method**](docs/MethodsApiApi.md#disable_method) | **DELETE** /profiles/{profileId}/methods/{id} | Disable payment method
|
||||
*MethodsApiApi* | [**disable_method_issuer**](docs/MethodsApiApi.md#disable_method_issuer) | **DELETE** /profiles/{profileId}/methods/{methodId}/issuers/{id} | Disable payment method issuer
|
||||
*MethodsApiApi* | [**enable_method**](docs/MethodsApiApi.md#enable_method) | **POST** /profiles/{profileId}/methods/{id} | Enable payment method
|
||||
*MethodsApiApi* | [**enable_method_issuer**](docs/MethodsApiApi.md#enable_method_issuer) | **POST** /profiles/{profileId}/methods/{methodId}/issuers/{id} | Enable payment method issuer
|
||||
*MethodsApiApi* | [**get_method**](docs/MethodsApiApi.md#get_method) | **GET** /methods/{id} | Get payment method
|
||||
*MethodsApiApi* | [**list_all_methods**](docs/MethodsApiApi.md#list_all_methods) | **GET** /methods/all | List all payment methods
|
||||
*MethodsApiApi* | [**list_methods**](docs/MethodsApiApi.md#list_methods) | **GET** /methods | List payment methods
|
||||
*OnboardingApiApi* | [**get_onboarding_status**](docs/OnboardingApiApi.md#get_onboarding_status) | **GET** /onboarding/me | Get onboarding status
|
||||
*OnboardingApiApi* | [**submit_onboarding_data**](docs/OnboardingApiApi.md#submit_onboarding_data) | **POST** /onboarding/me | Submit onboarding data
|
||||
*OrganizationsApiApi* | [**get_current_organization**](docs/OrganizationsApiApi.md#get_current_organization) | **GET** /organizations/me | Get current organization
|
||||
*OrganizationsApiApi* | [**get_organization**](docs/OrganizationsApiApi.md#get_organization) | **GET** /organizations/{id} | Get organization
|
||||
*OrganizationsApiApi* | [**get_partner_status**](docs/OrganizationsApiApi.md#get_partner_status) | **GET** /organizations/me/partner | Get partner status
|
||||
*PaymentLinksApiApi* | [**create_payment_link**](docs/PaymentLinksApiApi.md#create_payment_link) | **POST** /payment-links | Create payment link
|
||||
*PaymentLinksApiApi* | [**delete_payment_link**](docs/PaymentLinksApiApi.md#delete_payment_link) | **DELETE** /payment-links/{paymentLinkId} | Delete payment link
|
||||
*PaymentLinksApiApi* | [**get_payment_link**](docs/PaymentLinksApiApi.md#get_payment_link) | **GET** /payment-links/{paymentLinkId} | Get payment link
|
||||
*PaymentLinksApiApi* | [**get_payment_link_payments**](docs/PaymentLinksApiApi.md#get_payment_link_payments) | **GET** /payment-links/{paymentLinkId}/payments | Get payment link payments
|
||||
*PaymentLinksApiApi* | [**list_payment_links**](docs/PaymentLinksApiApi.md#list_payment_links) | **GET** /payment-links | List payment links
|
||||
*PaymentLinksApiApi* | [**update_payment_link**](docs/PaymentLinksApiApi.md#update_payment_link) | **PATCH** /payment-links/{paymentLinkId} | Update payment link
|
||||
*PaymentsApiApi* | [**cancel_payment**](docs/PaymentsApiApi.md#cancel_payment) | **DELETE** /payments/{paymentId} | Cancel payment
|
||||
*PaymentsApiApi* | [**create_payment**](docs/PaymentsApiApi.md#create_payment) | **POST** /payments | Create payment
|
||||
*PaymentsApiApi* | [**get_payment**](docs/PaymentsApiApi.md#get_payment) | **GET** /payments/{paymentId} | Get payment
|
||||
*PaymentsApiApi* | [**list_payments**](docs/PaymentsApiApi.md#list_payments) | **GET** /payments | List payments
|
||||
*PaymentsApiApi* | [**release_authorization**](docs/PaymentsApiApi.md#release_authorization) | **POST** /payments/{paymentId}/release-authorization | Release payment authorization
|
||||
*PaymentsApiApi* | [**update_payment**](docs/PaymentsApiApi.md#update_payment) | **PATCH** /payments/{paymentId} | Update payment
|
||||
*PermissionsApiApi* | [**get_permission**](docs/PermissionsApiApi.md#get_permission) | **GET** /permissions/{permissionId} | Get permission
|
||||
*PermissionsApiApi* | [**list_permissions**](docs/PermissionsApiApi.md#list_permissions) | **GET** /permissions | List permissions
|
||||
*ProfilesApiApi* | [**create_profile**](docs/ProfilesApiApi.md#create_profile) | **POST** /profiles | Create profile
|
||||
*ProfilesApiApi* | [**delete_profile**](docs/ProfilesApiApi.md#delete_profile) | **DELETE** /profiles/{id} | Delete profile
|
||||
*ProfilesApiApi* | [**get_current_profile**](docs/ProfilesApiApi.md#get_current_profile) | **GET** /profiles/me | Get current profile
|
||||
*ProfilesApiApi* | [**get_profile**](docs/ProfilesApiApi.md#get_profile) | **GET** /profiles/{id} | Get profile
|
||||
*ProfilesApiApi* | [**list_profiles**](docs/ProfilesApiApi.md#list_profiles) | **GET** /profiles | List profiles
|
||||
*ProfilesApiApi* | [**update_profile**](docs/ProfilesApiApi.md#update_profile) | **PATCH** /profiles/{id} | Update profile
|
||||
*RefundsApiApi* | [**cancel_refund**](docs/RefundsApiApi.md#cancel_refund) | **DELETE** /payments/{paymentId}/refunds/{refundId} | Cancel payment refund
|
||||
*RefundsApiApi* | [**create_refund**](docs/RefundsApiApi.md#create_refund) | **POST** /payments/{paymentId}/refunds | Create payment refund
|
||||
*RefundsApiApi* | [**get_refund**](docs/RefundsApiApi.md#get_refund) | **GET** /payments/{paymentId}/refunds/{refundId} | Get payment refund
|
||||
*RefundsApiApi* | [**list_all_refunds**](docs/RefundsApiApi.md#list_all_refunds) | **GET** /refunds | List all refunds
|
||||
*RefundsApiApi* | [**list_refunds**](docs/RefundsApiApi.md#list_refunds) | **GET** /payments/{paymentId}/refunds | List payment refunds
|
||||
*SalesInvoicesApiApi* | [**create_sales_invoice**](docs/SalesInvoicesApiApi.md#create_sales_invoice) | **POST** /sales-invoices | Create sales invoice
|
||||
*SalesInvoicesApiApi* | [**delete_sales_invoice**](docs/SalesInvoicesApiApi.md#delete_sales_invoice) | **DELETE** /sales-invoices/{id} | Delete sales invoice
|
||||
*SalesInvoicesApiApi* | [**get_sales_invoice**](docs/SalesInvoicesApiApi.md#get_sales_invoice) | **GET** /sales-invoices/{id} | Get sales invoice
|
||||
*SalesInvoicesApiApi* | [**list_sales_invoices**](docs/SalesInvoicesApiApi.md#list_sales_invoices) | **GET** /sales-invoices | List sales invoices
|
||||
*SalesInvoicesApiApi* | [**update_sales_invoice**](docs/SalesInvoicesApiApi.md#update_sales_invoice) | **PATCH** /sales-invoices/{id} | Update sales invoice
|
||||
*SettlementsApiApi* | [**get_next_settlement**](docs/SettlementsApiApi.md#get_next_settlement) | **GET** /settlements/next | Get next settlement
|
||||
*SettlementsApiApi* | [**get_open_settlement**](docs/SettlementsApiApi.md#get_open_settlement) | **GET** /settlements/open | Get open settlement
|
||||
*SettlementsApiApi* | [**get_settlement**](docs/SettlementsApiApi.md#get_settlement) | **GET** /settlements/{id} | Get settlement
|
||||
*SettlementsApiApi* | [**list_settlement_captures**](docs/SettlementsApiApi.md#list_settlement_captures) | **GET** /settlements/{settlementId}/captures | List settlement captures
|
||||
*SettlementsApiApi* | [**list_settlement_chargebacks**](docs/SettlementsApiApi.md#list_settlement_chargebacks) | **GET** /settlements/{settlementId}/chargebacks | List settlement chargebacks
|
||||
*SettlementsApiApi* | [**list_settlement_payments**](docs/SettlementsApiApi.md#list_settlement_payments) | **GET** /settlements/{settlementId}/payments | List settlement payments
|
||||
*SettlementsApiApi* | [**list_settlement_refunds**](docs/SettlementsApiApi.md#list_settlement_refunds) | **GET** /settlements/{settlementId}/refunds | List settlement refunds
|
||||
*SettlementsApiApi* | [**list_settlements**](docs/SettlementsApiApi.md#list_settlements) | **GET** /settlements | List settlements
|
||||
*SubscriptionsApiApi* | [**cancel_subscription**](docs/SubscriptionsApiApi.md#cancel_subscription) | **DELETE** /customers/{customerId}/subscriptions/{subscriptionId} | Cancel subscription
|
||||
*SubscriptionsApiApi* | [**create_subscription**](docs/SubscriptionsApiApi.md#create_subscription) | **POST** /customers/{customerId}/subscriptions | Create subscription
|
||||
*SubscriptionsApiApi* | [**get_subscription**](docs/SubscriptionsApiApi.md#get_subscription) | **GET** /customers/{customerId}/subscriptions/{subscriptionId} | Get subscription
|
||||
*SubscriptionsApiApi* | [**list_all_subscriptions**](docs/SubscriptionsApiApi.md#list_all_subscriptions) | **GET** /subscriptions | List all subscriptions
|
||||
*SubscriptionsApiApi* | [**list_subscription_payments**](docs/SubscriptionsApiApi.md#list_subscription_payments) | **GET** /customers/{customerId}/subscriptions/{subscriptionId}/payments | List subscription payments
|
||||
*SubscriptionsApiApi* | [**list_subscriptions**](docs/SubscriptionsApiApi.md#list_subscriptions) | **GET** /customers/{customerId}/subscriptions | List customer subscriptions
|
||||
*SubscriptionsApiApi* | [**update_subscription**](docs/SubscriptionsApiApi.md#update_subscription) | **PATCH** /customers/{customerId}/subscriptions/{subscriptionId} | Update subscription
|
||||
*TerminalsApiApi* | [**get_terminal**](docs/TerminalsApiApi.md#get_terminal) | **GET** /terminals/{terminalId} | Get terminal
|
||||
*TerminalsApiApi* | [**list_terminals**](docs/TerminalsApiApi.md#list_terminals) | **GET** /terminals | List terminals
|
||||
*WalletsApiApi* | [**request_apple_pay_payment_session**](docs/WalletsApiApi.md#request_apple_pay_payment_session) | **POST** /wallets/applepay/sessions | Request Apple Pay payment session
|
||||
*WebhookEventsApiApi* | [**get_webhook_event**](docs/WebhookEventsApiApi.md#get_webhook_event) | **GET** /events/{id} | Get a Webhook Event
|
||||
*WebhooksApiApi* | [**create_webhook**](docs/WebhooksApiApi.md#create_webhook) | **POST** /webhooks | Create a webhook
|
||||
*WebhooksApiApi* | [**delete_webhook**](docs/WebhooksApiApi.md#delete_webhook) | **DELETE** /webhooks/{id} | Delete a webhook
|
||||
*WebhooksApiApi* | [**get_webhook**](docs/WebhooksApiApi.md#get_webhook) | **GET** /webhooks/{id} | Get a webhook
|
||||
*WebhooksApiApi* | [**list_webhooks**](docs/WebhooksApiApi.md#list_webhooks) | **GET** /webhooks | List all webhooks
|
||||
*WebhooksApiApi* | [**test_webhook**](docs/WebhooksApiApi.md#test_webhook) | **POST** /webhooks/{id}/ping | Test a webhook
|
||||
*WebhooksApiApi* | [**update_webhook**](docs/WebhooksApiApi.md#update_webhook) | **PATCH** /webhooks/{id} | Update a webhook
|
||||
|
||||
|
||||
## Documentation For Models
|
||||
|
||||
- [Address](docs/Address.md)
|
||||
- [Amount](docs/Amount.md)
|
||||
- [AmountNullable](docs/AmountNullable.md)
|
||||
- [BalanceReportGrouping](docs/BalanceReportGrouping.md)
|
||||
- [BalanceStatus](docs/BalanceStatus.md)
|
||||
- [BalanceTransactionType](docs/BalanceTransactionType.md)
|
||||
- [BalanceTransferCategory](docs/BalanceTransferCategory.md)
|
||||
- [BalanceTransferCategoryResponse](docs/BalanceTransferCategoryResponse.md)
|
||||
- [BalanceTransferDestinationType](docs/BalanceTransferDestinationType.md)
|
||||
- [BalanceTransferFrequency](docs/BalanceTransferFrequency.md)
|
||||
- [BalanceTransferPartyType](docs/BalanceTransferPartyType.md)
|
||||
- [BalanceTransferPartyTypeResponse](docs/BalanceTransferPartyTypeResponse.md)
|
||||
- [BalanceTransferStatus](docs/BalanceTransferStatus.md)
|
||||
- [BalanceTransferStatusReason](docs/BalanceTransferStatusReason.md)
|
||||
- [BalanceTransferStatusReasonResponse](docs/BalanceTransferStatusReasonResponse.md)
|
||||
- [BillingAddress](docs/BillingAddress.md)
|
||||
- [CancelPaymentRequest](docs/CancelPaymentRequest.md)
|
||||
- [CapabilityRequirementStatus](docs/CapabilityRequirementStatus.md)
|
||||
- [CapabilityStatus](docs/CapabilityStatus.md)
|
||||
- [CapabilityStatusReason](docs/CapabilityStatusReason.md)
|
||||
- [CaptureMode](docs/CaptureMode.md)
|
||||
- [CaptureModeResponse](docs/CaptureModeResponse.md)
|
||||
- [CaptureResponse](docs/CaptureResponse.md)
|
||||
- [CaptureStatus](docs/CaptureStatus.md)
|
||||
- [ComponentsSubTotals](docs/ComponentsSubTotals.md)
|
||||
- [CreatePaymentLinkRequest](docs/CreatePaymentLinkRequest.md)
|
||||
- [CreatePaymentLinkRequestApplicationFee](docs/CreatePaymentLinkRequestApplicationFee.md)
|
||||
- [CreatePaymentLinkRequestLinks](docs/CreatePaymentLinkRequestLinks.md)
|
||||
- [CreateWebhook](docs/CreateWebhook.md)
|
||||
- [CreateWebhookRequest](docs/CreateWebhookRequest.md)
|
||||
- [Currencies](docs/Currencies.md)
|
||||
- [CustomerResponse](docs/CustomerResponse.md)
|
||||
- [DeleteValuesSalesInvoice](docs/DeleteValuesSalesInvoice.md)
|
||||
- [DeleteWebhookRequest](docs/DeleteWebhookRequest.md)
|
||||
- [EnableMethodIssuer200Response](docs/EnableMethodIssuer200Response.md)
|
||||
- [EnableMethodIssuerRequest](docs/EnableMethodIssuerRequest.md)
|
||||
- [EntityBalance](docs/EntityBalance.md)
|
||||
- [EntityBalanceLinks](docs/EntityBalanceLinks.md)
|
||||
- [EntityBalanceReport](docs/EntityBalanceReport.md)
|
||||
- [EntityBalanceReportTotals](docs/EntityBalanceReportTotals.md)
|
||||
- [EntityBalanceReportTotalsAvailableBalance](docs/EntityBalanceReportTotalsAvailableBalance.md)
|
||||
- [EntityBalanceReportTotalsOpen](docs/EntityBalanceReportTotalsOpen.md)
|
||||
- [EntityBalanceReportTotalsPayments](docs/EntityBalanceReportTotalsPayments.md)
|
||||
- [EntityBalanceReportTotalsPendingBalance](docs/EntityBalanceReportTotalsPendingBalance.md)
|
||||
- [EntityBalanceTransaction](docs/EntityBalanceTransaction.md)
|
||||
- [EntityBalanceTransactionContext](docs/EntityBalanceTransactionContext.md)
|
||||
- [EntityBalanceTransactionContextApplicationFee](docs/EntityBalanceTransactionContextApplicationFee.md)
|
||||
- [EntityBalanceTransactionContextCapture](docs/EntityBalanceTransactionContextCapture.md)
|
||||
- [EntityBalanceTransactionContextChargeback](docs/EntityBalanceTransactionContextChargeback.md)
|
||||
- [EntityBalanceTransactionContextInvoiceCompensation](docs/EntityBalanceTransactionContextInvoiceCompensation.md)
|
||||
- [EntityBalanceTransactionContextManagedFee](docs/EntityBalanceTransactionContextManagedFee.md)
|
||||
- [EntityBalanceTransactionContextOutgoingTransfer](docs/EntityBalanceTransactionContextOutgoingTransfer.md)
|
||||
- [EntityBalanceTransactionContextPayment](docs/EntityBalanceTransactionContextPayment.md)
|
||||
- [EntityBalanceTransactionContextPaymentCommission](docs/EntityBalanceTransactionContextPaymentCommission.md)
|
||||
- [EntityBalanceTransactionContextPostPaymentSplitPayment](docs/EntityBalanceTransactionContextPostPaymentSplitPayment.md)
|
||||
- [EntityBalanceTransactionContextRefund](docs/EntityBalanceTransactionContextRefund.md)
|
||||
- [EntityBalanceTransactionContextReturnedTransfer](docs/EntityBalanceTransactionContextReturnedTransfer.md)
|
||||
- [EntityBalanceTransactionContextSplitPayment](docs/EntityBalanceTransactionContextSplitPayment.md)
|
||||
- [EntityBalanceTransfer](docs/EntityBalanceTransfer.md)
|
||||
- [EntityBalanceTransferDestination](docs/EntityBalanceTransferDestination.md)
|
||||
- [EntityBalanceTransferParty](docs/EntityBalanceTransferParty.md)
|
||||
- [EntityBalanceTransferPartyResponse](docs/EntityBalanceTransferPartyResponse.md)
|
||||
- [EntityBalanceTransferResponse](docs/EntityBalanceTransferResponse.md)
|
||||
- [EntityBalanceTransferResponseStatusReason](docs/EntityBalanceTransferResponseStatusReason.md)
|
||||
- [EntityBalanceTransferStatusReason](docs/EntityBalanceTransferStatusReason.md)
|
||||
- [EntityCapability](docs/EntityCapability.md)
|
||||
- [EntityCapabilityRequirement](docs/EntityCapabilityRequirement.md)
|
||||
- [EntityCapabilityRequirementLinks](docs/EntityCapabilityRequirementLinks.md)
|
||||
- [EntityCapabilityRequirementLinksDashboard](docs/EntityCapabilityRequirementLinksDashboard.md)
|
||||
- [EntityCapture](docs/EntityCapture.md)
|
||||
- [EntityCaptureLinks](docs/EntityCaptureLinks.md)
|
||||
- [EntityCaptureResponse](docs/EntityCaptureResponse.md)
|
||||
- [EntityChargeback](docs/EntityChargeback.md)
|
||||
- [EntityChargebackReason](docs/EntityChargebackReason.md)
|
||||
- [EntityClient](docs/EntityClient.md)
|
||||
- [EntityClientCommission](docs/EntityClientCommission.md)
|
||||
- [EntityClientLink](docs/EntityClientLink.md)
|
||||
- [EntityClientLinkAddress](docs/EntityClientLinkAddress.md)
|
||||
- [EntityClientLinkLinks](docs/EntityClientLinkLinks.md)
|
||||
- [EntityClientLinkOwner](docs/EntityClientLinkOwner.md)
|
||||
- [EntityClientLinkResponse](docs/EntityClientLinkResponse.md)
|
||||
- [EntityClientLinks](docs/EntityClientLinks.md)
|
||||
- [EntityCustomer](docs/EntityCustomer.md)
|
||||
- [EntityCustomerLinks](docs/EntityCustomerLinks.md)
|
||||
- [EntityCustomerResponse](docs/EntityCustomerResponse.md)
|
||||
- [EntityEvent](docs/EntityEvent.md)
|
||||
- [EntityEventLinks](docs/EntityEventLinks.md)
|
||||
- [EntityInvoice](docs/EntityInvoice.md)
|
||||
- [EntityInvoiceLinesInner](docs/EntityInvoiceLinesInner.md)
|
||||
- [EntityInvoiceLinks](docs/EntityInvoiceLinks.md)
|
||||
- [EntityMandate](docs/EntityMandate.md)
|
||||
- [EntityMandateDetails](docs/EntityMandateDetails.md)
|
||||
- [EntityMandateLinks](docs/EntityMandateLinks.md)
|
||||
- [EntityMandateResponse](docs/EntityMandateResponse.md)
|
||||
- [EntityMandateResponseDetails](docs/EntityMandateResponseDetails.md)
|
||||
- [EntityMethod](docs/EntityMethod.md)
|
||||
- [EntityMethodAll](docs/EntityMethodAll.md)
|
||||
- [EntityMethodAllAllOfPricing](docs/EntityMethodAllAllOfPricing.md)
|
||||
- [EntityMethodImage](docs/EntityMethodImage.md)
|
||||
- [EntityMethodIssuersInner](docs/EntityMethodIssuersInner.md)
|
||||
- [EntityMethodIssuersInnerImage](docs/EntityMethodIssuersInnerImage.md)
|
||||
- [EntityMethodLinks](docs/EntityMethodLinks.md)
|
||||
- [EntityOnboardingStatus](docs/EntityOnboardingStatus.md)
|
||||
- [EntityOnboardingStatusLinks](docs/EntityOnboardingStatusLinks.md)
|
||||
- [EntityOrganization](docs/EntityOrganization.md)
|
||||
- [EntityOrganizationLinks](docs/EntityOrganizationLinks.md)
|
||||
- [EntityPayment](docs/EntityPayment.md)
|
||||
- [EntityPaymentApplicationFee](docs/EntityPaymentApplicationFee.md)
|
||||
- [EntityPaymentBillingAddress](docs/EntityPaymentBillingAddress.md)
|
||||
- [EntityPaymentDetails](docs/EntityPaymentDetails.md)
|
||||
- [EntityPaymentDetailsQrCode](docs/EntityPaymentDetailsQrCode.md)
|
||||
- [EntityPaymentDetailsReceipt](docs/EntityPaymentDetailsReceipt.md)
|
||||
- [EntityPaymentLinesInner](docs/EntityPaymentLinesInner.md)
|
||||
- [EntityPaymentLink](docs/EntityPaymentLink.md)
|
||||
- [EntityPaymentLinks](docs/EntityPaymentLinks.md)
|
||||
- [EntityPaymentResponse](docs/EntityPaymentResponse.md)
|
||||
- [EntityPaymentResponseDetails](docs/EntityPaymentResponseDetails.md)
|
||||
- [EntityPaymentResponseDetailsReceipt](docs/EntityPaymentResponseDetailsReceipt.md)
|
||||
- [EntityPaymentResponseLinesInner](docs/EntityPaymentResponseLinesInner.md)
|
||||
- [EntityPaymentRoute](docs/EntityPaymentRoute.md)
|
||||
- [EntityPaymentRouteDestination](docs/EntityPaymentRouteDestination.md)
|
||||
- [EntityPaymentRouteLinks](docs/EntityPaymentRouteLinks.md)
|
||||
- [EntityPaymentRouteResponse](docs/EntityPaymentRouteResponse.md)
|
||||
- [EntityPaymentRouteResponseDestination](docs/EntityPaymentRouteResponseDestination.md)
|
||||
- [EntityPermission](docs/EntityPermission.md)
|
||||
- [EntityProfile](docs/EntityProfile.md)
|
||||
- [EntityProfileLinks](docs/EntityProfileLinks.md)
|
||||
- [EntityProfileResponse](docs/EntityProfileResponse.md)
|
||||
- [EntityProfileResponseReview](docs/EntityProfileResponseReview.md)
|
||||
- [EntityProfileReview](docs/EntityProfileReview.md)
|
||||
- [EntityRefund](docs/EntityRefund.md)
|
||||
- [EntityRefundExternalReference](docs/EntityRefundExternalReference.md)
|
||||
- [EntityRefundLinks](docs/EntityRefundLinks.md)
|
||||
- [EntityRefundResponse](docs/EntityRefundResponse.md)
|
||||
- [EntityRefundResponseExternalReference](docs/EntityRefundResponseExternalReference.md)
|
||||
- [EntityRefundRoutingReversalsInner](docs/EntityRefundRoutingReversalsInner.md)
|
||||
- [EntityRefundRoutingReversalsInnerSource](docs/EntityRefundRoutingReversalsInnerSource.md)
|
||||
- [EntityRoute](docs/EntityRoute.md)
|
||||
- [EntityRouteDestination](docs/EntityRouteDestination.md)
|
||||
- [EntitySalesInvoice](docs/EntitySalesInvoice.md)
|
||||
- [EntitySalesInvoiceLinks](docs/EntitySalesInvoiceLinks.md)
|
||||
- [EntitySalesInvoiceResponse](docs/EntitySalesInvoiceResponse.md)
|
||||
- [EntitySettlement](docs/EntitySettlement.md)
|
||||
- [EntitySettlementLinks](docs/EntitySettlementLinks.md)
|
||||
- [EntitySettlementPeriodsValueValue](docs/EntitySettlementPeriodsValueValue.md)
|
||||
- [EntitySettlementPeriodsValueValueCostsInner](docs/EntitySettlementPeriodsValueValueCostsInner.md)
|
||||
- [EntitySettlementPeriodsValueValueCostsInnerRate](docs/EntitySettlementPeriodsValueValueCostsInnerRate.md)
|
||||
- [EntitySettlementPeriodsValueValueRevenueInner](docs/EntitySettlementPeriodsValueValueRevenueInner.md)
|
||||
- [EntitySubscription](docs/EntitySubscription.md)
|
||||
- [EntitySubscriptionApplicationFee](docs/EntitySubscriptionApplicationFee.md)
|
||||
- [EntitySubscriptionLinks](docs/EntitySubscriptionLinks.md)
|
||||
- [EntityTerminal](docs/EntityTerminal.md)
|
||||
- [EntityWebhook](docs/EntityWebhook.md)
|
||||
- [EntityWebhookEvent](docs/EntityWebhookEvent.md)
|
||||
- [EntityWebhookEventEmbedded](docs/EntityWebhookEventEmbedded.md)
|
||||
- [EntityWebhookEventEmbeddedEntity](docs/EntityWebhookEventEmbeddedEntity.md)
|
||||
- [EntityWebhookEventLinks](docs/EntityWebhookEventLinks.md)
|
||||
- [EntityWebhookLinks](docs/EntityWebhookLinks.md)
|
||||
- [ErrorResponse](docs/ErrorResponse.md)
|
||||
- [ErrorResponseLinks](docs/ErrorResponseLinks.md)
|
||||
- [ErrorResponseLinksDocumentation](docs/ErrorResponseLinksDocumentation.md)
|
||||
- [ExtraParameterParameters](docs/ExtraParameterParameters.md)
|
||||
- [ExtraParameterParametersCompany](docs/ExtraParameterParametersCompany.md)
|
||||
- [GetCustomer200Response](docs/GetCustomer200Response.md)
|
||||
- [GetPartnerStatus200Response](docs/GetPartnerStatus200Response.md)
|
||||
- [GetPartnerStatus200ResponseLinks](docs/GetPartnerStatus200ResponseLinks.md)
|
||||
- [GetPartnerStatus200ResponseUserAgentTokensInner](docs/GetPartnerStatus200ResponseUserAgentTokensInner.md)
|
||||
- [Giftcard](docs/Giftcard.md)
|
||||
- [InvoiceStatus](docs/InvoiceStatus.md)
|
||||
- [LineCategories](docs/LineCategories.md)
|
||||
- [LineCategoriesResponse](docs/LineCategoriesResponse.md)
|
||||
- [ListAllMethods200Response](docs/ListAllMethods200Response.md)
|
||||
- [ListAllMethods200ResponseEmbedded](docs/ListAllMethods200ResponseEmbedded.md)
|
||||
- [ListAllSubscriptions200Response](docs/ListAllSubscriptions200Response.md)
|
||||
- [ListAllSubscriptions200ResponseEmbedded](docs/ListAllSubscriptions200ResponseEmbedded.md)
|
||||
- [ListBalanceTransactions200Response](docs/ListBalanceTransactions200Response.md)
|
||||
- [ListBalanceTransactions200ResponseEmbedded](docs/ListBalanceTransactions200ResponseEmbedded.md)
|
||||
- [ListBalances200Response](docs/ListBalances200Response.md)
|
||||
- [ListBalances200ResponseEmbedded](docs/ListBalances200ResponseEmbedded.md)
|
||||
- [ListCapabilities200Response](docs/ListCapabilities200Response.md)
|
||||
- [ListCapabilities200ResponseEmbedded](docs/ListCapabilities200ResponseEmbedded.md)
|
||||
- [ListCapabilities200ResponseLinks](docs/ListCapabilities200ResponseLinks.md)
|
||||
- [ListCapabilities200ResponseLinksDocumentation](docs/ListCapabilities200ResponseLinksDocumentation.md)
|
||||
- [ListClients200Response](docs/ListClients200Response.md)
|
||||
- [ListClients200ResponseEmbedded](docs/ListClients200ResponseEmbedded.md)
|
||||
- [ListClients200ResponseEmbeddedClientsInner](docs/ListClients200ResponseEmbeddedClientsInner.md)
|
||||
- [ListClients200ResponseEmbeddedClientsInnerAllOfEmbedded](docs/ListClients200ResponseEmbeddedClientsInnerAllOfEmbedded.md)
|
||||
- [ListConnectBalanceTransfers200Response](docs/ListConnectBalanceTransfers200Response.md)
|
||||
- [ListConnectBalanceTransfers200ResponseEmbedded](docs/ListConnectBalanceTransfers200ResponseEmbedded.md)
|
||||
- [ListCustomers200Response](docs/ListCustomers200Response.md)
|
||||
- [ListCustomers200ResponseEmbedded](docs/ListCustomers200ResponseEmbedded.md)
|
||||
- [ListInvoices200Response](docs/ListInvoices200Response.md)
|
||||
- [ListInvoices200ResponseEmbedded](docs/ListInvoices200ResponseEmbedded.md)
|
||||
- [ListLinks](docs/ListLinks.md)
|
||||
- [ListMandates200Response](docs/ListMandates200Response.md)
|
||||
- [ListMandates200ResponseEmbedded](docs/ListMandates200ResponseEmbedded.md)
|
||||
- [ListMethods200Response](docs/ListMethods200Response.md)
|
||||
- [ListMethods200ResponseEmbedded](docs/ListMethods200ResponseEmbedded.md)
|
||||
- [ListMethods200ResponseLinks](docs/ListMethods200ResponseLinks.md)
|
||||
- [ListPaymentLinks200Response](docs/ListPaymentLinks200Response.md)
|
||||
- [ListPaymentLinks200ResponseEmbedded](docs/ListPaymentLinks200ResponseEmbedded.md)
|
||||
- [ListPermissions200Response](docs/ListPermissions200Response.md)
|
||||
- [ListPermissions200ResponseEmbedded](docs/ListPermissions200ResponseEmbedded.md)
|
||||
- [ListPermissions200ResponseLinks](docs/ListPermissions200ResponseLinks.md)
|
||||
- [ListProfiles200Response](docs/ListProfiles200Response.md)
|
||||
- [ListProfiles200ResponseEmbedded](docs/ListProfiles200ResponseEmbedded.md)
|
||||
- [ListSalesInvoices200Response](docs/ListSalesInvoices200Response.md)
|
||||
- [ListSalesInvoices200ResponseEmbedded](docs/ListSalesInvoices200ResponseEmbedded.md)
|
||||
- [ListSettlementCaptures200Response](docs/ListSettlementCaptures200Response.md)
|
||||
- [ListSettlementCaptures200ResponseEmbedded](docs/ListSettlementCaptures200ResponseEmbedded.md)
|
||||
- [ListSettlementChargebacks200Response](docs/ListSettlementChargebacks200Response.md)
|
||||
- [ListSettlementChargebacks200ResponseEmbedded](docs/ListSettlementChargebacks200ResponseEmbedded.md)
|
||||
- [ListSettlementPayments200Response](docs/ListSettlementPayments200Response.md)
|
||||
- [ListSettlementPayments200ResponseEmbedded](docs/ListSettlementPayments200ResponseEmbedded.md)
|
||||
- [ListSettlementRefunds200Response](docs/ListSettlementRefunds200Response.md)
|
||||
- [ListSettlementRefunds200ResponseEmbedded](docs/ListSettlementRefunds200ResponseEmbedded.md)
|
||||
- [ListSettlements200Response](docs/ListSettlements200Response.md)
|
||||
- [ListSettlements200ResponseEmbedded](docs/ListSettlements200ResponseEmbedded.md)
|
||||
- [ListSubscriptions200Response](docs/ListSubscriptions200Response.md)
|
||||
- [ListSubscriptions200ResponseEmbedded](docs/ListSubscriptions200ResponseEmbedded.md)
|
||||
- [ListTerminals200Response](docs/ListTerminals200Response.md)
|
||||
- [ListTerminals200ResponseEmbedded](docs/ListTerminals200ResponseEmbedded.md)
|
||||
- [ListWebhooks200Response](docs/ListWebhooks200Response.md)
|
||||
- [ListWebhooks200ResponseEmbedded](docs/ListWebhooks200ResponseEmbedded.md)
|
||||
- [Locale](docs/Locale.md)
|
||||
- [LocaleResponse](docs/LocaleResponse.md)
|
||||
- [MandateDetailsCardLabel](docs/MandateDetailsCardLabel.md)
|
||||
- [MandateDetailsCardLabelResponse](docs/MandateDetailsCardLabelResponse.md)
|
||||
- [MandateMethod](docs/MandateMethod.md)
|
||||
- [MandateMethodResponse](docs/MandateMethodResponse.md)
|
||||
- [MandateRequest](docs/MandateRequest.md)
|
||||
- [MandateResponse](docs/MandateResponse.md)
|
||||
- [MandateStatus](docs/MandateStatus.md)
|
||||
- [Metadata](docs/Metadata.md)
|
||||
- [Method](docs/Method.md)
|
||||
- [MethodIssuerStatus](docs/MethodIssuerStatus.md)
|
||||
- [MethodResponse](docs/MethodResponse.md)
|
||||
- [MethodStatus](docs/MethodStatus.md)
|
||||
- [Mode](docs/Mode.md)
|
||||
- [OnboardingStatus](docs/OnboardingStatus.md)
|
||||
- [OrganizationVatRegulation](docs/OrganizationVatRegulation.md)
|
||||
- [PaymentAddress](docs/PaymentAddress.md)
|
||||
- [PaymentDetailsCardAudition](docs/PaymentDetailsCardAudition.md)
|
||||
- [PaymentDetailsCardAuditionResponse](docs/PaymentDetailsCardAuditionResponse.md)
|
||||
- [PaymentDetailsCardFunding](docs/PaymentDetailsCardFunding.md)
|
||||
- [PaymentDetailsCardFundingResponse](docs/PaymentDetailsCardFundingResponse.md)
|
||||
- [PaymentDetailsCardLabel](docs/PaymentDetailsCardLabel.md)
|
||||
- [PaymentDetailsCardLabelResponse](docs/PaymentDetailsCardLabelResponse.md)
|
||||
- [PaymentDetailsCardSecurity](docs/PaymentDetailsCardSecurity.md)
|
||||
- [PaymentDetailsCardSecurityResponse](docs/PaymentDetailsCardSecurityResponse.md)
|
||||
- [PaymentDetailsFailureReason](docs/PaymentDetailsFailureReason.md)
|
||||
- [PaymentDetailsFailureReasonResponse](docs/PaymentDetailsFailureReasonResponse.md)
|
||||
- [PaymentDetailsFeeRegion](docs/PaymentDetailsFeeRegion.md)
|
||||
- [PaymentDetailsFeeRegionResponse](docs/PaymentDetailsFeeRegionResponse.md)
|
||||
- [PaymentDetailsReceiptCardReadMethod](docs/PaymentDetailsReceiptCardReadMethod.md)
|
||||
- [PaymentDetailsReceiptCardReadMethodResponse](docs/PaymentDetailsReceiptCardReadMethodResponse.md)
|
||||
- [PaymentDetailsReceiptCardVerificationMethod](docs/PaymentDetailsReceiptCardVerificationMethod.md)
|
||||
- [PaymentDetailsReceiptCardVerificationMethodResponse](docs/PaymentDetailsReceiptCardVerificationMethodResponse.md)
|
||||
- [PaymentDetailsSellerProtection](docs/PaymentDetailsSellerProtection.md)
|
||||
- [PaymentDetailsSellerProtectionResponse](docs/PaymentDetailsSellerProtectionResponse.md)
|
||||
- [PaymentDetailsWallet](docs/PaymentDetailsWallet.md)
|
||||
- [PaymentDetailsWalletResponse](docs/PaymentDetailsWalletResponse.md)
|
||||
- [PaymentLineItem](docs/PaymentLineItem.md)
|
||||
- [PaymentLineItemResponse](docs/PaymentLineItemResponse.md)
|
||||
- [PaymentLineType](docs/PaymentLineType.md)
|
||||
- [PaymentLineTypeResponse](docs/PaymentLineTypeResponse.md)
|
||||
- [PaymentLinkResponse](docs/PaymentLinkResponse.md)
|
||||
- [PaymentLinkSequenceType](docs/PaymentLinkSequenceType.md)
|
||||
- [PaymentLinkSequenceTypeResponse](docs/PaymentLinkSequenceTypeResponse.md)
|
||||
- [PaymentListRoutes200Response](docs/PaymentListRoutes200Response.md)
|
||||
- [PaymentListRoutes200ResponseEmbedded](docs/PaymentListRoutes200ResponseEmbedded.md)
|
||||
- [PaymentListRoutes200ResponseLinks](docs/PaymentListRoutes200ResponseLinks.md)
|
||||
- [PaymentMethod](docs/PaymentMethod.md)
|
||||
- [PaymentRequest](docs/PaymentRequest.md)
|
||||
- [PaymentResponse](docs/PaymentResponse.md)
|
||||
- [PaymentStatus](docs/PaymentStatus.md)
|
||||
- [ProfileReviewStatus](docs/ProfileReviewStatus.md)
|
||||
- [ProfileReviewStatusResponse](docs/ProfileReviewStatusResponse.md)
|
||||
- [ProfileStatus](docs/ProfileStatus.md)
|
||||
- [ProfilesProfileIdMethodsIdProfileIdParameter](docs/ProfilesProfileIdMethodsIdProfileIdParameter.md)
|
||||
- [RecurringLineItem](docs/RecurringLineItem.md)
|
||||
- [RefundExternalReferenceType](docs/RefundExternalReferenceType.md)
|
||||
- [RefundExternalReferenceTypeResponse](docs/RefundExternalReferenceTypeResponse.md)
|
||||
- [RefundRequest](docs/RefundRequest.md)
|
||||
- [RefundRoutingReversalsSourceType](docs/RefundRoutingReversalsSourceType.md)
|
||||
- [RefundStatus](docs/RefundStatus.md)
|
||||
- [ReleaseAuthorizationRequest](docs/ReleaseAuthorizationRequest.md)
|
||||
- [RequestApplePayPaymentSessionRequest](docs/RequestApplePayPaymentSessionRequest.md)
|
||||
- [RouteCreateRequest](docs/RouteCreateRequest.md)
|
||||
- [RouteCreateRequestDestination](docs/RouteCreateRequestDestination.md)
|
||||
- [RouteCreateResponse](docs/RouteCreateResponse.md)
|
||||
- [RouteDestinationType](docs/RouteDestinationType.md)
|
||||
- [RouteDestinationTypeResponse](docs/RouteDestinationTypeResponse.md)
|
||||
- [RouteGetResponse](docs/RouteGetResponse.md)
|
||||
- [SalesInvoiceDiscount](docs/SalesInvoiceDiscount.md)
|
||||
- [SalesInvoiceDiscountResponse](docs/SalesInvoiceDiscountResponse.md)
|
||||
- [SalesInvoiceDiscountType](docs/SalesInvoiceDiscountType.md)
|
||||
- [SalesInvoiceDiscountTypeResponse](docs/SalesInvoiceDiscountTypeResponse.md)
|
||||
- [SalesInvoiceEmailDetails](docs/SalesInvoiceEmailDetails.md)
|
||||
- [SalesInvoiceLineItem](docs/SalesInvoiceLineItem.md)
|
||||
- [SalesInvoiceLineItemResponse](docs/SalesInvoiceLineItemResponse.md)
|
||||
- [SalesInvoicePaymentDetails](docs/SalesInvoicePaymentDetails.md)
|
||||
- [SalesInvoicePaymentDetailsResponse](docs/SalesInvoicePaymentDetailsResponse.md)
|
||||
- [SalesInvoicePaymentDetailsSource](docs/SalesInvoicePaymentDetailsSource.md)
|
||||
- [SalesInvoicePaymentDetailsSourceResponse](docs/SalesInvoicePaymentDetailsSourceResponse.md)
|
||||
- [SalesInvoicePaymentTerm](docs/SalesInvoicePaymentTerm.md)
|
||||
- [SalesInvoicePaymentTermResponse](docs/SalesInvoicePaymentTermResponse.md)
|
||||
- [SalesInvoiceRecipient](docs/SalesInvoiceRecipient.md)
|
||||
- [SalesInvoiceRecipientLocale](docs/SalesInvoiceRecipientLocale.md)
|
||||
- [SalesInvoiceRecipientLocaleResponse](docs/SalesInvoiceRecipientLocaleResponse.md)
|
||||
- [SalesInvoiceRecipientResponse](docs/SalesInvoiceRecipientResponse.md)
|
||||
- [SalesInvoiceRecipientType](docs/SalesInvoiceRecipientType.md)
|
||||
- [SalesInvoiceRecipientTypeResponse](docs/SalesInvoiceRecipientTypeResponse.md)
|
||||
- [SalesInvoiceStatus](docs/SalesInvoiceStatus.md)
|
||||
- [SalesInvoiceStatusResponse](docs/SalesInvoiceStatusResponse.md)
|
||||
- [SalesInvoiceVatMode](docs/SalesInvoiceVatMode.md)
|
||||
- [SalesInvoiceVatModeResponse](docs/SalesInvoiceVatModeResponse.md)
|
||||
- [SalesInvoiceVatScheme](docs/SalesInvoiceVatScheme.md)
|
||||
- [SalesInvoiceVatSchemeResponse](docs/SalesInvoiceVatSchemeResponse.md)
|
||||
- [SequenceType](docs/SequenceType.md)
|
||||
- [SequenceTypeResponse](docs/SequenceTypeResponse.md)
|
||||
- [SettlementStatus](docs/SettlementStatus.md)
|
||||
- [StatusReason](docs/StatusReason.md)
|
||||
- [SubGroup](docs/SubGroup.md)
|
||||
- [SubTotals](docs/SubTotals.md)
|
||||
- [SubmitOnboardingDataRequest](docs/SubmitOnboardingDataRequest.md)
|
||||
- [SubmitOnboardingDataRequestOrganization](docs/SubmitOnboardingDataRequestOrganization.md)
|
||||
- [SubmitOnboardingDataRequestProfile](docs/SubmitOnboardingDataRequestProfile.md)
|
||||
- [SubscriptionMethod](docs/SubscriptionMethod.md)
|
||||
- [SubscriptionMethodResponse](docs/SubscriptionMethodResponse.md)
|
||||
- [SubscriptionRequest](docs/SubscriptionRequest.md)
|
||||
- [SubscriptionResponse](docs/SubscriptionResponse.md)
|
||||
- [SubscriptionStatus](docs/SubscriptionStatus.md)
|
||||
- [TerminalBrand](docs/TerminalBrand.md)
|
||||
- [TerminalModel](docs/TerminalModel.md)
|
||||
- [TerminalStatus](docs/TerminalStatus.md)
|
||||
- [UpdatePaymentLinkRequest](docs/UpdatePaymentLinkRequest.md)
|
||||
- [UpdatePaymentRequest](docs/UpdatePaymentRequest.md)
|
||||
- [UpdateProfileRequest](docs/UpdateProfileRequest.md)
|
||||
- [UpdateSubscriptionRequest](docs/UpdateSubscriptionRequest.md)
|
||||
- [UpdateValuesSalesInvoice](docs/UpdateValuesSalesInvoice.md)
|
||||
- [UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
|
||||
- [Url](docs/Url.md)
|
||||
- [UrlNullable](docs/UrlNullable.md)
|
||||
- [Voucher](docs/Voucher.md)
|
||||
- [VoucherContractor](docs/VoucherContractor.md)
|
||||
- [VoucherImage](docs/VoucherImage.md)
|
||||
- [WebhookEventTypes](docs/WebhookEventTypes.md)
|
||||
- [WebhookEventTypesResponse](docs/WebhookEventTypesResponse.md)
|
||||
- [WebhookStatus](docs/WebhookStatus.md)
|
||||
|
||||
|
||||
To get access to the crate's generated documentation, use:
|
||||
|
||||
```
|
||||
cargo doc --open
|
||||
```
|
||||
|
||||
## Author
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# Address
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**street_and_number** | Option<**String**> | A street and street number. | [optional]
|
||||
**postal_code** | Option<**String**> | A postal code. This field may be required if the provided country has a postal code system. | [optional]
|
||||
**city** | Option<**String**> | | [optional]
|
||||
**country** | Option<**String**> | A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# Amount
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**currency** | **String** | A three-character ISO 4217 currency code. |
|
||||
**value** | **String** | A string containing an exact monetary amount in the given currency. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# AmountNullable
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**currency** | **String** | A three-character ISO 4217 currency code. |
|
||||
**value** | **String** | A string containing an exact monetary amount in the given currency. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# BalanceReportGrouping
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| StatusBalances | status-balances |
|
||||
| TransactionCategories | transaction-categories |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# BalanceStatus
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Active | active |
|
||||
| Inactive | inactive |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
# BalanceTransactionType
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| ApplicationFee | application-fee |
|
||||
| Capture | capture |
|
||||
| Chargeback | chargeback |
|
||||
| ChargebackReversal | chargeback-reversal |
|
||||
| FailedPaymentFee | failed-payment-fee |
|
||||
| FailedPayment | failed-payment |
|
||||
| InvoiceCompensation | invoice-compensation |
|
||||
| Payment | payment |
|
||||
| PaymentFee | payment-fee |
|
||||
| PaymentCommission | payment-commission |
|
||||
| Refund | refund |
|
||||
| ReturnedRefund | returned-refund |
|
||||
| ReturnedTransfer | returned-transfer |
|
||||
| SplitPayment | split-payment |
|
||||
| OutgoingTransfer | outgoing-transfer |
|
||||
| CaptureCommission | capture-commission |
|
||||
| CanceledOutgoingTransfer | canceled-outgoing-transfer |
|
||||
| IncomingTransfer | incoming-transfer |
|
||||
| ApiPaymentRollingReserveRelease | api-payment-rolling-reserve-release |
|
||||
| CaptureRollingReserveRelease | capture-rolling-reserve-release |
|
||||
| ReimbursementFee | reimbursement-fee |
|
||||
| BalanceCorrection | balance-correction |
|
||||
| UnauthorizedDirectDebit | unauthorized-direct-debit |
|
||||
| BankChargedFailureFee | bank-charged-failure-fee |
|
||||
| PlatformPaymentRefund | platform-payment-refund |
|
||||
| RefundCompensation | refund-compensation |
|
||||
| ReturnedRefundCompensation | returned-refund-compensation |
|
||||
| ReturnedPlatformPaymentRefund | returned-platform-payment-refund |
|
||||
| PlatformPaymentChargeback | platform-payment-chargeback |
|
||||
| ChargebackCompensation | chargeback-compensation |
|
||||
| ReversedPlatformPaymentChargeback | reversed-platform-payment-chargeback |
|
||||
| ReversedChargebackCompensation | reversed-chargeback-compensation |
|
||||
| FailedSplitPaymentPlatform | failed-split-payment-platform |
|
||||
| FailedSplitPaymentCompensation | failed-split-payment-compensation |
|
||||
| CashAdvanceLoan | cash-advance-loan |
|
||||
| PlatformConnectedOrganizationsFee | platform-connected-organizations-fee |
|
||||
| SplitTransaction | split-transaction |
|
||||
| ManagedFee | managed-fee |
|
||||
| ReturnedManagedFee | returned-managed-fee |
|
||||
| Topup | topup |
|
||||
| BalanceReserve | balance-reserve |
|
||||
| BalanceReserveReturn | balance-reserve-return |
|
||||
| Movement | movement |
|
||||
| PostPaymentSplitPayment | post-payment-split-payment |
|
||||
| CashCollateralIssuance | cash-collateral-issuance |
|
||||
| CashCollateralRelease | cash-collateral-release |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# BalanceTransferCategory
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| InvoiceCollection | invoice_collection |
|
||||
| Purchase | purchase |
|
||||
| Chargeback | chargeback |
|
||||
| Refund | refund |
|
||||
| ServicePenalty | service_penalty |
|
||||
| DiscountCompensation | discount_compensation |
|
||||
| ManualCorrection | manual_correction |
|
||||
| OtherFee | other_fee |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# BalanceTransferCategoryResponse
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| InvoiceCollection | invoice_collection |
|
||||
| Purchase | purchase |
|
||||
| Chargeback | chargeback |
|
||||
| Refund | refund |
|
||||
| ServicePenalty | service_penalty |
|
||||
| DiscountCompensation | discount_compensation |
|
||||
| ManualCorrection | manual_correction |
|
||||
| OtherFee | other_fee |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# BalanceTransferDestinationType
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| BankAccount | bank-account |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# BalanceTransferFrequency
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Daily | daily |
|
||||
| EveryMonday | every-monday |
|
||||
| EveryTuesday | every-tuesday |
|
||||
| EveryWednesday | every-wednesday |
|
||||
| EveryThursday | every-thursday |
|
||||
| EveryFriday | every-friday |
|
||||
| Monthly | monthly |
|
||||
| Never | never |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# BalanceTransferPartyType
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Organization | organization |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# BalanceTransferPartyTypeResponse
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Organization | organization |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# BalanceTransferStatus
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Created | created |
|
||||
| Failed | failed |
|
||||
| Succeeded | succeeded |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# BalanceTransferStatusReason
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| RequestCreated | request_created |
|
||||
| Success | success |
|
||||
| SourceNotAllowed | source_not_allowed |
|
||||
| DestinationNotAllowed | destination_not_allowed |
|
||||
| InsufficientFunds | insufficient_funds |
|
||||
| InvalidSourceBalance | invalid_source_balance |
|
||||
| InvalidDestinationBalance | invalid_destination_balance |
|
||||
| TransferRequestExpired | transfer_request_expired |
|
||||
| TransferLimitReached | transfer_limit_reached |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# BalanceTransferStatusReasonResponse
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| RequestCreated | request_created |
|
||||
| Success | success |
|
||||
| SourceNotAllowed | source_not_allowed |
|
||||
| DestinationNotAllowed | destination_not_allowed |
|
||||
| InsufficientFunds | insufficient_funds |
|
||||
| InvalidSourceBalance | invalid_source_balance |
|
||||
| InvalidDestinationBalance | invalid_destination_balance |
|
||||
| TransferRequestExpired | transfer_request_expired |
|
||||
| TransferLimitReached | transfer_limit_reached |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,108 @@
|
||||
# \BalanceTransfersApiApi
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_connect_balance_transfer**](BalanceTransfersApiApi.md#create_connect_balance_transfer) | **POST** /connect/balance-transfers | Create a Connect balance transfer
|
||||
[**get_connect_balance_transfer**](BalanceTransfersApiApi.md#get_connect_balance_transfer) | **GET** /connect/balance-transfers/{id} | Get a Connect balance transfer
|
||||
[**list_connect_balance_transfers**](BalanceTransfersApiApi.md#list_connect_balance_transfers) | **GET** /connect/balance-transfers | List all Connect balance transfers
|
||||
|
||||
|
||||
|
||||
## create_connect_balance_transfer
|
||||
|
||||
> models::EntityBalanceTransferResponse create_connect_balance_transfer(idempotency_key, entity_balance_transfer)
|
||||
Create a Connect balance transfer
|
||||
|
||||
This API endpoint allows you to create a balance transfer from your organization's balance to a connected organization's balance, or vice versa. You can also create a balance transfer between two connected organizations. To create a balance transfer, you must be authenticated as the source organization, and the destination organization must be a connected organization that has authorized the `balance-transfers.write` scope for your organization.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
**entity_balance_transfer** | Option<[**EntityBalanceTransfer**](EntityBalanceTransfer.md)> | | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::EntityBalanceTransferResponse**](entity-balance-transfer-response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## get_connect_balance_transfer
|
||||
|
||||
> models::EntityBalanceTransferResponse get_connect_balance_transfer(id, testmode, idempotency_key)
|
||||
Get a Connect balance transfer
|
||||
|
||||
Retrieve a single Connect balance transfer object by its ID.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**id** | **String** | Provide the ID of the item you want to perform this operation on. | [required] |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::EntityBalanceTransferResponse**](entity-balance-transfer-response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## list_connect_balance_transfers
|
||||
|
||||
> models::ListConnectBalanceTransfers200Response list_connect_balance_transfers(from, limit, sort, testmode, idempotency_key)
|
||||
List all Connect balance transfers
|
||||
|
||||
Returns a paginated list of balance transfers associated with your organization. These may be a balance transfer that was received or sent from your balance, or a balance transfer that you initiated on behalf of your clients. If no balance transfers are available, the resulting array will be empty. This request should never throw an error.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**from** | Option<**String**> | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. | |
|
||||
**limit** | Option<**i32**> | The maximum number of items to return. Defaults to 50 items. | |
|
||||
**sort** | Option<**String**> | Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListConnectBalanceTransfers200Response**](list_connect_balance_transfers_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,178 @@
|
||||
# \BalancesApiApi
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_balance**](BalancesApiApi.md#get_balance) | **GET** /balances/{id} | Get balance
|
||||
[**get_balance_report**](BalancesApiApi.md#get_balance_report) | **GET** /balances/{balanceId}/report | Get balance report
|
||||
[**get_primary_balance**](BalancesApiApi.md#get_primary_balance) | **GET** /balances/primary | Get primary balance
|
||||
[**list_balance_transactions**](BalancesApiApi.md#list_balance_transactions) | **GET** /balances/{balanceId}/transactions | List balance transactions
|
||||
[**list_balances**](BalancesApiApi.md#list_balances) | **GET** /balances | List balances
|
||||
|
||||
|
||||
|
||||
## get_balance
|
||||
|
||||
> models::EntityBalance get_balance(id, testmode, idempotency_key)
|
||||
Get balance
|
||||
|
||||
When processing payments with Mollie, we put all pending funds — usually minus Mollie fees — on a balance. Once you have linked a bank account to your Mollie account, we can pay out your balance towards this bank account. With the Balances API you can retrieve your current balance. The response includes two amounts: * The *pending amount*. These are payments that have been marked as `paid`, but are not yet available on your balance. * The *available amount*. This is the amount that you can get paid out to your bank account, or use for refunds. With instant payment methods like iDEAL, payments are moved to the available balance instantly. With slower payment methods, like credit card for example, it can take a few days before the funds are available on your balance. These funds will be shown under the *pending amount* in the meanwhile.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**id** | **String** | Provide the ID of the item you want to perform this operation on. | [required] |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::EntityBalance**](entity-balance.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## get_balance_report
|
||||
|
||||
> models::EntityBalanceReport get_balance_report(from, until, balance_id, grouping, testmode, idempotency_key)
|
||||
Get balance report
|
||||
|
||||
Retrieve a summarized report for all transactions on a given balance within a given timeframe. The API also provides a detailed report on all 'prepayments' for Mollie fees that were deducted from your balance during the reported period, ahead of your Mollie invoice. The alias `primary` can be used instead of the balance ID to refer to the organization's primary balance.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**from** | **String** | The start date of the report, in `YYYY-MM-DD` format. The from date is 'inclusive', and in Central European Time. This means a report with for example `from=2024-01-01` will include transactions from 2024-01-01 0:00:00 CET and onwards. | [required] |
|
||||
**until** | **String** | The end date of the report, in `YYYY-MM-DD` format. The until date is 'exclusive', and in Central European Time. This means a report with for example `until=2024-02-01` will include transactions up until 2024-01-31 23:59:59 CET. | [required] |
|
||||
**balance_id** | **String** | Provide the ID of the related balance. | [required] |
|
||||
**grouping** | Option<**String**> | You can retrieve reports in two different formats. With the `status-balances` format, transactions are grouped by status (e.g. `pending`, `available`), then by transaction type, and then by other sub-groupings where available (e.g. payment method). With the `transaction-categories` format, transactions are grouped by transaction type, then by status, and then again by other sub-groupings where available. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::EntityBalanceReport**](entity-balance-report.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## get_primary_balance
|
||||
|
||||
> models::EntityBalance get_primary_balance(idempotency_key)
|
||||
Get primary balance
|
||||
|
||||
Retrieve the primary balance. This is the balance of your account's primary currency, where all payments are settled to by default. This endpoint is a convenient alias of the [Get balance](get-balance) endpoint.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::EntityBalance**](entity-balance.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## list_balance_transactions
|
||||
|
||||
> models::ListBalanceTransactions200Response list_balance_transactions(balance_id, from, limit, testmode, idempotency_key)
|
||||
List balance transactions
|
||||
|
||||
Retrieve a list of all balance transactions. Transactions include for example payments, refunds, chargebacks, and settlements. For an aggregated report of these balance transactions, refer to the [Get balance report](get-balance-report) endpoint. The alias `primary` can be used instead of the balance ID to refer to the organization's primary balance. The results are paginated.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**balance_id** | **String** | Provide the ID of the related balance. | [required] |
|
||||
**from** | Option<**String**> | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. | |
|
||||
**limit** | Option<**i32**> | The maximum number of items to return. Defaults to 50 items. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListBalanceTransactions200Response**](list_balance_transactions_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## list_balances
|
||||
|
||||
> models::ListBalances200Response list_balances(currency, from, limit, testmode, idempotency_key)
|
||||
List balances
|
||||
|
||||
Retrieve a list of the organization's balances, including the primary balance. The results are paginated.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**currency** | Option<**String**> | Optionally only return balances with the given currency. For example: `EUR`. | |
|
||||
**from** | Option<**String**> | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. | |
|
||||
**limit** | Option<**i32**> | The maximum number of items to return. Defaults to 50 items. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListBalances200Response**](list_balances_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# BillingAddress
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**title** | Option<**String**> | The title of the person, for example *Mr.* or *Mrs.*. | [optional]
|
||||
**given_name** | Option<**String**> | The given name (first name) of the person should be at least two characters and cannot contain only numbers. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. | [optional]
|
||||
**family_name** | Option<**String**> | The given family name (surname) of the person should be at least two characters and cannot contain only numbers. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. | [optional]
|
||||
**organization_name** | Option<[**serde_json::Value**](.md)> | | [optional]
|
||||
**street_and_number** | Option<**String**> | A street and street number. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. | [optional]
|
||||
**street_additional** | Option<**String**> | Any additional addressing details, for example an apartment number. | [optional]
|
||||
**postal_code** | Option<**String**> | A postal code. This field may be required if the provided country has a postal code system. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. | [optional]
|
||||
**email** | Option<**String**> | A valid e-mail address. If you provide the email address for a `banktransfer` payment, we will automatically send the instructions email upon payment creation. The language of the email will follow the locale parameter of the payment. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. | [optional]
|
||||
**phone** | Option<**String**> | If provided, it must be in the [E.164](https://en.wikipedia.org/wiki/E.164) format. For example: +31208202070. | [optional]
|
||||
**city** | Option<**String**> | A city name. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. | [optional]
|
||||
**region** | Option<**String**> | The top-level administrative subdivision of the country. For example: Noord-Holland. | [optional]
|
||||
**country** | Option<**String**> | A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# CancelPaymentRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**testmode** | Option<**bool**> | Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
# \CapabilitiesApiApi
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**list_capabilities**](CapabilitiesApiApi.md#list_capabilities) | **GET** /capabilities | List capabilities
|
||||
|
||||
|
||||
|
||||
## list_capabilities
|
||||
|
||||
> models::ListCapabilities200Response list_capabilities(idempotency_key)
|
||||
List capabilities
|
||||
|
||||
> 🚧 Beta feature > > This feature is currently in beta testing, and the final specification may still change. Retrieve a list of capabilities for an organization. This API provides detailed insights into the specific requirements and status of each client's onboarding journey. Capabilities are at the organization level, indicating if the organization can perform a given capability. For payments, regardless them being at the profile level, the capability is listed at the organization level. This means that if at least one of the clients's profiles can receive payments, the payments capability is enabled, communicating that the organization can indeed receive payments.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListCapabilities200Response**](list_capabilities_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# CapabilityRequirementStatus
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| CurrentlyDue | currently-due |
|
||||
| PastDue | past-due |
|
||||
| Requested | requested |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# CapabilityStatus
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Unrequested | unrequested |
|
||||
| Enabled | enabled |
|
||||
| Disabled | disabled |
|
||||
| Pending | pending |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# CapabilityStatusReason
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| RequirementPastDue | requirement-past-due |
|
||||
| OnboardingInformationNeeded | onboarding-information-needed |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# CaptureMode
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Automatic | automatic |
|
||||
| Manual | manual |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# CaptureModeResponse
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Automatic | automatic |
|
||||
| Manual | manual |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# CaptureResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a capture object. Will always contain the string `capture` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | | [optional]
|
||||
**mode** | Option<[**models::Mode**](mode.md)> | | [optional]
|
||||
**description** | Option<**String**> | The description of the capture. | [optional]
|
||||
**amount** | Option<[**models::AmountNullable**](amount-nullable.md)> | The amount captured. If no amount is provided, the full authorized amount is captured. | [optional]
|
||||
**settlement_amount** | Option<[**models::AmountNullable**](amount-nullable.md)> | This optional field will contain the approximate amount that will be settled to your account, converted to the currency your account is settled in. Since the field contains an estimated amount during capture processing, it may change over time. To retrieve accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions) instead. | [optional][readonly]
|
||||
**status** | Option<[**models::CaptureStatus**](capture-status.md)> | | [optional][readonly]
|
||||
**metadata** | Option<[**models::Metadata**](metadata.md)> | | [optional]
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**shipment_id** | Option<**String**> | | [optional]
|
||||
**settlement_id** | Option<**String**> | | [optional]
|
||||
**created_at** | Option<**String**> | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
**_links** | Option<[**models::EntityCaptureLinks**](entity_capture__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# CaptureStatus
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Pending | pending |
|
||||
| Succeeded | succeeded |
|
||||
| Failed | failed |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,112 @@
|
||||
# \CapturesApiApi
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_capture**](CapturesApiApi.md#create_capture) | **POST** /payments/{paymentId}/captures | Create capture
|
||||
[**get_capture**](CapturesApiApi.md#get_capture) | **GET** /payments/{paymentId}/captures/{captureId} | Get capture
|
||||
[**list_captures**](CapturesApiApi.md#list_captures) | **GET** /payments/{paymentId}/captures | List captures
|
||||
|
||||
|
||||
|
||||
## create_capture
|
||||
|
||||
> models::CaptureResponse create_capture(payment_id, idempotency_key, entity_capture)
|
||||
Create capture
|
||||
|
||||
Capture an *authorized* payment. Some payment methods allow you to first collect a customer's authorization, and capture the amount at a later point. By default, Mollie captures payments automatically. If however you configured your payment with `captureMode: manual`, you can capture the payment using this endpoint after having collected the customer's authorization.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**payment_id** | **String** | Provide the ID of the related payment. | [required] |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
**entity_capture** | Option<[**EntityCapture**](EntityCapture.md)> | | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::CaptureResponse**](capture-response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## get_capture
|
||||
|
||||
> models::CaptureResponse get_capture(payment_id, capture_id, embed, testmode, idempotency_key)
|
||||
Get capture
|
||||
|
||||
Retrieve a single payment capture by its ID and the ID of its parent payment.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**payment_id** | **String** | Provide the ID of the related payment. | [required] |
|
||||
**capture_id** | **String** | Provide the ID of the related capture. | [required] |
|
||||
**embed** | Option<**String**> | This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::CaptureResponse**](capture-response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## list_captures
|
||||
|
||||
> models::ListSettlementCaptures200Response list_captures(payment_id, from, limit, embed, testmode, idempotency_key)
|
||||
List captures
|
||||
|
||||
Retrieve a list of all captures created for a specific payment. The results are paginated.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**payment_id** | **String** | Provide the ID of the related payment. | [required] |
|
||||
**from** | Option<**String**> | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. | |
|
||||
**limit** | Option<**i32**> | The maximum number of items to return. Defaults to 50 items. | |
|
||||
**embed** | Option<**String**> | This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListSettlementCaptures200Response**](list_settlement_captures_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,116 @@
|
||||
# \ChargebacksApiApi
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_chargeback**](ChargebacksApiApi.md#get_chargeback) | **GET** /payments/{paymentId}/chargebacks/{chargebackId} | Get payment chargeback
|
||||
[**list_all_chargebacks**](ChargebacksApiApi.md#list_all_chargebacks) | **GET** /chargebacks | List all chargebacks
|
||||
[**list_chargebacks**](ChargebacksApiApi.md#list_chargebacks) | **GET** /payments/{paymentId}/chargebacks | List payment chargebacks
|
||||
|
||||
|
||||
|
||||
## get_chargeback
|
||||
|
||||
> models::EntityChargeback get_chargeback(payment_id, chargeback_id, embed, testmode, idempotency_key)
|
||||
Get payment chargeback
|
||||
|
||||
Retrieve a single payment chargeback by its ID and the ID of its parent payment.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**payment_id** | **String** | Provide the ID of the related payment. | [required] |
|
||||
**chargeback_id** | **String** | Provide the ID of the related chargeback. | [required] |
|
||||
**embed** | Option<**String**> | This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::EntityChargeback**](entity-chargeback.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## list_all_chargebacks
|
||||
|
||||
> models::ListSettlementChargebacks200Response list_all_chargebacks(from, limit, embed, sort, profile_id, testmode, idempotency_key)
|
||||
List all chargebacks
|
||||
|
||||
Retrieve all chargebacks initiated for all your payments. The results are paginated.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**from** | Option<**String**> | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. | |
|
||||
**limit** | Option<**i32**> | The maximum number of items to return. Defaults to 50 items. | |
|
||||
**embed** | Option<**String**> | This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter. | |
|
||||
**sort** | Option<**String**> | Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest. | |
|
||||
**profile_id** | Option<**String**> | The identifier referring to the [profile](get-profile) you wish to retrieve chargebacks for. Most API credentials are linked to a single profile. In these cases the `profileId` is already implied. To retrieve all chargebacks across the organization, use an organization-level API credential and omit the `profileId` parameter. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListSettlementChargebacks200Response**](list_settlement_chargebacks_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## list_chargebacks
|
||||
|
||||
> models::ListSettlementChargebacks200Response list_chargebacks(payment_id, from, limit, embed, testmode, idempotency_key)
|
||||
List payment chargebacks
|
||||
|
||||
Retrieve the chargebacks initiated for a specific payment. The results are paginated.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**payment_id** | **String** | Provide the ID of the related payment. | [required] |
|
||||
**from** | Option<**String**> | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. | |
|
||||
**limit** | Option<**i32**> | The maximum number of items to return. Defaults to 50 items. | |
|
||||
**embed** | Option<**String**> | This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListSettlementChargebacks200Response**](list_settlement_chargebacks_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# \ClientLinksApiApi
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_client_link**](ClientLinksApiApi.md#create_client_link) | **POST** /client-links | Create client link
|
||||
|
||||
|
||||
|
||||
## create_client_link
|
||||
|
||||
> models::EntityClientLinkResponse create_client_link(idempotency_key, entity_client_link)
|
||||
Create client link
|
||||
|
||||
Link a new or existing organization to your OAuth application, in effect creating a new client. The response contains a `clientLink` where you should redirect your customer to. ## Redirecting the Customer The `clientLink` URL behaves similarly to a standard OAuth authorization URL. Therefore, after receiving the `clientLink` URL in the API response, you need to **append the following query parameters** *before* redirecting the customer: * `client_id` _string (required)_ The client ID you received when you registered your OAuth app. The ID starts with `app_`. For example: `app_abc123qwerty`. * `state` _string (required)_ A random string **generated by your app** to prevent CSRF attacks. This will be reflected in the `state` query parameter when the user returns to the `redirect_uri` after authorizing your app. * `scope` _string (required)_ A space-separated list of permissions ('scopes') your app requires. See the [permissions list](https://docs.mollie.com/docs/connect-permissions) for more information about the available scopes. We recommend at least : `onboarding.read onboarding.write` * `approval_prompt` _string_ Can be set to `force` to force showing the consent screen to the merchant, *even when it is not necessary*. If you force an approval prompt and the user creates a new authorization, previously active authorizations will be revoked. Possible values: `auto` `force` (default: `auto`) ### Example of a Complete Redirect URL After adding the above url parameter your URL will look something like this and you can redirect your client to this page: ``` https://my.mollie.com/dashboard/client-link/{id}?client_id={your_client_id}&state={unique_state}&scope=onboarding.read%20onboarding.write ``` ## Error Handling Error handling is also dealt with similar to the [Authorize](https://docs.mollie.com/reference/authorize) endpoint: the customer is redirected back to your app's redirect URL with the `error` and `error_description` parameters added to the URL. > 🚧 > > A client link must be used within 30 days of creation. After that period, it will expire and you will need to create a new client link.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
**entity_client_link** | Option<[**EntityClientLink**](EntityClientLink.md)> | | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::EntityClientLinkResponse**](entity-client-link-response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
# \ClientsApiApi
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_client**](ClientsApiApi.md#get_client) | **GET** /clients/{id} | Get client
|
||||
[**list_clients**](ClientsApiApi.md#list_clients) | **GET** /clients | List clients
|
||||
|
||||
|
||||
|
||||
## get_client
|
||||
|
||||
> models::ListClients200ResponseEmbeddedClientsInner get_client(id, embed, idempotency_key)
|
||||
Get client
|
||||
|
||||
Retrieve a single client by its ID.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**id** | **String** | Provide the ID of the item you want to perform this operation on. | [required] |
|
||||
**embed** | Option<**String**> | This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListClients200ResponseEmbeddedClientsInner**](list_clients_200_response__embedded_clients_inner.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## list_clients
|
||||
|
||||
> models::ListClients200Response list_clients(embed, from, limit, idempotency_key)
|
||||
List clients
|
||||
|
||||
Retrieve a list of all clients linked to your account. The results are paginated.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**embed** | Option<**String**> | This endpoint allows embedding related API items by appending the following values via the `embed` query string parameter. | |
|
||||
**from** | Option<**String**> | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. | |
|
||||
**limit** | Option<**i32**> | The maximum number of items to return. Defaults to 50 items. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListClients200Response**](list_clients_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# ComponentsSubTotals
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**sub_totals** | Option<[**Vec<models::SubTotals>**](sub-totals.md)> | | [optional]
|
||||
**count** | Option<**i32**> | Number of transactions of this type | [optional]
|
||||
**method** | Option<[**models::PaymentMethod**](payment-method.md)> | Payment type of the transactions | [optional]
|
||||
**card_issuer** | Option<**String**> | In case of payments transactions with card, the card issuer will be available | [optional]
|
||||
**card_audience** | Option<**String**> | In case of payments trnsactions with card, the card audience will be available. | [optional]
|
||||
**card_region** | Option<**String**> | In case of payments transactions with card, the card region will be available. | [optional]
|
||||
**fee_type** | Option<**String**> | Present when the transaction represents a fee. | [optional]
|
||||
**prepayment_part_type** | Option<**String**> | Prepayment part: fee itself, reimbursement, discount, VAT or rounding compensation. | [optional]
|
||||
**transaction_type** | Option<**String**> | Represents the transaction type | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# CreatePaymentLinkRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a payment link object. Will always contain the string `payment-link` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | | [optional]
|
||||
**mode** | Option<[**models::Mode**](mode.md)> | | [optional]
|
||||
**description** | **String** | A short description of the payment link. The description is visible in the Dashboard and will be shown on the customer's bank or card statement when possible. |
|
||||
**amount** | Option<[**models::AmountNullable**](amount-nullable.md)> | The amount of the payment link. If no amount is provided initially, the customer will be prompted to enter an amount. | [optional]
|
||||
**minimum_amount** | Option<[**models::AmountNullable**](amount-nullable.md)> | The minimum amount of the payment link. This property is only allowed when there is no amount provided. The customer will be prompted to enter a value greater than or equal to the minimum amount. | [optional]
|
||||
**archived** | Option<**bool**> | Whether the payment link is archived. Customers will not be able to complete payments on archived payment links. | [optional][readonly]
|
||||
**redirect_url** | Option<**String**> | The URL your customer will be redirected to after completing the payment process. If no redirect URL is provided, the customer will be shown a generic message after completing the payment. | [optional]
|
||||
**webhook_url** | Option<**String**> | The webhook URL where we will send payment status updates to. The webhookUrl is optional, but without a webhook you will miss out on important status changes to any payments resulting from the payment link. The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your local machine. | [optional]
|
||||
**lines** | Option<[**Vec<models::PaymentLineItem>**](payment-line-item.md)> | Optionally provide the order lines for the payment. Each line contains details such as a description of the item ordered and its price. All lines must have the same currency as the payment. Required for payment methods `billie`, `in3`, `klarna`, `riverty` and `voucher`. | [optional]
|
||||
**billing_address** | Option<[**models::PaymentAddress**](payment-address.md)> | The customer's billing address details. We advise to provide these details to improve fraud protection and conversion. Should include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and `country`. Required for payment method `in3`, `klarna`, `billie` and `riverty`. | [optional]
|
||||
**shipping_address** | Option<[**models::PaymentAddress**](payment-address.md)> | The customer's shipping address details. We advise to provide these details to improve fraud protection and conversion. Should include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and `country`. | [optional]
|
||||
**profile_id** | Option<**String**> | The identifier referring to the [profile](get-profile) this entity belongs to. Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required. | [optional]
|
||||
**reusable** | Option<**bool**> | Indicates whether the payment link is reusable. If this field is set to `true`, customers can make multiple payments using the same link. If no value is specified, the field defaults to `false`, allowing only a single payment per link. | [optional]
|
||||
**created_at** | Option<**String**> | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
**paid_at** | Option<**String**> | The date and time the payment link became paid, in ISO 8601 format. | [optional][readonly]
|
||||
**expires_at** | Option<**String**> | The date and time the payment link is set to expire, in ISO 8601 format. If no expiry date was provided up front, the payment link will not expire automatically. | [optional]
|
||||
**allowed_methods** | Option<**Vec<String>**> | An array of payment methods that are allowed to be used for this payment link. When this parameter is not provided or is an empty array, all enabled payment methods will be available. Enum: 'applepay', 'bancomatpay', 'bancontact', 'banktransfer', 'belfius', 'blik', 'creditcard', 'eps', 'giftcard', 'ideal', 'kbc', 'mybank', 'paybybank', 'paypal', 'paysafecard', 'pointofsale', 'przelewy24', 'satispay', 'trustly', 'twint', 'in3', 'riverty', 'klarna', 'billie'. | [optional]
|
||||
**application_fee** | Option<[**models::CreatePaymentLinkRequestApplicationFee**](create_payment_link_request_applicationFee.md)> | | [optional]
|
||||
**sequence_type** | Option<[**models::PaymentLinkSequenceType**](payment-link-sequence-type.md)> | If set to `first`, a payment mandate is established right after a payment is made by the customer. Defaults to `oneoff`, which is a regular payment link and will not establish a mandate after payment. The mandate ID can be retrieved by making a call to the [Payment Link Payments Endpoint](get-payment-link-payments). | [optional]
|
||||
**customer_id** | Option<**String**> | **Only relevant when `sequenceType` is set to `first`** The ID of the [customer](get-customer) the payment link is being created for. If a value is not provided, the customer will be required to input relevant information which will be used to establish a mandate after the payment is made. | [optional]
|
||||
**testmode** | Option<**bool**> | Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. | [optional]
|
||||
**_links** | Option<[**models::CreatePaymentLinkRequestLinks**](create_payment_link_request__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# CreatePaymentLinkRequestApplicationFee
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**amount** | [**models::Amount**](amount.md) | The fee that you wish to charge. Be careful to leave enough space for Mollie's own fees to be deducted as well. For example, you cannot charge a €0.99 fee on a €1.00 payment. |
|
||||
**description** | **String** | The description of the application fee. This will appear on settlement reports towards both you and the connected merchant. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# CreatePaymentLinkRequestLinks
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**param_self** | [**models::Url**](url.md) | |
|
||||
**payment_link** | [**models::Url**](url.md) | The URL your customer should visit to make the payment. This is where you should redirect the customer to. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# CreateWebhook
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | **String** | Indicates the response contains a webhook subscription object. Will always contain the string `webhook` for this endpoint. | [readonly]
|
||||
**id** | **String** | The identifier uniquely referring to this subscription. | [readonly]
|
||||
**url** | **String** | The subscription's events destination. |
|
||||
**profile_id** | Option<**String**> | The identifier uniquely referring to the profile that created the subscription. | [readonly]
|
||||
**created_at** | **String** | The subscription's date time of creation. | [readonly]
|
||||
**name** | **String** | The subscription's name. |
|
||||
**event_types** | [**Vec<models::WebhookEventTypesResponse>**](webhook-event-types-response.md) | The events types that are subscribed. |
|
||||
**status** | [**models::WebhookStatus**](webhook-status.md) | |
|
||||
**mode** | [**models::Mode**](mode.md) | |
|
||||
**webhook_secret** | **String** | The subscription's secret. |
|
||||
**_links** | [**models::EntityWebhookLinks**](entity_webhook__links.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# CreateWebhookRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **String** | A name that identifies the webhook. |
|
||||
**url** | **String** | The URL Mollie will send the events to. This URL must be publicly accessible. |
|
||||
**event_types** | [**models::WebhookEventTypes**](webhook-event-types.md) | The list of events to enable for this webhook. You may specify `'*'` to add all events, except those that require explicit selection. Separate multiple event types with a comma. |
|
||||
**testmode** | Option<**bool**> | Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# Currencies
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Value |
|
||||
|---- | -----|
|
||||
| Eur | EUR |
|
||||
| Gbp | GBP |
|
||||
| Chf | CHF |
|
||||
| Dkk | DKK |
|
||||
| Nok | NOK |
|
||||
| Pln | PLN |
|
||||
| Sek | SEK |
|
||||
| Usd | USD |
|
||||
| Czk | CZK |
|
||||
| Huf | HUF |
|
||||
| Aud | AUD |
|
||||
| Cad | CAD |
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# CustomerResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a customer object. Will always contain the string `customer` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | | [optional]
|
||||
**mode** | Option<[**models::Mode**](mode.md)> | | [optional]
|
||||
**name** | Option<**String**> | The full name of the customer. | [optional]
|
||||
**email** | Option<**String**> | The email address of the customer. | [optional]
|
||||
**locale** | Option<[**models::LocaleResponse**](locale-response.md)> | Preconfigure the language to be used in the hosted payment pages shown to the customer. Should only be provided if absolutely necessary. If not provided, the browser language will be used which is typically highly accurate. | [optional]
|
||||
**metadata** | Option<[**models::Metadata**](metadata.md)> | | [optional]
|
||||
**created_at** | Option<**String**> | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
**testmode** | Option<**bool**> | Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. | [optional]
|
||||
**_links** | Option<[**models::EntityCustomerLinks**](entity_customer__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,245 @@
|
||||
# \CustomersApiApi
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_customer**](CustomersApiApi.md#create_customer) | **POST** /customers | Create customer
|
||||
[**create_customer_payment**](CustomersApiApi.md#create_customer_payment) | **POST** /customers/{customerId}/payments | Create customer payment
|
||||
[**delete_customer**](CustomersApiApi.md#delete_customer) | **DELETE** /customers/{customerId} | Delete customer
|
||||
[**get_customer**](CustomersApiApi.md#get_customer) | **GET** /customers/{customerId} | Get customer
|
||||
[**list_customer_payments**](CustomersApiApi.md#list_customer_payments) | **GET** /customers/{customerId}/payments | List customer payments
|
||||
[**list_customers**](CustomersApiApi.md#list_customers) | **GET** /customers | List customers
|
||||
[**update_customer**](CustomersApiApi.md#update_customer) | **PATCH** /customers/{customerId} | Update customer
|
||||
|
||||
|
||||
|
||||
## create_customer
|
||||
|
||||
> models::CustomerResponse create_customer(idempotency_key, entity_customer)
|
||||
Create customer
|
||||
|
||||
Creates a simple minimal representation of a customer. Payments, recurring mandates, and subscriptions can be linked to this customer object, which simplifies management of recurring payments. Once registered, customers will also appear in your Mollie dashboard.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
**entity_customer** | Option<[**EntityCustomer**](EntityCustomer.md)> | | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::CustomerResponse**](customer-response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## create_customer_payment
|
||||
|
||||
> models::PaymentResponse create_customer_payment(customer_id, idempotency_key, payment_request)
|
||||
Create customer payment
|
||||
|
||||
Creates a payment for the customer. Linking customers to payments enables you to: * Keep track of payment preferences for your customers * Allow your customers to charge a previously used credit card with a single click in our hosted checkout * Improve payment insights in the Mollie dashboard * Use recurring payments This endpoint is effectively an alias of the [Create payment endpoint](create-payment) with the `customerId` parameter predefined.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**customer_id** | **String** | Provide the ID of the related customer. | [required] |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
**payment_request** | Option<[**PaymentRequest**](PaymentRequest.md)> | | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::PaymentResponse**](payment-response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## delete_customer
|
||||
|
||||
> serde_json::Value delete_customer(customer_id, idempotency_key, delete_webhook_request)
|
||||
Delete customer
|
||||
|
||||
Delete a customer. All mandates and subscriptions created for this customer will be canceled as well.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**customer_id** | **String** | Provide the ID of the related customer. | [required] |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
**delete_webhook_request** | Option<[**DeleteWebhookRequest**](DeleteWebhookRequest.md)> | | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**serde_json::Value**](serde_json::Value.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## get_customer
|
||||
|
||||
> models::GetCustomer200Response get_customer(customer_id, include, testmode, idempotency_key)
|
||||
Get customer
|
||||
|
||||
Retrieve a single customer by its ID.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**customer_id** | **String** | Provide the ID of the related customer. | [required] |
|
||||
**include** | Option<**String**> | This endpoint allows you to include additional information via the `include` query string parameter. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::GetCustomer200Response**](get_customer_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## list_customer_payments
|
||||
|
||||
> models::ListSettlementPayments200Response list_customer_payments(customer_id, from, limit, sort, profile_id, testmode, idempotency_key)
|
||||
List customer payments
|
||||
|
||||
Retrieve all payments linked to the customer.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**customer_id** | **String** | Provide the ID of the related customer. | [required] |
|
||||
**from** | Option<**String**> | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. | |
|
||||
**limit** | Option<**i32**> | The maximum number of items to return. Defaults to 50 items. | |
|
||||
**sort** | Option<**String**> | Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest. | |
|
||||
**profile_id** | Option<**String**> | The identifier referring to the [profile](get-profile) you wish to retrieve the resources for. Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListSettlementPayments200Response**](list_settlement_payments_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## list_customers
|
||||
|
||||
> models::ListCustomers200Response list_customers(from, limit, sort, testmode, idempotency_key)
|
||||
List customers
|
||||
|
||||
Retrieve a list of all customers. The results are paginated.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**from** | Option<**String**> | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. | |
|
||||
**limit** | Option<**i32**> | The maximum number of items to return. Defaults to 50 items. | |
|
||||
**sort** | Option<**String**> | Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest. | |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::ListCustomers200Response**](list_customers_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## update_customer
|
||||
|
||||
> models::CustomerResponse update_customer(customer_id, idempotency_key, entity_customer)
|
||||
Update customer
|
||||
|
||||
Update an existing customer. For an in-depth explanation of each parameter, refer to the [Create customer](create-customer) endpoint.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**customer_id** | **String** | Provide the ID of the related customer. | [required] |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
**entity_customer** | Option<[**EntityCustomer**](EntityCustomer.md)> | | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::CustomerResponse**](customer-response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
# \DelayedRoutingApiApi
|
||||
|
||||
All URIs are relative to *https://api.mollie.com/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**payment_create_route**](DelayedRoutingApiApi.md#payment_create_route) | **POST** /payments/{paymentId}/routes | Create a delayed route
|
||||
[**payment_list_routes**](DelayedRoutingApiApi.md#payment_list_routes) | **GET** /payments/{paymentId}/routes | List payment routes
|
||||
|
||||
|
||||
|
||||
## payment_create_route
|
||||
|
||||
> models::RouteCreateResponse payment_create_route(payment_id, idempotency_key, route_create_request)
|
||||
Create a delayed route
|
||||
|
||||
Create a route for a specific payment. The routed amount is credited to the account of your customer.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**payment_id** | **String** | Provide the ID of the related payment. | [required] |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
**route_create_request** | Option<[**RouteCreateRequest**](RouteCreateRequest.md)> | | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::RouteCreateResponse**](route-create-response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
## payment_list_routes
|
||||
|
||||
> models::PaymentListRoutes200Response payment_list_routes(payment_id, testmode, idempotency_key)
|
||||
List payment routes
|
||||
|
||||
Retrieve a list of all routes created for a specific payment.
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Required | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
**payment_id** | **String** | Provide the ID of the related payment. | [required] |
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the `testmode` query parameter to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | |
|
||||
**idempotency_key** | Option<**String**> | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**models::PaymentListRoutes200Response**](payment_list_routes_200_response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[apiKey](../README.md#apiKey), [oAuth](../README.md#oAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# DeleteValuesSalesInvoice
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# DeleteWebhookRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**testmode** | Option<**bool**> | Most API credentials are specifically created for either live mode or test mode. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EnableMethodIssuer200Response
|
||||
|
||||
## Enum Variants
|
||||
|
||||
| Name | Description |
|
||||
|---- | -----|
|
||||
| Giftcard | |
|
||||
| Voucher | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# EnableMethodIssuerRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**contract_id** | Option<**String**> | When enabling a voucher issuer, an inbetween party may be involved which you have a contract with. Provide the contract ID for the first time you enable an issuer via this contractor. You can update the contract ID as long as it is not approved yet, by repeating the API call with a different contract ID. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# EntityBalance
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a balance object. Will always contain the string `balance` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | | [optional]
|
||||
**mode** | Option<[**models::Mode**](mode.md)> | | [optional]
|
||||
**created_at** | Option<**String**> | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
**currency** | Option<[**models::Currencies**](currencies.md)> | The balance's ISO 4217 currency code. | [optional][readonly]
|
||||
**description** | Option<**String**> | The description or name of the balance. Can be used to denote the purpose of the balance. | [optional][readonly]
|
||||
**status** | Option<[**models::BalanceStatus**](balance-status.md)> | | [optional][readonly]
|
||||
**transfer_frequency** | Option<[**models::BalanceTransferFrequency**](balance-transfer-frequency.md)> | | [optional][readonly]
|
||||
**transfer_threshold** | Option<[**models::Amount**](amount.md)> | The minimum amount configured for scheduled automatic settlements. As soon as the amount on the balance exceeds this threshold, the complete balance will be paid out to the transfer destination according to the configured frequency. | [optional][readonly]
|
||||
**transfer_reference** | Option<**String**> | The transfer reference set to be included in all the transfers for this balance. | [optional][readonly]
|
||||
**transfer_destination** | Option<[**models::EntityBalanceTransferDestination**](entity_balance_transferDestination.md)> | | [optional]
|
||||
**available_amount** | Option<[**models::Amount**](amount.md)> | The amount directly available on the balance, e.g. `{\"currency\":\"EUR\", \"value\":\"100.00\"}`. | [optional][readonly]
|
||||
**pending_amount** | Option<[**models::Amount**](amount.md)> | The total amount that is queued to be transferred to your balance. For example, a credit card payment can take a few days to clear. | [optional][readonly]
|
||||
**_links** | Option<[**models::EntityBalanceLinks**](entity_balance__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityBalanceLinks
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**param_self** | Option<[**models::Url**](url.md)> | | [optional]
|
||||
**documentation** | Option<[**models::Url**](url.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# EntityBalanceReport
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a balance report object. Will always contain the string `balance-report` for this endpoint. | [optional][readonly]
|
||||
**balance_id** | Option<**String**> | | [optional]
|
||||
**time_zone** | Option<**String**> | The time zone used for the from and until parameters. Currently only time zone `Europe/Amsterdam` is supported. | [optional]
|
||||
**from** | Option<**String**> | The start date of the report, in `YYYY-MM-DD` format. The from date is 'inclusive', and in Central European Time. This means a report with for example `from=2024-01-01` will include movements of 2024-01-01 00:00:00 CET and onwards. | [optional]
|
||||
**until** | Option<**String**> | The end date of the report, in `YYYY-MM-DD` format. The until date is 'exclusive', and in Central European Time. This means a report with for example `until=2024-02-01` will include movements up until 2024-01-31 23:59:59 CET. | [optional]
|
||||
**grouping** | Option<[**models::BalanceReportGrouping**](balance-report-grouping.md)> | | [optional]
|
||||
**totals** | Option<[**models::EntityBalanceReportTotals**](entity_balance_report_totals.md)> | | [optional]
|
||||
**_links** | Option<[**models::EntityBalanceLinks**](entity_balance__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# EntityBalanceReportTotals
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pending_balance** | Option<[**models::EntityBalanceReportTotalsPendingBalance**](entity_balance_report_totals_pendingBalance.md)> | | [optional]
|
||||
**available_balance** | Option<[**models::EntityBalanceReportTotalsAvailableBalance**](entity_balance_report_totals_availableBalance.md)> | | [optional]
|
||||
**open** | Option<[**models::EntityBalanceReportTotalsOpen**](entity_balance_report_totals_open.md)> | | [optional]
|
||||
**close** | Option<[**models::EntityBalanceReportTotalsOpen**](entity_balance_report_totals_open.md)> | | [optional]
|
||||
**payments** | Option<[**models::EntityBalanceReportTotalsPayments**](entity_balance_report_totals_payments.md)> | | [optional]
|
||||
**refunds** | Option<[**models::EntityBalanceReportTotalsPayments**](entity_balance_report_totals_payments.md)> | | [optional]
|
||||
**chargebacks** | Option<[**models::EntityBalanceReportTotalsPayments**](entity_balance_report_totals_payments.md)> | | [optional]
|
||||
**capital** | Option<[**models::EntityBalanceReportTotalsPayments**](entity_balance_report_totals_payments.md)> | | [optional]
|
||||
**transfers** | Option<[**models::EntityBalanceReportTotalsPayments**](entity_balance_report_totals_payments.md)> | | [optional]
|
||||
**fee_prepayments** | Option<[**models::EntityBalanceReportTotalsPayments**](entity_balance_report_totals_payments.md)> | | [optional]
|
||||
**corrections** | Option<[**models::EntityBalanceReportTotalsPayments**](entity_balance_report_totals_payments.md)> | | [optional]
|
||||
**topups** | Option<[**models::EntityBalanceReportTotalsPayments**](entity_balance_report_totals_payments.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# EntityBalanceReportTotalsAvailableBalance
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**open** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
**moved_from_pending** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
**immediately_available** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
**close** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityBalanceReportTotalsOpen
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pending** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
**available** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# EntityBalanceReportTotalsPayments
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pending** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
**moved_to_available** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
**immediately_available** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# EntityBalanceReportTotalsPendingBalance
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**open** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
**close** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
**pending** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
**moved_to_available** | Option<[**models::SubGroup**](sub-group.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# EntityBalanceTransaction
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a balance transaction object. Will always contain the string `balance-transaction` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | | [optional]
|
||||
**r#type** | Option<[**models::BalanceTransactionType**](balance-transaction-type.md)> | The type of transaction, for example `payment` or `refund`. Values include the below examples, although this list is not definitive. * Regular payment processing: `payment` `capture` `unauthorized-direct-debit` `failed-payment` * Refunds and chargebacks: `refund` `returned-refund` `chargeback` `chargeback-reversal` * Settlements: `outgoing-transfer` `canceled-outgoing-transfer` `returned-transfer` * Invoicing: `invoice-compensation` `balance-correction` * Mollie Connect: `application-fee` `split-payment` `platform-payment-refund` `platform-payment-chargeback` | [optional]
|
||||
**result_amount** | Option<[**models::Amount**](amount.md)> | The final amount that was moved to or from the balance. If the transaction moves funds away from the balance, for example when it concerns a refund, the amount will be negative. | [optional]
|
||||
**initial_amount** | Option<[**models::Amount**](amount.md)> | The amount that was to be moved to or from the balance, excluding deductions. If the transaction moves funds away from the balance, for example when it concerns a refund, the amount will be negative. | [optional]
|
||||
**deductions** | Option<[**models::AmountNullable**](amount-nullable.md)> | The total amount of deductions withheld from the movement. For example, if we charge a €0.29 fee on a €10 payment, the deductions amount will be `{\"currency\":\"EUR\", \"value\":\"-0.29\"}`. When moving funds to a balance, we always round the deduction to a 'real' amount. Any differences between these real-time rounded amounts and the final invoice will be compensated when the invoice is generated. | [optional]
|
||||
**context** | Option<[**models::EntityBalanceTransactionContext**](entity_balance_transaction_context.md)> | | [optional]
|
||||
**created_at** | Option<**String**> | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
# EntityBalanceTransactionContext
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**payment** | Option<[**models::EntityBalanceTransactionContextPayment**](entity_balance_transaction_context_payment.md)> | | [optional]
|
||||
**capture** | Option<[**models::EntityBalanceTransactionContextCapture**](entity_balance_transaction_context_capture.md)> | | [optional]
|
||||
**capture_commision** | Option<[**models::EntityBalanceTransactionContextCapture**](entity_balance_transaction_context_capture.md)> | | [optional]
|
||||
**capture_rolling_reserve_release** | Option<[**models::EntityBalanceTransactionContextCapture**](entity_balance_transaction_context_capture.md)> | | [optional]
|
||||
**unauthorized_direct_debit** | Option<[**models::EntityBalanceTransactionContextPayment**](entity_balance_transaction_context_payment.md)> | | [optional]
|
||||
**failed_payment** | Option<[**models::EntityBalanceTransactionContextPayment**](entity_balance_transaction_context_payment.md)> | | [optional]
|
||||
**refund** | Option<[**models::EntityBalanceTransactionContextRefund**](entity_balance_transaction_context_refund.md)> | | [optional]
|
||||
**refund_compensation** | Option<[**models::EntityBalanceTransactionContextRefund**](entity_balance_transaction_context_refund.md)> | | [optional]
|
||||
**returned_refund** | Option<[**models::EntityBalanceTransactionContextRefund**](entity_balance_transaction_context_refund.md)> | | [optional]
|
||||
**returned_refund_compensation** | Option<[**models::EntityBalanceTransactionContextRefund**](entity_balance_transaction_context_refund.md)> | | [optional]
|
||||
**chargeback** | Option<[**models::EntityBalanceTransactionContextChargeback**](entity_balance_transaction_context_chargeback.md)> | | [optional]
|
||||
**chargeback_reversal** | Option<[**models::EntityBalanceTransactionContextChargeback**](entity_balance_transaction_context_chargeback.md)> | | [optional]
|
||||
**chargeback_compensation** | Option<[**models::EntityBalanceTransactionContextChargeback**](entity_balance_transaction_context_chargeback.md)> | | [optional]
|
||||
**reversed_chargeback_compensation** | Option<[**models::EntityBalanceTransactionContextChargeback**](entity_balance_transaction_context_chargeback.md)> | | [optional]
|
||||
**outgoing_transfer** | Option<[**models::EntityBalanceTransactionContextOutgoingTransfer**](entity_balance_transaction_context_outgoing_transfer.md)> | | [optional]
|
||||
**canceled_outgoing_transfer** | Option<[**models::EntityBalanceTransactionContextOutgoingTransfer**](entity_balance_transaction_context_outgoing_transfer.md)> | | [optional]
|
||||
**returned_transfer** | Option<[**models::EntityBalanceTransactionContextReturnedTransfer**](entity_balance_transaction_context_returned_transfer.md)> | | [optional]
|
||||
**invoice_compensation** | Option<[**models::EntityBalanceTransactionContextInvoiceCompensation**](entity_balance_transaction_context_invoice_compensation.md)> | | [optional]
|
||||
**application_fee** | Option<[**models::EntityBalanceTransactionContextApplicationFee**](entity_balance_transaction_context_application_fee.md)> | | [optional]
|
||||
**split_payment** | Option<[**models::EntityBalanceTransactionContextSplitPayment**](entity_balance_transaction_context_split_payment.md)> | | [optional]
|
||||
**platform_payment_refund** | Option<[**models::EntityBalanceTransactionContextRefund**](entity_balance_transaction_context_refund.md)> | | [optional]
|
||||
**returned_platform_payment_refund** | Option<[**models::EntityBalanceTransactionContextRefund**](entity_balance_transaction_context_refund.md)> | | [optional]
|
||||
**platform_payment_chargeback** | Option<[**models::EntityBalanceTransactionContextChargeback**](entity_balance_transaction_context_chargeback.md)> | | [optional]
|
||||
**reversed_platform_payment_chargeback** | Option<[**models::EntityBalanceTransactionContextChargeback**](entity_balance_transaction_context_chargeback.md)> | | [optional]
|
||||
**payment_commission** | Option<[**models::EntityBalanceTransactionContextPaymentCommission**](entity_balance_transaction_context_payment_commission.md)> | | [optional]
|
||||
**reimbursement_fee** | Option<[**models::EntityBalanceTransactionContextPayment**](entity_balance_transaction_context_payment.md)> | | [optional]
|
||||
**failed_payment_fee** | Option<[**models::EntityBalanceTransactionContextPayment**](entity_balance_transaction_context_payment.md)> | | [optional]
|
||||
**payment_fee** | Option<[**models::EntityBalanceTransactionContextPayment**](entity_balance_transaction_context_payment.md)> | | [optional]
|
||||
**managed_fee** | Option<[**models::EntityBalanceTransactionContextManagedFee**](entity_balance_transaction_context_managed_fee.md)> | | [optional]
|
||||
**returned_managed_fee** | Option<[**models::EntityBalanceTransactionContextManagedFee**](entity_balance_transaction_context_managed_fee.md)> | | [optional]
|
||||
**post_payment_split_payment** | Option<[**models::EntityBalanceTransactionContextPostPaymentSplitPayment**](entity_balance_transaction_context_post_payment_split_payment.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# EntityBalanceTransactionContextApplicationFee
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**payment_description** | Option<**String**> | | [optional]
|
||||
**paying_owner** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# EntityBalanceTransactionContextCapture
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**payment_description** | Option<**String**> | | [optional]
|
||||
**capture_id** | Option<**String**> | | [optional]
|
||||
**capture_description** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# EntityBalanceTransactionContextChargeback
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**payment_description** | Option<**String**> | | [optional]
|
||||
**chargeback_id** | Option<**String**> | | [optional]
|
||||
**chargeback_description** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# EntityBalanceTransactionContextInvoiceCompensation
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**invoice_id** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityBalanceTransactionContextManagedFee
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**fee_type** | Option<**String**> | | [optional]
|
||||
**fee_id** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityBalanceTransactionContextOutgoingTransfer
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**transfer_id** | Option<**String**> | | [optional]
|
||||
**settlement_id** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityBalanceTransactionContextPayment
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**payment_description** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# EntityBalanceTransactionContextPaymentCommission
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**payment_description** | Option<**String**> | | [optional]
|
||||
**organization_id** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# EntityBalanceTransactionContextPostPaymentSplitPayment
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# EntityBalanceTransactionContextRefund
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**payment_description** | Option<**String**> | | [optional]
|
||||
**refund_id** | Option<**String**> | | [optional]
|
||||
**refund_description** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityBalanceTransactionContextReturnedTransfer
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**transfer_id** | Option<**String**> | | [optional]
|
||||
**settlement_id** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# EntityBalanceTransactionContextSplitPayment
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**payment_description** | Option<**String**> | | [optional]
|
||||
**payment_onwer** | Option<**String**> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# EntityBalanceTransfer
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | **String** | Indicates the response contains a balance transfer object. Will always contain the string `connect-balance-transfer` for this endpoint. | [readonly]
|
||||
**id** | **String** | |
|
||||
**amount** | [**models::Amount**](amount.md) | The amount to be transferred, e.g. `{\"currency\":\"EUR\", \"value\":\"1000.00\"}` if you would like to transfer €1000.00. |
|
||||
**source** | [**models::EntityBalanceTransferParty**](entity-balance-transfer-party.md) | |
|
||||
**destination** | [**models::EntityBalanceTransferParty**](entity-balance-transfer-party.md) | |
|
||||
**description** | **String** | The transfer description for initiating party. |
|
||||
**status** | [**models::BalanceTransferStatus**](balance-transfer-status.md) | |
|
||||
**status_reason** | [**models::EntityBalanceTransferStatusReason**](entity_balance_transfer_statusReason.md) | |
|
||||
**category** | Option<[**models::BalanceTransferCategory**](balance-transfer-category.md)> | | [optional]
|
||||
**created_at** | **String** | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [readonly]
|
||||
**executed_at** | Option<**String**> | The date and time when the transfer was completed, in ISO 8601 format. This parameter is omitted if the transfer is not executed (yet). | [optional][readonly]
|
||||
**testmode** | Option<**bool**> | Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. | [optional]
|
||||
**mode** | [**models::Mode**](mode.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# EntityBalanceTransferDestination
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**r#type** | Option<[**models::BalanceTransferDestinationType**](balance-transfer-destination-type.md)> | | [optional]
|
||||
**bank_account** | Option<**String**> | The configured bank account number of the beneficiary the balance amount is to be transferred to. | [optional]
|
||||
**beneficiary_name** | Option<**String**> | The full name of the beneficiary the balance amount is to be transferred to. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# EntityBalanceTransferParty
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**r#type** | [**models::BalanceTransferPartyType**](balance-transfer-party-type.md) | |
|
||||
**id** | **String** | |
|
||||
**description** | **String** | The transfer description for the transfer party. This is the description that will appear in the financial reports of the party. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# EntityBalanceTransferPartyResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**r#type** | [**models::BalanceTransferPartyTypeResponse**](balance-transfer-party-type-response.md) | |
|
||||
**id** | **String** | |
|
||||
**description** | **String** | The transfer description for the transfer party. This is the description that will appear in the financial reports of the party. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# EntityBalanceTransferResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | **String** | Indicates the response contains a balance transfer object. Will always contain the string `connect-balance-transfer` for this endpoint. | [readonly]
|
||||
**id** | **String** | |
|
||||
**amount** | [**models::Amount**](amount.md) | The amount to be transferred, e.g. `{\"currency\":\"EUR\", \"value\":\"1000.00\"}` if you would like to transfer €1000.00. |
|
||||
**source** | [**models::EntityBalanceTransferPartyResponse**](entity-balance-transfer-party-response.md) | |
|
||||
**destination** | [**models::EntityBalanceTransferPartyResponse**](entity-balance-transfer-party-response.md) | |
|
||||
**description** | **String** | The transfer description for initiating party. |
|
||||
**status** | [**models::BalanceTransferStatus**](balance-transfer-status.md) | |
|
||||
**status_reason** | [**models::EntityBalanceTransferResponseStatusReason**](entity_balance_transfer_response_statusReason.md) | |
|
||||
**category** | Option<[**models::BalanceTransferCategoryResponse**](balance-transfer-category-response.md)> | | [optional]
|
||||
**created_at** | **String** | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [readonly]
|
||||
**executed_at** | Option<**String**> | The date and time when the transfer was completed, in ISO 8601 format. This parameter is omitted if the transfer is not executed (yet). | [optional][readonly]
|
||||
**testmode** | Option<**bool**> | Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. | [optional]
|
||||
**mode** | [**models::Mode**](mode.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityBalanceTransferResponseStatusReason
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | [**models::BalanceTransferStatusReasonResponse**](balance-transfer-status-reason-response.md) | |
|
||||
**message** | **String** | A description of the status reason, localized according to the transfer. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityBalanceTransferStatusReason
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | [**models::BalanceTransferStatusReason**](balance-transfer-status-reason.md) | |
|
||||
**message** | **String** | A description of the status reason, localized according to the transfer. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# EntityCapability
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Always the word `capability` for this resource type. | [optional]
|
||||
**name** | Option<**String**> | A unique name for this capability like `payments` / `settlements`. | [optional]
|
||||
**status** | Option<[**models::CapabilityStatus**](capability-status.md)> | | [optional]
|
||||
**status_reason** | Option<[**models::CapabilityStatusReason**](capability-status-reason.md)> | | [optional]
|
||||
**requirements** | Option<[**Vec<models::EntityCapabilityRequirement>**](entity-capability-requirement.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# EntityCapabilityRequirement
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | Option<**String**> | The name of this requirement, referring to the task to be fulfilled by the organization to enable or re-enable the capability. The name is unique among other requirements of the same capability. | [optional]
|
||||
**status** | Option<[**models::CapabilityRequirementStatus**](capability-requirement-status.md)> | | [optional]
|
||||
**due_date** | Option<**String**> | Due date until the requirement must be fulfilled, if any. The date is shown in ISO-8601 format. | [optional]
|
||||
**_links** | Option<[**models::EntityCapabilityRequirementLinks**](entity_capability_requirement__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# EntityCapabilityRequirementLinks
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dashboard** | Option<[**models::EntityCapabilityRequirementLinksDashboard**](entity_capability_requirement__links_dashboard.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityCapabilityRequirementLinksDashboard
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | Option<**String**> | The actual URL string. | [optional]
|
||||
**r#type** | Option<**String**> | The content type of the page or endpoint the URL points to. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# EntityCapture
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a capture object. Will always contain the string `capture` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | | [optional]
|
||||
**mode** | Option<[**models::Mode**](mode.md)> | | [optional]
|
||||
**description** | Option<**String**> | The description of the capture. | [optional]
|
||||
**amount** | Option<[**models::AmountNullable**](amount-nullable.md)> | The amount captured. If no amount is provided, the full authorized amount is captured. | [optional]
|
||||
**settlement_amount** | Option<[**models::AmountNullable**](amount-nullable.md)> | This optional field will contain the approximate amount that will be settled to your account, converted to the currency your account is settled in. Since the field contains an estimated amount during capture processing, it may change over time. To retrieve accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions) instead. | [optional][readonly]
|
||||
**status** | Option<[**models::CaptureStatus**](capture-status.md)> | | [optional][readonly]
|
||||
**metadata** | Option<[**models::Metadata**](metadata.md)> | | [optional]
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**shipment_id** | Option<**String**> | | [optional]
|
||||
**settlement_id** | Option<**String**> | | [optional]
|
||||
**created_at** | Option<**String**> | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
**_links** | Option<[**models::EntityCaptureLinks**](entity_capture__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# EntityCaptureLinks
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**param_self** | [**models::Url**](url.md) | |
|
||||
**payment** | [**models::Url**](url.md) | The API resource URL of the [payment](get-payment) that this capture belongs to. |
|
||||
**settlement** | Option<[**models::UrlNullable**](url-nullable.md)> | The API resource URL of the [settlement](get-settlement) this capture has been settled with. Not present if not yet settled. | [optional]
|
||||
**shipment** | Option<[**models::UrlNullable**](url-nullable.md)> | The API resource URL of the [shipment](get-shipment) this capture is associated with. Not present if it isn't associated with a shipment. | [optional]
|
||||
**documentation** | [**models::Url**](url.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# EntityCaptureResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a capture object. Will always contain the string `capture` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | | [optional]
|
||||
**mode** | Option<[**models::Mode**](mode.md)> | | [optional]
|
||||
**description** | Option<**String**> | The description of the capture. | [optional]
|
||||
**amount** | Option<[**models::AmountNullable**](amount-nullable.md)> | The amount captured. If no amount is provided, the full authorized amount is captured. | [optional]
|
||||
**settlement_amount** | Option<[**models::AmountNullable**](amount-nullable.md)> | This optional field will contain the approximate amount that will be settled to your account, converted to the currency your account is settled in. Since the field contains an estimated amount during capture processing, it may change over time. To retrieve accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions) instead. | [optional][readonly]
|
||||
**status** | Option<[**models::CaptureStatus**](capture-status.md)> | | [optional][readonly]
|
||||
**metadata** | Option<[**models::Metadata**](metadata.md)> | | [optional]
|
||||
**payment_id** | Option<**String**> | | [optional]
|
||||
**shipment_id** | Option<**String**> | | [optional]
|
||||
**settlement_id** | Option<**String**> | | [optional]
|
||||
**created_at** | Option<**String**> | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
**_links** | Option<[**models::EntityCaptureLinks**](entity_capture__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# EntityChargeback
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | **String** | Indicates the response contains a chargeback object. Will always contain the string `chargeback` for this endpoint. | [readonly]
|
||||
**id** | **String** | |
|
||||
**amount** | [**models::Amount**](amount.md) | The amount charged back by the customer. |
|
||||
**settlement_amount** | Option<[**models::AmountNullable**](amount-nullable.md)> | This optional field will contain the approximate amount that will be deducted from your account balance, converted to the currency your account is settled in. The amount is a **negative** amount. Since the field contains an estimated amount during chargeback processing, it may change over time. To retrieve accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions) instead. | [optional][readonly]
|
||||
**reason** | Option<[**models::EntityChargebackReason**](entity_chargeback_reason.md)> | | [optional]
|
||||
**payment_id** | **String** | |
|
||||
**settlement_id** | Option<**String**> | | [optional]
|
||||
**created_at** | **String** | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [readonly]
|
||||
**reversed_at** | Option<**String**> | The date and time the chargeback was reversed if applicable, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
**_links** | [**models::EntityRefundLinks**](entity_refund__links.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# EntityChargebackReason
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **String** | Technical code provided by the bank. |
|
||||
**description** | **String** | A more detailed human-friendly description. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# EntityClient
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a client object. Will always contain the string `client` for this resource type. | [optional][readonly]
|
||||
**id** | Option<**String**> | The identifier uniquely referring to this client. Example: `org_12345678`. | [optional][readonly]
|
||||
**commission** | Option<[**models::EntityClientCommission**](entity_client_commission.md)> | | [optional]
|
||||
**organization_created_at** | Option<**String**> | The date and time the client organization was created, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
**_links** | Option<[**models::EntityClientLinks**](entity_client__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# EntityClientCommission
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**count** | Option<**i32**> | The commission count. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# EntityClientLink
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a client link object. Will always contain the string `client-link` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | The identifier uniquely referring to this client link. Example: `cl_vZCnNQsV2UtfXxYifWKWH`. | [optional][readonly]
|
||||
**owner** | Option<[**models::EntityClientLinkOwner**](entity_client_link_owner.md)> | | [optional]
|
||||
**name** | Option<**String**> | Name of the organization. | [optional]
|
||||
**address** | Option<[**models::EntityClientLinkAddress**](entity_client_link_address.md)> | | [optional]
|
||||
**registration_number** | Option<**String**> | The registration number of the organization at their local chamber of commerce. | [optional]
|
||||
**vat_number** | Option<**String**> | The VAT number of the organization, if based in the European Union. VAT numbers are verified against the international registry *VIES*. | [optional]
|
||||
**_links** | Option<[**models::EntityClientLinkLinks**](entity_client_link__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# EntityClientLinkAddress
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**street_and_number** | Option<**String**> | The street name and house number of the organization. | [optional]
|
||||
**postal_code** | Option<**String**> | The postal code of the organization. Required if a street address is provided and if the country has a postal code system. | [optional]
|
||||
**city** | Option<**String**> | The city of the organization. Required if a street address is provided. | [optional]
|
||||
**country** | **String** | The country of the address in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# EntityClientLinkLinks
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**param_self** | Option<[**models::Url**](url.md)> | | [optional]
|
||||
**client_link** | Option<[**models::Url**](url.md)> | The link you can send your customer to, where they can either log in and link their account, or sign up and proceed with onboarding. | [optional]
|
||||
**documentation** | Option<[**models::Url**](url.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# EntityClientLinkOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **String** | The email address of your customer. |
|
||||
**given_name** | **String** | The given name (first name) of your customer. |
|
||||
**family_name** | **String** | The family name (surname) of your customer. |
|
||||
**locale** | Option<[**models::LocaleResponse**](locale-response.md)> | Preset the language to be used for the login screen, if applicable. For the consent screen, the preferred language of the logged in merchant will be used and this parameter is ignored. When this parameter is omitted, the browser language will be used instead. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# EntityClientLinkResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a client link object. Will always contain the string `client-link` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | The identifier uniquely referring to this client link. Example: `cl_vZCnNQsV2UtfXxYifWKWH`. | [optional][readonly]
|
||||
**owner** | Option<[**models::EntityClientLinkOwner**](entity_client_link_owner.md)> | | [optional]
|
||||
**name** | Option<**String**> | Name of the organization. | [optional]
|
||||
**address** | Option<[**models::EntityClientLinkAddress**](entity_client_link_address.md)> | | [optional]
|
||||
**registration_number** | Option<**String**> | The registration number of the organization at their local chamber of commerce. | [optional]
|
||||
**vat_number** | Option<**String**> | The VAT number of the organization, if based in the European Union. VAT numbers are verified against the international registry *VIES*. | [optional]
|
||||
**_links** | Option<[**models::EntityClientLinkLinks**](entity_client_link__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# EntityClientLinks
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**param_self** | Option<[**models::Url**](url.md)> | | [optional]
|
||||
**organization** | Option<[**models::Url**](url.md)> | The API resource URL of the client's organization. | [optional]
|
||||
**onboarding** | Option<[**models::Url**](url.md)> | The API resource URL of the client's onboarding status. | [optional]
|
||||
**documentation** | Option<[**models::Url**](url.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# EntityCustomer
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**resource** | Option<**String**> | Indicates the response contains a customer object. Will always contain the string `customer` for this endpoint. | [optional][readonly]
|
||||
**id** | Option<**String**> | | [optional]
|
||||
**mode** | Option<[**models::Mode**](mode.md)> | | [optional]
|
||||
**name** | Option<**String**> | The full name of the customer. | [optional]
|
||||
**email** | Option<**String**> | The email address of the customer. | [optional]
|
||||
**locale** | Option<[**models::LocaleResponse**](locale-response.md)> | Preconfigure the language to be used in the hosted payment pages shown to the customer. Should only be provided if absolutely necessary. If not provided, the browser language will be used which is typically highly accurate. | [optional]
|
||||
**metadata** | Option<[**models::Metadata**](metadata.md)> | | [optional]
|
||||
**created_at** | Option<**String**> | The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. | [optional][readonly]
|
||||
**testmode** | Option<**bool**> | Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. | [optional]
|
||||
**_links** | Option<[**models::EntityCustomerLinks**](entity_customer__links.md)> | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# EntityCustomerLinks
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**param_self** | [**models::Url**](url.md) | |
|
||||
**dashboard** | [**models::Url**](url.md) | |
|
||||
**payments** | Option<[**models::UrlNullable**](url-nullable.md)> | The API resource URL of the [payments](list-payments) linked to this customer. Omitted if no such payments exist (yet). | [optional]
|
||||
**mandates** | Option<[**models::UrlNullable**](url-nullable.md)> | The API resource URL of the [mandates](list-mandates) linked to this customer. Omitted if no such mandates exist (yet). | [optional]
|
||||
**subscriptions** | Option<[**models::UrlNullable**](url-nullable.md)> | The API resource URL of the [subscriptions](list-subscriptions) linked to this customer. Omitted if no such subscriptions exist (yet). | [optional]
|
||||
**documentation** | [**models::Url**](url.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user