├── .github ├── dependabot.yml └── workflows │ └── generate-release-tag.yml ├── .gitignore ├── .openapi-generator-ignore ├── .openapi-generator ├── FILES └── VERSION ├── LICENSE ├── README.md ├── docs ├── BalanceApi.md ├── Configuration.md ├── CustomerApi.md ├── InvoiceApi.md ├── PaymentMethodApi.md ├── PaymentRequestApi.md ├── PayoutApi.md ├── RefundApi.md ├── TransactionApi.md ├── balance_and_transaction │ ├── Balance.md │ ├── ChannelsCategories.md │ ├── Currency.md │ ├── DateRangeFilter.md │ ├── FeeResponse.md │ ├── LinkItem.md │ ├── ServerError.md │ ├── TransactionId.md │ ├── TransactionResponse.md │ ├── TransactionResponseType.md │ ├── TransactionStatuses.md │ ├── TransactionTypes.md │ ├── TransactionsResponse.md │ └── ValidationError.md ├── customer │ ├── AccountBank.md │ ├── AccountCard.md │ ├── AccountEwallet.md │ ├── AccountOTC.md │ ├── AccountPayLater.md │ ├── AccountQRCode.md │ ├── Address.md │ ├── AddressRequest.md │ ├── AddressStatus.md │ ├── BusinessDetail.md │ ├── CountryCode.md │ ├── CreateCustomer400Response.md │ ├── CreateCustomer400ResponseAllOf.md │ ├── Customer.md │ ├── CustomerRequest.md │ ├── EmploymentDetail.md │ ├── EndCustomerStatus.md │ ├── Error.md │ ├── GetCustomerByReferenceID200Response.md │ ├── GetCustomerByReferenceID400Response.md │ ├── GetCustomerByReferenceID400ResponseAllOf.md │ ├── IdentityAccountRequest.md │ ├── IdentityAccountRequestProperties.md │ ├── IdentityAccountResponse.md │ ├── IdentityAccountResponseProperties.md │ ├── IdentityAccountType.md │ ├── IndividualDetail.md │ ├── KYCDocumentRequest.md │ ├── KYCDocumentResponse.md │ ├── KYCDocumentSubType.md │ ├── KYCDocumentType.md │ ├── PatchCustomer.md │ ├── ResponseDataNotFound.md │ ├── UpdateCustomer400Response.md │ └── UpdateCustomer400ResponseAllOf.md ├── invoice │ ├── AddressObject.md │ ├── AlternativeDisplayItem.md │ ├── BadRequestError.md │ ├── Bank.md │ ├── BankCode.md │ ├── ChannelProperties.md │ ├── ChannelPropertiesCards.md │ ├── ChannelPropertiesCardsInstallmentConfiguration.md │ ├── ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner.md │ ├── CreateInvoiceRequest.md │ ├── CustomerObject.md │ ├── DirectDebit.md │ ├── DirectDebitType.md │ ├── Ewallet.md │ ├── EwalletType.md │ ├── ForbiddenError.md │ ├── Invoice.md │ ├── InvoiceCallback.md │ ├── InvoiceCallbackItem.md │ ├── InvoiceClientType.md │ ├── InvoiceCurrency.md │ ├── InvoiceError404ResponseDefinition.md │ ├── InvoiceFee.md │ ├── InvoiceItem.md │ ├── InvoiceNotFoundError.md │ ├── InvoicePaymentMethod.md │ ├── InvoiceStatus.md │ ├── NotificationChannel.md │ ├── NotificationPreference.md │ ├── Paylater.md │ ├── PaylaterType.md │ ├── PaymentDetails.md │ ├── QrCode.md │ ├── QrCodeType.md │ ├── RetailOutlet.md │ ├── RetailOutletName.md │ ├── ServerError.md │ └── UnauthorizedError.md ├── payment_method │ ├── BillingInformation.md │ ├── Card.md │ ├── CardChannelCode.md │ ├── CardChannelProperties.md │ ├── CardInstallmentConfiguration.md │ ├── CardParameters.md │ ├── CardParametersCardInformation.md │ ├── CardVerificationResults.md │ ├── CardVerificationResultsThreeDSecure.md │ ├── CreatePaymentMethod409Response.md │ ├── CreatePaymentMethod503Response.md │ ├── DirectDebit.md │ ├── DirectDebitAllOf.md │ ├── DirectDebitBankAccount.md │ ├── DirectDebitChannelCode.md │ ├── DirectDebitChannelProperties.md │ ├── DirectDebitDebitCard.md │ ├── DirectDebitParameters.md │ ├── DirectDebitType.md │ ├── EWallet.md │ ├── EWalletAccount.md │ ├── EWalletChannelCode.md │ ├── EWalletChannelProperties.md │ ├── EWalletParameters.md │ ├── GetAllPaymentMethods400Response.md │ ├── GetAllPaymentMethods403Response.md │ ├── GetAllPaymentMethods404Response.md │ ├── GetAllPaymentMethodsDefaultResponse.md │ ├── OverTheCounter.md │ ├── OverTheCounterChannelCode.md │ ├── OverTheCounterChannelProperties.md │ ├── OverTheCounterChannelPropertiesUpdate.md │ ├── OverTheCounterParameters.md │ ├── OverTheCounterUpdateParameters.md │ ├── PaymentMethod.md │ ├── PaymentMethodAction.md │ ├── PaymentMethodAuthParameters.md │ ├── PaymentMethodCallback.md │ ├── PaymentMethodCountry.md │ ├── PaymentMethodExpireParameters.md │ ├── PaymentMethodList.md │ ├── PaymentMethodParameters.md │ ├── PaymentMethodReusability.md │ ├── PaymentMethodStatus.md │ ├── PaymentMethodType.md │ ├── PaymentMethodUpdateParameters.md │ ├── QRCode.md │ ├── QRCodeChannelCode.md │ ├── QRCodeChannelProperties.md │ ├── QRCodeParameters.md │ ├── SimulatePaymentRequest.md │ ├── TokenizedCardInformation.md │ ├── VirtualAccount.md │ ├── VirtualAccountAllOf.md │ ├── VirtualAccountAlternativeDisplay.md │ ├── VirtualAccountChannelCode.md │ ├── VirtualAccountChannelProperties.md │ ├── VirtualAccountChannelPropertiesPatch.md │ ├── VirtualAccountParameters.md │ └── VirtualAccountUpdateParameters.md ├── payment_request │ ├── Capture.md │ ├── CaptureList.md │ ├── CaptureListResponse.md │ ├── CaptureParameters.md │ ├── Card.md │ ├── CardChannelCode.md │ ├── CardChannelProperties.md │ ├── CardInformation.md │ ├── CardInstallmentConfiguration.md │ ├── CardParameters.md │ ├── CardVerificationResults.md │ ├── CardVerificationResultsThreeDSecure.md │ ├── DirectDebit.md │ ├── DirectDebitAllOf.md │ ├── DirectDebitBankAccount.md │ ├── DirectDebitChannelCode.md │ ├── DirectDebitChannelProperties.md │ ├── DirectDebitChannelPropertiesBankAccount.md │ ├── DirectDebitChannelPropertiesBankRedirect.md │ ├── DirectDebitChannelPropertiesDebitCard.md │ ├── DirectDebitDebitCard.md │ ├── DirectDebitParameters.md │ ├── DirectDebitType.md │ ├── EWallet.md │ ├── EWalletAccount.md │ ├── EWalletAllOf.md │ ├── EWalletChannelCode.md │ ├── EWalletChannelProperties.md │ ├── EWalletParameters.md │ ├── Error.md │ ├── InvoicePartnerMetadata.md │ ├── OverTheCounter.md │ ├── OverTheCounterChannelCode.md │ ├── OverTheCounterChannelProperties.md │ ├── OverTheCounterParameters.md │ ├── PaymentCallback.md │ ├── PaymentCallbackData.md │ ├── PaymentMethod.md │ ├── PaymentMethodParameters.md │ ├── PaymentMethodReusability.md │ ├── PaymentMethodStatus.md │ ├── PaymentMethodType.md │ ├── PaymentRequest.md │ ├── PaymentRequestAction.md │ ├── PaymentRequestAuthParameters.md │ ├── PaymentRequestBasket.md │ ├── PaymentRequestBasketItem.md │ ├── PaymentRequestCaptureMethod.md │ ├── PaymentRequestCardVerificationResults.md │ ├── PaymentRequestCardVerificationResultsThreeDeeSecure.md │ ├── PaymentRequestChannelProperties.md │ ├── PaymentRequestCountry.md │ ├── PaymentRequestCurrency.md │ ├── PaymentRequestInitiator.md │ ├── PaymentRequestListResponse.md │ ├── PaymentRequestParameters.md │ ├── PaymentRequestParametersChannelProperties.md │ ├── PaymentRequestParametersChannelPropertiesAllOf.md │ ├── PaymentRequestShippingInformation.md │ ├── PaymentRequestStatus.md │ ├── PaymentSimulation.md │ ├── QRCode.md │ ├── QRCodeChannelCode.md │ ├── QRCodeChannelProperties.md │ ├── QRCodeParameters.md │ ├── VirtualAccount.md │ ├── VirtualAccountAllOf.md │ ├── VirtualAccountAlternativeDisplay.md │ ├── VirtualAccountChannelCode.md │ ├── VirtualAccountChannelProperties.md │ └── VirtualAccountParameters.md ├── payout │ ├── Channel.md │ ├── ChannelAccountType.md │ ├── ChannelAmountLimits.md │ ├── ChannelCategory.md │ ├── CreatePayoutRequest.md │ ├── DigitalPayoutChannelProperties.md │ ├── Error.md │ ├── ErrorErrorsInner.md │ ├── GetPayouts200Response.md │ ├── GetPayouts200ResponseDataInner.md │ ├── GetPayouts200ResponseLinks.md │ ├── Payout.md │ ├── PayoutAllOf.md │ └── ReceiptNotification.md └── refund │ ├── CreateRefund.md │ ├── CreateRefund400Response.md │ ├── CreateRefund403Response.md │ ├── CreateRefund404Response.md │ ├── CreateRefund409Response.md │ ├── CreateRefund503Response.md │ ├── GetAllRefundsDefaultResponse.md │ ├── Refund.md │ ├── RefundCallback.md │ ├── RefundCallbackData.md │ └── RefundList.md ├── images └── header.jpg ├── pyproject.toml ├── requirements.txt ├── setup.cfg ├── setup.py ├── test-requirements.txt ├── test ├── .env.test ├── __init__.py ├── invoice_api_test.py ├── payment_api_test.py └── utils │ ├── __init__.py │ └── test_utils.py ├── tox.ini └── xendit ├── __init__.py ├── api_client.py ├── apis └── __init__.py ├── balance_and_transaction ├── __init__.py ├── balance_api.py ├── model │ ├── __init__.py │ ├── balance.py │ ├── channels_categories.py │ ├── currency.py │ ├── date_range_filter.py │ ├── fee_response.py │ ├── link_item.py │ ├── server_error.py │ ├── transaction_id.py │ ├── transaction_response.py │ ├── transaction_response_type.py │ ├── transaction_statuses.py │ ├── transaction_types.py │ ├── transactions_response.py │ └── validation_error.py └── transaction_api.py ├── configuration.py ├── customer ├── __init__.py ├── customer_api.py └── model │ ├── __init__.py │ ├── account_bank.py │ ├── account_card.py │ ├── account_ewallet.py │ ├── account_otc.py │ ├── account_pay_later.py │ ├── account_qr_code.py │ ├── address.py │ ├── address_request.py │ ├── address_status.py │ ├── business_detail.py │ ├── country_code.py │ ├── create_customer400_response.py │ ├── create_customer400_response_all_of.py │ ├── customer.py │ ├── customer_request.py │ ├── employment_detail.py │ ├── end_customer_status.py │ ├── error.py │ ├── get_customer_by_reference_id200_response.py │ ├── get_customer_by_reference_id400_response.py │ ├── get_customer_by_reference_id400_response_all_of.py │ ├── identity_account_request.py │ ├── identity_account_request_properties.py │ ├── identity_account_response.py │ ├── identity_account_response_properties.py │ ├── identity_account_type.py │ ├── individual_detail.py │ ├── kyc_document_request.py │ ├── kyc_document_response.py │ ├── kyc_document_sub_type.py │ ├── kyc_document_type.py │ ├── patch_customer.py │ ├── response_data_not_found.py │ ├── update_customer400_response.py │ └── update_customer400_response_all_of.py ├── exceptions.py ├── invoice ├── __init__.py ├── invoice_api.py └── model │ ├── __init__.py │ ├── address_object.py │ ├── alternative_display_item.py │ ├── bad_request_error.py │ ├── bank.py │ ├── bank_code.py │ ├── channel_properties.py │ ├── channel_properties_cards.py │ ├── channel_properties_cards_installment_configuration.py │ ├── channel_properties_cards_installment_configuration_allowed_terms_inner.py │ ├── create_invoice_request.py │ ├── customer_object.py │ ├── direct_debit.py │ ├── direct_debit_type.py │ ├── ewallet.py │ ├── ewallet_type.py │ ├── forbidden_error.py │ ├── invoice.py │ ├── invoice_callback.py │ ├── invoice_callback_item.py │ ├── invoice_client_type.py │ ├── invoice_currency.py │ ├── invoice_error404_response_definition.py │ ├── invoice_fee.py │ ├── invoice_item.py │ ├── invoice_not_found_error.py │ ├── invoice_payment_method.py │ ├── invoice_status.py │ ├── notification_channel.py │ ├── notification_preference.py │ ├── paylater.py │ ├── paylater_type.py │ ├── payment_details.py │ ├── qr_code.py │ ├── qr_code_type.py │ ├── retail_outlet.py │ ├── retail_outlet_name.py │ ├── server_error.py │ └── unauthorized_error.py ├── model_utils.py ├── models └── __init__.py ├── payment_method ├── __init__.py ├── model │ ├── __init__.py │ ├── billing_information.py │ ├── card.py │ ├── card_channel_code.py │ ├── card_channel_properties.py │ ├── card_installment_configuration.py │ ├── card_parameters.py │ ├── card_parameters_card_information.py │ ├── card_verification_results.py │ ├── card_verification_results_three_d_secure.py │ ├── create_payment_method409_response.py │ ├── create_payment_method503_response.py │ ├── direct_debit.py │ ├── direct_debit_all_of.py │ ├── direct_debit_bank_account.py │ ├── direct_debit_channel_code.py │ ├── direct_debit_channel_properties.py │ ├── direct_debit_debit_card.py │ ├── direct_debit_parameters.py │ ├── direct_debit_type.py │ ├── e_wallet.py │ ├── e_wallet_account.py │ ├── e_wallet_channel_code.py │ ├── e_wallet_channel_properties.py │ ├── e_wallet_parameters.py │ ├── get_all_payment_methods400_response.py │ ├── get_all_payment_methods403_response.py │ ├── get_all_payment_methods404_response.py │ ├── get_all_payment_methods_default_response.py │ ├── over_the_counter.py │ ├── over_the_counter_channel_code.py │ ├── over_the_counter_channel_properties.py │ ├── over_the_counter_channel_properties_update.py │ ├── over_the_counter_parameters.py │ ├── over_the_counter_update_parameters.py │ ├── payment_method.py │ ├── payment_method_action.py │ ├── payment_method_auth_parameters.py │ ├── payment_method_callback.py │ ├── payment_method_country.py │ ├── payment_method_expire_parameters.py │ ├── payment_method_list.py │ ├── payment_method_parameters.py │ ├── payment_method_reusability.py │ ├── payment_method_status.py │ ├── payment_method_type.py │ ├── payment_method_update_parameters.py │ ├── qr_code.py │ ├── qr_code_channel_code.py │ ├── qr_code_channel_properties.py │ ├── qr_code_parameters.py │ ├── simulate_payment_request.py │ ├── tokenized_card_information.py │ ├── virtual_account.py │ ├── virtual_account_all_of.py │ ├── virtual_account_alternative_display.py │ ├── virtual_account_channel_code.py │ ├── virtual_account_channel_properties.py │ ├── virtual_account_channel_properties_patch.py │ ├── virtual_account_parameters.py │ └── virtual_account_update_parameters.py └── payment_method_api.py ├── payment_request ├── __init__.py ├── model │ ├── __init__.py │ ├── capture.py │ ├── capture_list.py │ ├── capture_list_response.py │ ├── capture_parameters.py │ ├── card.py │ ├── card_channel_code.py │ ├── card_channel_properties.py │ ├── card_information.py │ ├── card_installment_configuration.py │ ├── card_parameters.py │ ├── card_verification_results.py │ ├── card_verification_results_three_d_secure.py │ ├── direct_debit.py │ ├── direct_debit_all_of.py │ ├── direct_debit_bank_account.py │ ├── direct_debit_channel_code.py │ ├── direct_debit_channel_properties.py │ ├── direct_debit_channel_properties_bank_account.py │ ├── direct_debit_channel_properties_bank_redirect.py │ ├── direct_debit_channel_properties_debit_card.py │ ├── direct_debit_debit_card.py │ ├── direct_debit_parameters.py │ ├── direct_debit_type.py │ ├── e_wallet.py │ ├── e_wallet_account.py │ ├── e_wallet_all_of.py │ ├── e_wallet_channel_code.py │ ├── e_wallet_channel_properties.py │ ├── e_wallet_parameters.py │ ├── error.py │ ├── invoice_partner_metadata.py │ ├── over_the_counter.py │ ├── over_the_counter_channel_code.py │ ├── over_the_counter_channel_properties.py │ ├── over_the_counter_parameters.py │ ├── payment_callback.py │ ├── payment_callback_data.py │ ├── payment_method.py │ ├── payment_method_parameters.py │ ├── payment_method_reusability.py │ ├── payment_method_status.py │ ├── payment_method_type.py │ ├── payment_request.py │ ├── payment_request_action.py │ ├── payment_request_auth_parameters.py │ ├── payment_request_basket.py │ ├── payment_request_basket_item.py │ ├── payment_request_capture_method.py │ ├── payment_request_card_verification_results.py │ ├── payment_request_card_verification_results_three_dee_secure.py │ ├── payment_request_channel_properties.py │ ├── payment_request_country.py │ ├── payment_request_currency.py │ ├── payment_request_initiator.py │ ├── payment_request_list_response.py │ ├── payment_request_parameters.py │ ├── payment_request_parameters_channel_properties.py │ ├── payment_request_parameters_channel_properties_all_of.py │ ├── payment_request_shipping_information.py │ ├── payment_request_status.py │ ├── payment_simulation.py │ ├── qr_code.py │ ├── qr_code_channel_code.py │ ├── qr_code_channel_properties.py │ ├── qr_code_parameters.py │ ├── virtual_account.py │ ├── virtual_account_all_of.py │ ├── virtual_account_alternative_display.py │ ├── virtual_account_channel_code.py │ ├── virtual_account_channel_properties.py │ └── virtual_account_parameters.py └── payment_request_api.py ├── payout ├── __init__.py ├── model │ ├── __init__.py │ ├── channel.py │ ├── channel_account_type.py │ ├── channel_amount_limits.py │ ├── channel_category.py │ ├── create_payout_request.py │ ├── digital_payout_channel_properties.py │ ├── error.py │ ├── error_errors_inner.py │ ├── get_payouts200_response.py │ ├── get_payouts200_response_data_inner.py │ ├── get_payouts200_response_links.py │ ├── payout.py │ ├── payout_all_of.py │ └── receipt_notification.py └── payout_api.py ├── refund ├── __init__.py ├── model │ ├── __init__.py │ ├── create_refund.py │ ├── create_refund400_response.py │ ├── create_refund403_response.py │ ├── create_refund404_response.py │ ├── create_refund409_response.py │ ├── create_refund503_response.py │ ├── get_all_refunds_default_response.py │ ├── refund.py │ ├── refund_callback.py │ ├── refund_callback_data.py │ └── refund_list.py └── refund_api.py └── rest.py /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "pip" # See documentation for possible values 4 | directory: "/" # Location of package manifests 5 | schedule: 6 | interval: "weekly" 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | venv/ 48 | .venv/ 49 | .python-version 50 | .pytest_cache 51 | 52 | # Translations 53 | *.mo 54 | *.pot 55 | 56 | # Django stuff: 57 | *.log 58 | 59 | # Sphinx documentation 60 | docs/_build/ 61 | 62 | # PyBuilder 63 | target/ 64 | 65 | #Ipython Notebook 66 | .ipynb_checkpoints 67 | 68 | .vscode/ 69 | test.py -------------------------------------------------------------------------------- /.openapi-generator-ignore: -------------------------------------------------------------------------------- 1 | # OpenAPI Generator Ignore 2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /.openapi-generator/VERSION: -------------------------------------------------------------------------------- 1 | 6.6.0 -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017-2025 Xendit 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /docs/balance_and_transaction/Balance.md: -------------------------------------------------------------------------------- 1 | # Balance 2 | > xendit.balance_and_transaction.model.Balance 3 | 4 | The balance remaining in your account 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **balance** | **float** | ☑️ | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/ChannelsCategories.md: -------------------------------------------------------------------------------- 1 | # ChannelsCategories 2 | > xendit.balance_and_transaction.model.ChannelsCategories 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `BANK` (value: `"BANK"`) 10 | 11 | * `CARDLESS_CREDIT` (value: `"CARDLESS_CREDIT"`) 12 | 13 | * `PAYLATER` (value: `"PAYLATER"`) 14 | 15 | * `CARDS` (value: `"CARDS"`) 16 | 17 | * `CASH` (value: `"CASH"`) 18 | 19 | * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) 20 | 21 | * `EWALLET` (value: `"EWALLET"`) 22 | 23 | * `INVOICE` (value: `"INVOICE"`) 24 | 25 | * `QR_CODE` (value: `"QR_CODE"`) 26 | 27 | * `RETAIL_OUTLET` (value: `"RETAIL_OUTLET"`) 28 | 29 | * `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) 30 | 31 | * `XENPLATFORM` (value: `"XENPLATFORM"`) 32 | 33 | * `DIRECT_BANK_TRANSFER` (value: `"DIRECT_BANK_TRANSFER"`) 34 | 35 | * `OTHER` (value: `"OTHER"`) 36 | 37 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 38 | 39 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 40 | 41 | [[Back to README]](../../README.md) 42 | 43 | 44 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/DateRangeFilter.md: -------------------------------------------------------------------------------- 1 | # DateRangeFilter 2 | > xendit.balance_and_transaction.model.DateRangeFilter 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **gte** | **datetime** | | Start time of transaction. If not specified will list all dates. | | 9 | | **lte** | **datetime** | | End time of transaction. If not specified will list all dates. | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/FeeResponse.md: -------------------------------------------------------------------------------- 1 | # FeeResponse 2 | > xendit.balance_and_transaction.model.FeeResponse 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **xendit_fee** | **float** | ☑️ | Amount of the Xendit fee for this transaction. | | | 9 | | **value_added_tax** | **float** | ☑️ | Amount of the VAT for this transaction. | | | 10 | | **xendit_withholding_tax** | **float** | | Amount of the Xendit Withholding Tax for this transaction if applicable. See [Tax Documentation](https://docs.xendit.co/fees-and-vat#vat) for more information. | | 11 | | **third_party_withholding_tax** | **float** | | Amount of the 3rd Party Withholding Tax for this transaction if applicable. 3rd party example: Bank | | 12 | | **status** | **str** | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/LinkItem.md: -------------------------------------------------------------------------------- 1 | # LinkItem 2 | > xendit.balance_and_transaction.model.LinkItem 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **href** | **str** | ☑️ | URI of target, this will be to the next link. | | | 9 | | **rel** | **str** | ☑️ | The relationship between source and target. The value will be `next`. | | | 10 | | **method** | **str** | ☑️ | The HTTP method, the value will be `GET`. | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/ServerError.md: -------------------------------------------------------------------------------- 1 | # ServerError 2 | > xendit.balance_and_transaction.model.ServerError 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **status_code** | **float** | ☑️ | | | | 9 | | **error** | **str** | ☑️ | | | | 10 | | **message** | **str** | ☑️ | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/TransactionId.md: -------------------------------------------------------------------------------- 1 | # TransactionId 2 | > xendit.balance_and_transaction.model.TransactionId 3 | 4 | The unique id of a transaction. It will have `txn_` as prefix 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **value** | **str** | The unique id of a transaction. It will have `txn_` as prefix | ☑️ | The unique id of a transaction. It will have `txn_` as prefix | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/TransactionResponseType.md: -------------------------------------------------------------------------------- 1 | # TransactionResponseType 2 | > xendit.balance_and_transaction.model.TransactionResponseType 3 | 4 | The type of the transactions. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/TransactionStatuses.md: -------------------------------------------------------------------------------- 1 | # TransactionStatuses 2 | > xendit.balance_and_transaction.model.TransactionStatuses 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `SUCCESS` (value: `"SUCCESS"`) 10 | 11 | * `PENDING` (value: `"PENDING"`) 12 | 13 | * `FAILED` (value: `"FAILED"`) 14 | 15 | * `REVERSED` (value: `"REVERSED"`) 16 | 17 | * `VOIDED` (value: `"VOIDED"`) 18 | 19 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 20 | 21 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/TransactionTypes.md: -------------------------------------------------------------------------------- 1 | # TransactionTypes 2 | > xendit.balance_and_transaction.model.TransactionTypes 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `BATCH_DISBURSEMENT` (value: `"BATCH_DISBURSEMENT"`) 10 | 11 | * `DISBURSEMENT` (value: `"DISBURSEMENT"`) 12 | 13 | * `PAYMENT` (value: `"PAYMENT"`) 14 | 15 | * `REMITTANCE` (value: `"REMITTANCE"`) 16 | 17 | * `REMITTANCE_PAYOUT` (value: `"REMITTANCE_PAYOUT"`) 18 | 19 | * `REMITTANCE_COLLECTION` (value: `"REMITTANCE_COLLECTION"`) 20 | 21 | * `TRANSFER` (value: `"TRANSFER"`) 22 | 23 | * `PLATFORM_FEE` (value: `"PLATFORM_FEE"`) 24 | 25 | * `REFUND` (value: `"REFUND"`) 26 | 27 | * `CASHBACK` (value: `"CASHBACK"`) 28 | 29 | * `TOPUP` (value: `"TOPUP"`) 30 | 31 | * `WITHDRAWAL` (value: `"WITHDRAWAL"`) 32 | 33 | * `OTHER` (value: `"OTHER"`) 34 | 35 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 36 | 37 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 38 | 39 | [[Back to README]](../../README.md) 40 | 41 | 42 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/TransactionsResponse.md: -------------------------------------------------------------------------------- 1 | # TransactionsResponse 2 | > xendit.balance_and_transaction.model.TransactionsResponse 3 | 4 | Returns an array of Transaction Objects. Returns empty array when there is no result. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **has_more** | **bool** | ☑️ | Indicates whether there are more items to be queried with `after_id` of the last item from the current result. Use the `links` to follow to the next result. | | | 10 | | **data** | [**[TransactionResponse]**](TransactionResponse.md) | ☑️ | | | | 11 | | **links** | [**[LinkItem]**](LinkItem.md) | | The links to the next page based on LinkItem if there is next result. | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/balance_and_transaction/ValidationError.md: -------------------------------------------------------------------------------- 1 | # ValidationError 2 | > xendit.balance_and_transaction.model.ValidationError 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **status_code** | **float** | ☑️ | | | | 9 | | **error** | **str** | ☑️ | | | | 10 | | **message** | **str** | ☑️ | | | | 11 | | **validation** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/customer/AccountBank.md: -------------------------------------------------------------------------------- 1 | # AccountBank 2 | > xendit.customer.model.AccountBank 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **account_number** | **str** | | Unique account identifier as per the bank records. | | 9 | | **account_holder_name** | **str, none_type** | | Name of account holder as per the bank records. Needs to match the registered account name exactly. . | | 10 | | **swift_code** | **str, none_type** | | The SWIFT code for international payments | | 11 | | **account_type** | **str, none_type** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | | 12 | | **account_details** | **str, none_type** | | Potentially masked account detail, for display purposes only. | | 13 | | **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/customer/AccountCard.md: -------------------------------------------------------------------------------- 1 | # AccountCard 2 | > xendit.customer.model.AccountCard 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **token_id** | **str** | | The token id returned in tokenisation | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/customer/AccountEwallet.md: -------------------------------------------------------------------------------- 1 | # AccountEwallet 2 | > xendit.customer.model.AccountEwallet 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **account_number** | **str** | | Unique account identifier as per the bank records. | | 9 | | **account_holder_name** | **str, none_type** | | Name of account holder as per the bank records. Needs to match the registered account name exactly. | | 10 | | **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/customer/AccountOTC.md: -------------------------------------------------------------------------------- 1 | # AccountOTC 2 | > xendit.customer.model.AccountOTC 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **payment_code** | **str** | | Complete fixed payment code (including prefix) | | 9 | | **expires_at** | **str, none_type** | | YYYY-MM-DD string with expiry date for the payment code | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/customer/AccountPayLater.md: -------------------------------------------------------------------------------- 1 | # AccountPayLater 2 | > xendit.customer.model.AccountPayLater 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **account_id** | **str** | | Alphanumeric string identifying this account. Usually an email address or phone number. | | 9 | | **account_holder_name** | **str, none_type** | | Name of account holder as per the cardless credit account. | | 10 | | **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/customer/AccountQRCode.md: -------------------------------------------------------------------------------- 1 | # AccountQRCode 2 | > xendit.customer.model.AccountQRCode 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **qr_string** | **str** | | String representation of the QR Code image | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/customer/Address.md: -------------------------------------------------------------------------------- 1 | # Address 2 | > xendit.customer.model.Address 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **category** | **str, none_type** | ☑️ | | | | 9 | | **country** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | 10 | | **province_state** | **str, none_type** | ☑️ | | | | 11 | | **city** | **str, none_type** | ☑️ | | | | 12 | | **postal_code** | **str, none_type** | ☑️ | | | | 13 | | **street_line1** | **str, none_type** | ☑️ | | | | 14 | | **street_line2** | **str, none_type** | ☑️ | | | | 15 | | **is_primary** | **bool, none_type** | ☑️ | | | | 16 | | **id** | **str** | | | | 17 | | **status** | [**AddressStatus**](AddressStatus.md) | | | | 18 | | **meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 19 | | **created** | **datetime** | | | | 20 | | **updated** | **datetime** | | | | 21 | 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/customer/AddressRequest.md: -------------------------------------------------------------------------------- 1 | # AddressRequest 2 | > xendit.customer.model.AddressRequest 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **category** | **str** | | Home, work or provincial | | 9 | | **country_code** | [**CountryCode**](CountryCode.md) | | | | 10 | | **province_state** | **str** | | | | 11 | | **city** | **str** | | | | 12 | | **suburb** | **str** | | | | 13 | | **postal_code** | **str** | | | | 14 | | **line_1** | **str** | | | | 15 | | **line_2** | **str** | | | | 16 | | **status** | [**AddressStatus**](AddressStatus.md) | | | | 17 | | **is_primary** | **bool** | | | False | 18 | 19 | 20 | [[Back to README]](../../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/customer/AddressStatus.md: -------------------------------------------------------------------------------- 1 | # AddressStatus 2 | > xendit.customer.model.AddressStatus 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `ACTIVE` (value: `"ACTIVE"`) 10 | 11 | * `DELETED` (value: `"DELETED"`) 12 | 13 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 14 | 15 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/customer/BusinessDetail.md: -------------------------------------------------------------------------------- 1 | # BusinessDetail 2 | > xendit.customer.model.BusinessDetail 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **business_name** | **str** | | | | 9 | | **business_type** | **str, none_type** | | | | 10 | | **date_of_registration** | **str, none_type** | | | | 11 | | **nature_of_business** | **str, none_type** | | | | 12 | | **business_domicile** | [**CountryCode**](CountryCode.md) | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/customer/CountryCode.md: -------------------------------------------------------------------------------- 1 | # CountryCode 2 | > xendit.customer.model.CountryCode 3 | 4 | ISO3166-2 country code 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **value** | **str** | ISO3166-2 country code | ☑️ | ISO3166-2 country code | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/customer/CreateCustomer400Response.md: -------------------------------------------------------------------------------- 1 | # CreateCustomer400Response 2 | > xendit.customer.model.CreateCustomer400Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | ☑️ | | | | 9 | | **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | 10 | | **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/customer/CreateCustomer400ResponseAllOf.md: -------------------------------------------------------------------------------- 1 | # CreateCustomer400ResponseAllOf 2 | > xendit.customer.model.CreateCustomer400ResponseAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/customer/Customer.md: -------------------------------------------------------------------------------- 1 | # Customer 2 | > xendit.customer.model.Customer 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **reference_id** | **str** | ☑️ | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | | 9 | | **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | ☑️ | | | | 10 | | **business_detail** | [**BusinessDetail**](BusinessDetail.md) | ☑️ | | | | 11 | | **description** | **str, none_type** | ☑️ | | | | 12 | | **email** | **str, none_type** | ☑️ | | | | 13 | | **mobile_number** | **str, none_type** | ☑️ | | | | 14 | | **phone_number** | **str, none_type** | ☑️ | | | | 15 | | **addresses** | [**[Address], none_type**](Address.md) | ☑️ | | | | 16 | | **identity_accounts** | [**[IdentityAccountResponse], none_type**](IdentityAccountResponse.md) | ☑️ | | | | 17 | | **kyc_documents** | [**[KYCDocumentResponse], none_type**](KYCDocumentResponse.md) | ☑️ | | | | 18 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | ☑️ | | | | 19 | | **id** | **str** | ☑️ | | | | 20 | | **created** | **datetime** | ☑️ | | | | 21 | | **updated** | **datetime** | ☑️ | | | | 22 | | **type** | **str** | ☑️ | | | "INDIVIDUAL" | 23 | | **status** | [**EndCustomerStatus**](EndCustomerStatus.md) | | | | 24 | 25 | 26 | [[Back to README]](../../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/customer/CustomerRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerRequest 2 | > xendit.customer.model.CustomerRequest 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **reference_id** | **str** | ☑️ | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | | 9 | | **client_name** | **str** | | Entity's name for this client | | 10 | | **type** | **str** | | | "INDIVIDUAL" | 11 | | **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | | | | 12 | | **business_detail** | [**BusinessDetail**](BusinessDetail.md) | | | | 13 | | **description** | **str, none_type** | | | | 14 | | **email** | **str** | | | | 15 | | **mobile_number** | **str** | | | | 16 | | **phone_number** | **str** | | | | 17 | | **addresses** | [**[AddressRequest]**](AddressRequest.md) | | | | 18 | | **identity_accounts** | [**[IdentityAccountRequest]**](IdentityAccountRequest.md) | | | | 19 | | **kyc_documents** | [**[KYCDocumentRequest]**](KYCDocumentRequest.md) | | | | 20 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | | | 21 | 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/customer/EmploymentDetail.md: -------------------------------------------------------------------------------- 1 | # EmploymentDetail 2 | > xendit.customer.model.EmploymentDetail 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **employer_name** | **str, none_type** | | Name of employer | | 9 | | **nature_of_business** | **str, none_type** | | Industry or nature of business | | 10 | | **role_description** | **str, none_type** | | Occupation or title | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/customer/EndCustomerStatus.md: -------------------------------------------------------------------------------- 1 | # EndCustomerStatus 2 | > xendit.customer.model.EndCustomerStatus 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `ACTIVE` (value: `"ACTIVE"`) 10 | 11 | * `INACTIVE` (value: `"INACTIVE"`) 12 | 13 | * `PENDING` (value: `"PENDING"`) 14 | 15 | * `BLOCKED` (value: `"BLOCKED"`) 16 | 17 | * `DELETED` (value: `"DELETED"`) 18 | 19 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 20 | 21 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/customer/Error.md: -------------------------------------------------------------------------------- 1 | # Error 2 | > xendit.customer.model.Error 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | ☑️ | | | | 9 | | **message** | **str** | ☑️ | | | | 10 | | **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/customer/GetCustomerByReferenceID200Response.md: -------------------------------------------------------------------------------- 1 | # GetCustomerByReferenceID200Response 2 | > xendit.customer.model.GetCustomerByReferenceID200Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **has_more** | **bool** | | | | 9 | | **data** | [**[Customer]**](Customer.md) | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/customer/GetCustomerByReferenceID400Response.md: -------------------------------------------------------------------------------- 1 | # GetCustomerByReferenceID400Response 2 | > xendit.customer.model.GetCustomerByReferenceID400Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | ☑️ | | | | 9 | | **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | 10 | | **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/customer/GetCustomerByReferenceID400ResponseAllOf.md: -------------------------------------------------------------------------------- 1 | # GetCustomerByReferenceID400ResponseAllOf 2 | > xendit.customer.model.GetCustomerByReferenceID400ResponseAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/customer/IdentityAccountRequest.md: -------------------------------------------------------------------------------- 1 | # IdentityAccountRequest 2 | > xendit.customer.model.IdentityAccountRequest 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **type** | [**IdentityAccountType**](IdentityAccountType.md) | | | | 9 | | **company** | **str** | | The issuing institution associated with the account (e.g., OCBC, GOPAY, 7-11). If adding financial accounts that Xendit supports, we recommend you use the channel_name found at https://xendit.github.io/apireference/#payment-channels for this field | | 10 | | **description** | **str** | | Free text description of this account | | 11 | | **country** | [**CountryCode**](CountryCode.md) | | | | 12 | | **properties** | [**IdentityAccountRequestProperties**](IdentityAccountRequestProperties.md) | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/customer/IdentityAccountRequestProperties.md: -------------------------------------------------------------------------------- 1 | # IdentityAccountRequestProperties 2 | > xendit.customer.model.IdentityAccountRequestProperties 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **account_number** | **str** | | Unique account identifier as per the bank records. | | 9 | | **account_holder_name** | **str, none_type** | | Name of account holder as per the cardless credit account. | | 10 | | **swift_code** | **str, none_type** | | The SWIFT code for international payments | | 11 | | **account_type** | **str, none_type** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | | 12 | | **account_details** | **str, none_type** | | Potentially masked account detail, for display purposes only. | | 13 | | **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | 14 | | **token_id** | **str** | | The token id returned in tokenisation | | 15 | | **account_id** | **str** | | Alphanumeric string identifying this account. Usually an email address or phone number. | | 16 | | **payment_code** | **str** | | Complete fixed payment code (including prefix) | | 17 | | **expires_at** | **str, none_type** | | YYYY-MM-DD string with expiry date for the payment code | | 18 | | **qr_string** | **str** | | String representation of the QR Code image | | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/customer/IdentityAccountResponse.md: -------------------------------------------------------------------------------- 1 | # IdentityAccountResponse 2 | > xendit.customer.model.IdentityAccountResponse 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **company** | **str, none_type** | ☑️ | | | | 9 | | **description** | **str, none_type** | ☑️ | | | | 10 | | **country** | [**CountryCode**](CountryCode.md) | ☑️ | | | | 11 | | **type** | **str, none_type** | ☑️ | | | | 12 | | **properties** | [**IdentityAccountResponseProperties**](IdentityAccountResponseProperties.md) | ☑️ | | | | 13 | | **id** | **str** | | | | 14 | | **code** | **str, none_type** | | | | 15 | | **holder_name** | **str, none_type** | | | | 16 | | **created** | **datetime** | | | | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/customer/IdentityAccountResponseProperties.md: -------------------------------------------------------------------------------- 1 | # IdentityAccountResponseProperties 2 | > xendit.customer.model.IdentityAccountResponseProperties 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **account_number** | **str** | | Unique account identifier as per the bank records. | | 9 | | **account_holder_name** | **str, none_type** | | Name of account holder as per the cardless credit account. | | 10 | | **swift_code** | **str, none_type** | | The SWIFT code for international payments | | 11 | | **account_type** | **str, none_type** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | | 12 | | **account_details** | **str, none_type** | | Potentially masked account detail, for display purposes only. | | 13 | | **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | 14 | | **token_id** | **str** | | The token id returned in tokenisation | | 15 | | **payment_code** | **str** | | Complete fixed payment code (including prefix) | | 16 | | **expires_at** | **str, none_type** | | YYYY-MM-DD string with expiry date for the payment code | | 17 | | **qr_string** | **str** | | String representation of the QR Code image | | 18 | | **account_id** | **str** | | Alphanumeric string identifying this account. Usually an email address or phone number. | | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/customer/IdentityAccountType.md: -------------------------------------------------------------------------------- 1 | # IdentityAccountType 2 | > xendit.customer.model.IdentityAccountType 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) 10 | 11 | * `EWALLET` (value: `"EWALLET"`) 12 | 13 | * `CREDIT_CARD` (value: `"CREDIT_CARD"`) 14 | 15 | * `PAY_LATER` (value: `"PAY_LATER"`) 16 | 17 | * `OTC` (value: `"OTC"`) 18 | 19 | * `QR_CODE` (value: `"QR_CODE"`) 20 | 21 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 22 | 23 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 24 | 25 | [[Back to README]](../../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/customer/IndividualDetail.md: -------------------------------------------------------------------------------- 1 | # IndividualDetail 2 | > xendit.customer.model.IndividualDetail 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **given_names** | **str** | | | | 9 | | **given_names_non_roman** | **str, none_type** | | | | 10 | | **middle_name** | **str, none_type** | | | | 11 | | **surname** | **str, none_type** | | | | 12 | | **surname_non_roman** | **str, none_type** | | | | 13 | | **mother_maiden_name** | **str, none_type** | | | | 14 | | **gender** | **str, none_type** | | | | 15 | | **date_of_birth** | **str, none_type** | | | | 16 | | **nationality** | [**CountryCode**](CountryCode.md) | | | | 17 | | **place_of_birth** | **str, none_type** | | | | 18 | | **employment** | [**EmploymentDetail**](EmploymentDetail.md) | | | | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/customer/KYCDocumentRequest.md: -------------------------------------------------------------------------------- 1 | # KYCDocumentRequest 2 | > xendit.customer.model.KYCDocumentRequest 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **country** | [**CountryCode**](CountryCode.md) | | | | 9 | | **type** | [**KYCDocumentType**](KYCDocumentType.md) | | | | 10 | | **sub_type** | [**KYCDocumentSubType**](KYCDocumentSubType.md) | | | | 11 | | **document_name** | **str** | | | | 12 | | **document_number** | **str** | | | | 13 | | **expires_at** | **str** | | | | 14 | | **holder_name** | **str** | | | | 15 | | **document_images** | **[str]** | | | | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/customer/KYCDocumentResponse.md: -------------------------------------------------------------------------------- 1 | # KYCDocumentResponse 2 | > xendit.customer.model.KYCDocumentResponse 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **country** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | 9 | | **type** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | 10 | | **sub_type** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | 11 | | **document_name** | **str, none_type** | ☑️ | | | | 12 | | **document_number** | **str, none_type** | ☑️ | | | | 13 | | **expires_at** | **str, none_type** | ☑️ | | | | 14 | | **holder_name** | **str, none_type** | ☑️ | | | | 15 | | **document_images** | **[str], none_type** | ☑️ | | | | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/customer/KYCDocumentSubType.md: -------------------------------------------------------------------------------- 1 | # KYCDocumentSubType 2 | > xendit.customer.model.KYCDocumentSubType 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `NATIONAL_ID` (value: `"NATIONAL_ID"`) 10 | 11 | * `CONSULAR_ID` (value: `"CONSULAR_ID"`) 12 | 13 | * `VOTER_ID` (value: `"VOTER_ID"`) 14 | 15 | * `POSTAL_ID` (value: `"POSTAL_ID"`) 16 | 17 | * `RESIDENCE_PERMIT` (value: `"RESIDENCE_PERMIT"`) 18 | 19 | * `TAX_ID` (value: `"TAX_ID"`) 20 | 21 | * `STUDENT_ID` (value: `"STUDENT_ID"`) 22 | 23 | * `MILITARY_ID` (value: `"MILITARY_ID"`) 24 | 25 | * `MEDICAL_ID` (value: `"MEDICAL_ID"`) 26 | 27 | * `OTHERS` (value: `"OTHERS"`) 28 | 29 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 30 | 31 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 32 | 33 | [[Back to README]](../../README.md) 34 | 35 | 36 | -------------------------------------------------------------------------------- /docs/customer/KYCDocumentType.md: -------------------------------------------------------------------------------- 1 | # KYCDocumentType 2 | > xendit.customer.model.KYCDocumentType 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `BIRTH_CERTIFICATE` (value: `"BIRTH_CERTIFICATE"`) 10 | 11 | * `BANK_STATEMENT` (value: `"BANK_STATEMENT"`) 12 | 13 | * `DRIVING_LICENSE` (value: `"DRIVING_LICENSE"`) 14 | 15 | * `IDENTITY_CARD` (value: `"IDENTITY_CARD"`) 16 | 17 | * `PASSPORT` (value: `"PASSPORT"`) 18 | 19 | * `VISA` (value: `"VISA"`) 20 | 21 | * `BUSINESS_REGISTRATION` (value: `"BUSINESS_REGISTRATION"`) 22 | 23 | * `BUSINESS_LICENSE` (value: `"BUSINESS_LICENSE"`) 24 | 25 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 26 | 27 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 28 | 29 | [[Back to README]](../../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/customer/PatchCustomer.md: -------------------------------------------------------------------------------- 1 | # PatchCustomer 2 | > xendit.customer.model.PatchCustomer 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **client_name** | **str, none_type** | | Entity's name for this client | | 9 | | **reference_id** | **str, none_type** | | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | 10 | | **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | | | | 11 | | **business_detail** | [**BusinessDetail**](BusinessDetail.md) | | | | 12 | | **description** | **str, none_type** | | | | 13 | | **email** | **str, none_type** | | | | 14 | | **mobile_number** | **str, none_type** | | | | 15 | | **phone_number** | **str, none_type** | | | | 16 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 17 | | **addresses** | [**[AddressRequest], none_type**](AddressRequest.md) | | | | 18 | | **identity_accounts** | [**[IdentityAccountRequest], none_type**](IdentityAccountRequest.md) | | | | 19 | | **kyc_documents** | [**[KYCDocumentRequest], none_type**](KYCDocumentRequest.md) | | | | 20 | | **status** | [**EndCustomerStatus**](EndCustomerStatus.md) | | | | 21 | 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/customer/ResponseDataNotFound.md: -------------------------------------------------------------------------------- 1 | # ResponseDataNotFound 2 | > xendit.customer.model.ResponseDataNotFound 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/customer/UpdateCustomer400Response.md: -------------------------------------------------------------------------------- 1 | # UpdateCustomer400Response 2 | > xendit.customer.model.UpdateCustomer400Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | ☑️ | | | | 9 | | **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | 10 | | **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/customer/UpdateCustomer400ResponseAllOf.md: -------------------------------------------------------------------------------- 1 | # UpdateCustomer400ResponseAllOf 2 | > xendit.customer.model.UpdateCustomer400ResponseAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/invoice/AddressObject.md: -------------------------------------------------------------------------------- 1 | # AddressObject 2 | > xendit.invoice.model.AddressObject 3 | 4 | An object representing an address with various properties. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **country** | **str, none_type** | | The country where the address is located. | | 10 | | **street_line1** | **str, none_type** | | The first line of the street address. | | 11 | | **street_line2** | **str, none_type** | | The second line of the street address. | | 12 | | **city** | **str, none_type** | | The city or locality within the address. | | 13 | | **province** | **str, none_type** | | The province or region within the country. | | 14 | | **state** | **str, none_type** | | The state or administrative division within the country. | | 15 | | **postal_code** | **str, none_type** | | The postal code or ZIP code for the address. | | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/invoice/AlternativeDisplayItem.md: -------------------------------------------------------------------------------- 1 | # AlternativeDisplayItem 2 | > xendit.invoice.model.AlternativeDisplayItem 3 | 4 | An object representing alternative display of a VA. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **type** | **str** | | Represent type of alternative display. | | 10 | | **value** | **str** | | Represent value of alternative display value. | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/BadRequestError.md: -------------------------------------------------------------------------------- 1 | # BadRequestError 2 | > xendit.invoice.model.BadRequestError 3 | 4 | Response definition for a 400 Bad Request error when creating an invoice. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **error_code** | **str** | ☑️ | The error code indicating the type of error that occurred. | | | 10 | | **message** | **str** | ☑️ | A human-readable error message that provides additional information about the error. | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/Bank.md: -------------------------------------------------------------------------------- 1 | # Bank 2 | > xendit.invoice.model.Bank 3 | 4 | An object representing bank details for invoices. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **bank_code** | [**BankCode**](BankCode.md) | ☑️ | | | | 10 | | **collection_type** | **str** | ☑️ | The collection type for the bank details. | | | 11 | | **account_holder_name** | **str** | ☑️ | The name of the account holder. | | | 12 | | **bank_branch** | **str** | | The branch of the bank. | | 13 | | **bank_account_number** | **str** | | The bank account number. | | 14 | | **transfer_amount** | **float** | | The transfer amount. | | 15 | | **alternative_displays** | [**[AlternativeDisplayItem]**](AlternativeDisplayItem.md) | | | | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/invoice/BankCode.md: -------------------------------------------------------------------------------- 1 | # BankCode 2 | > xendit.invoice.model.BankCode 3 | 4 | Representing the available bank channels used for invoice-related transactions. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `BCA` (value: `"BCA"`) 11 | 12 | * `BNI` (value: `"BNI"`) 13 | 14 | * `BRI` (value: `"BRI"`) 15 | 16 | * `MANDIRI` (value: `"MANDIRI"`) 17 | 18 | * `PERMATA` (value: `"PERMATA"`) 19 | 20 | * `BSI` (value: `"BSI"`) 21 | 22 | * `BJB` (value: `"BJB"`) 23 | 24 | * `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) 25 | 26 | * `CIMB` (value: `"CIMB"`) 27 | 28 | * `VIETCAPITAL` (value: `"VIETCAPITAL"`) 29 | 30 | * `WOORI` (value: `"WOORI"`) 31 | 32 | * `PV` (value: `"PV"`) 33 | 34 | * `MSB` (value: `"MSB"`) 35 | 36 | * `VPB` (value: `"VPB"`) 37 | 38 | * `BIDV` (value: `"BIDV"`) 39 | 40 | * `CAKE` (value: `"CAKE"`) 41 | 42 | * `BNC` (value: `"BNC"`) 43 | 44 | * `HANA` (value: `"HANA"`) 45 | 46 | * `MUAMALAT` (value: `"MUAMALAT"`) 47 | 48 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 49 | 50 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 51 | 52 | [[Back to README]](../../README.md) 53 | 54 | 55 | -------------------------------------------------------------------------------- /docs/invoice/ChannelProperties.md: -------------------------------------------------------------------------------- 1 | # ChannelProperties 2 | > xendit.invoice.model.ChannelProperties 3 | 4 | An object representing channel-specific properties. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **cards** | [**ChannelPropertiesCards**](ChannelPropertiesCards.md) | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/invoice/ChannelPropertiesCards.md: -------------------------------------------------------------------------------- 1 | # ChannelPropertiesCards 2 | > xendit.invoice.model.ChannelPropertiesCards 3 | 4 | An object representing properties specific for credit card payment method. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **allowed_bins** | **[str]** | | An array of allowed BINs (6 or 8 digits) for credit card payments. | | 10 | | **installment_configuration** | [**ChannelPropertiesCardsInstallmentConfiguration**](ChannelPropertiesCardsInstallmentConfiguration.md) | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/ChannelPropertiesCardsInstallmentConfiguration.md: -------------------------------------------------------------------------------- 1 | # ChannelPropertiesCardsInstallmentConfiguration 2 | > xendit.invoice.model.ChannelPropertiesCardsInstallmentConfiguration 3 | 4 | An object to pre-set cards installment for a specific invoice 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **allow_full_payment** | **bool** | | Indicate whether full payment (without installment) is allowed | | 10 | | **allowed_terms** | [**[ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner]**](ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner.md) | | An object to set what kind (from specific bank / specific tenor) of cards installments will be available on a specific invoice | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner.md: -------------------------------------------------------------------------------- 1 | # ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner 2 | > xendit.invoice.model.ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **issuer** | **str** | | The bank code of the installment provider / issuer | | 9 | | **terms** | **[float]** | | An array containing list of installment tenor available to choose | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/invoice/CustomerObject.md: -------------------------------------------------------------------------------- 1 | # CustomerObject 2 | > xendit.invoice.model.CustomerObject 3 | 4 | An object representing a customer with various properties, including addresses. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **id** | **str, none_type** | | The unique identifier for the customer. | | 10 | | **phone_number** | **str, none_type** | | The customer's phone number. | | 11 | | **given_names** | **str, none_type** | | The customer's given names or first names. | | 12 | | **surname** | **str, none_type** | | The customer's surname or last name. | | 13 | | **email** | **str, none_type** | | The customer's email address. | | 14 | | **mobile_number** | **str, none_type** | | The customer's mobile phone number. | | 15 | | **customer_id** | **str, none_type** | | An additional identifier for the customer. | | 16 | | **addresses** | [**[AddressObject], none_type**](AddressObject.md) | | An array of addresses associated with the customer. | | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/invoice/DirectDebit.md: -------------------------------------------------------------------------------- 1 | # DirectDebit 2 | > xendit.invoice.model.DirectDebit 3 | 4 | An object representing direct debit details for invoices. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **direct_debit_type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/invoice/Ewallet.md: -------------------------------------------------------------------------------- 1 | # Ewallet 2 | > xendit.invoice.model.Ewallet 3 | 4 | An object representing e-wallet details for invoices. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **ewallet_type** | [**EwalletType**](EwalletType.md) | ☑️ | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/invoice/EwalletType.md: -------------------------------------------------------------------------------- 1 | # EwalletType 2 | > xendit.invoice.model.EwalletType 3 | 4 | Representing the available eWallet channels used for invoice-related transactions. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `OVO` (value: `"OVO"`) 11 | 12 | * `GOPAY` (value: `"GOPAY"`) 13 | 14 | * `DANA` (value: `"DANA"`) 15 | 16 | * `LINKAJA` (value: `"LINKAJA"`) 17 | 18 | * `PAYMAYA` (value: `"PAYMAYA"`) 19 | 20 | * `SHOPEEPAY` (value: `"SHOPEEPAY"`) 21 | 22 | * `GCASH` (value: `"GCASH"`) 23 | 24 | * `GRABPAY` (value: `"GRABPAY"`) 25 | 26 | * `ASTRAPAY` (value: `"ASTRAPAY"`) 27 | 28 | * `NEXCASH` (value: `"NEXCASH"`) 29 | 30 | * `JENIUSPAY` (value: `"JENIUSPAY"`) 31 | 32 | * `MOMO` (value: `"MOMO"`) 33 | 34 | * `ZALOPAY` (value: `"ZALOPAY"`) 35 | 36 | * `VIETTELPAY` (value: `"VIETTELPAY"`) 37 | 38 | * `VNPTWALLET` (value: `"VNPTWALLET"`) 39 | 40 | * `APPOTA` (value: `"APPOTA"`) 41 | 42 | * `LINEPAY` (value: `"LINEPAY"`) 43 | 44 | * `TRUEMONEY` (value: `"TRUEMONEY"`) 45 | 46 | * `WECHATPAY` (value: `"WECHATPAY"`) 47 | 48 | * `TOUCHNGO` (value: `"TOUCHNGO"`) 49 | 50 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 51 | 52 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 53 | 54 | [[Back to README]](../../README.md) 55 | 56 | 57 | -------------------------------------------------------------------------------- /docs/invoice/ForbiddenError.md: -------------------------------------------------------------------------------- 1 | # ForbiddenError 2 | > xendit.invoice.model.ForbiddenError 3 | 4 | An error object used to indicate a 403 Forbidden response related to invoice operations. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **message** | **str** | ☑️ | A human-readable error message providing additional context about the 403 Forbidden response. | | | 10 | | **error_code** | **str** | ☑️ | The specific error code indicating that access to the invoice operation is suspended. | | "ACCESS_SUSPENDED" | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/InvoiceCallbackItem.md: -------------------------------------------------------------------------------- 1 | # InvoiceCallbackItem 2 | > xendit.invoice.model.InvoiceCallbackItem 3 | 4 | An object representing an item within an invoice. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **name** | **str** | ☑️ | The name of the item. | | | 10 | | **price** | **float** | ☑️ | The price of the item. | | | 11 | | **quantity** | **float** | ☑️ | The quantity of the item. Must be greater than or equal to 0. | | | 12 | | **url** | **str** | | The URL associated with the item. | | 13 | | **category** | **str** | | The category of the item. | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/invoice/InvoiceClientType.md: -------------------------------------------------------------------------------- 1 | # InvoiceClientType 2 | > xendit.invoice.model.InvoiceClientType 3 | 4 | Representing the client type or source of an invoice. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `DASHBOARD` (value: `"DASHBOARD"`) 11 | 12 | * `API_GATEWAY` (value: `"API_GATEWAY"`) 13 | 14 | * `INTEGRATION` (value: `"INTEGRATION"`) 15 | 16 | * `ON_DEMAND` (value: `"ON_DEMAND"`) 17 | 18 | * `RECURRING` (value: `"RECURRING"`) 19 | 20 | * `MOBILE` (value: `"MOBILE"`) 21 | 22 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 23 | 24 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 25 | 26 | [[Back to README]](../../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/invoice/InvoiceCurrency.md: -------------------------------------------------------------------------------- 1 | # InvoiceCurrency 2 | > xendit.invoice.model.InvoiceCurrency 3 | 4 | Representing the currency used for an invoice. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `IDR` (value: `"IDR"`) 11 | 12 | * `USD` (value: `"USD"`) 13 | 14 | * `THB` (value: `"THB"`) 15 | 16 | * `VND` (value: `"VND"`) 17 | 18 | * `PHP` (value: `"PHP"`) 19 | 20 | * `MYR` (value: `"MYR"`) 21 | 22 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 23 | 24 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 25 | 26 | [[Back to README]](../../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/invoice/InvoiceError404ResponseDefinition.md: -------------------------------------------------------------------------------- 1 | # InvoiceError404ResponseDefinition 2 | > xendit.invoice.model.InvoiceError404ResponseDefinition 3 | 4 | An error object used to indicate that the requested resource, in this case, an invoice, was not found. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **message** | **str** | ☑️ | A human-readable error message providing additional context about the resource not being found. | | | 10 | | **error_code** | **str** | ☑️ | The specific error code indicating that the requested invoice was not found. | | "INVOICE_NOT_FOUND_ERROR" | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/InvoiceFee.md: -------------------------------------------------------------------------------- 1 | # InvoiceFee 2 | > xendit.invoice.model.InvoiceFee 3 | 4 | An object representing internal details for a fee associated with an invoice. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **type** | **str** | ☑️ | The type of fee. | | | 10 | | **value** | **float** | ☑️ | The value or amount of the fee. | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/InvoiceItem.md: -------------------------------------------------------------------------------- 1 | # InvoiceItem 2 | > xendit.invoice.model.InvoiceItem 3 | 4 | An object representing an item within an invoice. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **name** | **str** | ☑️ | The name of the item. | | | 10 | | **price** | **float** | ☑️ | The price of the item. | | | 11 | | **quantity** | **float** | ☑️ | The quantity of the item. Must be greater than or equal to 0. | | | 12 | | **reference_id** | **str** | | The reference ID of the item. | | 13 | | **url** | **str** | | The URL associated with the item. | | 14 | | **category** | **str** | | The category of the item. | | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/invoice/InvoiceNotFoundError.md: -------------------------------------------------------------------------------- 1 | # InvoiceNotFoundError 2 | > xendit.invoice.model.InvoiceNotFoundError 3 | 4 | Response definition for a 404 Not Found error when creating an invoice. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **error_code** | **str** | ☑️ | The error code indicating the type of error that occurred. | | | 10 | | **message** | **str** | ☑️ | A human-readable error message that provides additional information about the error. | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/InvoicePaymentMethod.md: -------------------------------------------------------------------------------- 1 | # InvoicePaymentMethod 2 | > xendit.invoice.model.InvoicePaymentMethod 3 | 4 | Representing the payment method used for an invoice. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `POOL` (value: `"POOL"`) 11 | 12 | * `CALLBACK_VIRTUAL_ACCOUNT` (value: `"CALLBACK_VIRTUAL_ACCOUNT"`) 13 | 14 | * `CREDIT_CARD` (value: `"CREDIT_CARD"`) 15 | 16 | * `RETAIL_OUTLET` (value: `"RETAIL_OUTLET"`) 17 | 18 | * `QR_CODE` (value: `"QR_CODE"`) 19 | 20 | * `QRIS` (value: `"QRIS"`) 21 | 22 | * `EWALLET` (value: `"EWALLET"`) 23 | 24 | * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) 25 | 26 | * `BANK_TRANSFER` (value: `"BANK_TRANSFER"`) 27 | 28 | * `PAYLATER` (value: `"PAYLATER"`) 29 | 30 | * `CRYPTOCURRENCY` (value: `"CRYPTOCURRENCY"`) 31 | 32 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 33 | 34 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 35 | 36 | [[Back to README]](../../README.md) 37 | 38 | 39 | -------------------------------------------------------------------------------- /docs/invoice/InvoiceStatus.md: -------------------------------------------------------------------------------- 1 | # InvoiceStatus 2 | > xendit.invoice.model.InvoiceStatus 3 | 4 | Representing the status of an invoice. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `PENDING` (value: `"PENDING"`) 11 | 12 | * `PAID` (value: `"PAID"`) 13 | 14 | * `SETTLED` (value: `"SETTLED"`) 15 | 16 | * `EXPIRED` (value: `"EXPIRED"`) 17 | 18 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 19 | 20 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 21 | 22 | [[Back to README]](../../README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/invoice/NotificationChannel.md: -------------------------------------------------------------------------------- 1 | # NotificationChannel 2 | > xendit.invoice.model.NotificationChannel 3 | 4 | Representing a notification channel for sending messages. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `EMAIL` (value: `"email"`) 11 | 12 | * `SMS` (value: `"sms"`) 13 | 14 | * `WHATSAPP` (value: `"whatsapp"`) 15 | 16 | * `VIBER` (value: `"viber"`) 17 | 18 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 19 | 20 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 21 | 22 | [[Back to README]](../../README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/invoice/NotificationPreference.md: -------------------------------------------------------------------------------- 1 | # NotificationPreference 2 | > xendit.invoice.model.NotificationPreference 3 | 4 | An object representing notification preferences for different invoice events. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **invoice_created** | [**[NotificationChannel]**](NotificationChannel.md) | | Notification channels for when an invoice is created. | | 10 | | **invoice_reminder** | [**[NotificationChannel]**](NotificationChannel.md) | | Notification channels for invoice reminders. | | 11 | | **invoice_paid** | [**[NotificationChannel]**](NotificationChannel.md) | | Notification channels for when an invoice is paid. | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/invoice/Paylater.md: -------------------------------------------------------------------------------- 1 | # Paylater 2 | > xendit.invoice.model.Paylater 3 | 4 | An object representing paylater details for invoices. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **paylater_type** | [**PaylaterType**](PaylaterType.md) | ☑️ | | | | 10 | | **should_exclude** | **bool** | | Indicates whether this paylater option should be excluded. | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/PaylaterType.md: -------------------------------------------------------------------------------- 1 | # PaylaterType 2 | > xendit.invoice.model.PaylaterType 3 | 4 | Representing the available paylater channels used for invoice-related transactions. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `KREDIVO` (value: `"KREDIVO"`) 11 | 12 | * `AKULAKU` (value: `"AKULAKU"`) 13 | 14 | * `UANGME` (value: `"UANGME"`) 15 | 16 | * `BILLEASE` (value: `"BILLEASE"`) 17 | 18 | * `CASHALO` (value: `"CASHALO"`) 19 | 20 | * `ATOME` (value: `"ATOME"`) 21 | 22 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 23 | 24 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 25 | 26 | [[Back to README]](../../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/invoice/PaymentDetails.md: -------------------------------------------------------------------------------- 1 | # PaymentDetails 2 | > xendit.invoice.model.PaymentDetails 3 | 4 | An object representing payment details. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **receipt_id** | **str** | | The unique identifier or reference ID associated with the payment receipt. | | 10 | | **source** | **str** | | The source or method of payment. | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/invoice/QrCode.md: -------------------------------------------------------------------------------- 1 | # QrCode 2 | > xendit.invoice.model.QrCode 3 | 4 | An object representing QR code details for invoices. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **qr_code_type** | [**QrCodeType**](QrCodeType.md) | ☑️ | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/invoice/QrCodeType.md: -------------------------------------------------------------------------------- 1 | # QrCodeType 2 | > xendit.invoice.model.QrCodeType 3 | 4 | Representing the available QR Code channels used for invoice-related transactions. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `QRIS` (value: `"QRIS"`) 11 | 12 | * `PROMPTPAY` (value: `"PROMPTPAY"`) 13 | 14 | * `QRPH` (value: `"QRPH"`) 15 | 16 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 17 | 18 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 19 | 20 | [[Back to README]](../../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/invoice/RetailOutlet.md: -------------------------------------------------------------------------------- 1 | # RetailOutlet 2 | > xendit.invoice.model.RetailOutlet 3 | 4 | An object representing retail outlet details for invoices. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **retail_outlet_name** | [**RetailOutletName**](RetailOutletName.md) | ☑️ | | | | 10 | | **payment_code** | **str** | | The payment code. | | 11 | | **transfer_amount** | **float** | | The transfer amount. | | 12 | | **merchant_name** | **str** | | The name of the merchant. | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/invoice/RetailOutletName.md: -------------------------------------------------------------------------------- 1 | # RetailOutletName 2 | > xendit.invoice.model.RetailOutletName 3 | 4 | Representing the available retail outlet channels used for invoice-related transactions. 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `ALFAMART` (value: `"ALFAMART"`) 11 | 12 | * `INDOMARET` (value: `"INDOMARET"`) 13 | 14 | * `7ELEVEN` (value: `"7ELEVEN"`) 15 | 16 | * `CEBUANA` (value: `"CEBUANA"`) 17 | 18 | * `DP_ECPAY_LOAN` (value: `"DP_ECPAY_LOAN"`) 19 | 20 | * `DP_MLHUILLIER` (value: `"DP_MLHUILLIER"`) 21 | 22 | * `DP_PALAWAN` (value: `"DP_PALAWAN"`) 23 | 24 | * `DP_ECPAY_SCHOOL` (value: `"DP_ECPAY_SCHOOL"`) 25 | 26 | * `LBC` (value: `"LBC"`) 27 | 28 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 29 | 30 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 31 | 32 | [[Back to README]](../../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/invoice/ServerError.md: -------------------------------------------------------------------------------- 1 | # ServerError 2 | > xendit.invoice.model.ServerError 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **message** | **str** | ☑️ | | | | 9 | | **error_code** | **str** | ☑️ | | | "SERVER_ERROR" | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/invoice/UnauthorizedError.md: -------------------------------------------------------------------------------- 1 | # UnauthorizedError 2 | > xendit.invoice.model.UnauthorizedError 3 | 4 | An error object used to indicate unauthorized access to an invoice-related resource. 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **message** | **str** | ☑️ | A human-readable error message providing additional context about the unauthorized access. | | | 10 | | **error_code** | **str** | ☑️ | The specific error code associated with the unauthorized access. | | "INVALID_API_KEY" | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_method/BillingInformation.md: -------------------------------------------------------------------------------- 1 | # BillingInformation 2 | > xendit.payment_method.model.BillingInformation 3 | 4 | Billing Information 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **country** | **str** | ☑️ | | | | 10 | | **street_line1** | **str, none_type** | | | | 11 | | **street_line2** | **str, none_type** | | | | 12 | | **city** | **str, none_type** | | | | 13 | | **province_state** | **str, none_type** | | | | 14 | | **postal_code** | **str, none_type** | | | | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/payment_method/Card.md: -------------------------------------------------------------------------------- 1 | # Card 2 | > xendit.payment_method.model.Card 3 | 4 | Card Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | ☑️ | | | | 10 | | **channel_code** | [**CardChannelCode**](CardChannelCode.md) | | | | 11 | | **currency** | **str, none_type** | | | | 12 | | **card_information** | [**TokenizedCardInformation**](TokenizedCardInformation.md) | | | | 13 | | **card_verification_results** | [**CardVerificationResults**](CardVerificationResults.md) | | | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/payment_method/CardChannelCode.md: -------------------------------------------------------------------------------- 1 | # CardChannelCode 2 | > xendit.payment_method.model.CardChannelCode 3 | 4 | Card Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `BAY_CARD_INSTALLMENT` (value: `"BAY_CARD_INSTALLMENT"`) 11 | 12 | * `BBL_CARD_INSTALLMENT` (value: `"BBL_CARD_INSTALLMENT"`) 13 | 14 | * `GPN` (value: `"GPN"`) 15 | 16 | * `KBANK_CARD_INSTALLMENT` (value: `"KBANK_CARD_INSTALLMENT"`) 17 | 18 | * `KTB_CARD_INSTALLMENT` (value: `"KTB_CARD_INSTALLMENT"`) 19 | 20 | * `SCB_CARD_INSTALLMENT` (value: `"SCB_CARD_INSTALLMENT"`) 21 | 22 | * `TTB_CARD_INSTALLMENT` (value: `"TTB_CARD_INSTALLMENT"`) 23 | 24 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/payment_method/CardChannelProperties.md: -------------------------------------------------------------------------------- 1 | # CardChannelProperties 2 | > xendit.payment_method.model.CardChannelProperties 3 | 4 | Card Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **skip_three_d_secure** | **bool, none_type** | | This field value is only being used for reusability = MULTIPLE_USE. To indicate whether to perform 3DS during the linking phase. Defaults to false. | | 10 | | **success_return_url** | **str, none_type** | | URL where the end-customer is redirected if the authorization is successful | | 11 | | **failure_return_url** | **str, none_type** | | URL where the end-customer is redirected if the authorization failed | | 12 | | **cardonfile_type** | **str, none_type** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | | 13 | | **expires_at** | **datetime** | | | | 14 | | **installment_configuration** | [**CardInstallmentConfiguration**](CardInstallmentConfiguration.md) | | | | 15 | | **merchant_id_tag** | **str** | | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/payment_method/CardInstallmentConfiguration.md: -------------------------------------------------------------------------------- 1 | # CardInstallmentConfiguration 2 | > xendit.payment_method.model.CardInstallmentConfiguration 3 | 4 | Card Installment Configuration 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **terms** | **int** | | | | 10 | | **interval** | **str** | | | | 11 | | **code** | **str, none_type** | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_method/CardParameters.md: -------------------------------------------------------------------------------- 1 | # CardParameters 2 | > xendit.payment_method.model.CardParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **currency** | **str** | ☑️ | | | | 9 | | **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | | | | 10 | | **card_information** | [**CardParametersCardInformation**](CardParametersCardInformation.md) | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_method/CardParametersCardInformation.md: -------------------------------------------------------------------------------- 1 | # CardParametersCardInformation 2 | > xendit.payment_method.model.CardParametersCardInformation 3 | 4 | Card Information 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **card_number** | **str** | ☑️ | | | | 10 | | **expiry_month** | **str** | ☑️ | Card expiry month in MM format | | | 11 | | **expiry_year** | **str** | ☑️ | Card expiry month in YY format | | | 12 | | **cardholder_name** | **str, none_type** | | Cardholder name | | 13 | | **cvv** | **str, none_type** | | | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/payment_method/CardVerificationResults.md: -------------------------------------------------------------------------------- 1 | # CardVerificationResults 2 | > xendit.payment_method.model.CardVerificationResults 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **three_d_secure** | [**CardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | ☑️ | | | | 9 | | **cvv_result** | **str, none_type** | | | | 10 | | **address_verification_result** | **str, none_type** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_method/CardVerificationResultsThreeDSecure.md: -------------------------------------------------------------------------------- 1 | # CardVerificationResultsThreeDSecure 2 | > xendit.payment_method.model.CardVerificationResultsThreeDSecure 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **three_d_secure_flow** | **str, none_type** | | | | 9 | | **eci_code** | **str, none_type** | | | | 10 | | **three_d_secure_result** | **str, none_type** | | | | 11 | | **three_d_secure_result_reason** | **str, none_type** | | | | 12 | | **three_d_secure_version** | **str, none_type** | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_method/CreatePaymentMethod409Response.md: -------------------------------------------------------------------------------- 1 | # CreatePaymentMethod409Response 2 | > xendit.payment_method.model.CreatePaymentMethod409Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/CreatePaymentMethod503Response.md: -------------------------------------------------------------------------------- 1 | # CreatePaymentMethod503Response 2 | > xendit.payment_method.model.CreatePaymentMethod503Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/DirectDebit.md: -------------------------------------------------------------------------------- 1 | # DirectDebit 2 | > xendit.payment_method.model.DirectDebit 3 | 4 | Direct Debit Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | | 10 | | **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | | 11 | | **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | 12 | | **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | 13 | | **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/payment_method/DirectDebitAllOf.md: -------------------------------------------------------------------------------- 1 | # DirectDebitAllOf 2 | > xendit.payment_method.model.DirectDebitAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | 9 | | **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | 10 | | **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_method/DirectDebitBankAccount.md: -------------------------------------------------------------------------------- 1 | # DirectDebitBankAccount 2 | > xendit.payment_method.model.DirectDebitBankAccount 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **masked_bank_account_number** | **str, none_type** | | | | 9 | | **bank_account_hash** | **str, none_type** | | | | 10 | | **mobile_number** | **str, none_type** | | Mobile number of the customer registered to the partner channel | | 11 | | **identity_document_number** | **str, none_type** | | Identity number of the customer registered to the partner channel | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_method/DirectDebitChannelProperties.md: -------------------------------------------------------------------------------- 1 | # DirectDebitChannelProperties 2 | > xendit.payment_method.model.DirectDebitChannelProperties 3 | 4 | Direct Debit Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **success_return_url** | **str** | | | | 10 | | **failure_return_url** | **str, none_type** | | | | 11 | | **mobile_number** | **str, none_type** | | Mobile number of the customer registered to the partner channel | | 12 | | **card_last_four** | **str, none_type** | | Last four digits of the debit card | | 13 | | **card_expiry** | **str, none_type** | | Expiry month and year of the debit card (in MM/YY format) | | 14 | | **email** | **str, none_type** | | Email address of the customer that is registered to the partner channel | | 15 | | **identity_document_number** | **str, none_type** | | Identity number of the customer registered to the partner channel | | 16 | | **require_auth** | **bool, none_type** | | | | 17 | | **account_number** | **str, none_type** | | Account number of the customer | | 18 | | **destination_account_id** | **str, none_type** | | Destination Account ID for BaaS topups | | 19 | 20 | 21 | [[Back to README]](../../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/payment_method/DirectDebitDebitCard.md: -------------------------------------------------------------------------------- 1 | # DirectDebitDebitCard 2 | > xendit.payment_method.model.DirectDebitDebitCard 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **mobile_number** | **str, none_type** | | Mobile number of the customer registered to the partner channel | | 9 | | **card_last_four** | **str, none_type** | | Last four digits of the debit card | | 10 | | **card_expiry** | **str, none_type** | | Expiry month and year of the debit card (in MM/YY format) | | 11 | | **email** | **str, none_type** | | Email address of the customer that is registered to the partner channel | | 12 | | **account_number** | **str, none_type** | | Account number of the customer | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_method/DirectDebitParameters.md: -------------------------------------------------------------------------------- 1 | # DirectDebitParameters 2 | > xendit.payment_method.model.DirectDebitParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | | 9 | | **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/DirectDebitType.md: -------------------------------------------------------------------------------- 1 | # DirectDebitType 2 | > xendit.payment_method.model.DirectDebitType 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `DEBIT_CARD` (value: `"DEBIT_CARD"`) 10 | 11 | * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) 12 | 13 | * `BANK_REDIRECT` (value: `"BANK_REDIRECT"`) 14 | 15 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 16 | 17 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/payment_method/EWallet.md: -------------------------------------------------------------------------------- 1 | # EWallet 2 | > xendit.payment_method.model.EWallet 3 | 4 | Ewallet Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | ☑️ | | | | 10 | | **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | 11 | | **account** | [**EWalletAccount**](EWalletAccount.md) | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_method/EWalletAccount.md: -------------------------------------------------------------------------------- 1 | # EWalletAccount 2 | > xendit.payment_method.model.EWalletAccount 3 | 4 | EWallet Account Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **name** | **str, none_type** | | Name of the eWallet account holder. The value is null if unavailableName of the eWallet account holder. The value is null if unavailable | | 10 | | **account_details** | **str, none_type** | | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | | 11 | | **balance** | **float, none_type** | | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | | 12 | | **point_balance** | **float, none_type** | | The point balance amount on eWallet account. Applicable only on some eWallet provider that has point system. The value is null if unavailabl | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_method/EWalletChannelCode.md: -------------------------------------------------------------------------------- 1 | # EWalletChannelCode 2 | > xendit.payment_method.model.EWalletChannelCode 3 | 4 | EWallet Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `GCASH` (value: `"GCASH"`) 11 | 12 | * `GRABPAY` (value: `"GRABPAY"`) 13 | 14 | * `PAYMAYA` (value: `"PAYMAYA"`) 15 | 16 | * `OVO` (value: `"OVO"`) 17 | 18 | * `DANA` (value: `"DANA"`) 19 | 20 | * `LINKAJA` (value: `"LINKAJA"`) 21 | 22 | * `SHOPEEPAY` (value: `"SHOPEEPAY"`) 23 | 24 | * `SAKUKU` (value: `"SAKUKU"`) 25 | 26 | * `NEXCASH` (value: `"NEXCASH"`) 27 | 28 | * `ASTRAPAY` (value: `"ASTRAPAY"`) 29 | 30 | * `JENIUSPAY` (value: `"JENIUSPAY"`) 31 | 32 | * `APPOTA` (value: `"APPOTA"`) 33 | 34 | * `MOMO` (value: `"MOMO"`) 35 | 36 | * `VNPTWALLET` (value: `"VNPTWALLET"`) 37 | 38 | * `VIETTELPAY` (value: `"VIETTELPAY"`) 39 | 40 | * `ZALOPAY` (value: `"ZALOPAY"`) 41 | 42 | * `WECHATPAY` (value: `"WECHATPAY"`) 43 | 44 | * `LINEPAY` (value: `"LINEPAY"`) 45 | 46 | * `TRUEMONEY` (value: `"TRUEMONEY"`) 47 | 48 | * `ALIPAY` (value: `"ALIPAY"`) 49 | 50 | * `TOUCHNGO` (value: `"TOUCHNGO"`) 51 | 52 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 53 | 54 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 55 | 56 | [[Back to README]](../../README.md) 57 | 58 | 59 | -------------------------------------------------------------------------------- /docs/payment_method/EWalletChannelProperties.md: -------------------------------------------------------------------------------- 1 | # EWalletChannelProperties 2 | > xendit.payment_method.model.EWalletChannelProperties 3 | 4 | EWallet Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **success_return_url** | **str** | | URL where the end-customer is redirected if the authorization is successful | | 10 | | **failure_return_url** | **str** | | URL where the end-customer is redirected if the authorization failed | | 11 | | **pending_return_url** | **str** | | URL where the end-customer is redirected if the authorization is pending | | 12 | | **cancel_return_url** | **str** | | URL where the end-customer is redirected if the authorization cancelled | | 13 | | **mobile_number** | **str** | | Mobile number of customer in E.164 format (e.g. +628123123123). For OVO one time payment use only. | | 14 | | **redeem_points** | **str** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | | 15 | | **cashtag** | **str** | | Available for JENIUSPAY only | | 16 | | **promotion_label** | **str** | | Available only for OVO | | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/payment_method/EWalletParameters.md: -------------------------------------------------------------------------------- 1 | # EWalletParameters 2 | > xendit.payment_method.model.EWalletParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | ☑️ | | | | 9 | | **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | 10 | | **account** | [**EWalletAccount**](EWalletAccount.md) | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_method/GetAllPaymentMethods400Response.md: -------------------------------------------------------------------------------- 1 | # GetAllPaymentMethods400Response 2 | > xendit.payment_method.model.GetAllPaymentMethods400Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/GetAllPaymentMethods403Response.md: -------------------------------------------------------------------------------- 1 | # GetAllPaymentMethods403Response 2 | > xendit.payment_method.model.GetAllPaymentMethods403Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/GetAllPaymentMethods404Response.md: -------------------------------------------------------------------------------- 1 | # GetAllPaymentMethods404Response 2 | > xendit.payment_method.model.GetAllPaymentMethods404Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | "DATA_NOT_FOUND" | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/GetAllPaymentMethodsDefaultResponse.md: -------------------------------------------------------------------------------- 1 | # GetAllPaymentMethodsDefaultResponse 2 | > xendit.payment_method.model.GetAllPaymentMethodsDefaultResponse 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/OverTheCounter.md: -------------------------------------------------------------------------------- 1 | # OverTheCounter 2 | > xendit.payment_method.model.OverTheCounter 3 | 4 | Over The Counter Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | | 10 | | **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | | 11 | | **amount** | **float, none_type** | | | | 12 | | **currency** | **str** | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_method/OverTheCounterChannelCode.md: -------------------------------------------------------------------------------- 1 | # OverTheCounterChannelCode 2 | > xendit.payment_method.model.OverTheCounterChannelCode 3 | 4 | Over The Counter Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `7ELEVEN` (value: `"7ELEVEN"`) 11 | 12 | * `7ELEVEN_CLIQQ` (value: `"7ELEVEN_CLIQQ"`) 13 | 14 | * `CEBUANA` (value: `"CEBUANA"`) 15 | 16 | * `ECPAY` (value: `"ECPAY"`) 17 | 18 | * `PALAWAN` (value: `"PALAWAN"`) 19 | 20 | * `MLHUILLIER` (value: `"MLHUILLIER"`) 21 | 22 | * `ECPAY_DRAGONLOAN` (value: `"ECPAY_DRAGONLOAN"`) 23 | 24 | * `LBC` (value: `"LBC"`) 25 | 26 | * `ECPAY_SCHOOL` (value: `"ECPAY_SCHOOL"`) 27 | 28 | * `RD_PAWNSHOP` (value: `"RD_PAWNSHOP"`) 29 | 30 | * `CVM` (value: `"CVM"`) 31 | 32 | * `USSC` (value: `"USSC"`) 33 | 34 | * `SM_BILLS` (value: `"SM_BILLS"`) 35 | 36 | * `ROBINSONS_BILLS` (value: `"ROBINSONS_BILLS"`) 37 | 38 | * `ALFAMART` (value: `"ALFAMART"`) 39 | 40 | * `INDOMARET` (value: `"INDOMARET"`) 41 | 42 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 43 | 44 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 45 | 46 | [[Back to README]](../../README.md) 47 | 48 | 49 | -------------------------------------------------------------------------------- /docs/payment_method/OverTheCounterChannelProperties.md: -------------------------------------------------------------------------------- 1 | # OverTheCounterChannelProperties 2 | > xendit.payment_method.model.OverTheCounterChannelProperties 3 | 4 | Over The Counter Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **customer_name** | **str** | ☑️ | Name of customer. | | | 10 | | **payment_code** | **str** | | The payment code that you want to assign, e.g 12345. If you do not send one, one will be picked at random. | | 11 | | **expires_at** | **datetime** | | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_method/OverTheCounterChannelPropertiesUpdate.md: -------------------------------------------------------------------------------- 1 | # OverTheCounterChannelPropertiesUpdate 2 | > xendit.payment_method.model.OverTheCounterChannelPropertiesUpdate 3 | 4 | Over The Counter Channel properties that can be updated 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **customer_name** | **str** | | Name of customer. | | 10 | | **expires_at** | **datetime** | | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_method/OverTheCounterParameters.md: -------------------------------------------------------------------------------- 1 | # OverTheCounterParameters 2 | > xendit.payment_method.model.OverTheCounterParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | | 9 | | **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | | 10 | | **amount** | **float, none_type** | | | | 11 | | **currency** | **str** | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_method/OverTheCounterUpdateParameters.md: -------------------------------------------------------------------------------- 1 | # OverTheCounterUpdateParameters 2 | > xendit.payment_method.model.OverTheCounterUpdateParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **amount** | **float, none_type** | | | | 9 | | **channel_properties** | [**OverTheCounterChannelPropertiesUpdate**](OverTheCounterChannelPropertiesUpdate.md) | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethod.md: -------------------------------------------------------------------------------- 1 | # PaymentMethod 2 | > xendit.payment_method.model.PaymentMethod 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **id** | **str** | ☑️ | | | | 9 | | **business_id** | **str** | | | | 10 | | **type** | [**PaymentMethodType**](PaymentMethodType.md) | | | | 11 | | **country** | [**PaymentMethodCountry**](PaymentMethodCountry.md) | | | | 12 | | **customer_id** | **str, none_type** | | | | 13 | | **customer** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 14 | | **reference_id** | **str** | | | | 15 | | **description** | **str, none_type** | | | | 16 | | **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | | 17 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | | 18 | | **actions** | [**[PaymentMethodAction]**](PaymentMethodAction.md) | | | | 19 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 20 | | **billing_information** | [**BillingInformation**](BillingInformation.md) | | | | 21 | | **failure_code** | **str, none_type** | | | | 22 | | **created** | **datetime** | | | | 23 | | **updated** | **datetime** | | | | 24 | | **ewallet** | [**EWallet**](EWallet.md) | | | | 25 | | **direct_debit** | [**DirectDebit**](DirectDebit.md) | | | | 26 | | **over_the_counter** | [**OverTheCounter**](OverTheCounter.md) | | | | 27 | | **card** | [**Card**](Card.md) | | | | 28 | | **qr_code** | [**QRCode**](QRCode.md) | | | | 29 | | **virtual_account** | [**VirtualAccount**](VirtualAccount.md) | | | | 30 | 31 | 32 | [[Back to README]](../../README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodAction.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodAction 2 | > xendit.payment_method.model.PaymentMethodAction 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **action** | **str** | | | | 9 | | **method** | **str** | | | | 10 | | **url** | **str** | | | | 11 | | **url_type** | **str** | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodAuthParameters.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodAuthParameters 2 | > xendit.payment_method.model.PaymentMethodAuthParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **auth_code** | **str** | ☑️ | | | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodCallback.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodCallback 2 | > xendit.payment_method.model.PaymentMethodCallback 3 | 4 | Callback for active or expired E-Wallet or Direct Debit account linking, Virtual Accounts or QR strings 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **event** | **str** | ☑️ | Identifies the event that triggered a notification to the merchant | | | 10 | | **business_id** | **str** | ☑️ | business_id | | | 11 | | **created** | **str** | ☑️ | | | | 12 | | **data** | [**PaymentMethod**](PaymentMethod.md) | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodCountry.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodCountry 2 | > xendit.payment_method.model.PaymentMethodCountry 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `PH` (value: `"PH"`) 10 | 11 | * `ID` (value: `"ID"`) 12 | 13 | * `VN` (value: `"VN"`) 14 | 15 | * `TH` (value: `"TH"`) 16 | 17 | * `MY` (value: `"MY"`) 18 | 19 | * `US` (value: `"US"`) 20 | 21 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 22 | 23 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 24 | 25 | [[Back to README]](../../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodExpireParameters.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodExpireParameters 2 | > xendit.payment_method.model.PaymentMethodExpireParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **success_return_url** | **str, none_type** | | URL where the end customer is redirected if the unlinking authorization is successful. | | 9 | | **failure_return_url** | **str, none_type** | | URL where the end customer is redirected if the unlinking authorization is failed. | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodList.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodList 2 | > xendit.payment_method.model.PaymentMethodList 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **data** | [**[PaymentMethod]**](PaymentMethod.md) | ☑️ | | | | 9 | | **has_more** | **bool** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodParameters.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodParameters 2 | > xendit.payment_method.model.PaymentMethodParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | | | 9 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | | | 10 | | **country** | **str, none_type** | | | | 11 | | **customer_id** | **str, none_type** | | | | 12 | | **reference_id** | **str** | | | | 13 | | **description** | **str, none_type** | | | | 14 | | **card** | [**CardParameters**](CardParameters.md) | | | | 15 | | **direct_debit** | [**DirectDebitParameters**](DirectDebitParameters.md) | | | | 16 | | **ewallet** | [**EWalletParameters**](EWalletParameters.md) | | | | 17 | | **over_the_counter** | [**OverTheCounterParameters**](OverTheCounterParameters.md) | | | | 18 | | **virtual_account** | [**VirtualAccountParameters**](VirtualAccountParameters.md) | | | | 19 | | **qr_code** | [**QRCodeParameters**](QRCodeParameters.md) | | | | 20 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 21 | | **billing_information** | [**BillingInformation**](BillingInformation.md) | | | | 22 | 23 | 24 | [[Back to README]](../../README.md) 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodReusability.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodReusability 2 | > xendit.payment_method.model.PaymentMethodReusability 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `MULTIPLE_USE` (value: `"MULTIPLE_USE"`) 10 | 11 | * `ONE_TIME_USE` (value: `"ONE_TIME_USE"`) 12 | 13 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 14 | 15 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodStatus.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodStatus 2 | > xendit.payment_method.model.PaymentMethodStatus 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `ACTIVE` (value: `"ACTIVE"`) 10 | 11 | * `EXPIRED` (value: `"EXPIRED"`) 12 | 13 | * `INACTIVE` (value: `"INACTIVE"`) 14 | 15 | * `PENDING` (value: `"PENDING"`) 16 | 17 | * `REQUIRES_ACTION` (value: `"REQUIRES_ACTION"`) 18 | 19 | * `FAILED` (value: `"FAILED"`) 20 | 21 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 22 | 23 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 24 | 25 | [[Back to README]](../../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodType.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodType 2 | > xendit.payment_method.model.PaymentMethodType 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `CARD` (value: `"CARD"`) 10 | 11 | * `CRYPTOCURRENCY` (value: `"CRYPTOCURRENCY"`) 12 | 13 | * `DIRECT_BANK_TRANSFER` (value: `"DIRECT_BANK_TRANSFER"`) 14 | 15 | * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) 16 | 17 | * `EWALLET` (value: `"EWALLET"`) 18 | 19 | * `OVER_THE_COUNTER` (value: `"OVER_THE_COUNTER"`) 20 | 21 | * `QR_CODE` (value: `"QR_CODE"`) 22 | 23 | * `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) 24 | 25 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 26 | 27 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 28 | 29 | [[Back to README]](../../README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/payment_method/PaymentMethodUpdateParameters.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodUpdateParameters 2 | > xendit.payment_method.model.PaymentMethodUpdateParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **description** | **str** | | | | 9 | | **reference_id** | **str** | | | | 10 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | | 11 | | **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | | 12 | | **over_the_counter** | [**OverTheCounterUpdateParameters**](OverTheCounterUpdateParameters.md) | | | | 13 | | **virtual_account** | [**VirtualAccountUpdateParameters**](VirtualAccountUpdateParameters.md) | | | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/payment_method/QRCode.md: -------------------------------------------------------------------------------- 1 | # QRCode 2 | > xendit.payment_method.model.QRCode 3 | 4 | QR Code Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **amount** | **float, none_type** | | | | 10 | | **currency** | **str** | | | | 11 | | **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | | 12 | | **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_method/QRCodeChannelCode.md: -------------------------------------------------------------------------------- 1 | # QRCodeChannelCode 2 | > xendit.payment_method.model.QRCodeChannelCode 3 | 4 | QR Code Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `QRIS` (value: `"QRIS"`) 11 | 12 | * `DANA` (value: `"DANA"`) 13 | 14 | * `RCBC` (value: `"RCBC"`) 15 | 16 | * `PROMPTPAY` (value: `"PROMPTPAY"`) 17 | 18 | * `LINKAJA` (value: `"LINKAJA"`) 19 | 20 | * `XENDIT` (value: `"XENDIT"`) 21 | 22 | * `QRPH` (value: `"QRPH"`) 23 | 24 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/payment_method/QRCodeChannelProperties.md: -------------------------------------------------------------------------------- 1 | # QRCodeChannelProperties 2 | > xendit.payment_method.model.QRCodeChannelProperties 3 | 4 | QR Code Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **qr_string** | **str** | | QR string to be rendered for display to end users. QR string to image rendering are commonly available in software libraries (e.g Nodejs, PHP, Java) | | 10 | | **expires_at** | **datetime** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_method/QRCodeParameters.md: -------------------------------------------------------------------------------- 1 | # QRCodeParameters 2 | > xendit.payment_method.model.QRCodeParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **amount** | **float, none_type** | | | | 9 | | **currency** | **str** | | | | 10 | | **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | | 11 | | **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_method/SimulatePaymentRequest.md: -------------------------------------------------------------------------------- 1 | # SimulatePaymentRequest 2 | > xendit.payment_method.model.SimulatePaymentRequest 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **amount** | **float** | | | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_method/TokenizedCardInformation.md: -------------------------------------------------------------------------------- 1 | # TokenizedCardInformation 2 | > xendit.payment_method.model.TokenizedCardInformation 3 | 4 | Tokenized Card Information 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **token_id** | **str** | | | | 10 | | **masked_card_number** | **str** | | 1st 6 and last 4 digits of the card | | 11 | | **cardholder_name** | **str, none_type** | | Cardholder name is optional but recommended for 3DS 2 / AVS verification | | 12 | | **expiry_month** | **str** | | Card expiry month in MM format | | 13 | | **expiry_year** | **str** | | Card expiry month in YY format | | 14 | | **fingerprint** | **str** | | Xendit-generated identifier for the unique card number. Multiple payment method objects can be created for the same account - e.g. if the user first creates a one-time payment request, and then later on creates a multiple-use payment method using the same account. The fingerprint helps to identify the unique account being used. | | 15 | | **type** | **str** | | Whether the card is a credit or debit card | | 16 | | **network** | **str** | | Card network - VISA, MASTERCARD, JCB, AMEX, DISCOVER, BCA | | 17 | | **country** | **str** | | Country where the card was issued ISO 3166-1 Alpha-2 | | 18 | | **issuer** | **str** | | Issuer of the card, most often an issuing bank For example, “BCA”, “MANDIRI” | | 19 | | **card_number** | **str** | | | | 20 | | **one_time_token** | **str** | | | | 21 | 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/payment_method/VirtualAccount.md: -------------------------------------------------------------------------------- 1 | # VirtualAccount 2 | > xendit.payment_method.model.VirtualAccount 3 | 4 | Virtual Account Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | | 10 | | **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | | 11 | | **amount** | **float, none_type** | | | | 12 | | **min_amount** | **float, none_type** | | | | 13 | | **max_amount** | **float, none_type** | | | | 14 | | **currency** | **str** | | | | 15 | | **alternative_display_types** | **[str]** | | For payments in Vietnam only, alternative display requested for the virtual account | | 16 | | **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | | | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/payment_method/VirtualAccountAllOf.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountAllOf 2 | > xendit.payment_method.model.VirtualAccountAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_method/VirtualAccountAlternativeDisplay.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountAlternativeDisplay 2 | > xendit.payment_method.model.VirtualAccountAlternativeDisplay 3 | 4 | Alternative Display Object 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **type** | **str** | | Type of the alternative display [readonly] | "QR_STRING" | 10 | | **data** | **str** | | Data payload of the given alternative display | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_method/VirtualAccountChannelCode.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountChannelCode 2 | > xendit.payment_method.model.VirtualAccountChannelCode 3 | 4 | Virtual Account Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `BCA` (value: `"BCA"`) 11 | 12 | * `BJB` (value: `"BJB"`) 13 | 14 | * `BNI` (value: `"BNI"`) 15 | 16 | * `BRI` (value: `"BRI"`) 17 | 18 | * `MANDIRI` (value: `"MANDIRI"`) 19 | 20 | * `PERMATA` (value: `"PERMATA"`) 21 | 22 | * `BSI` (value: `"BSI"`) 23 | 24 | * `CIMB` (value: `"CIMB"`) 25 | 26 | * `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) 27 | 28 | * `ARTAJASA` (value: `"ARTAJASA"`) 29 | 30 | * `PV` (value: `"PV"`) 31 | 32 | * `VIETCAPITAL` (value: `"VIETCAPITAL"`) 33 | 34 | * `WOORI` (value: `"WOORI"`) 35 | 36 | * `MSB` (value: `"MSB"`) 37 | 38 | * `VPB` (value: `"VPB"`) 39 | 40 | * `BIDV` (value: `"BIDV"`) 41 | 42 | * `CAKE` (value: `"CAKE"`) 43 | 44 | * `STANDARD_CHARTERED` (value: `"STANDARD_CHARTERED"`) 45 | 46 | * `AMBANK` (value: `"AMBANK"`) 47 | 48 | * `UOB` (value: `"UOB"`) 49 | 50 | * `BNC` (value: `"BNC"`) 51 | 52 | * `HANA` (value: `"HANA"`) 53 | 54 | * `MUAMALAT` (value: `"MUAMALAT"`) 55 | 56 | * `BANK_TRANSFER` (value: `"BANK_TRANSFER"`) 57 | 58 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 59 | 60 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 61 | 62 | [[Back to README]](../../README.md) 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/payment_method/VirtualAccountChannelProperties.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountChannelProperties 2 | > xendit.payment_method.model.VirtualAccountChannelProperties 3 | 4 | Virtual Account Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **customer_name** | **str** | | Name of customer. | | 10 | | **virtual_account_number** | **str** | | You can assign specific Virtual Account number using this parameter. If you do not send one, one will be picked at random. Make sure the number you specify is within your Virtual Account range. | | 11 | | **expires_at** | **datetime** | | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | | 12 | | **suggested_amount** | **float** | | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_method/VirtualAccountChannelPropertiesPatch.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountChannelPropertiesPatch 2 | > xendit.payment_method.model.VirtualAccountChannelPropertiesPatch 3 | 4 | Virtual Account Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **expires_at** | **datetime** | | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | | 10 | | **suggested_amount** | **float** | | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_method/VirtualAccountParameters.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountParameters 2 | > xendit.payment_method.model.VirtualAccountParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | | 9 | | **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | | 10 | | **amount** | **float, none_type** | | | | 11 | | **min_amount** | **float, none_type** | | | | 12 | | **max_amount** | **float, none_type** | | | | 13 | | **currency** | **str** | | | | 14 | | **alternative_display_types** | **[str]** | | For payments in Vietnam only, alternative display requested for the virtual account | | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/payment_method/VirtualAccountUpdateParameters.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountUpdateParameters 2 | > xendit.payment_method.model.VirtualAccountUpdateParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **amount** | **float, none_type** | | | | 9 | | **min_amount** | **float, none_type** | | | | 10 | | **max_amount** | **float, none_type** | | | | 11 | | **channel_properties** | [**VirtualAccountChannelPropertiesPatch**](VirtualAccountChannelPropertiesPatch.md) | | | | 12 | | **alternative_display_types** | **[str]** | | For payments in Vietnam only, alternative display requested for the virtual account | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/Capture.md: -------------------------------------------------------------------------------- 1 | # Capture 2 | > xendit.payment_request.model.Capture 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **id** | **str** | ☑️ | | | | 9 | | **payment_request_id** | **str** | ☑️ | | | | 10 | | **payment_id** | **str** | ☑️ | | | | 11 | | **reference_id** | **str** | ☑️ | | | | 12 | | **currency** | **str** | ☑️ | | | | 13 | | **authorized_amount** | **float** | ☑️ | | | | 14 | | **captured_amount** | **float** | ☑️ | | | | 15 | | **status** | **str** | ☑️ | | | | 16 | | **payment_method** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | | | 17 | | **failure_code** | **str, none_type** | ☑️ | | | | 18 | | **customer_id** | **str, none_type** | ☑️ | | | | 19 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | ☑️ | | | | 20 | | **channel_properties** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | ☑️ | | | | 21 | | **created** | **str** | ☑️ | | | | 22 | | **updated** | **str** | ☑️ | | | | 23 | 24 | 25 | [[Back to README]](../../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/payment_request/CaptureList.md: -------------------------------------------------------------------------------- 1 | # CaptureList 2 | > xendit.payment_request.model.CaptureList 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **value** | [**[Capture]**](Capture.md) | | ☑️ | | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_request/CaptureListResponse.md: -------------------------------------------------------------------------------- 1 | # CaptureListResponse 2 | > xendit.payment_request.model.CaptureListResponse 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **data** | [**CaptureList**](CaptureList.md) | ☑️ | | | | 9 | | **has_more** | **bool** | ☑️ | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_request/CaptureParameters.md: -------------------------------------------------------------------------------- 1 | # CaptureParameters 2 | > xendit.payment_request.model.CaptureParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **capture_amount** | **float** | ☑️ | | | | 9 | | **reference_id** | **str, none_type** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_request/Card.md: -------------------------------------------------------------------------------- 1 | # Card 2 | > xendit.payment_request.model.Card 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | ☑️ | | | | 9 | | **channel_code** | [**CardChannelCode**](CardChannelCode.md) | | | | 10 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | 11 | | **card_information** | [**CardInformation**](CardInformation.md) | | | | 12 | | **card_verification_results** | [**CardVerificationResults**](CardVerificationResults.md) | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/CardChannelCode.md: -------------------------------------------------------------------------------- 1 | # CardChannelCode 2 | > xendit.payment_request.model.CardChannelCode 3 | 4 | Card Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `BAY_CARD_INSTALLMENT` (value: `"BAY_CARD_INSTALLMENT"`) 11 | 12 | * `BBL_CARD_INSTALLMENT` (value: `"BBL_CARD_INSTALLMENT"`) 13 | 14 | * `GPN` (value: `"GPN"`) 15 | 16 | * `KBANK_CARD_INSTALLMENT` (value: `"KBANK_CARD_INSTALLMENT"`) 17 | 18 | * `KTB_CARD_INSTALLMENT` (value: `"KTB_CARD_INSTALLMENT"`) 19 | 20 | * `SCB_CARD_INSTALLMENT` (value: `"SCB_CARD_INSTALLMENT"`) 21 | 22 | * `TTB_CARD_INSTALLMENT` (value: `"TTB_CARD_INSTALLMENT"`) 23 | 24 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/payment_request/CardChannelProperties.md: -------------------------------------------------------------------------------- 1 | # CardChannelProperties 2 | > xendit.payment_request.model.CardChannelProperties 3 | 4 | Card Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **skip_three_d_secure** | **bool, none_type** | | To indicate whether to perform 3DS during the linking phase | | 10 | | **success_return_url** | **str, none_type** | | URL where the end-customer is redirected if the authorization is successful | | 11 | | **failure_return_url** | **str, none_type** | | URL where the end-customer is redirected if the authorization failed | | 12 | | **cardonfile_type** | **str, none_type** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | | 13 | | **merchant_id_tag** | **str** | | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | | 14 | | **expires_at** | **datetime** | | | | 15 | | **installment_configuration** | [**CardInstallmentConfiguration**](CardInstallmentConfiguration.md) | | | | 16 | | **skip_authorization** | **bool** | | To indicate whether to skip the authorization phase | | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/payment_request/CardInformation.md: -------------------------------------------------------------------------------- 1 | # CardInformation 2 | > xendit.payment_request.model.CardInformation 3 | 4 | Card Information 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **token_id** | **str** | | | | 10 | | **masked_card_number** | **str** | | 1st 6 and last 4 digits of the card | | 11 | | **expiry_month** | **str** | | Card expiry month in MM format | | 12 | | **expiry_year** | **str** | | Card expiry month in YY format | | 13 | | **cardholder_name** | **str, none_type** | | Cardholder name | | 14 | | **fingerprint** | **str** | | | | 15 | | **type** | **str** | | | | 16 | | **network** | **str** | | | | 17 | | **country** | **str** | | | | 18 | | **issuer** | **str** | | | | 19 | | **card_number** | **str** | | | | 20 | | **one_time_token** | **str** | | | | 21 | 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/payment_request/CardInstallmentConfiguration.md: -------------------------------------------------------------------------------- 1 | # CardInstallmentConfiguration 2 | > xendit.payment_request.model.CardInstallmentConfiguration 3 | 4 | Card Installment Configuration 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **terms** | **int** | | | | 10 | | **interval** | **str** | | | | 11 | | **code** | **str, none_type** | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_request/CardParameters.md: -------------------------------------------------------------------------------- 1 | # CardParameters 2 | > xendit.payment_request.model.CardParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | ☑️ | | | | 9 | | **card_information** | [**CardInformation**](CardInformation.md) | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_request/CardVerificationResults.md: -------------------------------------------------------------------------------- 1 | # CardVerificationResults 2 | > xendit.payment_request.model.CardVerificationResults 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **three_d_secure** | [**CardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | | | | 9 | | **cvv_result** | **str, none_type** | | | | 10 | | **address_verification_result** | **str, none_type** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_request/CardVerificationResultsThreeDSecure.md: -------------------------------------------------------------------------------- 1 | # CardVerificationResultsThreeDSecure 2 | > xendit.payment_request.model.CardVerificationResultsThreeDSecure 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **three_d_secure_flow** | **str, none_type** | | | | 9 | | **eci_code** | **str, none_type** | | | | 10 | | **three_d_secure_result** | **str, none_type** | | | | 11 | | **three_d_secure_result_reason** | **str, none_type** | | | | 12 | | **three_d_secure_version** | **str, none_type** | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebit.md: -------------------------------------------------------------------------------- 1 | # DirectDebit 2 | > xendit.payment_request.model.DirectDebit 3 | 4 | Direct Debit Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | | 10 | | **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | | 11 | | **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | 12 | | **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | 13 | | **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebitAllOf.md: -------------------------------------------------------------------------------- 1 | # DirectDebitAllOf 2 | > xendit.payment_request.model.DirectDebitAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | 9 | | **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | 10 | | **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebitBankAccount.md: -------------------------------------------------------------------------------- 1 | # DirectDebitBankAccount 2 | > xendit.payment_request.model.DirectDebitBankAccount 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **masked_bank_account_number** | **str, none_type** | | | | 9 | | **bank_account_hash** | **str, none_type** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebitChannelProperties.md: -------------------------------------------------------------------------------- 1 | # DirectDebitChannelProperties 2 | > xendit.payment_request.model.DirectDebitChannelProperties 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **email** | **str** | | Email address of the customer that is registered to the partner channel | | 9 | | **mobile_number** | **str** | | Mobile number of the customer registered to the partner channel | | 10 | | **success_return_url** | **str** | | | | 11 | | **failure_return_url** | **str** | | | | 12 | | **identity_document_number** | **str** | | | | 13 | | **account_number** | **str** | | | | 14 | | **card_last_four** | **str** | | Last four digits of the debit card | | 15 | | **card_expiry** | **str** | | Expiry month and year of the debit card (in MM/YY format) | | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebitChannelPropertiesBankAccount.md: -------------------------------------------------------------------------------- 1 | # DirectDebitChannelPropertiesBankAccount 2 | > xendit.payment_request.model.DirectDebitChannelPropertiesBankAccount 3 | 4 | Direct Debit Bank Account Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **success_return_url** | **str** | | | | 10 | | **failure_return_url** | **str** | | | | 11 | | **mobile_number** | **str** | | | | 12 | | **identity_document_number** | **str** | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md: -------------------------------------------------------------------------------- 1 | # DirectDebitChannelPropertiesBankRedirect 2 | > xendit.payment_request.model.DirectDebitChannelPropertiesBankRedirect 3 | 4 | Direct Debit Bank Account Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **email** | **str** | | | | 10 | | **mobile_number** | **str** | | Mobile number of the customer that is registered to channel | | 11 | | **success_return_url** | **str** | | | | 12 | | **failure_return_url** | **str** | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebitChannelPropertiesDebitCard.md: -------------------------------------------------------------------------------- 1 | # DirectDebitChannelPropertiesDebitCard 2 | > xendit.payment_request.model.DirectDebitChannelPropertiesDebitCard 3 | 4 | Direct Debit Debit Card Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **mobile_number** | **str** | | Mobile number of the customer registered to the partner channel | | 10 | | **account_number** | **str** | | | | 11 | | **card_last_four** | **str** | | Last four digits of the debit card | | 12 | | **card_expiry** | **str** | | Expiry month and year of the debit card (in MM/YY format) | | 13 | | **email** | **str** | | Email address of the customer that is registered to the partner channel | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebitDebitCard.md: -------------------------------------------------------------------------------- 1 | # DirectDebitDebitCard 2 | > xendit.payment_request.model.DirectDebitDebitCard 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **mobile_number** | **str, none_type** | | Mobile number of the customer registered to the partner channel | | 9 | | **account_number** | **str** | | | | 10 | | **card_last_four** | **str, none_type** | | Last four digits of the debit card | | 11 | | **card_expiry** | **str, none_type** | | Expiry month and year of the debit card (in MM/YY format) | | 12 | | **email** | **str, none_type** | | Email address of the customer that is registered to the partner channel | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebitParameters.md: -------------------------------------------------------------------------------- 1 | # DirectDebitParameters 2 | > xendit.payment_request.model.DirectDebitParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | | 9 | | **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | | 10 | | **type** | [**DirectDebitType**](DirectDebitType.md) | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_request/DirectDebitType.md: -------------------------------------------------------------------------------- 1 | # DirectDebitType 2 | > xendit.payment_request.model.DirectDebitType 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `DEBIT_CARD` (value: `"DEBIT_CARD"`) 10 | 11 | * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) 12 | 13 | * `BANK_REDIRECT` (value: `"BANK_REDIRECT"`) 14 | 15 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 16 | 17 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/payment_request/EWallet.md: -------------------------------------------------------------------------------- 1 | # EWallet 2 | > xendit.payment_request.model.EWallet 3 | 4 | Ewallet Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | | | | 10 | | **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | 11 | | **account** | [**EWalletAccount**](EWalletAccount.md) | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_request/EWalletAccount.md: -------------------------------------------------------------------------------- 1 | # EWalletAccount 2 | > xendit.payment_request.model.EWalletAccount 3 | 4 | EWallet Account Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **name** | **str, none_type** | | Name of the eWallet account holder. The value is null if unavailableName of the eWallet account holder. The value is null if unavailable | | 10 | | **account_details** | **str, none_type** | | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | | 11 | | **balance** | **float, none_type** | | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | | 12 | | **point_balance** | **float, none_type** | | The point balance amount on eWallet account. Applicable only on some eWallet provider that has point system. The value is null if unavailabl | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/EWalletAllOf.md: -------------------------------------------------------------------------------- 1 | # EWalletAllOf 2 | > xendit.payment_request.model.EWalletAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **account** | [**EWalletAccount**](EWalletAccount.md) | | | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_request/EWalletChannelCode.md: -------------------------------------------------------------------------------- 1 | # EWalletChannelCode 2 | > xendit.payment_request.model.EWalletChannelCode 3 | 4 | Ewallet Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `GCASH` (value: `"GCASH"`) 11 | 12 | * `GRABPAY` (value: `"GRABPAY"`) 13 | 14 | * `PAYMAYA` (value: `"PAYMAYA"`) 15 | 16 | * `DANA` (value: `"DANA"`) 17 | 18 | * `OVO` (value: `"OVO"`) 19 | 20 | * `LINKAJA` (value: `"LINKAJA"`) 21 | 22 | * `SHOPEEPAY` (value: `"SHOPEEPAY"`) 23 | 24 | * `NEXCASH` (value: `"NEXCASH"`) 25 | 26 | * `ASTRAPAY` (value: `"ASTRAPAY"`) 27 | 28 | * `JENIUSPAY` (value: `"JENIUSPAY"`) 29 | 30 | * `APPOTA` (value: `"APPOTA"`) 31 | 32 | * `MOMO` (value: `"MOMO"`) 33 | 34 | * `VNPTWALLET` (value: `"VNPTWALLET"`) 35 | 36 | * `VIETTELPAY` (value: `"VIETTELPAY"`) 37 | 38 | * `ZALOPAY` (value: `"ZALOPAY"`) 39 | 40 | * `WECHATPAY` (value: `"WECHATPAY"`) 41 | 42 | * `LINEPAY` (value: `"LINEPAY"`) 43 | 44 | * `TRUEMONEY` (value: `"TRUEMONEY"`) 45 | 46 | * `ALIPAY` (value: `"ALIPAY"`) 47 | 48 | * `TOUCHNGO` (value: `"TOUCHNGO"`) 49 | 50 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 51 | 52 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 53 | 54 | [[Back to README]](../../README.md) 55 | 56 | 57 | -------------------------------------------------------------------------------- /docs/payment_request/EWalletChannelProperties.md: -------------------------------------------------------------------------------- 1 | # EWalletChannelProperties 2 | > xendit.payment_request.model.EWalletChannelProperties 3 | 4 | Ewallet Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **success_return_url** | **str** | | URL where the end-customer is redirected if the authorization is successful | | 10 | | **pending_return_url** | **str** | | URL where the end-customer is redirected if the authorization is successful | | 11 | | **failure_return_url** | **str** | | URL where the end-customer is redirected if the authorization failed | | 12 | | **cancel_return_url** | **str** | | URL where the end-customer is redirected if the authorization cancelled | | 13 | | **redeem_points** | **str** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | | 14 | | **mobile_number** | **str** | | | | 15 | | **cashtag** | **str** | | | | 16 | | **promotion_label** | **str** | | | | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/payment_request/EWalletParameters.md: -------------------------------------------------------------------------------- 1 | # EWalletParameters 2 | > xendit.payment_request.model.EWalletParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | | | | 9 | | **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_request/Error.md: -------------------------------------------------------------------------------- 1 | # Error 2 | > xendit.payment_request.model.Error 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str, none_type** | | | | 9 | | **message** | **str, none_type** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_request/InvoicePartnerMetadata.md: -------------------------------------------------------------------------------- 1 | # InvoicePartnerMetadata 2 | > xendit.payment_request.model.InvoicePartnerMetadata 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **notes** | **str** | | | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_request/OverTheCounter.md: -------------------------------------------------------------------------------- 1 | # OverTheCounter 2 | > xendit.payment_request.model.OverTheCounter 3 | 4 | Over the Counter Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | | 10 | | **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | | 11 | | **amount** | **float, none_type** | | | | 12 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/OverTheCounterChannelCode.md: -------------------------------------------------------------------------------- 1 | # OverTheCounterChannelCode 2 | > xendit.payment_request.model.OverTheCounterChannelCode 3 | 4 | Over The Counter Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `7ELEVEN` (value: `"7ELEVEN"`) 11 | 12 | * `7ELEVEN_CLIQQ` (value: `"7ELEVEN_CLIQQ"`) 13 | 14 | * `CEBUANA` (value: `"CEBUANA"`) 15 | 16 | * `ECPAY` (value: `"ECPAY"`) 17 | 18 | * `PALAWAN` (value: `"PALAWAN"`) 19 | 20 | * `MLHUILLIER` (value: `"MLHUILLIER"`) 21 | 22 | * `ECPAY_DRAGONLOAN` (value: `"ECPAY_DRAGONLOAN"`) 23 | 24 | * `LBC` (value: `"LBC"`) 25 | 26 | * `ECPAY_SCHOOL` (value: `"ECPAY_SCHOOL"`) 27 | 28 | * `RD_PAWNSHOP` (value: `"RD_PAWNSHOP"`) 29 | 30 | * `CVM` (value: `"CVM"`) 31 | 32 | * `USSC` (value: `"USSC"`) 33 | 34 | * `SM_BILLS` (value: `"SM_BILLS"`) 35 | 36 | * `ROBINSONS_BILLS` (value: `"ROBINSONS_BILLS"`) 37 | 38 | * `ALFAMART` (value: `"ALFAMART"`) 39 | 40 | * `INDOMARET` (value: `"INDOMARET"`) 41 | 42 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 43 | 44 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 45 | 46 | [[Back to README]](../../README.md) 47 | 48 | 49 | -------------------------------------------------------------------------------- /docs/payment_request/OverTheCounterChannelProperties.md: -------------------------------------------------------------------------------- 1 | # OverTheCounterChannelProperties 2 | > xendit.payment_request.model.OverTheCounterChannelProperties 3 | 4 | Over The Counter Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **customer_name** | **str** | ☑️ | Name of customer. | | | 10 | | **payment_code** | **str** | | The payment code that you want to assign, e.g 12345. If you do not send one, one will be picked at random. | | 11 | | **expires_at** | **datetime** | | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_request/OverTheCounterParameters.md: -------------------------------------------------------------------------------- 1 | # OverTheCounterParameters 2 | > xendit.payment_request.model.OverTheCounterParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | | 9 | | **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | | 10 | | **amount** | **float, none_type** | | | | 11 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentCallback.md: -------------------------------------------------------------------------------- 1 | # PaymentCallback 2 | > xendit.payment_request.model.PaymentCallback 3 | 4 | Callback for successful or failed payments made via the Payments API 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **event** | **str** | ☑️ | Identifies the event that triggered a notification to the merchant | | | 10 | | **business_id** | **str** | ☑️ | business_id | | | 11 | | **created** | **str** | ☑️ | | | | 12 | | **data** | [**PaymentCallbackData**](PaymentCallbackData.md) | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentCallbackData.md: -------------------------------------------------------------------------------- 1 | # PaymentCallbackData 2 | > xendit.payment_request.model.PaymentCallbackData 3 | 4 | Represents the actual funds transaction/attempt made to a payment method 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **id** | **str** | ☑️ | | | | 10 | | **reference_id** | **str** | ☑️ | | | | 11 | | **currency** | **str** | ☑️ | | | | 12 | | **amount** | **float** | ☑️ | | | | 13 | | **country** | **str** | ☑️ | | | | 14 | | **status** | **str** | ☑️ | | | | 15 | | **payment_method** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | | | 16 | | **created** | **str** | ☑️ | | | | 17 | | **updated** | **str** | ☑️ | | | | 18 | | **payment_request_id** | **str, none_type** | | | | 19 | | **customer_id** | **str, none_type** | | | | 20 | | **channel_properties** | [**PaymentRequestChannelProperties**](PaymentRequestChannelProperties.md) | | | | 21 | | **payment_detail** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 22 | | **failure_code** | **str, none_type** | | | | 23 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 24 | 25 | 26 | [[Back to README]](../../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentMethod.md: -------------------------------------------------------------------------------- 1 | # PaymentMethod 2 | > xendit.payment_request.model.PaymentMethod 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **id** | **str** | ☑️ | | | | 9 | | **type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | | | 10 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | | | 11 | | **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | ☑️ | | | | 12 | | **created** | **str** | | | | 13 | | **updated** | **str** | | | | 14 | | **description** | **str, none_type** | | | | 15 | | **reference_id** | **str** | | | | 16 | | **card** | [**Card**](Card.md) | | | | 17 | | **direct_debit** | [**DirectDebit**](DirectDebit.md) | | | | 18 | | **ewallet** | [**EWallet**](EWallet.md) | | | | 19 | | **over_the_counter** | [**OverTheCounter**](OverTheCounter.md) | | | | 20 | | **virtual_account** | [**VirtualAccount**](VirtualAccount.md) | | | | 21 | | **qr_code** | [**QRCode**](QRCode.md) | | | | 22 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 23 | 24 | 25 | [[Back to README]](../../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentMethodParameters.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodParameters 2 | > xendit.payment_request.model.PaymentMethodParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | | | 9 | | **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | | | 10 | | **description** | **str, none_type** | | | | 11 | | **reference_id** | **str** | | | | 12 | | **card** | [**CardParameters**](CardParameters.md) | | | | 13 | | **direct_debit** | [**DirectDebitParameters**](DirectDebitParameters.md) | | | | 14 | | **ewallet** | [**EWalletParameters**](EWalletParameters.md) | | | | 15 | | **over_the_counter** | [**OverTheCounterParameters**](OverTheCounterParameters.md) | | | | 16 | | **virtual_account** | [**VirtualAccountParameters**](VirtualAccountParameters.md) | | | | 17 | | **qr_code** | [**QRCodeParameters**](QRCodeParameters.md) | | | | 18 | 19 | 20 | [[Back to README]](../../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentMethodReusability.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodReusability 2 | > xendit.payment_request.model.PaymentMethodReusability 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `MULTIPLE_USE` (value: `"MULTIPLE_USE"`) 10 | 11 | * `ONE_TIME_USE` (value: `"ONE_TIME_USE"`) 12 | 13 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 14 | 15 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentMethodStatus.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodStatus 2 | > xendit.payment_request.model.PaymentMethodStatus 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `ACTIVE` (value: `"ACTIVE"`) 10 | 11 | * `INACTIVE` (value: `"INACTIVE"`) 12 | 13 | * `PENDING` (value: `"PENDING"`) 14 | 15 | * `EXPIRED` (value: `"EXPIRED"`) 16 | 17 | * `FAILED` (value: `"FAILED"`) 18 | 19 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 20 | 21 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentMethodType.md: -------------------------------------------------------------------------------- 1 | # PaymentMethodType 2 | > xendit.payment_request.model.PaymentMethodType 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `CARD` (value: `"CARD"`) 10 | 11 | * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) 12 | 13 | * `EWALLET` (value: `"EWALLET"`) 14 | 15 | * `OVER_THE_COUNTER` (value: `"OVER_THE_COUNTER"`) 16 | 17 | * `QR_CODE` (value: `"QR_CODE"`) 18 | 19 | * `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) 20 | 21 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 22 | 23 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 24 | 25 | [[Back to README]](../../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequest.md: -------------------------------------------------------------------------------- 1 | # PaymentRequest 2 | > xendit.payment_request.model.PaymentRequest 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **id** | **str** | ☑️ | | | | 9 | | **created** | **str** | ☑️ | | | | 10 | | **updated** | **str** | ☑️ | | | | 11 | | **reference_id** | **str** | ☑️ | | | | 12 | | **business_id** | **str** | ☑️ | | | | 13 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | | | 14 | | **payment_method** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | | | 15 | | **status** | [**PaymentRequestStatus**](PaymentRequestStatus.md) | ☑️ | | | | 16 | | **customer_id** | **str, none_type** | | | | 17 | | **customer** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 18 | | **amount** | **float** | | | | 19 | | **min_amount** | **float, none_type** | | | | 20 | | **max_amount** | **float, none_type** | | | | 21 | | **country** | [**PaymentRequestCountry**](PaymentRequestCountry.md) | | | | 22 | | **description** | **str, none_type** | | | | 23 | | **failure_code** | **str, none_type** | | | | 24 | | **capture_method** | [**PaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | | | 25 | | **initiator** | [**PaymentRequestInitiator**](PaymentRequestInitiator.md) | | | | 26 | | **card_verification_results** | [**PaymentRequestCardVerificationResults**](PaymentRequestCardVerificationResults.md) | | | | 27 | | **actions** | [**[PaymentRequestAction]**](PaymentRequestAction.md) | | | | 28 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 29 | | **shipping_information** | [**PaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | | | 30 | | **items** | [**PaymentRequestBasket**](PaymentRequestBasket.md) | | | | 31 | 32 | 33 | [[Back to README]](../../README.md) 34 | 35 | 36 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestAction.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestAction 2 | > xendit.payment_request.model.PaymentRequestAction 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **action** | **str** | ☑️ | | | | 9 | | **url_type** | **str** | ☑️ | | | | 10 | | **method** | **str, none_type** | ☑️ | | | | 11 | | **url** | **str, none_type** | ☑️ | | | | 12 | | **qr_code** | **str, none_type** | ☑️ | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestAuthParameters.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestAuthParameters 2 | > xendit.payment_request.model.PaymentRequestAuthParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **auth_code** | **str** | ☑️ | | | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestBasket.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestBasket 2 | > xendit.payment_request.model.PaymentRequestBasket 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **value** | [**[PaymentRequestBasketItem], none_type**](PaymentRequestBasketItem.md) | | ☑️ | | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestBasketItem.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestBasketItem 2 | > xendit.payment_request.model.PaymentRequestBasketItem 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **name** | **str** | ☑️ | | | | 9 | | **category** | **str** | ☑️ | | | | 10 | | **currency** | **str** | ☑️ | | | | 11 | | **quantity** | **float** | ☑️ | | | | 12 | | **price** | **float** | ☑️ | | | | 13 | | **reference_id** | **str** | | | | 14 | | **description** | **str** | | | | 15 | | **type** | **str** | | | | 16 | | **sub_category** | **str** | | | | 17 | | **payer_charged_currency** | **str** | | | | 18 | | **payer_charged_price** | **float** | | | | 19 | | **url** | **str** | | | | 20 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | | | 21 | 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestCaptureMethod.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestCaptureMethod 2 | > xendit.payment_request.model.PaymentRequestCaptureMethod 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `AUTOMATIC` (value: `"AUTOMATIC"`) 10 | 11 | * `MANUAL` (value: `"MANUAL"`) 12 | 13 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 14 | 15 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestCardVerificationResults.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestCardVerificationResults 2 | > xendit.payment_request.model.PaymentRequestCardVerificationResults 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **three_d_secure** | [**PaymentRequestCardVerificationResultsThreeDeeSecure**](PaymentRequestCardVerificationResultsThreeDeeSecure.md) | ☑️ | | | | 9 | | **cvv_result** | **str, none_type** | | | | 10 | | **address_verification_result** | **str, none_type** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestCardVerificationResultsThreeDeeSecure 2 | > xendit.payment_request.model.PaymentRequestCardVerificationResultsThreeDeeSecure 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **three_d_secure_flow** | **str** | | | | 9 | | **eci_code** | **str** | | | | 10 | | **three_d_secure_result** | **str** | | | | 11 | | **three_d_secure_result_reason** | **str, none_type** | | | | 12 | | **three_d_secure_version** | **str** | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestChannelProperties.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestChannelProperties 2 | > xendit.payment_request.model.PaymentRequestChannelProperties 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **success_return_url** | **str** | | URL where the end-customer is redirected if the authorization is successful | | 9 | | **failure_return_url** | **str** | | URL where the end-customer is redirected if the authorization failed | | 10 | | **cancel_return_url** | **str** | | URL where the end-customer is redirected if the authorization cancelled | | 11 | | **pending_return_url** | **str** | | URL where the end-customer is redirected if the authorization is pending | | 12 | | **redeem_points** | **str** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | | 13 | | **require_auth** | **bool** | | Toggle used to require end-customer to input undergo OTP validation before completing a payment. OTP will always be required for transactions greater than 1,000,000 IDR. For BRI tokenized payment use only. | | 14 | | **merchant_id_tag** | **str** | | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | | 15 | | **cardonfile_type** | **str, none_type** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | | 16 | 17 | 18 | [[Back to README]](../../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestCountry.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestCountry 2 | > xendit.payment_request.model.PaymentRequestCountry 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `ID` (value: `"ID"`) 10 | 11 | * `PH` (value: `"PH"`) 12 | 13 | * `VN` (value: `"VN"`) 14 | 15 | * `TH` (value: `"TH"`) 16 | 17 | * `MY` (value: `"MY"`) 18 | 19 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 20 | 21 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 22 | 23 | [[Back to README]](../../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestCurrency.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestCurrency 2 | > xendit.payment_request.model.PaymentRequestCurrency 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `IDR` (value: `"IDR"`) 10 | 11 | * `PHP` (value: `"PHP"`) 12 | 13 | * `VND` (value: `"VND"`) 14 | 15 | * `THB` (value: `"THB"`) 16 | 17 | * `MYR` (value: `"MYR"`) 18 | 19 | * `USD` (value: `"USD"`) 20 | 21 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 22 | 23 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 24 | 25 | [[Back to README]](../../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestInitiator.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestInitiator 2 | > xendit.payment_request.model.PaymentRequestInitiator 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `CUSTOMER` (value: `"CUSTOMER"`) 10 | 11 | * `MERCHANT` (value: `"MERCHANT"`) 12 | 13 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 14 | 15 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestListResponse.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestListResponse 2 | > xendit.payment_request.model.PaymentRequestListResponse 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **data** | [**[PaymentRequest]**](PaymentRequest.md) | ☑️ | | | | 9 | | **has_more** | **bool** | ☑️ | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestParameters.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestParameters 2 | > xendit.payment_request.model.PaymentRequestParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | | | 9 | | **reference_id** | **str** | | | | 10 | | **amount** | **float** | | | | 11 | | **payment_method** | [**PaymentMethodParameters**](PaymentMethodParameters.md) | | | | 12 | | **description** | **str, none_type** | | | | 13 | | **capture_method** | [**PaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | | | 14 | | **initiator** | [**PaymentRequestInitiator**](PaymentRequestInitiator.md) | | | | 15 | | **payment_method_id** | **str** | | | | 16 | | **channel_properties** | [**PaymentRequestParametersChannelProperties**](PaymentRequestParametersChannelProperties.md) | | | | 17 | | **shipping_information** | [**PaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | | | 18 | | **items** | [**PaymentRequestBasket**](PaymentRequestBasket.md) | | | | 19 | | **customer_id** | **str, none_type** | | | | 20 | | **customer** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 21 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 22 | 23 | 24 | [[Back to README]](../../README.md) 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestParametersChannelProperties.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestParametersChannelProperties 2 | > xendit.payment_request.model.PaymentRequestParametersChannelProperties 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **success_return_url** | **str** | | URL where the end-customer is redirected if the authorization is successful | | 9 | | **failure_return_url** | **str** | | URL where the end-customer is redirected if the authorization failed | | 10 | | **cancel_return_url** | **str** | | URL where the end-customer is redirected if the authorization cancelled | | 11 | | **pending_return_url** | **str** | | URL where the end-customer is redirected if the authorization is pending | | 12 | | **redeem_points** | **str** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | | 13 | | **require_auth** | **bool** | | Toggle used to require end-customer to input undergo OTP validation before completing a payment. OTP will always be required for transactions greater than 1,000,000 IDR. For BRI tokenized payment use only. | | 14 | | **merchant_id_tag** | **str** | | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | | 15 | | **cardonfile_type** | **str, none_type** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | | 16 | | **cvv** | **str** | | Three digit code written on the back of the card (usually called CVV/CVN). | | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestParametersChannelPropertiesAllOf 2 | > xendit.payment_request.model.PaymentRequestParametersChannelPropertiesAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **cvv** | **str** | | Three digit code written on the back of the card (usually called CVV/CVN). | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestShippingInformation.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestShippingInformation 2 | > xendit.payment_request.model.PaymentRequestShippingInformation 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **country** | **str** | ☑️ | | | | 9 | | **street_line1** | **str** | | | | 10 | | **street_line2** | **str** | | | | 11 | | **city** | **str** | | | | 12 | | **province_state** | **str** | | | | 13 | | **postal_code** | **str** | | | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentRequestStatus.md: -------------------------------------------------------------------------------- 1 | # PaymentRequestStatus 2 | > xendit.payment_request.model.PaymentRequestStatus 3 | 4 | 5 | 6 | ## Enum 7 | 8 | 9 | * `PENDING` (value: `"PENDING"`) 10 | 11 | * `REQUIRES_ACTION` (value: `"REQUIRES_ACTION"`) 12 | 13 | * `CANCELED` (value: `"CANCELED"`) 14 | 15 | * `SUCCEEDED` (value: `"SUCCEEDED"`) 16 | 17 | * `FAILED` (value: `"FAILED"`) 18 | 19 | * `VOIDED` (value: `"VOIDED"`) 20 | 21 | * `UNKNOWN` (value: `"UNKNOWN"`) 22 | 23 | * `AWAITING_CAPTURE` (value: `"AWAITING_CAPTURE"`) 24 | 25 | * `EXPIRED` (value: `"EXPIRED"`) 26 | 27 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 28 | 29 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 30 | 31 | [[Back to README]](../../README.md) 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/payment_request/PaymentSimulation.md: -------------------------------------------------------------------------------- 1 | # PaymentSimulation 2 | > xendit.payment_request.model.PaymentSimulation 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **status** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_request/QRCode.md: -------------------------------------------------------------------------------- 1 | # QRCode 2 | > xendit.payment_request.model.QRCode 3 | 4 | QRCode Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | | 10 | | **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_request/QRCodeChannelCode.md: -------------------------------------------------------------------------------- 1 | # QRCodeChannelCode 2 | > xendit.payment_request.model.QRCodeChannelCode 3 | 4 | QR Code Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `QRIS` (value: `"QRIS"`) 11 | 12 | * `DANA` (value: `"DANA"`) 13 | 14 | * `RCBC` (value: `"RCBC"`) 15 | 16 | * `LINKAJA` (value: `"LINKAJA"`) 17 | 18 | * `PROMPTPAY` (value: `"PROMPTPAY"`) 19 | 20 | * `XENDIT` (value: `"XENDIT"`) 21 | 22 | * `QRPH` (value: `"QRPH"`) 23 | 24 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 25 | 26 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 27 | 28 | [[Back to README]](../../README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/payment_request/QRCodeChannelProperties.md: -------------------------------------------------------------------------------- 1 | # QRCodeChannelProperties 2 | > xendit.payment_request.model.QRCodeChannelProperties 3 | 4 | QR Code Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **qr_string** | **str** | | | | 10 | | **expires_at** | **datetime** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_request/QRCodeParameters.md: -------------------------------------------------------------------------------- 1 | # QRCodeParameters 2 | > xendit.payment_request.model.QRCodeParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | | 9 | | **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payment_request/VirtualAccount.md: -------------------------------------------------------------------------------- 1 | # VirtualAccount 2 | > xendit.payment_request.model.VirtualAccount 3 | 4 | Virtual Account Payment Method Details 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | | 10 | | **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | | 11 | | **min_amount** | **float, none_type** | | | | 12 | | **max_amount** | **float, none_type** | | | | 13 | | **amount** | **float, none_type** | | | | 14 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | 15 | | **alternative_display_types** | **[str]** | | Alternative display requested for the virtual account | | 16 | | **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | | | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/payment_request/VirtualAccountAllOf.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountAllOf 2 | > xendit.payment_request.model.VirtualAccountAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | | | 9 | 10 | 11 | [[Back to README]](../../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/payment_request/VirtualAccountAlternativeDisplay.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountAlternativeDisplay 2 | > xendit.payment_request.model.VirtualAccountAlternativeDisplay 3 | 4 | Alternative Display Object 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **type** | **str** | | Type of the alternative display [readonly] | "QR_STRING" | 10 | | **data** | **str** | | Data payload of the given alternative display | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payment_request/VirtualAccountChannelCode.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountChannelCode 2 | > xendit.payment_request.model.VirtualAccountChannelCode 3 | 4 | Virtual Account Channel Code 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `BCA` (value: `"BCA"`) 11 | 12 | * `BJB` (value: `"BJB"`) 13 | 14 | * `BNI` (value: `"BNI"`) 15 | 16 | * `BRI` (value: `"BRI"`) 17 | 18 | * `MANDIRI` (value: `"MANDIRI"`) 19 | 20 | * `PERMATA` (value: `"PERMATA"`) 21 | 22 | * `BSI` (value: `"BSI"`) 23 | 24 | * `CIMB` (value: `"CIMB"`) 25 | 26 | * `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) 27 | 28 | * `ARTAJASA` (value: `"ARTAJASA"`) 29 | 30 | * `PV` (value: `"PV"`) 31 | 32 | * `VIETCAPITAL` (value: `"VIETCAPITAL"`) 33 | 34 | * `WOORI` (value: `"WOORI"`) 35 | 36 | * `MSB` (value: `"MSB"`) 37 | 38 | * `VPB` (value: `"VPB"`) 39 | 40 | * `BIDV` (value: `"BIDV"`) 41 | 42 | * `STANDARD_CHARTERED` (value: `"STANDARD_CHARTERED"`) 43 | 44 | * `AMBANK` (value: `"AMBANK"`) 45 | 46 | * `UOB` (value: `"UOB"`) 47 | 48 | * `BNC` (value: `"BNC"`) 49 | 50 | * `HANA` (value: `"HANA"`) 51 | 52 | * `MUAMALAT` (value: `"MUAMALAT"`) 53 | 54 | * `BANK_TRANSFER` (value: `"BANK_TRANSFER"`) 55 | 56 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 57 | 58 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 59 | 60 | [[Back to README]](../../README.md) 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/payment_request/VirtualAccountChannelProperties.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountChannelProperties 2 | > xendit.payment_request.model.VirtualAccountChannelProperties 3 | 4 | Virtual Account Channel Properties 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **customer_name** | **str** | ☑️ | Name of customer. | | | 10 | | **virtual_account_number** | **str** | | You can assign specific Virtual Account number using this parameter. If you do not send one, one will be picked at random. Make sure the number you specify is within your Virtual Account range. | | 11 | | **expires_at** | **datetime** | | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | | 12 | | **suggested_amount** | **float** | | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/payment_request/VirtualAccountParameters.md: -------------------------------------------------------------------------------- 1 | # VirtualAccountParameters 2 | > xendit.payment_request.model.VirtualAccountParameters 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | | 9 | | **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | | 10 | | **min_amount** | **float, none_type** | | | | 11 | | **max_amount** | **float, none_type** | | | | 12 | | **amount** | **float, none_type** | | | | 13 | | **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | 14 | | **alternative_display_types** | **[str]** | | Alternative display requested for the virtual account | | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/payout/Channel.md: -------------------------------------------------------------------------------- 1 | # Channel 2 | > xendit.payout.model.Channel 3 | 4 | Channel information where you can send the money to 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **channel_code** | **str** | ☑️ | Destination channel to send the money to, prefixed by ISO-3166 country code | | | 10 | | **channel_category** | [**ChannelCategory**](ChannelCategory.md) | ☑️ | | | | 11 | | **currency** | **str** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | | 12 | | **channel_name** | **str** | ☑️ | Name of the destination channel | | | 13 | | **amount_limits** | [**ChannelAmountLimits**](ChannelAmountLimits.md) | ☑️ | | | | 14 | 15 | 16 | [[Back to README]](../../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/payout/ChannelAccountType.md: -------------------------------------------------------------------------------- 1 | # ChannelAccountType 2 | > xendit.payout.model.ChannelAccountType 3 | 4 | Available account types (applicable for MY_DUITNOW) 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `NATIONAL_ID` (value: `"NATIONAL_ID"`) 11 | 12 | * `MOBILE_NO` (value: `"MOBILE_NO"`) 13 | 14 | * `PASSPORT` (value: `"PASSPORT"`) 15 | 16 | * `BUSINESS_REGISTRATION` (value: `"BUSINESS_REGISTRATION"`) 17 | 18 | * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) 19 | 20 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 21 | 22 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 23 | 24 | [[Back to README]](../../README.md) 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/payout/ChannelAmountLimits.md: -------------------------------------------------------------------------------- 1 | # ChannelAmountLimits 2 | > xendit.payout.model.ChannelAmountLimits 3 | 4 | Supported amount ranges for payouts to this channel 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **minimum** | **float** | ☑️ | Lowest amount supported for a payout to this channel | | | 10 | | **maximum** | **float** | ☑️ | Highest amount supported for a payout to this channel | | | 11 | | **minimum_increment** | **float** | ☑️ | Supported increments | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payout/ChannelCategory.md: -------------------------------------------------------------------------------- 1 | # ChannelCategory 2 | > xendit.payout.model.ChannelCategory 3 | 4 | Category of channel code, as some channels might require more fields during processing 5 | 6 | 7 | ## Enum 8 | 9 | 10 | * `BANK` (value: `"BANK"`) 11 | 12 | * `EWALLET` (value: `"EWALLET"`) 13 | 14 | * `OTC` (value: `"OTC"`) 15 | 16 | * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) 17 | 18 | If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. 19 | 20 | [[Back to README]](../../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/payout/CreatePayoutRequest.md: -------------------------------------------------------------------------------- 1 | # CreatePayoutRequest 2 | > xendit.payout.model.CreatePayoutRequest 3 | 4 | Information needed by Xendit to send money to the destination channel provided 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **reference_id** | **str** | ☑️ | A client defined payout identifier | | | 10 | | **channel_code** | **str** | ☑️ | Channel code of selected destination bank or e-wallet | | | 11 | | **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | ☑️ | | | | 12 | | **amount** | **float** | ☑️ | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | | 13 | | **currency** | **str** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | | 14 | | **description** | **str** | | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | | 15 | | **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | | | 16 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | Object of additional information you may use | | 17 | 18 | 19 | [[Back to README]](../../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/payout/DigitalPayoutChannelProperties.md: -------------------------------------------------------------------------------- 1 | # DigitalPayoutChannelProperties 2 | > xendit.payout.model.DigitalPayoutChannelProperties 3 | 4 | Channel information for digital destinations (banks, e-wallets) 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **account_number** | **str** | ☑️ | Registered account number | | | 10 | | **account_holder_name** | **str, none_type** | | Registered account name | | 11 | | **account_type** | [**ChannelAccountType**](ChannelAccountType.md) | | | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/payout/Error.md: -------------------------------------------------------------------------------- 1 | # Error 2 | > xendit.payout.model.Error 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | ☑️ | Specific error encountered when processing the request, can refer to the API documentation on proper handling of each available error code https://developers.xendit.co/api-reference/#payouts | | | 9 | | **message** | **str** | ☑️ | Human readable error message | | | 10 | | **errors** | [**[ErrorErrorsInner]**](ErrorErrorsInner.md) | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payout/ErrorErrorsInner.md: -------------------------------------------------------------------------------- 1 | # ErrorErrorsInner 2 | > xendit.payout.model.ErrorErrorsInner 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **path** | **str** | ☑️ | Precise location of the error | | | 9 | | **message** | **str** | ☑️ | Specific description of the error | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/payout/GetPayouts200Response.md: -------------------------------------------------------------------------------- 1 | # GetPayouts200Response 2 | > xendit.payout.model.GetPayouts200Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **data** | [**[GetPayouts200ResponseDataInner]**](GetPayouts200ResponseDataInner.md) | | | | 9 | | **has_more** | **bool** | | | | 10 | | **links** | [**GetPayouts200ResponseLinks**](GetPayouts200ResponseLinks.md) | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payout/GetPayouts200ResponseDataInner.md: -------------------------------------------------------------------------------- 1 | # GetPayouts200ResponseDataInner 2 | > xendit.payout.model.GetPayouts200ResponseDataInner 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **description** | **str** | | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | | 9 | | **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | | | 10 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | Object of additional information you may use | | 11 | | **failure_code** | **str** | | If the Payout failed, we include a failure code for more details on the failure. | | 12 | | **estimated_arrival_time** | **datetime** | | Our estimated time on to when your payout is reflected to the destination account | | 13 | | **reference_id** | **str** | | A client defined payout identifier | | 14 | | **channel_code** | **str** | | Channel code of selected destination bank or e-wallet | | 15 | | **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | | | | 16 | | **amount** | **float** | | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | 17 | | **currency** | **str** | | Currency of the destination channel using ISO-4217 currency code | | 18 | | **id** | **str** | | Xendit-generated unique identifier for each payout | | 19 | | **created** | **datetime** | | The time payout was created on Xendit's system, in ISO 8601 format | | 20 | | **updated** | **datetime** | | The time payout was last updated on Xendit's system, in ISO 8601 format | | 21 | | **business_id** | **str** | | Xendit Business ID | | 22 | | **status** | **str** | | Status of payout | | 23 | 24 | 25 | [[Back to README]](../../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/payout/GetPayouts200ResponseLinks.md: -------------------------------------------------------------------------------- 1 | # GetPayouts200ResponseLinks 2 | > xendit.payout.model.GetPayouts200ResponseLinks 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **href** | **str** | | | | 9 | | **rel** | **str** | | | | 10 | | **method** | **str** | | | | 11 | 12 | 13 | [[Back to README]](../../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/payout/Payout.md: -------------------------------------------------------------------------------- 1 | # Payout 2 | > xendit.payout.model.Payout 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **reference_id** | **str** | ☑️ | A client defined payout identifier | | | 9 | | **channel_code** | **str** | ☑️ | Channel code of selected destination bank or e-wallet | | | 10 | | **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | ☑️ | | | | 11 | | **amount** | **float** | ☑️ | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | | 12 | | **currency** | **str** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | | 13 | | **id** | **str** | ☑️ | Xendit-generated unique identifier for each payout | | | 14 | | **created** | **datetime** | ☑️ | The time payout was created on Xendit's system, in ISO 8601 format | | | 15 | | **updated** | **datetime** | ☑️ | The time payout was last updated on Xendit's system, in ISO 8601 format | | | 16 | | **business_id** | **str** | ☑️ | Xendit Business ID | | | 17 | | **status** | **str** | ☑️ | Status of payout | | | 18 | | **description** | **str** | | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | | 19 | | **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | | | 20 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | Object of additional information you may use | | 21 | | **failure_code** | **str** | | If the Payout failed, we include a failure code for more details on the failure. | | 22 | | **estimated_arrival_time** | **datetime** | | Our estimated time on to when your payout is reflected to the destination account | | 23 | 24 | 25 | [[Back to README]](../../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/payout/PayoutAllOf.md: -------------------------------------------------------------------------------- 1 | # PayoutAllOf 2 | > xendit.payout.model.PayoutAllOf 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **id** | **str** | ☑️ | Xendit-generated unique identifier for each payout | | | 9 | | **created** | **datetime** | ☑️ | The time payout was created on Xendit's system, in ISO 8601 format | | | 10 | | **updated** | **datetime** | ☑️ | The time payout was last updated on Xendit's system, in ISO 8601 format | | | 11 | | **business_id** | **str** | ☑️ | Xendit Business ID | | | 12 | | **status** | **str** | ☑️ | Status of payout | | | 13 | | **failure_code** | **str** | | If the Payout failed, we include a failure code for more details on the failure. | | 14 | | **estimated_arrival_time** | **datetime** | | Our estimated time on to when your payout is reflected to the destination account | | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/payout/ReceiptNotification.md: -------------------------------------------------------------------------------- 1 | # ReceiptNotification 2 | > xendit.payout.model.ReceiptNotification 3 | 4 | Additional notification for completed payout 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **email_to** | **[str], none_type** | | Valid email address to send the payout receipt | | 10 | | **email_cc** | **[str], none_type** | | Valid email address to cc the payout receipt | | 11 | | **email_bcc** | **[str], none_type** | | Valid email address to bcc the payout receipt | | 12 | 13 | 14 | [[Back to README]](../../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/refund/CreateRefund.md: -------------------------------------------------------------------------------- 1 | # CreateRefund 2 | > xendit.refund.model.CreateRefund 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **payment_request_id** | **str** | | | | 9 | | **invoice_id** | **str** | | | | 10 | | **reference_id** | **str** | | | | 11 | | **amount** | **float** | | | | 12 | | **currency** | **str** | | | | 13 | | **reason** | **str** | | | | 14 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 15 | 16 | 17 | [[Back to README]](../../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/refund/CreateRefund400Response.md: -------------------------------------------------------------------------------- 1 | # CreateRefund400Response 2 | > xendit.refund.model.CreateRefund400Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/refund/CreateRefund403Response.md: -------------------------------------------------------------------------------- 1 | # CreateRefund403Response 2 | > xendit.refund.model.CreateRefund403Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | "UNAUTHORIZED" | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/refund/CreateRefund404Response.md: -------------------------------------------------------------------------------- 1 | # CreateRefund404Response 2 | > xendit.refund.model.CreateRefund404Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | "DATA_NOT_FOUND" | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/refund/CreateRefund409Response.md: -------------------------------------------------------------------------------- 1 | # CreateRefund409Response 2 | > xendit.refund.model.CreateRefund409Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/refund/CreateRefund503Response.md: -------------------------------------------------------------------------------- 1 | # CreateRefund503Response 2 | > xendit.refund.model.CreateRefund503Response 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/refund/GetAllRefundsDefaultResponse.md: -------------------------------------------------------------------------------- 1 | # GetAllRefundsDefaultResponse 2 | > xendit.refund.model.GetAllRefundsDefaultResponse 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **error_code** | **str** | | | | 9 | | **message** | **str** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/refund/Refund.md: -------------------------------------------------------------------------------- 1 | # Refund 2 | > xendit.refund.model.Refund 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **id** | **str** | | | | 9 | | **payment_request_id** | **str** | | | | 10 | | **amount** | **float** | | | | 11 | | **channel_code** | **str** | | | | 12 | | **country** | **str** | | | | 13 | | **currency** | **str** | | | | 14 | | **reference_id** | **str, none_type** | | | | 15 | | **failure_code** | **str, none_type** | | | | 16 | | **refund_fee_amount** | **float, none_type** | | | | 17 | | **created** | **str** | | | | 18 | | **updated** | **str** | | | | 19 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 20 | 21 | 22 | [[Back to README]](../../README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/refund/RefundCallback.md: -------------------------------------------------------------------------------- 1 | # RefundCallback 2 | > xendit.refund.model.RefundCallback 3 | 4 | Callback for successful or failed Refunds made via the Payments API 5 | 6 | ## Properties 7 | | Name | Type | Required | Description | Examples | 8 | |------------|:-------------:|:-------------:|-------------|:-------------:| 9 | | **event** | **str** | ☑️ | Identifies the event that triggered a notification to the merchant | | | 10 | | **business_id** | **str** | ☑️ | business_id | | | 11 | | **created** | **str** | ☑️ | | | | 12 | | **data** | [**RefundCallbackData**](RefundCallbackData.md) | | | | 13 | 14 | 15 | [[Back to README]](../../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/refund/RefundCallbackData.md: -------------------------------------------------------------------------------- 1 | # RefundCallbackData 2 | > xendit.refund.model.RefundCallbackData 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **id** | **str** | ☑️ | | | | 9 | | **payment_id** | **str** | ☑️ | | | | 10 | | **payment_method_type** | **str** | ☑️ | | | | 11 | | **amount** | **float** | ☑️ | | | | 12 | | **channel_code** | **str** | ☑️ | | | | 13 | | **status** | **str** | ☑️ | | | | 14 | | **reason** | **str** | ☑️ | | | | 15 | | **country** | **str** | ☑️ | | | | 16 | | **currency** | **str** | ☑️ | | | | 17 | | **created** | **str** | ☑️ | | | | 18 | | **updated** | **str** | ☑️ | | | | 19 | | **invoice_id** | **str, none_type** | | | | 20 | | **reference_id** | **str, none_type** | | | | 21 | | **failure_code** | **str, none_type** | | | | 22 | | **refund_fee_amount** | **float, none_type** | | | | 23 | | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | 24 | 25 | 26 | [[Back to README]](../../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/refund/RefundList.md: -------------------------------------------------------------------------------- 1 | # RefundList 2 | > xendit.refund.model.RefundList 3 | 4 | 5 | ## Properties 6 | | Name | Type | Required | Description | Examples | 7 | |------------|:-------------:|:-------------:|-------------|:-------------:| 8 | | **data** | [**[Refund]**](Refund.md) | ☑️ | | | | 9 | | **has_more** | **bool** | | | | 10 | 11 | 12 | [[Back to README]](../../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /images/header.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xendit/xendit-python/44fce2945c47a6cddd449984ab4b5a7416f0dae3/images/header.jpg -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "xendit-python" 3 | version = "7.0.0" 4 | description = "Xendit REST API Client for Python - Invoice, Payment Request, Payment Method, Refund, Balance, Transaction, Customer, and Payout Services https://xendit.github.io/apireference/" 5 | authors = ["DevX Team "] 6 | license = "MIT" 7 | repository = "https://github.com/xendit/xendit-python" 8 | readme = "README.md" 9 | keywords = ["xendit", "sdk"] 10 | classifiers = [ 11 | "Intended Audience :: Developers", 12 | "Operating System :: OS Independent", 13 | "Programming Language :: Python :: 3.10" 14 | ] 15 | packages = [ 16 | { include = "xendit" } 17 | ] 18 | 19 | [tool.poetry.dependencies] 20 | python = "^3.10" 21 | requests = "^2.23.0" 22 | 23 | [tool.poetry.dev-dependencies] 24 | black = "^19.10b0" 25 | pytest = "^5.4.3" 26 | flake8 = "^3.8.3" 27 | pytest-mock = "^3.1.1" 28 | pre-commit = "^2.5.1" 29 | responses = "^0.10.15" 30 | pytest-cov = "^2.10.0" 31 | 32 | [build-system] 33 | requires = ["poetry-core>=1.0.0a5"] 34 | build-backend = "poetry.core.masonry.api" -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | python_dateutil >= 2.5.3 2 | setuptools >= 21.0.0 3 | urllib3 >= 1.25.3 4 | python-dotenv==1.0.0 5 | pytest==7.4.3 6 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length=99 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """ 2 | The version of the XENDIT API: 1.70.0 3 | """ 4 | 5 | 6 | from setuptools import setup, find_packages # noqa: H301 7 | 8 | NAME = "xendit" 9 | VERSION = "7.0.0" 10 | # To install the library, run the following 11 | # 12 | # python setup.py install 13 | # 14 | # prerequisite: setuptools 15 | # http://pypi.python.org/pypi/setuptools 16 | 17 | REQUIRES = [ 18 | "urllib3 >= 1.25.3", 19 | "python-dateutil", 20 | ] 21 | 22 | setup( 23 | name=NAME, 24 | version=VERSION, 25 | description="Payment Requests", 26 | author="OpenAPI Generator community", 27 | author_email="team@openapitools.org", 28 | url="", 29 | keywords=["OpenAPI", "OpenAPI-Generator", "Payment Requests"], 30 | python_requires=">=3.6", 31 | install_requires=REQUIRES, 32 | packages=find_packages(exclude=["test", "tests"]), 33 | include_package_data=True, 34 | long_description="""\ 35 | This API is used for Payment Requests # noqa: E501 36 | """ 37 | ) 38 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest-cov>=2.8.1 2 | -------------------------------------------------------------------------------- /test/.env.test: -------------------------------------------------------------------------------- 1 | IGNORED_ERRORCODE=[INVALID_API_KEY] 2 | -------------------------------------------------------------------------------- /test/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xendit/xendit-python/44fce2945c47a6cddd449984ab4b5a7416f0dae3/test/__init__.py -------------------------------------------------------------------------------- /test/utils/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xendit/xendit-python/44fce2945c47a6cddd449984ab4b5a7416f0dae3/test/utils/__init__.py -------------------------------------------------------------------------------- /test/utils/test_utils.py: -------------------------------------------------------------------------------- 1 | import time 2 | 3 | 4 | class TestUtil: 5 | @staticmethod 6 | def generate_unique_id_for_business(business_id): 7 | return f'{business_id}-{str(int(time.time() * 1000))}' 8 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | pytest --cov=xendit 10 | -------------------------------------------------------------------------------- /xendit/__init__.py: -------------------------------------------------------------------------------- 1 | # flake8: noqa 2 | 3 | """ 4 | The version of the XENDIT API: 1.70.0 5 | """ 6 | 7 | 8 | __version__ = "7.0.0" 9 | 10 | # import ApiClient 11 | from xendit.api_client import ApiClient 12 | 13 | # import Configuration 14 | from xendit.configuration import set_api_key 15 | from xendit.configuration import Configuration 16 | 17 | # import exceptions 18 | from xendit.exceptions import OpenApiException 19 | from xendit.exceptions import ApiAttributeError 20 | from xendit.exceptions import ApiTypeError 21 | from xendit.exceptions import ApiValueError 22 | from xendit.exceptions import ApiKeyError 23 | from xendit.exceptions import XenditSdkException 24 | -------------------------------------------------------------------------------- /xendit/apis/__init__.py: -------------------------------------------------------------------------------- 1 | from xendit.balance_and_transaction.balance_api import BalanceApi 2 | from xendit.balance_and_transaction.transaction_api import TransactionApi 3 | from xendit.customer.customer_api import CustomerApi 4 | from xendit.invoice.invoice_api import InvoiceApi 5 | from xendit.payment_method.payment_method_api import PaymentMethodApi 6 | from xendit.payment_request.payment_request_api import PaymentRequestApi 7 | from xendit.payout.payout_api import PayoutApi 8 | from xendit.refund.refund_api import RefundApi 9 | -------------------------------------------------------------------------------- /xendit/balance_and_transaction/__init__.py: -------------------------------------------------------------------------------- 1 | from xendit.balance_and_transaction.balance_api import BalanceApi 2 | from xendit.balance_and_transaction.transaction_api import TransactionApi 3 | -------------------------------------------------------------------------------- /xendit/balance_and_transaction/model/__init__.py: -------------------------------------------------------------------------------- 1 | # flake8: noqa 2 | 3 | # import all models into this package 4 | # if you have many models here with many references from one model to another this may 5 | # raise a RecursionError 6 | # to avoid this, import only the models that you directly need like: 7 | # from xendit.balance_and_transaction.model.pet import Pet 8 | # or import this package, but before doing it, use: 9 | # import sys 10 | # sys.setrecursionlimit(n) 11 | 12 | from xendit.balance_and_transaction.model.balance import Balance 13 | from xendit.balance_and_transaction.model.channels_categories import ChannelsCategories 14 | from xendit.balance_and_transaction.model.currency import Currency 15 | from xendit.balance_and_transaction.model.date_range_filter import DateRangeFilter 16 | from xendit.balance_and_transaction.model.fee_response import FeeResponse 17 | from xendit.balance_and_transaction.model.link_item import LinkItem 18 | from xendit.balance_and_transaction.model.server_error import ServerError 19 | from xendit.balance_and_transaction.model.transaction_id import TransactionId 20 | from xendit.balance_and_transaction.model.transaction_response import TransactionResponse 21 | from xendit.balance_and_transaction.model.transaction_response_type import TransactionResponseType 22 | from xendit.balance_and_transaction.model.transaction_statuses import TransactionStatuses 23 | from xendit.balance_and_transaction.model.transaction_types import TransactionTypes 24 | from xendit.balance_and_transaction.model.transactions_response import TransactionsResponse 25 | from xendit.balance_and_transaction.model.validation_error import ValidationError 26 | -------------------------------------------------------------------------------- /xendit/customer/__init__.py: -------------------------------------------------------------------------------- 1 | from xendit.customer.customer_api import CustomerApi 2 | -------------------------------------------------------------------------------- /xendit/invoice/__init__.py: -------------------------------------------------------------------------------- 1 | from xendit.invoice.invoice_api import InvoiceApi 2 | -------------------------------------------------------------------------------- /xendit/models/__init__.py: -------------------------------------------------------------------------------- 1 | # models imported to module specific directories 2 | -------------------------------------------------------------------------------- /xendit/payment_method/__init__.py: -------------------------------------------------------------------------------- 1 | from xendit.payment_method.payment_method_api import PaymentMethodApi 2 | -------------------------------------------------------------------------------- /xendit/payment_request/__init__.py: -------------------------------------------------------------------------------- 1 | from xendit.payment_request.payment_request_api import PaymentRequestApi 2 | -------------------------------------------------------------------------------- /xendit/payout/__init__.py: -------------------------------------------------------------------------------- 1 | from xendit.payout.payout_api import PayoutApi 2 | -------------------------------------------------------------------------------- /xendit/payout/model/__init__.py: -------------------------------------------------------------------------------- 1 | # flake8: noqa 2 | 3 | # import all models into this package 4 | # if you have many models here with many references from one model to another this may 5 | # raise a RecursionError 6 | # to avoid this, import only the models that you directly need like: 7 | # from xendit.payout.model.pet import Pet 8 | # or import this package, but before doing it, use: 9 | # import sys 10 | # sys.setrecursionlimit(n) 11 | 12 | from xendit.payout.model.channel import Channel 13 | from xendit.payout.model.channel_account_type import ChannelAccountType 14 | from xendit.payout.model.channel_amount_limits import ChannelAmountLimits 15 | from xendit.payout.model.channel_category import ChannelCategory 16 | from xendit.payout.model.create_payout_request import CreatePayoutRequest 17 | from xendit.payout.model.digital_payout_channel_properties import DigitalPayoutChannelProperties 18 | from xendit.payout.model.error import Error 19 | from xendit.payout.model.error_errors_inner import ErrorErrorsInner 20 | from xendit.payout.model.get_payouts200_response import GetPayouts200Response 21 | from xendit.payout.model.get_payouts200_response_data_inner import GetPayouts200ResponseDataInner 22 | from xendit.payout.model.get_payouts200_response_links import GetPayouts200ResponseLinks 23 | from xendit.payout.model.payout import Payout 24 | from xendit.payout.model.payout_all_of import PayoutAllOf 25 | from xendit.payout.model.receipt_notification import ReceiptNotification 26 | -------------------------------------------------------------------------------- /xendit/refund/__init__.py: -------------------------------------------------------------------------------- 1 | from xendit.refund.refund_api import RefundApi 2 | -------------------------------------------------------------------------------- /xendit/refund/model/__init__.py: -------------------------------------------------------------------------------- 1 | # flake8: noqa 2 | 3 | # import all models into this package 4 | # if you have many models here with many references from one model to another this may 5 | # raise a RecursionError 6 | # to avoid this, import only the models that you directly need like: 7 | # from xendit.refund.model.pet import Pet 8 | # or import this package, but before doing it, use: 9 | # import sys 10 | # sys.setrecursionlimit(n) 11 | 12 | from xendit.refund.model.create_refund import CreateRefund 13 | from xendit.refund.model.create_refund400_response import CreateRefund400Response 14 | from xendit.refund.model.create_refund403_response import CreateRefund403Response 15 | from xendit.refund.model.create_refund404_response import CreateRefund404Response 16 | from xendit.refund.model.create_refund409_response import CreateRefund409Response 17 | from xendit.refund.model.create_refund503_response import CreateRefund503Response 18 | from xendit.refund.model.get_all_refunds_default_response import GetAllRefundsDefaultResponse 19 | from xendit.refund.model.refund import Refund 20 | from xendit.refund.model.refund_callback import RefundCallback 21 | from xendit.refund.model.refund_callback_data import RefundCallbackData 22 | from xendit.refund.model.refund_list import RefundList 23 | --------------------------------------------------------------------------------