From c76c5be2185945e16ee4d27625f17bee426e37f9 Mon Sep 17 00:00:00 2001 From: xendit-devx-bot Date: Mon, 6 Nov 2023 05:00:53 +0000 Subject: [PATCH] Generated Xendit python SDK --- .github/workflows/generate-release-tag.yml | 11 + .openapi-generator/FILES | 131 ++-- README.md | 4 +- docs/AccountBank.md | 17 - docs/AccountCard.md | 12 - docs/AccountEwallet.md | 14 - docs/AccountOTC.md | 13 - docs/AccountPayLater.md | 14 - docs/AccountQRCode.md | 12 - docs/Address.md | 24 - docs/AddressObject.md | 19 - docs/AddressRequest.md | 21 - docs/AddressStatus.md | 13 - docs/AlternativeDisplayItem.md | 14 - docs/BadRequestError.md | 14 - docs/Balance.md | 13 - docs/BalanceApi.md | 71 ++- docs/Bank.md | 19 - docs/BankCode.md | 14 - docs/BillingInformation.md | 18 - docs/BusinessDetail.md | 16 - docs/Capture.md | 26 - docs/CaptureList.md | 12 - docs/CaptureListResponse.md | 13 - docs/CaptureParameters.md | 13 - docs/Card.md | 15 - docs/CardChannelProperties.md | 17 - docs/CardInformation.md | 22 - docs/CardParameters.md | 14 - docs/CardParametersCardInformation.md | 17 - docs/CardVerificationResults.md | 14 - docs/CardVerificationResultsThreeDSecure.md | 16 - docs/Channel.md | 17 - docs/ChannelAccountType.md | 14 - docs/ChannelAmountLimits.md | 15 - docs/ChannelCategory.md | 14 - docs/ChannelsCategories.md | 13 - docs/CountryCode.md | 13 - docs/CreateCustomer400Response.md | 14 - docs/CreateCustomer400ResponseAllOf.md | 13 - docs/CreateInvoiceRequest.md | 32 - docs/CreatePaymentMethod409Response.md | 13 - docs/CreatePaymentMethod503Response.md | 13 - docs/CreatePayoutRequest.md | 20 - docs/CreateRefund.md | 18 - docs/CreateRefund400Response.md | 13 - docs/CreateRefund403Response.md | 13 - docs/CreateRefund404Response.md | 13 - docs/CreateRefund409Response.md | 13 - docs/CreateRefund503Response.md | 13 - docs/Currency.md | 13 - docs/Customer.md | 27 - docs/CustomerApi.md | 338 ++++++---- docs/CustomerObject.md | 20 - docs/CustomerRequest.md | 24 - docs/DateRangeFilter.md | 13 - docs/DigitalPayoutChannelProperties.md | 15 - docs/DirectDebit.md | 17 - docs/DirectDebitAllOf.md | 14 - docs/DirectDebitBankAccount.md | 13 - docs/DirectDebitChannelCode.md | 14 - docs/DirectDebitChannelProperties.md | 19 - ...DirectDebitChannelPropertiesBankAccount.md | 16 - ...irectDebitChannelPropertiesBankRedirect.md | 15 - docs/DirectDebitChannelPropertiesDebitCard.md | 17 - docs/DirectDebitDebitCard.md | 16 - docs/DirectDebitParameters.md | 14 - docs/DirectDebitType.md | 13 - docs/EWallet.md | 15 - docs/EWalletAccount.md | 16 - docs/EWalletAllOf.md | 12 - docs/EWalletChannelCode.md | 14 - docs/EWalletChannelProperties.md | 18 - docs/EWalletParameters.md | 13 - docs/EmploymentDetail.md | 14 - docs/EndCustomerStatus.md | 13 - docs/Error.md | 13 - docs/ErrorErrorsInner.md | 13 - docs/Ewallet.md | 13 - docs/EwalletType.md | 14 - docs/FeeResponse.md | 16 - docs/ForbiddenError.md | 14 - docs/GetAllPaymentMethods400Response.md | 13 - docs/GetAllPaymentMethods403Response.md | 13 - docs/GetAllPaymentMethods404Response.md | 13 - docs/GetAllPaymentMethodsDefaultResponse.md | 13 - docs/GetAllRefundsDefaultResponse.md | 13 - docs/GetCustomerByReferenceID200Response.md | 13 - docs/GetCustomerByReferenceID400Response.md | 14 - ...etCustomerByReferenceID400ResponseAllOf.md | 13 - docs/GetPayouts200Response.md | 14 - docs/GetPayouts200ResponseDataInner.md | 26 - docs/GetPayouts200ResponseLinks.md | 14 - docs/IdentityAccountRequest.md | 16 - docs/IdentityAccountRequestProperties.md | 22 - docs/IdentityAccountResponse.md | 20 - docs/IdentityAccountResponseProperties.md | 22 - docs/IdentityAccountType.md | 13 - docs/IndividualDetail.md | 22 - docs/Invoice.md | 45 -- docs/InvoiceApi.md | 251 ++++---- docs/InvoiceClientType.md | 14 - docs/InvoiceCurrency.md | 14 - docs/InvoiceError404ResponseDefinition.md | 14 - docs/InvoiceFee.md | 14 - docs/InvoiceItem.md | 18 - docs/InvoiceNotFoundError.md | 14 - docs/InvoicePaymentMethod.md | 14 - docs/InvoiceStatus.md | 14 - docs/KYCDocumentRequest.md | 19 - docs/KYCDocumentResponse.md | 19 - docs/KYCDocumentSubType.md | 13 - docs/KYCDocumentType.md | 13 - docs/LinkItem.md | 14 - docs/NotificationChannel.md | 14 - docs/NotificationPreference.md | 16 - docs/OverTheCounter.md | 16 - docs/OverTheCounterChannelCode.md | 14 - docs/OverTheCounterChannelProperties.md | 15 - docs/OverTheCounterChannelPropertiesUpdate.md | 14 - docs/OverTheCounterParameters.md | 15 - docs/OverTheCounterUpdateParameters.md | 13 - docs/PatchCustomer.md | 24 - docs/Paylater.md | 14 - docs/PaylaterType.md | 14 - docs/PaymentMethod.md | 26 - docs/PaymentMethodAction.md | 15 - docs/PaymentMethodApi.md | 593 ++++++++++-------- docs/PaymentMethodAuthParameters.md | 12 - docs/PaymentMethodCountry.md | 13 - docs/PaymentMethodExpireParameters.md | 13 - docs/PaymentMethodList.md | 13 - docs/PaymentMethodParameters.md | 20 - docs/PaymentMethodReusability.md | 13 - docs/PaymentMethodStatus.md | 13 - docs/PaymentMethodType.md | 13 - docs/PaymentMethodUpdateParameters.md | 17 - docs/PaymentRequest.md | 34 - docs/PaymentRequestAction.md | 16 - docs/PaymentRequestApi.md | 554 ++++++++++------ docs/PaymentRequestAuthParameters.md | 12 - docs/PaymentRequestBasket.md | 12 - docs/PaymentRequestBasketItem.md | 24 - docs/PaymentRequestCaptureMethod.md | 13 - docs/PaymentRequestCardVerificationResults.md | 14 - ...stCardVerificationResultsThreeDeeSecure.md | 16 - docs/PaymentRequestChannelProperties.md | 18 - docs/PaymentRequestCountry.md | 13 - docs/PaymentRequestCurrency.md | 13 - docs/PaymentRequestInitiator.md | 13 - docs/PaymentRequestListResponse.md | 13 - docs/PaymentRequestParameters.md | 25 - ...ymentRequestParametersChannelProperties.md | 19 - ...RequestParametersChannelPropertiesAllOf.md | 12 - docs/PaymentRequestShippingInformation.md | 17 - docs/PaymentRequestStatus.md | 13 - docs/Payout.md | 26 - docs/PayoutAllOf.md | 18 - docs/PayoutApi.md | 270 ++++---- docs/QRCode.md | 14 - docs/QRCodeChannelCode.md | 14 - docs/QRCodeChannelProperties.md | 14 - docs/QRCodeParameters.md | 13 - docs/QrCode.md | 13 - docs/QrCodeType.md | 14 - docs/ReceiptNotification.md | 15 - docs/Refund.md | 23 - docs/RefundApi.md | 235 ++++--- docs/RefundList.md | 13 - docs/ResponseDataNotFound.md | 13 - docs/RetailOutlet.md | 16 - docs/RetailOutletName.md | 14 - docs/ServerError.md | 13 - docs/SimulatePaymentRequest.md | 12 - docs/TokenizedCardInformation.md | 22 - docs/TransactionApi.md | 165 ++--- docs/TransactionId.md | 13 - docs/TransactionResponse.md | 28 - docs/TransactionResponseType.md | 12 - docs/TransactionStatuses.md | 13 - docs/TransactionTypes.md | 13 - docs/TransactionsResponse.md | 15 - docs/UnauthorizedError.md | 14 - docs/UpdateCustomer400Response.md | 14 - docs/UpdateCustomer400ResponseAllOf.md | 13 - docs/ValidationError.md | 15 - docs/VirtualAccount.md | 20 - docs/VirtualAccountAllOf.md | 12 - docs/VirtualAccountAlternativeDisplay.md | 14 - docs/VirtualAccountChannelCode.md | 14 - docs/VirtualAccountChannelProperties.md | 16 - docs/VirtualAccountChannelPropertiesPatch.md | 14 - docs/VirtualAccountParameters.md | 18 - docs/VirtualAccountUpdateParameters.md | 16 - docs/balance_and_transaction/Balance.md | 14 + .../ChannelsCategories.md | 43 ++ docs/balance_and_transaction/Currency.md | 339 ++++++++++ .../DateRangeFilter.md | 14 + docs/balance_and_transaction/FeeResponse.md | 17 + docs/balance_and_transaction/LinkItem.md | 15 + docs/balance_and_transaction/ServerError.md | 15 + docs/balance_and_transaction/TransactionId.md | 14 + .../TransactionResponse.md | 29 + .../TransactionResponseType.md | 13 + .../TransactionStatuses.md | 25 + .../TransactionTypes.md | 41 ++ .../TransactionsResponse.md | 16 + .../ValidationError.md | 16 + docs/customer/AccountBank.md | 18 + docs/customer/AccountCard.md | 13 + docs/customer/AccountEwallet.md | 15 + docs/customer/AccountOTC.md | 14 + docs/customer/AccountPayLater.md | 15 + docs/customer/AccountQRCode.md | 13 + docs/customer/Address.md | 25 + docs/customer/AddressRequest.md | 22 + docs/customer/AddressStatus.md | 19 + docs/customer/BusinessDetail.md | 17 + docs/customer/CountryCode.md | 14 + docs/customer/CreateCustomer400Response.md | 15 + .../CreateCustomer400ResponseAllOf.md | 14 + docs/customer/Customer.md | 28 + docs/customer/CustomerRequest.md | 25 + docs/customer/EmploymentDetail.md | 15 + docs/customer/EndCustomerStatus.md | 25 + docs/customer/Error.md | 15 + .../GetCustomerByReferenceID200Response.md | 14 + .../GetCustomerByReferenceID400Response.md | 15 + ...etCustomerByReferenceID400ResponseAllOf.md | 14 + docs/customer/IdentityAccountRequest.md | 17 + .../IdentityAccountRequestProperties.md | 23 + docs/customer/IdentityAccountResponse.md | 21 + .../IdentityAccountResponseProperties.md | 23 + docs/customer/IdentityAccountType.md | 27 + docs/customer/IndividualDetail.md | 23 + docs/customer/KYCDocumentRequest.md | 20 + docs/customer/KYCDocumentResponse.md | 20 + docs/customer/KYCDocumentSubType.md | 35 ++ docs/customer/KYCDocumentType.md | 31 + docs/customer/PatchCustomer.md | 25 + docs/customer/ResponseDataNotFound.md | 14 + docs/customer/UpdateCustomer400Response.md | 15 + .../UpdateCustomer400ResponseAllOf.md | 14 + docs/invoice/AddressObject.md | 20 + docs/invoice/AlternativeDisplayItem.md | 15 + docs/invoice/BadRequestError.md | 15 + docs/invoice/Bank.md | 20 + docs/invoice/BankCode.md | 36 ++ docs/invoice/CreateInvoiceRequest.md | 33 + docs/invoice/CustomerObject.md | 21 + docs/invoice/DirectDebit.md | 14 + docs/invoice/DirectDebitType.md | 54 ++ docs/invoice/Ewallet.md | 14 + docs/invoice/EwalletType.md | 36 ++ docs/invoice/ForbiddenError.md | 15 + docs/invoice/Invoice.md | 46 ++ docs/invoice/InvoiceClientType.md | 28 + docs/invoice/InvoiceCurrency.md | 26 + .../InvoiceError404ResponseDefinition.md | 15 + docs/invoice/InvoiceFee.md | 15 + docs/invoice/InvoiceItem.md | 19 + docs/invoice/InvoiceNotFoundError.md | 15 + docs/invoice/InvoicePaymentMethod.md | 36 ++ docs/invoice/InvoiceStatus.md | 24 + docs/invoice/NotificationChannel.md | 24 + docs/invoice/NotificationPreference.md | 17 + docs/invoice/Paylater.md | 15 + docs/invoice/PaylaterType.md | 28 + docs/invoice/QrCode.md | 14 + docs/invoice/QrCodeType.md | 20 + docs/invoice/RetailOutlet.md | 17 + docs/invoice/RetailOutletName.md | 34 + docs/invoice/ServerError.md | 14 + docs/invoice/UnauthorizedError.md | 15 + docs/payment_method/BillingInformation.md | 19 + docs/payment_method/Card.md | 17 + docs/payment_method/CardChannelProperties.md | 17 + docs/payment_method/CardParameters.md | 15 + .../CardParametersCardInformation.md | 18 + .../payment_method/CardVerificationResults.md | 15 + .../CardVerificationResultsThreeDSecure.md | 17 + .../CreatePaymentMethod409Response.md | 14 + .../CreatePaymentMethod503Response.md | 14 + docs/payment_method/DirectDebit.md | 18 + docs/payment_method/DirectDebitAllOf.md | 15 + docs/payment_method/DirectDebitBankAccount.md | 16 + docs/payment_method/DirectDebitChannelCode.md | 142 +++++ .../DirectDebitChannelProperties.md | 22 + docs/payment_method/DirectDebitDebitCard.md | 17 + docs/payment_method/DirectDebitParameters.md | 14 + docs/payment_method/DirectDebitType.md | 21 + docs/payment_method/EWallet.md | 16 + docs/payment_method/EWalletAccount.md | 17 + docs/payment_method/EWalletChannelCode.md | 58 ++ .../EWalletChannelProperties.md | 19 + docs/payment_method/EWalletParameters.md | 15 + .../GetAllPaymentMethods400Response.md | 14 + .../GetAllPaymentMethods403Response.md | 14 + .../GetAllPaymentMethods404Response.md | 14 + .../GetAllPaymentMethodsDefaultResponse.md | 14 + docs/payment_method/OverTheCounter.md | 17 + .../OverTheCounterChannelCode.md | 48 ++ .../OverTheCounterChannelProperties.md | 16 + .../OverTheCounterChannelPropertiesUpdate.md | 15 + .../OverTheCounterParameters.md | 16 + .../OverTheCounterUpdateParameters.md | 14 + docs/payment_method/PaymentMethod.md | 34 + docs/payment_method/PaymentMethodAction.md | 16 + .../PaymentMethodAuthParameters.md | 13 + docs/payment_method/PaymentMethodCountry.md | 27 + .../PaymentMethodExpireParameters.md | 14 + docs/payment_method/PaymentMethodList.md | 14 + .../payment_method/PaymentMethodParameters.md | 26 + .../PaymentMethodReusability.md | 19 + docs/payment_method/PaymentMethodStatus.md | 27 + docs/payment_method/PaymentMethodType.md | 31 + .../PaymentMethodUpdateParameters.md | 18 + docs/payment_method/QRCode.md | 17 + docs/payment_method/QRCodeChannelCode.md | 26 + .../payment_method/QRCodeChannelProperties.md | 15 + docs/payment_method/QRCodeParameters.md | 16 + docs/payment_method/SimulatePaymentRequest.md | 13 + .../TokenizedCardInformation.md | 23 + docs/payment_method/VirtualAccount.md | 21 + docs/payment_method/VirtualAccountAllOf.md | 13 + .../VirtualAccountAlternativeDisplay.md | 15 + .../VirtualAccountChannelCode.md | 48 ++ .../VirtualAccountChannelProperties.md | 17 + .../VirtualAccountChannelPropertiesPatch.md | 15 + .../VirtualAccountParameters.md | 19 + .../VirtualAccountUpdateParameters.md | 17 + docs/payment_request/Capture.md | 27 + docs/payment_request/CaptureList.md | 13 + docs/payment_request/CaptureListResponse.md | 14 + docs/payment_request/CaptureParameters.md | 14 + docs/payment_request/Card.md | 16 + docs/payment_request/CardChannelProperties.md | 18 + docs/payment_request/CardInformation.md | 23 + .../CardVerificationResults.md | 15 + .../CardVerificationResultsThreeDSecure.md | 17 + docs/payment_request/DirectDebit.md | 18 + docs/payment_request/DirectDebitAllOf.md | 15 + .../payment_request/DirectDebitBankAccount.md | 14 + .../payment_request/DirectDebitChannelCode.md | 142 +++++ .../DirectDebitChannelProperties.md | 20 + ...DirectDebitChannelPropertiesBankAccount.md | 17 + ...irectDebitChannelPropertiesBankRedirect.md | 16 + .../DirectDebitChannelPropertiesDebitCard.md | 18 + docs/payment_request/DirectDebitDebitCard.md | 17 + docs/payment_request/DirectDebitParameters.md | 15 + docs/payment_request/DirectDebitType.md | 21 + docs/payment_request/EWallet.md | 16 + docs/payment_request/EWalletAccount.md | 17 + docs/payment_request/EWalletAllOf.md | 13 + docs/payment_request/EWalletChannelCode.md | 56 ++ .../EWalletChannelProperties.md | 19 + docs/payment_request/EWalletParameters.md | 14 + docs/payment_request/Error.md | 14 + docs/payment_request/OverTheCounter.md | 17 + .../OverTheCounterChannelCode.md | 48 ++ .../OverTheCounterChannelProperties.md | 16 + .../OverTheCounterParameters.md | 16 + docs/payment_request/PaymentMethod.md | 27 + .../PaymentMethodParameters.md | 21 + .../PaymentMethodReusability.md | 19 + docs/payment_request/PaymentMethodStatus.md | 25 + docs/payment_request/PaymentMethodType.md | 27 + docs/payment_request/PaymentRequest.md | 35 ++ docs/payment_request/PaymentRequestAction.md | 17 + .../PaymentRequestAuthParameters.md | 13 + docs/payment_request/PaymentRequestBasket.md | 13 + .../PaymentRequestBasketItem.md | 25 + .../PaymentRequestCaptureMethod.md | 19 + .../PaymentRequestCardVerificationResults.md | 15 + ...stCardVerificationResultsThreeDeeSecure.md | 17 + .../PaymentRequestChannelProperties.md | 19 + docs/payment_request/PaymentRequestCountry.md | 25 + .../payment_request/PaymentRequestCurrency.md | 27 + .../PaymentRequestInitiator.md | 19 + .../PaymentRequestListResponse.md | 14 + .../PaymentRequestParameters.md | 26 + ...ymentRequestParametersChannelProperties.md | 20 + ...RequestParametersChannelPropertiesAllOf.md | 13 + .../PaymentRequestShippingInformation.md | 18 + docs/payment_request/PaymentRequestStatus.md | 31 + docs/payment_request/QRCode.md | 15 + docs/payment_request/QRCodeChannelCode.md | 24 + .../QRCodeChannelProperties.md | 15 + docs/payment_request/QRCodeParameters.md | 14 + docs/payment_request/VirtualAccount.md | 21 + docs/payment_request/VirtualAccountAllOf.md | 13 + .../VirtualAccountAlternativeDisplay.md | 15 + .../VirtualAccountChannelCode.md | 48 ++ .../VirtualAccountChannelProperties.md | 17 + .../VirtualAccountParameters.md | 19 + docs/payout/Channel.md | 18 + docs/payout/ChannelAccountType.md | 26 + docs/payout/ChannelAmountLimits.md | 16 + docs/payout/ChannelCategory.md | 22 + docs/payout/CreatePayoutRequest.md | 21 + docs/payout/DigitalPayoutChannelProperties.md | 16 + docs/payout/Error.md | 15 + docs/payout/ErrorErrorsInner.md | 14 + docs/payout/GetPayouts200Response.md | 15 + docs/payout/GetPayouts200ResponseDataInner.md | 27 + docs/payout/GetPayouts200ResponseLinks.md | 15 + docs/payout/Payout.md | 27 + docs/payout/PayoutAllOf.md | 19 + docs/payout/ReceiptNotification.md | 16 + docs/refund/CreateRefund.md | 19 + docs/refund/CreateRefund400Response.md | 14 + docs/refund/CreateRefund403Response.md | 14 + docs/refund/CreateRefund404Response.md | 14 + docs/refund/CreateRefund409Response.md | 14 + docs/refund/CreateRefund503Response.md | 14 + docs/refund/GetAllRefundsDefaultResponse.md | 14 + docs/refund/Refund.md | 24 + docs/refund/RefundList.md | 14 + {docs => images}/header.jpg | Bin pyproject.toml | 34 + setup.py | 4 +- test/test_balance.py | 2 +- test/test_balance_api.py | 2 +- test/test_billing_information.py | 2 +- test/test_capture.py | 2 +- test/test_capture_list.py | 2 +- test/test_capture_list_response.py | 2 +- test/test_capture_parameters.py | 2 +- test/test_card.py | 2 +- test/test_card_channel_properties.py | 2 +- test/test_card_information.py | 2 +- test/test_card_parameters.py | 2 +- test/test_card_parameters_card_information.py | 2 +- test/test_card_verification_results.py | 2 +- ...ard_verification_results_three_d_secure.py | 2 +- test/test_channels_categories.py | 2 +- .../test_create_payment_method409_response.py | 2 +- .../test_create_payment_method503_response.py | 2 +- test/test_currency.py | 2 +- test/test_date_range_filter.py | 2 +- test/test_direct_debit_all_of.py | 2 +- test/test_direct_debit_bank_account.py | 2 +- test/test_direct_debit_channel_code.py | 2 +- test/test_direct_debit_channel_properties.py | 2 +- ...t_debit_channel_properties_bank_account.py | 2 +- ..._debit_channel_properties_bank_redirect.py | 2 +- ...ect_debit_channel_properties_debit_card.py | 2 +- test/test_direct_debit_debit_card.py | 2 +- test/test_direct_debit_parameters.py | 2 +- test/test_e_wallet.py | 2 +- test/test_e_wallet_account.py | 2 +- test/test_e_wallet_all_of.py | 2 +- test/test_e_wallet_channel_code.py | 2 +- test/test_e_wallet_channel_properties.py | 2 +- test/test_e_wallet_parameters.py | 2 +- test/test_fee_response.py | 2 +- ...est_get_all_payment_methods400_response.py | 2 +- ...est_get_all_payment_methods403_response.py | 2 +- ...est_get_all_payment_methods404_response.py | 2 +- ...et_all_payment_methods_default_response.py | 2 +- test/test_link_item.py | 2 +- test/test_over_the_counter.py | 2 +- test/test_over_the_counter_channel_code.py | 2 +- ...est_over_the_counter_channel_properties.py | 2 +- ...r_the_counter_channel_properties_update.py | 2 +- test/test_over_the_counter_parameters.py | 2 +- ...test_over_the_counter_update_parameters.py | 2 +- test/test_payment_method.py | 2 +- test/test_payment_method_action.py | 2 +- test/test_payment_method_api.py | 2 +- test/test_payment_method_auth_parameters.py | 2 +- test/test_payment_method_country.py | 2 +- test/test_payment_method_expire_parameters.py | 2 +- test/test_payment_method_list.py | 2 +- test/test_payment_method_parameters.py | 2 +- test/test_payment_method_reusability.py | 2 +- test/test_payment_method_status.py | 2 +- test/test_payment_method_type.py | 2 +- test/test_payment_method_update_parameters.py | 2 +- test/test_payment_request.py | 2 +- test/test_payment_request_action.py | 2 +- test/test_payment_request_api.py | 2 +- test/test_payment_request_auth_parameters.py | 2 +- test/test_payment_request_basket.py | 2 +- test/test_payment_request_basket_item.py | 2 +- test/test_payment_request_capture_method.py | 2 +- ...yment_request_card_verification_results.py | 2 +- ...d_verification_results_three_dee_secure.py | 2 +- ...test_payment_request_channel_properties.py | 2 +- test/test_payment_request_country.py | 2 +- test/test_payment_request_currency.py | 2 +- test/test_payment_request_initiator.py | 2 +- test/test_payment_request_list_response.py | 2 +- test/test_payment_request_parameters.py | 2 +- ...t_request_parameters_channel_properties.py | 2 +- ...st_parameters_channel_properties_all_of.py | 2 +- ...st_payment_request_shipping_information.py | 2 +- test/test_payment_request_status.py | 2 +- test/test_qr_code_channel_code.py | 2 +- test/test_qr_code_channel_properties.py | 2 +- test/test_qr_code_parameters.py | 2 +- test/test_server_error.py | 2 +- test/test_simulate_payment_request.py | 2 +- test/test_tokenized_card_information.py | 2 +- test/test_transaction_api.py | 2 +- test/test_transaction_id.py | 2 +- test/test_transaction_response.py | 2 +- test/test_transaction_response_type.py | 2 +- test/test_transaction_statuses.py | 2 +- test/test_transaction_types.py | 2 +- test/test_transactions_response.py | 2 +- test/test_validation_error.py | 2 +- test/test_virtual_account.py | 2 +- test/test_virtual_account_all_of.py | 2 +- ...est_virtual_account_alternative_display.py | 2 +- test/test_virtual_account_channel_code.py | 2 +- ...test_virtual_account_channel_properties.py | 2 +- ...irtual_account_channel_properties_patch.py | 2 +- test/test_virtual_account_parameters.py | 2 +- .../test_virtual_account_update_parameters.py | 2 +- xendit/__init__.py | 4 +- xendit/api_client.py | 6 +- xendit/balance_and_transaction/balance_api.py | 2 +- .../balance_and_transaction/model/balance.py | 2 +- .../model/channels_categories.py | 2 +- .../balance_and_transaction/model/currency.py | 2 +- .../model/date_range_filter.py | 2 +- .../model/fee_response.py | 2 +- .../model/link_item.py | 2 +- .../model/server_error.py | 2 +- .../model/transaction_id.py | 2 +- .../model/transaction_response.py | 2 +- .../model/transaction_response_type.py | 2 +- .../model/transaction_statuses.py | 2 +- .../model/transaction_types.py | 2 +- .../model/transactions_response.py | 2 +- .../model/validation_error.py | 2 +- .../transaction_api.py | 2 +- xendit/configuration.py | 4 +- xendit/exceptions.py | 2 +- xendit/model_utils.py | 2 +- .../model/billing_information.py | 2 +- xendit/payment_method/model/card.py | 2 +- .../model/card_channel_properties.py | 2 +- .../payment_method/model/card_parameters.py | 2 +- .../model/card_parameters_card_information.py | 2 +- .../model/card_verification_results.py | 2 +- ...ard_verification_results_three_d_secure.py | 2 +- .../create_payment_method409_response.py | 2 +- .../create_payment_method503_response.py | 2 +- xendit/payment_method/model/direct_debit.py | 2 +- .../model/direct_debit_all_of.py | 2 +- .../model/direct_debit_bank_account.py | 2 +- .../model/direct_debit_channel_code.py | 2 +- .../model/direct_debit_channel_properties.py | 9 +- .../model/direct_debit_debit_card.py | 9 +- .../model/direct_debit_parameters.py | 2 +- .../payment_method/model/direct_debit_type.py | 2 +- xendit/payment_method/model/e_wallet.py | 2 +- .../payment_method/model/e_wallet_account.py | 2 +- .../model/e_wallet_channel_code.py | 11 +- .../model/e_wallet_channel_properties.py | 2 +- .../model/e_wallet_parameters.py | 2 +- .../get_all_payment_methods400_response.py | 2 +- .../get_all_payment_methods403_response.py | 2 +- .../get_all_payment_methods404_response.py | 2 +- ...et_all_payment_methods_default_response.py | 2 +- .../payment_method/model/over_the_counter.py | 2 +- .../model/over_the_counter_channel_code.py | 2 +- .../over_the_counter_channel_properties.py | 2 +- ...r_the_counter_channel_properties_update.py | 2 +- .../model/over_the_counter_parameters.py | 2 +- .../over_the_counter_update_parameters.py | 2 +- xendit/payment_method/model/payment_method.py | 2 +- .../model/payment_method_action.py | 2 +- .../model/payment_method_auth_parameters.py | 2 +- .../model/payment_method_country.py | 11 +- .../model/payment_method_expire_parameters.py | 2 +- .../model/payment_method_list.py | 2 +- .../model/payment_method_parameters.py | 2 +- .../model/payment_method_reusability.py | 2 +- .../model/payment_method_status.py | 2 +- .../model/payment_method_type.py | 2 +- .../model/payment_method_update_parameters.py | 2 +- xendit/payment_method/model/qr_code.py | 2 +- .../model/qr_code_channel_code.py | 2 +- .../model/qr_code_channel_properties.py | 2 +- .../model/qr_code_parameters.py | 2 +- .../model/simulate_payment_request.py | 2 +- .../model/tokenized_card_information.py | 2 +- .../payment_method/model/virtual_account.py | 2 +- .../model/virtual_account_all_of.py | 2 +- .../virtual_account_alternative_display.py | 2 +- .../model/virtual_account_channel_code.py | 11 +- .../virtual_account_channel_properties.py | 2 +- ...irtual_account_channel_properties_patch.py | 2 +- .../model/virtual_account_parameters.py | 2 +- .../virtual_account_update_parameters.py | 2 +- xendit/payment_method/payment_method_api.py | 2 +- xendit/payment_request/model/capture.py | 2 +- xendit/payment_request/model/capture_list.py | 2 +- .../model/capture_list_response.py | 2 +- .../model/capture_parameters.py | 2 +- xendit/payment_request/model/card.py | 2 +- .../model/card_channel_properties.py | 2 +- .../payment_request/model/card_information.py | 2 +- .../model/card_verification_results.py | 2 +- ...ard_verification_results_three_d_secure.py | 2 +- xendit/payment_request/model/direct_debit.py | 2 +- .../model/direct_debit_all_of.py | 2 +- .../model/direct_debit_bank_account.py | 2 +- .../model/direct_debit_channel_code.py | 2 +- .../model/direct_debit_channel_properties.py | 2 +- ...t_debit_channel_properties_bank_account.py | 2 +- ..._debit_channel_properties_bank_redirect.py | 2 +- ...ect_debit_channel_properties_debit_card.py | 2 +- .../model/direct_debit_debit_card.py | 2 +- .../model/direct_debit_parameters.py | 2 +- .../model/direct_debit_type.py | 2 +- xendit/payment_request/model/e_wallet.py | 2 +- .../payment_request/model/e_wallet_account.py | 2 +- .../payment_request/model/e_wallet_all_of.py | 2 +- .../model/e_wallet_channel_code.py | 11 +- .../model/e_wallet_channel_properties.py | 2 +- .../model/e_wallet_parameters.py | 2 +- xendit/payment_request/model/error.py | 2 +- .../payment_request/model/over_the_counter.py | 2 +- .../model/over_the_counter_channel_code.py | 2 +- .../over_the_counter_channel_properties.py | 2 +- .../model/over_the_counter_parameters.py | 2 +- .../payment_request/model/payment_method.py | 2 +- .../model/payment_method_parameters.py | 2 +- .../model/payment_method_reusability.py | 2 +- .../model/payment_method_status.py | 2 +- .../model/payment_method_type.py | 2 +- .../payment_request/model/payment_request.py | 2 +- .../model/payment_request_action.py | 2 +- .../model/payment_request_auth_parameters.py | 2 +- .../model/payment_request_basket.py | 2 +- .../model/payment_request_basket_item.py | 2 +- .../model/payment_request_capture_method.py | 2 +- ...yment_request_card_verification_results.py | 2 +- ...d_verification_results_three_dee_secure.py | 2 +- .../payment_request_channel_properties.py | 2 +- .../model/payment_request_country.py | 2 +- .../model/payment_request_currency.py | 11 +- .../model/payment_request_initiator.py | 2 +- .../model/payment_request_list_response.py | 2 +- .../model/payment_request_parameters.py | 2 +- ...t_request_parameters_channel_properties.py | 2 +- ...st_parameters_channel_properties_all_of.py | 2 +- .../payment_request_shipping_information.py | 2 +- .../model/payment_request_status.py | 2 +- xendit/payment_request/model/qr_code.py | 2 +- .../model/qr_code_channel_code.py | 2 +- .../model/qr_code_channel_properties.py | 2 +- .../model/qr_code_parameters.py | 2 +- .../payment_request/model/virtual_account.py | 2 +- .../model/virtual_account_all_of.py | 2 +- .../virtual_account_alternative_display.py | 2 +- .../model/virtual_account_channel_code.py | 11 +- .../virtual_account_channel_properties.py | 2 +- .../model/virtual_account_parameters.py | 2 +- xendit/payment_request/payment_request_api.py | 2 +- xendit/rest.py | 2 +- 665 files changed, 6835 insertions(+), 4317 deletions(-) delete mode 100644 docs/AccountBank.md delete mode 100644 docs/AccountCard.md delete mode 100644 docs/AccountEwallet.md delete mode 100644 docs/AccountOTC.md delete mode 100644 docs/AccountPayLater.md delete mode 100644 docs/AccountQRCode.md delete mode 100644 docs/Address.md delete mode 100644 docs/AddressObject.md delete mode 100644 docs/AddressRequest.md delete mode 100644 docs/AddressStatus.md delete mode 100644 docs/AlternativeDisplayItem.md delete mode 100644 docs/BadRequestError.md delete mode 100644 docs/Balance.md delete mode 100644 docs/Bank.md delete mode 100644 docs/BankCode.md delete mode 100644 docs/BillingInformation.md delete mode 100644 docs/BusinessDetail.md delete mode 100644 docs/Capture.md delete mode 100644 docs/CaptureList.md delete mode 100644 docs/CaptureListResponse.md delete mode 100644 docs/CaptureParameters.md delete mode 100644 docs/Card.md delete mode 100644 docs/CardChannelProperties.md delete mode 100644 docs/CardInformation.md delete mode 100644 docs/CardParameters.md delete mode 100644 docs/CardParametersCardInformation.md delete mode 100644 docs/CardVerificationResults.md delete mode 100644 docs/CardVerificationResultsThreeDSecure.md delete mode 100644 docs/Channel.md delete mode 100644 docs/ChannelAccountType.md delete mode 100644 docs/ChannelAmountLimits.md delete mode 100644 docs/ChannelCategory.md delete mode 100644 docs/ChannelsCategories.md delete mode 100644 docs/CountryCode.md delete mode 100644 docs/CreateCustomer400Response.md delete mode 100644 docs/CreateCustomer400ResponseAllOf.md delete mode 100644 docs/CreateInvoiceRequest.md delete mode 100644 docs/CreatePaymentMethod409Response.md delete mode 100644 docs/CreatePaymentMethod503Response.md delete mode 100644 docs/CreatePayoutRequest.md delete mode 100644 docs/CreateRefund.md delete mode 100644 docs/CreateRefund400Response.md delete mode 100644 docs/CreateRefund403Response.md delete mode 100644 docs/CreateRefund404Response.md delete mode 100644 docs/CreateRefund409Response.md delete mode 100644 docs/CreateRefund503Response.md delete mode 100644 docs/Currency.md delete mode 100644 docs/Customer.md delete mode 100644 docs/CustomerObject.md delete mode 100644 docs/CustomerRequest.md delete mode 100644 docs/DateRangeFilter.md delete mode 100644 docs/DigitalPayoutChannelProperties.md delete mode 100644 docs/DirectDebit.md delete mode 100644 docs/DirectDebitAllOf.md delete mode 100644 docs/DirectDebitBankAccount.md delete mode 100644 docs/DirectDebitChannelCode.md delete mode 100644 docs/DirectDebitChannelProperties.md delete mode 100644 docs/DirectDebitChannelPropertiesBankAccount.md delete mode 100644 docs/DirectDebitChannelPropertiesBankRedirect.md delete mode 100644 docs/DirectDebitChannelPropertiesDebitCard.md delete mode 100644 docs/DirectDebitDebitCard.md delete mode 100644 docs/DirectDebitParameters.md delete mode 100644 docs/DirectDebitType.md delete mode 100644 docs/EWallet.md delete mode 100644 docs/EWalletAccount.md delete mode 100644 docs/EWalletAllOf.md delete mode 100644 docs/EWalletChannelCode.md delete mode 100644 docs/EWalletChannelProperties.md delete mode 100644 docs/EWalletParameters.md delete mode 100644 docs/EmploymentDetail.md delete mode 100644 docs/EndCustomerStatus.md delete mode 100644 docs/Error.md delete mode 100644 docs/ErrorErrorsInner.md delete mode 100644 docs/Ewallet.md delete mode 100644 docs/EwalletType.md delete mode 100644 docs/FeeResponse.md delete mode 100644 docs/ForbiddenError.md delete mode 100644 docs/GetAllPaymentMethods400Response.md delete mode 100644 docs/GetAllPaymentMethods403Response.md delete mode 100644 docs/GetAllPaymentMethods404Response.md delete mode 100644 docs/GetAllPaymentMethodsDefaultResponse.md delete mode 100644 docs/GetAllRefundsDefaultResponse.md delete mode 100644 docs/GetCustomerByReferenceID200Response.md delete mode 100644 docs/GetCustomerByReferenceID400Response.md delete mode 100644 docs/GetCustomerByReferenceID400ResponseAllOf.md delete mode 100644 docs/GetPayouts200Response.md delete mode 100644 docs/GetPayouts200ResponseDataInner.md delete mode 100644 docs/GetPayouts200ResponseLinks.md delete mode 100644 docs/IdentityAccountRequest.md delete mode 100644 docs/IdentityAccountRequestProperties.md delete mode 100644 docs/IdentityAccountResponse.md delete mode 100644 docs/IdentityAccountResponseProperties.md delete mode 100644 docs/IdentityAccountType.md delete mode 100644 docs/IndividualDetail.md delete mode 100644 docs/Invoice.md delete mode 100644 docs/InvoiceClientType.md delete mode 100644 docs/InvoiceCurrency.md delete mode 100644 docs/InvoiceError404ResponseDefinition.md delete mode 100644 docs/InvoiceFee.md delete mode 100644 docs/InvoiceItem.md delete mode 100644 docs/InvoiceNotFoundError.md delete mode 100644 docs/InvoicePaymentMethod.md delete mode 100644 docs/InvoiceStatus.md delete mode 100644 docs/KYCDocumentRequest.md delete mode 100644 docs/KYCDocumentResponse.md delete mode 100644 docs/KYCDocumentSubType.md delete mode 100644 docs/KYCDocumentType.md delete mode 100644 docs/LinkItem.md delete mode 100644 docs/NotificationChannel.md delete mode 100644 docs/NotificationPreference.md delete mode 100644 docs/OverTheCounter.md delete mode 100644 docs/OverTheCounterChannelCode.md delete mode 100644 docs/OverTheCounterChannelProperties.md delete mode 100644 docs/OverTheCounterChannelPropertiesUpdate.md delete mode 100644 docs/OverTheCounterParameters.md delete mode 100644 docs/OverTheCounterUpdateParameters.md delete mode 100644 docs/PatchCustomer.md delete mode 100644 docs/Paylater.md delete mode 100644 docs/PaylaterType.md delete mode 100644 docs/PaymentMethod.md delete mode 100644 docs/PaymentMethodAction.md delete mode 100644 docs/PaymentMethodAuthParameters.md delete mode 100644 docs/PaymentMethodCountry.md delete mode 100644 docs/PaymentMethodExpireParameters.md delete mode 100644 docs/PaymentMethodList.md delete mode 100644 docs/PaymentMethodParameters.md delete mode 100644 docs/PaymentMethodReusability.md delete mode 100644 docs/PaymentMethodStatus.md delete mode 100644 docs/PaymentMethodType.md delete mode 100644 docs/PaymentMethodUpdateParameters.md delete mode 100644 docs/PaymentRequest.md delete mode 100644 docs/PaymentRequestAction.md delete mode 100644 docs/PaymentRequestAuthParameters.md delete mode 100644 docs/PaymentRequestBasket.md delete mode 100644 docs/PaymentRequestBasketItem.md delete mode 100644 docs/PaymentRequestCaptureMethod.md delete mode 100644 docs/PaymentRequestCardVerificationResults.md delete mode 100644 docs/PaymentRequestCardVerificationResultsThreeDeeSecure.md delete mode 100644 docs/PaymentRequestChannelProperties.md delete mode 100644 docs/PaymentRequestCountry.md delete mode 100644 docs/PaymentRequestCurrency.md delete mode 100644 docs/PaymentRequestInitiator.md delete mode 100644 docs/PaymentRequestListResponse.md delete mode 100644 docs/PaymentRequestParameters.md delete mode 100644 docs/PaymentRequestParametersChannelProperties.md delete mode 100644 docs/PaymentRequestParametersChannelPropertiesAllOf.md delete mode 100644 docs/PaymentRequestShippingInformation.md delete mode 100644 docs/PaymentRequestStatus.md delete mode 100644 docs/Payout.md delete mode 100644 docs/PayoutAllOf.md delete mode 100644 docs/QRCode.md delete mode 100644 docs/QRCodeChannelCode.md delete mode 100644 docs/QRCodeChannelProperties.md delete mode 100644 docs/QRCodeParameters.md delete mode 100644 docs/QrCode.md delete mode 100644 docs/QrCodeType.md delete mode 100644 docs/ReceiptNotification.md delete mode 100644 docs/Refund.md delete mode 100644 docs/RefundList.md delete mode 100644 docs/ResponseDataNotFound.md delete mode 100644 docs/RetailOutlet.md delete mode 100644 docs/RetailOutletName.md delete mode 100644 docs/ServerError.md delete mode 100644 docs/SimulatePaymentRequest.md delete mode 100644 docs/TokenizedCardInformation.md delete mode 100644 docs/TransactionId.md delete mode 100644 docs/TransactionResponse.md delete mode 100644 docs/TransactionResponseType.md delete mode 100644 docs/TransactionStatuses.md delete mode 100644 docs/TransactionTypes.md delete mode 100644 docs/TransactionsResponse.md delete mode 100644 docs/UnauthorizedError.md delete mode 100644 docs/UpdateCustomer400Response.md delete mode 100644 docs/UpdateCustomer400ResponseAllOf.md delete mode 100644 docs/ValidationError.md delete mode 100644 docs/VirtualAccount.md delete mode 100644 docs/VirtualAccountAllOf.md delete mode 100644 docs/VirtualAccountAlternativeDisplay.md delete mode 100644 docs/VirtualAccountChannelCode.md delete mode 100644 docs/VirtualAccountChannelProperties.md delete mode 100644 docs/VirtualAccountChannelPropertiesPatch.md delete mode 100644 docs/VirtualAccountParameters.md delete mode 100644 docs/VirtualAccountUpdateParameters.md create mode 100644 docs/balance_and_transaction/Balance.md create mode 100644 docs/balance_and_transaction/ChannelsCategories.md create mode 100644 docs/balance_and_transaction/Currency.md create mode 100644 docs/balance_and_transaction/DateRangeFilter.md create mode 100644 docs/balance_and_transaction/FeeResponse.md create mode 100644 docs/balance_and_transaction/LinkItem.md create mode 100644 docs/balance_and_transaction/ServerError.md create mode 100644 docs/balance_and_transaction/TransactionId.md create mode 100644 docs/balance_and_transaction/TransactionResponse.md create mode 100644 docs/balance_and_transaction/TransactionResponseType.md create mode 100644 docs/balance_and_transaction/TransactionStatuses.md create mode 100644 docs/balance_and_transaction/TransactionTypes.md create mode 100644 docs/balance_and_transaction/TransactionsResponse.md create mode 100644 docs/balance_and_transaction/ValidationError.md create mode 100644 docs/customer/AccountBank.md create mode 100644 docs/customer/AccountCard.md create mode 100644 docs/customer/AccountEwallet.md create mode 100644 docs/customer/AccountOTC.md create mode 100644 docs/customer/AccountPayLater.md create mode 100644 docs/customer/AccountQRCode.md create mode 100644 docs/customer/Address.md create mode 100644 docs/customer/AddressRequest.md create mode 100644 docs/customer/AddressStatus.md create mode 100644 docs/customer/BusinessDetail.md create mode 100644 docs/customer/CountryCode.md create mode 100644 docs/customer/CreateCustomer400Response.md create mode 100644 docs/customer/CreateCustomer400ResponseAllOf.md create mode 100644 docs/customer/Customer.md create mode 100644 docs/customer/CustomerRequest.md create mode 100644 docs/customer/EmploymentDetail.md create mode 100644 docs/customer/EndCustomerStatus.md create mode 100644 docs/customer/Error.md create mode 100644 docs/customer/GetCustomerByReferenceID200Response.md create mode 100644 docs/customer/GetCustomerByReferenceID400Response.md create mode 100644 docs/customer/GetCustomerByReferenceID400ResponseAllOf.md create mode 100644 docs/customer/IdentityAccountRequest.md create mode 100644 docs/customer/IdentityAccountRequestProperties.md create mode 100644 docs/customer/IdentityAccountResponse.md create mode 100644 docs/customer/IdentityAccountResponseProperties.md create mode 100644 docs/customer/IdentityAccountType.md create mode 100644 docs/customer/IndividualDetail.md create mode 100644 docs/customer/KYCDocumentRequest.md create mode 100644 docs/customer/KYCDocumentResponse.md create mode 100644 docs/customer/KYCDocumentSubType.md create mode 100644 docs/customer/KYCDocumentType.md create mode 100644 docs/customer/PatchCustomer.md create mode 100644 docs/customer/ResponseDataNotFound.md create mode 100644 docs/customer/UpdateCustomer400Response.md create mode 100644 docs/customer/UpdateCustomer400ResponseAllOf.md create mode 100644 docs/invoice/AddressObject.md create mode 100644 docs/invoice/AlternativeDisplayItem.md create mode 100644 docs/invoice/BadRequestError.md create mode 100644 docs/invoice/Bank.md create mode 100644 docs/invoice/BankCode.md create mode 100644 docs/invoice/CreateInvoiceRequest.md create mode 100644 docs/invoice/CustomerObject.md create mode 100644 docs/invoice/DirectDebit.md create mode 100644 docs/invoice/DirectDebitType.md create mode 100644 docs/invoice/Ewallet.md create mode 100644 docs/invoice/EwalletType.md create mode 100644 docs/invoice/ForbiddenError.md create mode 100644 docs/invoice/Invoice.md create mode 100644 docs/invoice/InvoiceClientType.md create mode 100644 docs/invoice/InvoiceCurrency.md create mode 100644 docs/invoice/InvoiceError404ResponseDefinition.md create mode 100644 docs/invoice/InvoiceFee.md create mode 100644 docs/invoice/InvoiceItem.md create mode 100644 docs/invoice/InvoiceNotFoundError.md create mode 100644 docs/invoice/InvoicePaymentMethod.md create mode 100644 docs/invoice/InvoiceStatus.md create mode 100644 docs/invoice/NotificationChannel.md create mode 100644 docs/invoice/NotificationPreference.md create mode 100644 docs/invoice/Paylater.md create mode 100644 docs/invoice/PaylaterType.md create mode 100644 docs/invoice/QrCode.md create mode 100644 docs/invoice/QrCodeType.md create mode 100644 docs/invoice/RetailOutlet.md create mode 100644 docs/invoice/RetailOutletName.md create mode 100644 docs/invoice/ServerError.md create mode 100644 docs/invoice/UnauthorizedError.md create mode 100644 docs/payment_method/BillingInformation.md create mode 100644 docs/payment_method/Card.md create mode 100644 docs/payment_method/CardChannelProperties.md create mode 100644 docs/payment_method/CardParameters.md create mode 100644 docs/payment_method/CardParametersCardInformation.md create mode 100644 docs/payment_method/CardVerificationResults.md create mode 100644 docs/payment_method/CardVerificationResultsThreeDSecure.md create mode 100644 docs/payment_method/CreatePaymentMethod409Response.md create mode 100644 docs/payment_method/CreatePaymentMethod503Response.md create mode 100644 docs/payment_method/DirectDebit.md create mode 100644 docs/payment_method/DirectDebitAllOf.md create mode 100644 docs/payment_method/DirectDebitBankAccount.md create mode 100644 docs/payment_method/DirectDebitChannelCode.md create mode 100644 docs/payment_method/DirectDebitChannelProperties.md create mode 100644 docs/payment_method/DirectDebitDebitCard.md create mode 100644 docs/payment_method/DirectDebitParameters.md create mode 100644 docs/payment_method/DirectDebitType.md create mode 100644 docs/payment_method/EWallet.md create mode 100644 docs/payment_method/EWalletAccount.md create mode 100644 docs/payment_method/EWalletChannelCode.md create mode 100644 docs/payment_method/EWalletChannelProperties.md create mode 100644 docs/payment_method/EWalletParameters.md create mode 100644 docs/payment_method/GetAllPaymentMethods400Response.md create mode 100644 docs/payment_method/GetAllPaymentMethods403Response.md create mode 100644 docs/payment_method/GetAllPaymentMethods404Response.md create mode 100644 docs/payment_method/GetAllPaymentMethodsDefaultResponse.md create mode 100644 docs/payment_method/OverTheCounter.md create mode 100644 docs/payment_method/OverTheCounterChannelCode.md create mode 100644 docs/payment_method/OverTheCounterChannelProperties.md create mode 100644 docs/payment_method/OverTheCounterChannelPropertiesUpdate.md create mode 100644 docs/payment_method/OverTheCounterParameters.md create mode 100644 docs/payment_method/OverTheCounterUpdateParameters.md create mode 100644 docs/payment_method/PaymentMethod.md create mode 100644 docs/payment_method/PaymentMethodAction.md create mode 100644 docs/payment_method/PaymentMethodAuthParameters.md create mode 100644 docs/payment_method/PaymentMethodCountry.md create mode 100644 docs/payment_method/PaymentMethodExpireParameters.md create mode 100644 docs/payment_method/PaymentMethodList.md create mode 100644 docs/payment_method/PaymentMethodParameters.md create mode 100644 docs/payment_method/PaymentMethodReusability.md create mode 100644 docs/payment_method/PaymentMethodStatus.md create mode 100644 docs/payment_method/PaymentMethodType.md create mode 100644 docs/payment_method/PaymentMethodUpdateParameters.md create mode 100644 docs/payment_method/QRCode.md create mode 100644 docs/payment_method/QRCodeChannelCode.md create mode 100644 docs/payment_method/QRCodeChannelProperties.md create mode 100644 docs/payment_method/QRCodeParameters.md create mode 100644 docs/payment_method/SimulatePaymentRequest.md create mode 100644 docs/payment_method/TokenizedCardInformation.md create mode 100644 docs/payment_method/VirtualAccount.md create mode 100644 docs/payment_method/VirtualAccountAllOf.md create mode 100644 docs/payment_method/VirtualAccountAlternativeDisplay.md create mode 100644 docs/payment_method/VirtualAccountChannelCode.md create mode 100644 docs/payment_method/VirtualAccountChannelProperties.md create mode 100644 docs/payment_method/VirtualAccountChannelPropertiesPatch.md create mode 100644 docs/payment_method/VirtualAccountParameters.md create mode 100644 docs/payment_method/VirtualAccountUpdateParameters.md create mode 100644 docs/payment_request/Capture.md create mode 100644 docs/payment_request/CaptureList.md create mode 100644 docs/payment_request/CaptureListResponse.md create mode 100644 docs/payment_request/CaptureParameters.md create mode 100644 docs/payment_request/Card.md create mode 100644 docs/payment_request/CardChannelProperties.md create mode 100644 docs/payment_request/CardInformation.md create mode 100644 docs/payment_request/CardVerificationResults.md create mode 100644 docs/payment_request/CardVerificationResultsThreeDSecure.md create mode 100644 docs/payment_request/DirectDebit.md create mode 100644 docs/payment_request/DirectDebitAllOf.md create mode 100644 docs/payment_request/DirectDebitBankAccount.md create mode 100644 docs/payment_request/DirectDebitChannelCode.md create mode 100644 docs/payment_request/DirectDebitChannelProperties.md create mode 100644 docs/payment_request/DirectDebitChannelPropertiesBankAccount.md create mode 100644 docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md create mode 100644 docs/payment_request/DirectDebitChannelPropertiesDebitCard.md create mode 100644 docs/payment_request/DirectDebitDebitCard.md create mode 100644 docs/payment_request/DirectDebitParameters.md create mode 100644 docs/payment_request/DirectDebitType.md create mode 100644 docs/payment_request/EWallet.md create mode 100644 docs/payment_request/EWalletAccount.md create mode 100644 docs/payment_request/EWalletAllOf.md create mode 100644 docs/payment_request/EWalletChannelCode.md create mode 100644 docs/payment_request/EWalletChannelProperties.md create mode 100644 docs/payment_request/EWalletParameters.md create mode 100644 docs/payment_request/Error.md create mode 100644 docs/payment_request/OverTheCounter.md create mode 100644 docs/payment_request/OverTheCounterChannelCode.md create mode 100644 docs/payment_request/OverTheCounterChannelProperties.md create mode 100644 docs/payment_request/OverTheCounterParameters.md create mode 100644 docs/payment_request/PaymentMethod.md create mode 100644 docs/payment_request/PaymentMethodParameters.md create mode 100644 docs/payment_request/PaymentMethodReusability.md create mode 100644 docs/payment_request/PaymentMethodStatus.md create mode 100644 docs/payment_request/PaymentMethodType.md create mode 100644 docs/payment_request/PaymentRequest.md create mode 100644 docs/payment_request/PaymentRequestAction.md create mode 100644 docs/payment_request/PaymentRequestAuthParameters.md create mode 100644 docs/payment_request/PaymentRequestBasket.md create mode 100644 docs/payment_request/PaymentRequestBasketItem.md create mode 100644 docs/payment_request/PaymentRequestCaptureMethod.md create mode 100644 docs/payment_request/PaymentRequestCardVerificationResults.md create mode 100644 docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md create mode 100644 docs/payment_request/PaymentRequestChannelProperties.md create mode 100644 docs/payment_request/PaymentRequestCountry.md create mode 100644 docs/payment_request/PaymentRequestCurrency.md create mode 100644 docs/payment_request/PaymentRequestInitiator.md create mode 100644 docs/payment_request/PaymentRequestListResponse.md create mode 100644 docs/payment_request/PaymentRequestParameters.md create mode 100644 docs/payment_request/PaymentRequestParametersChannelProperties.md create mode 100644 docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md create mode 100644 docs/payment_request/PaymentRequestShippingInformation.md create mode 100644 docs/payment_request/PaymentRequestStatus.md create mode 100644 docs/payment_request/QRCode.md create mode 100644 docs/payment_request/QRCodeChannelCode.md create mode 100644 docs/payment_request/QRCodeChannelProperties.md create mode 100644 docs/payment_request/QRCodeParameters.md create mode 100644 docs/payment_request/VirtualAccount.md create mode 100644 docs/payment_request/VirtualAccountAllOf.md create mode 100644 docs/payment_request/VirtualAccountAlternativeDisplay.md create mode 100644 docs/payment_request/VirtualAccountChannelCode.md create mode 100644 docs/payment_request/VirtualAccountChannelProperties.md create mode 100644 docs/payment_request/VirtualAccountParameters.md create mode 100644 docs/payout/Channel.md create mode 100644 docs/payout/ChannelAccountType.md create mode 100644 docs/payout/ChannelAmountLimits.md create mode 100644 docs/payout/ChannelCategory.md create mode 100644 docs/payout/CreatePayoutRequest.md create mode 100644 docs/payout/DigitalPayoutChannelProperties.md create mode 100644 docs/payout/Error.md create mode 100644 docs/payout/ErrorErrorsInner.md create mode 100644 docs/payout/GetPayouts200Response.md create mode 100644 docs/payout/GetPayouts200ResponseDataInner.md create mode 100644 docs/payout/GetPayouts200ResponseLinks.md create mode 100644 docs/payout/Payout.md create mode 100644 docs/payout/PayoutAllOf.md create mode 100644 docs/payout/ReceiptNotification.md create mode 100644 docs/refund/CreateRefund.md create mode 100644 docs/refund/CreateRefund400Response.md create mode 100644 docs/refund/CreateRefund403Response.md create mode 100644 docs/refund/CreateRefund404Response.md create mode 100644 docs/refund/CreateRefund409Response.md create mode 100644 docs/refund/CreateRefund503Response.md create mode 100644 docs/refund/GetAllRefundsDefaultResponse.md create mode 100644 docs/refund/Refund.md create mode 100644 docs/refund/RefundList.md rename {docs => images}/header.jpg (100%) create mode 100644 pyproject.toml diff --git a/.github/workflows/generate-release-tag.yml b/.github/workflows/generate-release-tag.yml index 26f8a989..af91f10a 100644 --- a/.github/workflows/generate-release-tag.yml +++ b/.github/workflows/generate-release-tag.yml @@ -36,5 +36,16 @@ jobs: id-token: write steps: - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Install Poetry + uses: abatilo/actions-poetry@v2 + with: + poetry-version: '1.6.1' + - name: Build Package + run: | + poetry install + poetry build - name: Publish a Python distribution to PyPI uses: pypa/gh-action-pypi-publish@release/v1 \ No newline at end of file diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 32fc43e0..d5c60bc2 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -3,72 +3,73 @@ .gitignore LICENSE README.md -docs/Capture.md -docs/CaptureList.md -docs/CaptureListResponse.md -docs/CaptureParameters.md -docs/Card.md -docs/CardChannelProperties.md -docs/CardInformation.md -docs/CardVerificationResults.md -docs/CardVerificationResultsThreeDSecure.md -docs/DirectDebit.md -docs/DirectDebitAllOf.md -docs/DirectDebitBankAccount.md -docs/DirectDebitChannelCode.md -docs/DirectDebitChannelProperties.md -docs/DirectDebitChannelPropertiesBankAccount.md -docs/DirectDebitChannelPropertiesBankRedirect.md -docs/DirectDebitChannelPropertiesDebitCard.md -docs/DirectDebitDebitCard.md -docs/DirectDebitParameters.md -docs/DirectDebitType.md -docs/EWallet.md -docs/EWalletAccount.md -docs/EWalletAllOf.md -docs/EWalletChannelCode.md -docs/EWalletChannelProperties.md -docs/EWalletParameters.md -docs/Error.md -docs/OverTheCounter.md -docs/OverTheCounterChannelCode.md -docs/OverTheCounterChannelProperties.md -docs/OverTheCounterParameters.md -docs/PaymentMethod.md -docs/PaymentMethodParameters.md -docs/PaymentMethodReusability.md -docs/PaymentMethodStatus.md -docs/PaymentMethodType.md -docs/PaymentRequest.md -docs/PaymentRequestAction.md docs/PaymentRequestApi.md -docs/PaymentRequestAuthParameters.md -docs/PaymentRequestBasket.md -docs/PaymentRequestBasketItem.md -docs/PaymentRequestCaptureMethod.md -docs/PaymentRequestCardVerificationResults.md -docs/PaymentRequestCardVerificationResultsThreeDeeSecure.md -docs/PaymentRequestChannelProperties.md -docs/PaymentRequestCountry.md -docs/PaymentRequestCurrency.md -docs/PaymentRequestInitiator.md -docs/PaymentRequestListResponse.md -docs/PaymentRequestParameters.md -docs/PaymentRequestParametersChannelProperties.md -docs/PaymentRequestParametersChannelPropertiesAllOf.md -docs/PaymentRequestShippingInformation.md -docs/PaymentRequestStatus.md -docs/QRCode.md -docs/QRCodeChannelCode.md -docs/QRCodeChannelProperties.md -docs/QRCodeParameters.md -docs/VirtualAccount.md -docs/VirtualAccountAllOf.md -docs/VirtualAccountAlternativeDisplay.md -docs/VirtualAccountChannelCode.md -docs/VirtualAccountChannelProperties.md -docs/VirtualAccountParameters.md -docs/header.jpg +docs/payment_request/Capture.md +docs/payment_request/CaptureList.md +docs/payment_request/CaptureListResponse.md +docs/payment_request/CaptureParameters.md +docs/payment_request/Card.md +docs/payment_request/CardChannelProperties.md +docs/payment_request/CardInformation.md +docs/payment_request/CardVerificationResults.md +docs/payment_request/CardVerificationResultsThreeDSecure.md +docs/payment_request/DirectDebit.md +docs/payment_request/DirectDebitAllOf.md +docs/payment_request/DirectDebitBankAccount.md +docs/payment_request/DirectDebitChannelCode.md +docs/payment_request/DirectDebitChannelProperties.md +docs/payment_request/DirectDebitChannelPropertiesBankAccount.md +docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md +docs/payment_request/DirectDebitChannelPropertiesDebitCard.md +docs/payment_request/DirectDebitDebitCard.md +docs/payment_request/DirectDebitParameters.md +docs/payment_request/DirectDebitType.md +docs/payment_request/EWallet.md +docs/payment_request/EWalletAccount.md +docs/payment_request/EWalletAllOf.md +docs/payment_request/EWalletChannelCode.md +docs/payment_request/EWalletChannelProperties.md +docs/payment_request/EWalletParameters.md +docs/payment_request/Error.md +docs/payment_request/OverTheCounter.md +docs/payment_request/OverTheCounterChannelCode.md +docs/payment_request/OverTheCounterChannelProperties.md +docs/payment_request/OverTheCounterParameters.md +docs/payment_request/PaymentMethod.md +docs/payment_request/PaymentMethodParameters.md +docs/payment_request/PaymentMethodReusability.md +docs/payment_request/PaymentMethodStatus.md +docs/payment_request/PaymentMethodType.md +docs/payment_request/PaymentRequest.md +docs/payment_request/PaymentRequestAction.md +docs/payment_request/PaymentRequestAuthParameters.md +docs/payment_request/PaymentRequestBasket.md +docs/payment_request/PaymentRequestBasketItem.md +docs/payment_request/PaymentRequestCaptureMethod.md +docs/payment_request/PaymentRequestCardVerificationResults.md +docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md +docs/payment_request/PaymentRequestChannelProperties.md +docs/payment_request/PaymentRequestCountry.md +docs/payment_request/PaymentRequestCurrency.md +docs/payment_request/PaymentRequestInitiator.md +docs/payment_request/PaymentRequestListResponse.md +docs/payment_request/PaymentRequestParameters.md +docs/payment_request/PaymentRequestParametersChannelProperties.md +docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md +docs/payment_request/PaymentRequestShippingInformation.md +docs/payment_request/PaymentRequestStatus.md +docs/payment_request/QRCode.md +docs/payment_request/QRCodeChannelCode.md +docs/payment_request/QRCodeChannelProperties.md +docs/payment_request/QRCodeParameters.md +docs/payment_request/VirtualAccount.md +docs/payment_request/VirtualAccountAllOf.md +docs/payment_request/VirtualAccountAlternativeDisplay.md +docs/payment_request/VirtualAccountChannelCode.md +docs/payment_request/VirtualAccountChannelProperties.md +docs/payment_request/VirtualAccountParameters.md +images/header.jpg +pyproject.toml requirements.txt setup.cfg setup.py diff --git a/README.md b/README.md index feebdd9e..e189de49 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -![Xendit Python SDK](docs/header.jpg "Xendit Pyton SDK") +![Xendit Python SDK](images/header.jpg "Xendit Python SDK") # Xendit Python SDK The official Xendit Python SDK provides a simple and convenient way to call Xendit's REST API in applications written in Python. -* Package version: 3.4.0 +* Package version: 3.6.0 ## Requirements diff --git a/docs/AccountBank.md b/docs/AccountBank.md deleted file mode 100644 index e3af6911..00000000 --- a/docs/AccountBank.md +++ /dev/null @@ -1,17 +0,0 @@ -# xendit.customer.model.AccountBank - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **account_number** | **str** | Unique account identifier as per the bank records. | [optional] | -| **account_holder_name** | **str, none_type** | Name of account holder as per the bank records. Needs to match the registered account name exactly. . | [optional] | -| **swift_code** | **str, none_type** | The SWIFT code for international payments | [optional] | -| **account_type** | **str, none_type** | Free text account type, e.g., Savings, Transaction, Virtual Account. | [optional] | -| **account_details** | **str, none_type** | Potentially masked account detail, for display purposes only. | [optional] | -| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AccountCard.md b/docs/AccountCard.md deleted file mode 100644 index 34c41863..00000000 --- a/docs/AccountCard.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.customer.model.AccountCard - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **token_id** | **str** | The token id returned in tokenisation | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AccountEwallet.md b/docs/AccountEwallet.md deleted file mode 100644 index 60e98024..00000000 --- a/docs/AccountEwallet.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.customer.model.AccountEwallet - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **account_number** | **str** | Unique account identifier as per the bank records. | [optional] | -| **account_holder_name** | **str, none_type** | Name of account holder as per the bank records. Needs to match the registered account name exactly. | [optional] | -| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AccountOTC.md b/docs/AccountOTC.md deleted file mode 100644 index 8fa831ef..00000000 --- a/docs/AccountOTC.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.AccountOTC - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **payment_code** | **str** | Complete fixed payment code (including prefix) | [optional] | -| **expires_at** | **str, none_type** | YYYY-MM-DD string with expiry date for the payment code | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AccountPayLater.md b/docs/AccountPayLater.md deleted file mode 100644 index 839ca248..00000000 --- a/docs/AccountPayLater.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.customer.model.AccountPayLater - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **account_id** | **str** | Alphanumeric string identifying this account. Usually an email address or phone number. | [optional] | -| **account_holder_name** | **str, none_type** | Name of account holder as per the cardless credit account. | [optional] | -| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AccountQRCode.md b/docs/AccountQRCode.md deleted file mode 100644 index c82647fc..00000000 --- a/docs/AccountQRCode.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.customer.model.AccountQRCode - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **qr_string** | **str** | String representation of the QR Code image | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Address.md b/docs/Address.md deleted file mode 100644 index cf1d3886..00000000 --- a/docs/Address.md +++ /dev/null @@ -1,24 +0,0 @@ -# xendit.customer.model.Address - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **category** | **str, none_type** | | | -| **country** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | -| **province_state** | **str, none_type** | | | -| **city** | **str, none_type** | | | -| **postal_code** | **str, none_type** | | | -| **street_line1** | **str, none_type** | | | -| **street_line2** | **str, none_type** | | | -| **is_primary** | **bool, none_type** | | | -| **id** | **str** | | [optional] | -| **status** | [**AddressStatus**](AddressStatus.md) | | [optional] | -| **meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | -| **created** | **datetime** | | [optional] | -| **updated** | **datetime** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AddressObject.md b/docs/AddressObject.md deleted file mode 100644 index f291a6da..00000000 --- a/docs/AddressObject.md +++ /dev/null @@ -1,19 +0,0 @@ -# xendit.invoice.model.AddressObject - -An object representing an address with various properties. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **country** | **str, none_type** | The country where the address is located. | [optional] | -| **street_line1** | **str, none_type** | The first line of the street address. | [optional] | -| **street_line2** | **str, none_type** | The second line of the street address. | [optional] | -| **city** | **str, none_type** | The city or locality within the address. | [optional] | -| **province** | **str, none_type** | The province or region within the country. | [optional] | -| **state** | **str, none_type** | The state or administrative division within the country. | [optional] | -| **postal_code** | **str, none_type** | The postal code or ZIP code for the address. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AddressRequest.md b/docs/AddressRequest.md deleted file mode 100644 index 09eb9314..00000000 --- a/docs/AddressRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# xendit.customer.model.AddressRequest - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **category** | **str** | Home, work or provincial | [optional] | -| **country_code** | [**CountryCode**](CountryCode.md) | | [optional] | -| **province_state** | **str** | | [optional] | -| **city** | **str** | | [optional] | -| **suburb** | **str** | | [optional] | -| **postal_code** | **str** | | [optional] | -| **line_1** | **str** | | [optional] | -| **line_2** | **str** | | [optional] | -| **status** | [**AddressStatus**](AddressStatus.md) | | [optional] | -| **is_primary** | **bool** | | [optional] if omitted the server will use the default value of False | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AddressStatus.md b/docs/AddressStatus.md deleted file mode 100644 index 9f888bc5..00000000 --- a/docs/AddressStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.AddressStatus - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["ACTIVE", "DELETED", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AlternativeDisplayItem.md b/docs/AlternativeDisplayItem.md deleted file mode 100644 index c1116d4e..00000000 --- a/docs/AlternativeDisplayItem.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.AlternativeDisplayItem - -An object representing alternative display of a VA. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **type** | **str** | Represent type of alternative display. | [optional] | -| **value** | **str** | Represent value of alternative display value. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BadRequestError.md b/docs/BadRequestError.md deleted file mode 100644 index d015d233..00000000 --- a/docs/BadRequestError.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.BadRequestError - -Response definition for a 400 Bad Request error when creating an invoice. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | The error code indicating the type of error that occurred. | | -| **message** | **str** | A human-readable error message that provides additional information about the error. | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Balance.md b/docs/Balance.md deleted file mode 100644 index d25efe0f..00000000 --- a/docs/Balance.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.balance_and_transaction.model.Balance - -The balance remaining in your account - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **balance** | **float** | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BalanceApi.md b/docs/BalanceApi.md index 084c34db..7cc9d67c 100644 --- a/docs/BalanceApi.md +++ b/docs/BalanceApi.md @@ -1,22 +1,51 @@ -# xendit.apis.BalanceApi +# BalanceApi + + +You can use the APIs below to interface with Xendit's `BalanceApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```python +import time +import xendit +from xendit.apis import BalanceApi + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() + +# Create an instance of the API class +api_instance = BalanceApi(api_client) +``` All URIs are relative to *https://api.xendit.co* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_balance**](BalanceApi.md#get_balance) | **GET** /balance | Retrieves balances for a business, default to CASH type +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**get_balance**](BalanceApi.md#get_balance-function) | **GET** /balance | Retrieves balances for a business, default to CASH type | -# **get_balance** +# `get_balance()` Function > Balance get_balance() Retrieves balances for a business, default to CASH type -Retrieves balance for your business, defaults to CASH type +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_balance` | +| Request Parameters | [GetBalanceRequestParams](#request-parameters--GetBalanceRequestParams) | +| Return Type | [**Balance**](balance_and_transaction/Balance.md) | -### Example +### Request Parameters - GetBalanceRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **account_type** | **str**| | "CASH" | +| **currency** | **str**| | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -34,6 +63,9 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = BalanceApi(api_client) +account_type = "CASH" # str | The selected balance type +currency = "IDR" # str | Currency for filter for customers with multi currency accounts +for_user_id = "5dbf20d7c8eb0c0896f811b6" # str | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information # example passing only required values which don't have defaults set # and optional values @@ -45,27 +77,4 @@ except xendit.XenditSdkException as e: print("Exception when calling BalanceApi->get_balance: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_type** | **str**| The selected balance type | [optional] if omitted the server will use the default value of "CASH" - **currency** | **str**| Currency for filter for customers with multi currency accounts | [optional] - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information | [optional] - -### Return type - -[**Balance**](Balance.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | success | - | -**400** | invalid input, object invalid | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to README]](../README.md) diff --git a/docs/Bank.md b/docs/Bank.md deleted file mode 100644 index bac5ef62..00000000 --- a/docs/Bank.md +++ /dev/null @@ -1,19 +0,0 @@ -# xendit.invoice.model.Bank - -An object representing bank details for invoices. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **bank_code** | [**BankCode**](BankCode.md) | | | -| **collection_type** | **str** | The collection type for the bank details. | | -| **account_holder_name** | **str** | The name of the account holder. | | -| **bank_branch** | **str** | The branch of the bank. | [optional] | -| **bank_account_number** | **str** | The bank account number. | [optional] | -| **transfer_amount** | **float** | The transfer amount. | [optional] | -| **alternative_displays** | [**[AlternativeDisplayItem]**](AlternativeDisplayItem.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BankCode.md b/docs/BankCode.md deleted file mode 100644 index 4bfa457e..00000000 --- a/docs/BankCode.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.BankCode - -Representing the available bank channels used for invoice-related transactions. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing the available bank channels used for invoice-related transactions. | must be one of ["BCA", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "BJB", "SAHABAT_SAMPOERNA", "CIMB", "BNC", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BillingInformation.md b/docs/BillingInformation.md deleted file mode 100644 index 7aa1417a..00000000 --- a/docs/BillingInformation.md +++ /dev/null @@ -1,18 +0,0 @@ -# xendit.payment_method.model.BillingInformation - -Billing Information - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **country** | **str** | | | -| **street_line1** | **str, none_type** | | [optional] | -| **street_line2** | **str, none_type** | | [optional] | -| **city** | **str, none_type** | | [optional] | -| **province_state** | **str, none_type** | | [optional] | -| **postal_code** | **str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BusinessDetail.md b/docs/BusinessDetail.md deleted file mode 100644 index 177582ce..00000000 --- a/docs/BusinessDetail.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.customer.model.BusinessDetail - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **business_name** | **str** | | [optional] | -| **business_type** | **str, none_type** | | [optional] | -| **date_of_registration** | **str, none_type** | | [optional] | -| **nature_of_business** | **str, none_type** | | [optional] | -| **business_domicile** | [**CountryCode**](CountryCode.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Capture.md b/docs/Capture.md deleted file mode 100644 index 6c47c575..00000000 --- a/docs/Capture.md +++ /dev/null @@ -1,26 +0,0 @@ -# xendit.payment_request.model.Capture - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **id** | **str** | | | -| **payment_request_id** | **str** | | | -| **payment_id** | **str** | | | -| **reference_id** | **str** | | | -| **currency** | **str** | | | -| **authorized_amount** | **float** | | | -| **captured_amount** | **float** | | | -| **status** | **str** | | | -| **payment_method** | [**PaymentMethod**](PaymentMethod.md) | | | -| **failure_code** | **str, none_type** | | | -| **customer_id** | **str, none_type** | | | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | -| **channel_properties** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | -| **created** | **str** | | | -| **updated** | **str** | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CaptureList.md b/docs/CaptureList.md deleted file mode 100644 index af71dc52..00000000 --- a/docs/CaptureList.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.payment_request.model.CaptureList - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | [**[Capture]**](Capture.md) | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CaptureListResponse.md b/docs/CaptureListResponse.md deleted file mode 100644 index d2e8a046..00000000 --- a/docs/CaptureListResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.CaptureListResponse - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **data** | [**CaptureList**](CaptureList.md) | | | -| **has_more** | **bool** | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CaptureParameters.md b/docs/CaptureParameters.md deleted file mode 100644 index 7e1ac415..00000000 --- a/docs/CaptureParameters.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.CaptureParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **capture_amount** | **float** | | | -| **reference_id** | **str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Card.md b/docs/Card.md deleted file mode 100644 index a4351d83..00000000 --- a/docs/Card.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.payment_request.model.Card - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | -| **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | | | -| **card_information** | [**CardInformation**](CardInformation.md) | | | -| **card_verification_results** | [**CardVerificationResults**](CardVerificationResults.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CardChannelProperties.md b/docs/CardChannelProperties.md deleted file mode 100644 index 74a1605e..00000000 --- a/docs/CardChannelProperties.md +++ /dev/null @@ -1,17 +0,0 @@ -# xendit.payment_request.model.CardChannelProperties - -Card Channel Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **skip_three_d_secure** | **bool, none_type** | To indicate whether to perform 3DS during the linking phase | [optional] | -| **success_return_url** | **str, none_type** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **failure_return_url** | **str, none_type** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **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. | [optional] | -| **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 | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CardInformation.md b/docs/CardInformation.md deleted file mode 100644 index b20ecd07..00000000 --- a/docs/CardInformation.md +++ /dev/null @@ -1,22 +0,0 @@ -# xendit.payment_request.model.CardInformation - -Card Information - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **token_id** | **str** | | | -| **masked_card_number** | **str** | 1st 6 and last 4 digits of the card | | -| **expiry_month** | **str** | Card expiry month in MM format | | -| **expiry_year** | **str** | Card expiry month in YY format | | -| **cardholder_name** | **str, none_type** | Cardholder name | [optional] | -| **fingerprint** | **str** | | [optional] | -| **type** | **str** | | [optional] | -| **network** | **str** | | [optional] | -| **country** | **str** | | [optional] | -| **issuer** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CardParameters.md b/docs/CardParameters.md deleted file mode 100644 index ad1b384f..00000000 --- a/docs/CardParameters.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_method.model.CardParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **currency** | **str** | | | -| **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | | [optional] | -| **card_information** | [**CardParametersCardInformation**](CardParametersCardInformation.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CardParametersCardInformation.md b/docs/CardParametersCardInformation.md deleted file mode 100644 index 8377fcf1..00000000 --- a/docs/CardParametersCardInformation.md +++ /dev/null @@ -1,17 +0,0 @@ -# xendit.payment_method.model.CardParametersCardInformation - -Card Information - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **card_number** | **str** | | | -| **expiry_month** | **str** | Card expiry month in MM format | | -| **expiry_year** | **str** | Card expiry month in YY format | | -| **cardholder_name** | **str, none_type** | Cardholder name | [optional] | -| **cvv** | **str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CardVerificationResults.md b/docs/CardVerificationResults.md deleted file mode 100644 index 9f3216f3..00000000 --- a/docs/CardVerificationResults.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.CardVerificationResults - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **three_d_secure** | [**CardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | | [optional] | -| **cvv_result** | **str, none_type** | | [optional] | -| **address_verification_result** | **str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CardVerificationResultsThreeDSecure.md b/docs/CardVerificationResultsThreeDSecure.md deleted file mode 100644 index a9f2d997..00000000 --- a/docs/CardVerificationResultsThreeDSecure.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.payment_request.model.CardVerificationResultsThreeDSecure - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **three_d_secure_flow** | **str, none_type** | | [optional] | -| **eci_code** | **str, none_type** | | [optional] | -| **three_d_secure_result** | **str, none_type** | | [optional] | -| **three_d_secure_result_reason** | **str, none_type** | | [optional] | -| **three_d_secure_version** | **str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Channel.md b/docs/Channel.md deleted file mode 100644 index 974a2077..00000000 --- a/docs/Channel.md +++ /dev/null @@ -1,17 +0,0 @@ -# xendit.payout.model.Channel - -Channel information where you can send the money to - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | **str** | Destination channel to send the money to, prefixed by ISO-3166 country code | | -| **channel_category** | [**ChannelCategory**](ChannelCategory.md) | | | -| **currency** | **str** | Currency of the destination channel using ISO-4217 currency code | | -| **channel_name** | **str** | Name of the destination channel | | -| **amount_limits** | [**ChannelAmountLimits**](ChannelAmountLimits.md) | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ChannelAccountType.md b/docs/ChannelAccountType.md deleted file mode 100644 index 1505cdc9..00000000 --- a/docs/ChannelAccountType.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payout.model.ChannelAccountType - -Available account types (applicable for MY_DUITNOW) - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Available account types (applicable for MY_DUITNOW) | must be one of ["NATIONAL_ID", "MOBILE_NO", "PASSPORT", "BUSINESS_REGISTRATION", "BANK_ACCOUNT", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ChannelAmountLimits.md b/docs/ChannelAmountLimits.md deleted file mode 100644 index a1141110..00000000 --- a/docs/ChannelAmountLimits.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.payout.model.ChannelAmountLimits - -Supported amount ranges for payouts to this channel - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **minimum** | **float** | Lowest amount supported for a payout to this channel | | -| **maximum** | **float** | Highest amount supported for a payout to this channel | | -| **minimum_increment** | **float** | Supported increments | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ChannelCategory.md b/docs/ChannelCategory.md deleted file mode 100644 index 8baf4d18..00000000 --- a/docs/ChannelCategory.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payout.model.ChannelCategory - -Category of channel code, as some channels might require more fields during processing - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Category of channel code, as some channels might require more fields during processing | must be one of ["BANK", "EWALLET", "OTC", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ChannelsCategories.md b/docs/ChannelsCategories.md deleted file mode 100644 index 7b7743ab..00000000 --- a/docs/ChannelsCategories.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.balance_and_transaction.model.ChannelsCategories - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["BANK", "CARDLESS_CREDIT", "PAYLATER", "CARDS", "CASH", "DIRECT_DEBIT", "EWALLET", "INVOICE", "QR_CODE", "RETAIL_OUTLET", "VIRTUAL_ACCOUNT", "XENPLATFORM", "DIRECT_BANK_TRANSFER", "OTHER", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CountryCode.md b/docs/CountryCode.md deleted file mode 100644 index 816f7833..00000000 --- a/docs/CountryCode.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.CountryCode - -ISO3166-2 country code - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | ISO3166-2 country code | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateCustomer400Response.md b/docs/CreateCustomer400Response.md deleted file mode 100644 index e9acfc74..00000000 --- a/docs/CreateCustomer400Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.customer.model.CreateCustomer400Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | | -| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | -| **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateCustomer400ResponseAllOf.md b/docs/CreateCustomer400ResponseAllOf.md deleted file mode 100644 index 0babb64f..00000000 --- a/docs/CreateCustomer400ResponseAllOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.CreateCustomer400ResponseAllOf - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateInvoiceRequest.md b/docs/CreateInvoiceRequest.md deleted file mode 100644 index 4a7dcddc..00000000 --- a/docs/CreateInvoiceRequest.md +++ /dev/null @@ -1,32 +0,0 @@ -# xendit.invoice.model.CreateInvoiceRequest - -An object representing for an invoice creation request. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **external_id** | **str** | The external ID of the invoice. | | -| **amount** | **float** | The invoice amount. | | -| **payer_email** | **str** | The email address of the payer. | [optional] | -| **description** | **str** | A description of the payment. | [optional] | -| **invoice_duration** | **str** | The duration of the invoice. | [optional] | -| **callback_virtual_account_id** | **str** | The ID of the callback virtual account. | [optional] | -| **should_send_email** | **bool** | Indicates whether email notifications should be sent. | [optional] | -| **customer** | [**CustomerObject**](CustomerObject.md) | | [optional] | -| **customer_notification_preference** | [**NotificationPreference**](NotificationPreference.md) | | [optional] | -| **success_redirect_url** | **str** | The URL to redirect to on successful payment. | [optional] | -| **failure_redirect_url** | **str** | The URL to redirect to on payment failure. | [optional] | -| **payment_methods** | **[str]** | An array of available payment methods. | [optional] | -| **mid_label** | **str** | The middle label. | [optional] | -| **should_authenticate_credit_card** | **bool** | Indicates whether credit card authentication is required. | [optional] | -| **currency** | **str** | The currency of the invoice. | [optional] | -| **reminder_time** | **float** | The reminder time. | [optional] | -| **local** | **str** | The local. | [optional] | -| **reminder_time_unit** | **str** | The unit of the reminder time. | [optional] | -| **items** | [**[InvoiceItem]**](InvoiceItem.md) | An array of items included in the invoice. | [optional] | -| **fees** | [**[InvoiceFee]**](InvoiceFee.md) | An array of fees associated with the invoice. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreatePaymentMethod409Response.md b/docs/CreatePaymentMethod409Response.md deleted file mode 100644 index a98b7ff9..00000000 --- a/docs/CreatePaymentMethod409Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.CreatePaymentMethod409Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreatePaymentMethod503Response.md b/docs/CreatePaymentMethod503Response.md deleted file mode 100644 index 8e511a43..00000000 --- a/docs/CreatePaymentMethod503Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.CreatePaymentMethod503Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreatePayoutRequest.md b/docs/CreatePayoutRequest.md deleted file mode 100644 index 02b5aa0c..00000000 --- a/docs/CreatePayoutRequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# xendit.payout.model.CreatePayoutRequest - -Information needed by Xendit to send money to the destination channel provided - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **reference_id** | **str** | A client defined payout identifier | | -| **channel_code** | **str** | Channel code of selected destination bank or e-wallet | | -| **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | | | -| **amount** | **float** | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | -| **currency** | **str** | Currency of the destination channel using ISO-4217 currency code | | -| **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 | [optional] | -| **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Object of additional information you may use | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateRefund.md b/docs/CreateRefund.md deleted file mode 100644 index 79f1d51b..00000000 --- a/docs/CreateRefund.md +++ /dev/null @@ -1,18 +0,0 @@ -# xendit.refund.model.CreateRefund - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **payment_request_id** | **str** | | [optional] | -| **invoice_id** | **str** | | [optional] | -| **reference_id** | **str** | | [optional] | -| **amount** | **float** | | [optional] | -| **currency** | **str** | | [optional] | -| **reason** | **str** | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateRefund400Response.md b/docs/CreateRefund400Response.md deleted file mode 100644 index dcfcef7f..00000000 --- a/docs/CreateRefund400Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.refund.model.CreateRefund400Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateRefund403Response.md b/docs/CreateRefund403Response.md deleted file mode 100644 index bc8405a4..00000000 --- a/docs/CreateRefund403Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.refund.model.CreateRefund403Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] if omitted the server will use the default value of "UNAUTHORIZED" | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateRefund404Response.md b/docs/CreateRefund404Response.md deleted file mode 100644 index 3b8dc026..00000000 --- a/docs/CreateRefund404Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.refund.model.CreateRefund404Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] if omitted the server will use the default value of "DATA_NOT_FOUND" | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateRefund409Response.md b/docs/CreateRefund409Response.md deleted file mode 100644 index e6189981..00000000 --- a/docs/CreateRefund409Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.refund.model.CreateRefund409Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateRefund503Response.md b/docs/CreateRefund503Response.md deleted file mode 100644 index b50bffd7..00000000 --- a/docs/CreateRefund503Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.refund.model.CreateRefund503Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Currency.md b/docs/Currency.md deleted file mode 100644 index 547a7e07..00000000 --- a/docs/Currency.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.balance_and_transaction.model.Currency - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["IDR", "PHP", "USD", "JPY", "VND", "SGD", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SPL", "SRD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Customer.md b/docs/Customer.md deleted file mode 100644 index bf6e69ac..00000000 --- a/docs/Customer.md +++ /dev/null @@ -1,27 +0,0 @@ -# xendit.customer.model.Customer - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **reference_id** | **str** | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | -| **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | | | -| **business_detail** | [**BusinessDetail**](BusinessDetail.md) | | | -| **description** | **str, none_type** | | | -| **email** | **str, none_type** | | | -| **mobile_number** | **str, none_type** | | | -| **phone_number** | **str, none_type** | | | -| **addresses** | [**[Address], none_type**](Address.md) | | | -| **identity_accounts** | [**[IdentityAccountResponse], none_type**](IdentityAccountResponse.md) | | | -| **kyc_documents** | [**[KYCDocumentResponse], none_type**](KYCDocumentResponse.md) | | | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | -| **id** | **str** | | | -| **created** | **datetime** | | | -| **updated** | **datetime** | | | -| **type** | **str** | | defaults to "INDIVIDUAL" | -| **status** | [**EndCustomerStatus**](EndCustomerStatus.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CustomerApi.md b/docs/CustomerApi.md index 0bee67b0..a27cd107 100644 --- a/docs/CustomerApi.md +++ b/docs/CustomerApi.md @@ -1,25 +1,54 @@ -# xendit.apis.CustomerApi +# CustomerApi + + +You can use the APIs below to interface with Xendit's `CustomerApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```python +import time +import xendit +from xendit.apis import CustomerApi + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() + +# Create an instance of the API class +api_instance = CustomerApi(api_client) +``` All URIs are relative to *https://api.xendit.co* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_customer**](CustomerApi.md#create_customer) | **POST** /customers | Create Customer -[**get_customer**](CustomerApi.md#get_customer) | **GET** /customers/{id} | Get Customer By ID -[**get_customer_by_reference_id**](CustomerApi.md#get_customer_by_reference_id) | **GET** /customers | GET customers by reference id -[**update_customer**](CustomerApi.md#update_customer) | **PATCH** /customers/{id} | Update End Customer Resource +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**create_customer**](CustomerApi.md#create_customer-function) | **POST** /customers | Create Customer | +| [**get_customer**](CustomerApi.md#get_customer-function) | **GET** /customers/{id} | Get Customer By ID | +| [**get_customer_by_reference_id**](CustomerApi.md#get_customer_by_reference_id-function) | **GET** /customers | GET customers by reference id | +| [**update_customer**](CustomerApi.md#update_customer-function) | **PATCH** /customers/{id} | Update End Customer Resource | -# **create_customer** +# `create_customer()` Function > Customer create_customer() Create Customer -Function to create a customer that you may use in your Invoice or Payment Requests. For detail explanations, see this link: https://developers.xendit.co/api-reference/#create-customer +| Name | Value | +|--------------------|:-------------:| +| Function Name | `create_customer` | +| Request Parameters | [CreateCustomerRequestParams](#request-parameters--CreateCustomerRequestParams) | +| Return Type | [**Customer**](customer/Customer.md) | -### Example +### Request Parameters - CreateCustomerRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **idempotency_key** | **str**| | | +| **for_user_id** | **str**| | | +| **customer_request** | [**CustomerRequest**](customer/CustomerRequest.md)| | | +### Usage Example ```python import time import xendit @@ -38,6 +67,79 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = CustomerApi(api_client) +idempotency_key = "idempotency-123" # str | A unique key to prevent processing duplicate requests. +for_user_id = "user-1" # str | The sub-account user-id that you want to make this transaction for. +customer_request = CustomerRequest( + client_name="AirAsia Indonesia", + reference_id="reference_id_example", + type="INDIVIDUAL", + individual_detail=IndividualDetail( + given_names="given_names_example", + given_names_non_roman="given_names_non_roman_example", + middle_name="middle_name_example", + surname="surname_example", + surname_non_roman="surname_non_roman_example", + mother_maiden_name="mother_maiden_name_example", + gender="MALE", + date_of_birth="2017-07-21", + nationality=CountryCode("ID"), + place_of_birth="place_of_birth_example", + employment=EmploymentDetail( + employer_name="employer_name_example", + nature_of_business="nature_of_business_example", + role_description="role_description_example", + ), + ), + business_detail=BusinessDetail( + business_name="business_name_example", + business_type="CORPORATION", + date_of_registration="2017-07-21", + nature_of_business="nature_of_business_example", + business_domicile=CountryCode("ID"), + ), + description="description_example", + email="info@xendit.co", + mobile_number="+6281295412345", + phone_number="+6281295412345", + addresses=[ + AddressRequest( + category="category_example", + country_code=CountryCode("ID"), + province_state="province_state_example", + city="city_example", + suburb="suburb_example", + postal_code="postal_code_example", + line_1="line_1_example", + line_2="line_2_example", + status=AddressStatus("ACTIVE"), + is_primary=False, + ), + ], + identity_accounts=[ + IdentityAccountRequest( + type=IdentityAccountType("BANK_ACCOUNT"), + company="company_example", + description="description_example", + country=CountryCode("ID"), + properties=IdentityAccountRequestProperties(None), + ), + ], + kyc_documents=[ + KYCDocumentRequest( + country=CountryCode("ID"), + type=KYCDocumentType("BIRTH_CERTIFICATE"), + sub_type=KYCDocumentSubType("NATIONAL_ID"), + document_name="KTP", + document_number="AA123467890", + expires_at="2017-07-21", + holder_name="John Doe", + document_images=[ + "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc=", + ], + ), + ], + metadata={}, + ) # CustomerRequest | Request object for end customer object # example passing only required values which don't have defaults set # and optional values @@ -49,40 +151,25 @@ except xendit.XenditSdkException as e: print("Exception when calling CustomerApi->create_customer: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **idempotency_key** | **str**| A unique key to prevent processing duplicate requests. | [optional] - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. | [optional] - **customer_request** | [**CustomerRequest**](CustomerRequest.md)| Request object for end customer object | [optional] - -### Return type - -[**Customer**](Customer.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Created End Customer | - | -**400** | Various errors | - | -**0** | Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_customer** +# `get_customer()` Function > Customer get_customer(id) Get Customer By ID -Retrieves a single customer object For detail explanations, see this link: https://developers.xendit.co/api-reference/#get-customer +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_customer` | +| Request Parameters | [GetCustomerRequestParams](#request-parameters--GetCustomerRequestParams) | +| Return Type | [**Customer**](customer/Customer.md) | -### Example +### Request Parameters - GetCustomerRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -102,6 +189,7 @@ api_client = xendit.ApiClient() # Create an instance of the API class api_instance = CustomerApi(api_client) id = "d290f1ee-6c54-4b01-90e6-d701748f0851" # str | End customer resource id +for_user_id = "user-1" # str | The sub-account user-id that you want to make this transaction for. # example passing only required values which don't have defaults set try: @@ -121,40 +209,25 @@ except xendit.XenditSdkException as e: print("Exception when calling CustomerApi->get_customer: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| End customer resource id | - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. | [optional] - -### Return type - -[**Customer**](Customer.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | End Customer Resource | - | -**400** | Various errors | - | -**404** | Customer not found | - | -**0** | Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_customer_by_reference_id** +# `get_customer_by_reference_id()` Function > GetCustomerByReferenceID200Response get_customer_by_reference_id(reference_id) GET customers by reference id -Retrieves an array with a customer object that matches the provided reference_id - the identifier provided by you For detail explanations, see this link: https://developers.xendit.co/api-reference/#get-customer-by-reference-id +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_customer_by_reference_id` | +| Request Parameters | [GetCustomerByReferenceIdRequestParams](#request-parameters--GetCustomerByReferenceIdRequestParams) | +| Return Type | [**GetCustomerByReferenceID200Response**](customer/GetCustomerByReferenceID200Response.md) | -### Example +### Request Parameters - GetCustomerByReferenceIdRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **reference_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -173,6 +246,7 @@ api_client = xendit.ApiClient() # Create an instance of the API class api_instance = CustomerApi(api_client) reference_id = "reference_id_example" # str | Merchant's reference of end customer +for_user_id = "user-1" # str | The sub-account user-id that you want to make this transaction for. # example passing only required values which don't have defaults set try: @@ -192,39 +266,26 @@ except xendit.XenditSdkException as e: print("Exception when calling CustomerApi->get_customer_by_reference_id: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **reference_id** | **str**| Merchant's reference of end customer | - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. | [optional] - -### Return type - -[**GetCustomerByReferenceID200Response**](GetCustomerByReferenceID200Response.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | End Customers | - | -**400** | Various errors | - | -**0** | Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_customer** +# `update_customer()` Function > Customer update_customer(id) Update End Customer Resource -Function to update an existing customer. For a detailed explanation For detail explanations, see this link: https://developers.xendit.co/api-reference/#update-customer +| Name | Value | +|--------------------|:-------------:| +| Function Name | `update_customer` | +| Request Parameters | [UpdateCustomerRequestParams](#request-parameters--UpdateCustomerRequestParams) | +| Return Type | [**Customer**](customer/Customer.md) | -### Example +### Request Parameters - UpdateCustomerRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +| **patch_customer** | [**PatchCustomer**](customer/PatchCustomer.md)| | | +### Usage Example ```python import time import xendit @@ -244,6 +305,78 @@ api_client = xendit.ApiClient() # Create an instance of the API class api_instance = CustomerApi(api_client) id = "d290f1ee-6c54-4b01-90e6-d701748f0851" # str | End customer resource id +for_user_id = "user-1" # str | The sub-account user-id that you want to make this transaction for. +patch_customer = PatchCustomer( + client_name="AirAsia Indonesia", + reference_id="reference_id_example", + individual_detail=IndividualDetail( + given_names="given_names_example", + given_names_non_roman="given_names_non_roman_example", + middle_name="middle_name_example", + surname="surname_example", + surname_non_roman="surname_non_roman_example", + mother_maiden_name="mother_maiden_name_example", + gender="MALE", + date_of_birth="2017-07-21", + nationality=CountryCode("ID"), + place_of_birth="place_of_birth_example", + employment=EmploymentDetail( + employer_name="employer_name_example", + nature_of_business="nature_of_business_example", + role_description="role_description_example", + ), + ), + business_detail=BusinessDetail( + business_name="business_name_example", + business_type="CORPORATION", + date_of_registration="2017-07-21", + nature_of_business="nature_of_business_example", + business_domicile=CountryCode("ID"), + ), + description="description_example", + email="info@xendit.co", + mobile_number="+6281295412345", + phone_number="+6281295412345", + metadata={}, + addresses=[ + AddressRequest( + category="category_example", + country_code=CountryCode("ID"), + province_state="province_state_example", + city="city_example", + suburb="suburb_example", + postal_code="postal_code_example", + line_1="line_1_example", + line_2="line_2_example", + status=AddressStatus("ACTIVE"), + is_primary=False, + ), + ], + identity_accounts=[ + IdentityAccountRequest( + type=IdentityAccountType("BANK_ACCOUNT"), + company="company_example", + description="description_example", + country=CountryCode("ID"), + properties=IdentityAccountRequestProperties(None), + ), + ], + kyc_documents=[ + KYCDocumentRequest( + country=CountryCode("ID"), + type=KYCDocumentType("BIRTH_CERTIFICATE"), + sub_type=KYCDocumentSubType("NATIONAL_ID"), + document_name="KTP", + document_number="AA123467890", + expires_at="2017-07-21", + holder_name="John Doe", + document_images=[ + "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc=", + ], + ), + ], + status=EndCustomerStatus("ACTIVE"), + ) # PatchCustomer | Update Request for end customer object # example passing only required values which don't have defaults set try: @@ -263,27 +396,4 @@ except xendit.XenditSdkException as e: print("Exception when calling CustomerApi->update_customer: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| End customer resource id | - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. | [optional] - **patch_customer** | [**PatchCustomer**](PatchCustomer.md)| Update Request for end customer object | [optional] - -### Return type - -[**Customer**](Customer.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Updated End Customer | - | -**400** | Various errors | - | -**0** | Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to README]](../README.md) diff --git a/docs/CustomerObject.md b/docs/CustomerObject.md deleted file mode 100644 index fc088c9a..00000000 --- a/docs/CustomerObject.md +++ /dev/null @@ -1,20 +0,0 @@ -# xendit.invoice.model.CustomerObject - -An object representing a customer with various properties, including addresses. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **id** | **str, none_type** | The unique identifier for the customer. | [optional] | -| **phone_number** | **str, none_type** | The customer's phone number. | [optional] | -| **given_names** | **str, none_type** | The customer's given names or first names. | [optional] | -| **surname** | **str, none_type** | The customer's surname or last name. | [optional] | -| **email** | **str, none_type** | The customer's email address. | [optional] | -| **mobile_number** | **str, none_type** | The customer's mobile phone number. | [optional] | -| **customer_id** | **str, none_type** | An additional identifier for the customer. | [optional] | -| **addresses** | [**[AddressObject], none_type**](AddressObject.md) | An array of addresses associated with the customer. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CustomerRequest.md b/docs/CustomerRequest.md deleted file mode 100644 index e6922cc6..00000000 --- a/docs/CustomerRequest.md +++ /dev/null @@ -1,24 +0,0 @@ -# xendit.customer.model.CustomerRequest - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **reference_id** | **str** | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | -| **client_name** | **str** | Entity's name for this client | [optional] | -| **type** | **str** | | [optional] if omitted the server will use the default value of "INDIVIDUAL" | -| **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | | [optional] | -| **business_detail** | [**BusinessDetail**](BusinessDetail.md) | | [optional] | -| **description** | **str, none_type** | | [optional] | -| **email** | **str** | | [optional] | -| **mobile_number** | **str** | | [optional] | -| **phone_number** | **str** | | [optional] | -| **addresses** | [**[AddressRequest]**](AddressRequest.md) | | [optional] | -| **identity_accounts** | [**[IdentityAccountRequest]**](IdentityAccountRequest.md) | | [optional] | -| **kyc_documents** | [**[KYCDocumentRequest]**](KYCDocumentRequest.md) | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DateRangeFilter.md b/docs/DateRangeFilter.md deleted file mode 100644 index 9a5ec8f2..00000000 --- a/docs/DateRangeFilter.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.balance_and_transaction.model.DateRangeFilter - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **gte** | **datetime** | Start time of transaction. If not specified will list all dates. | [optional] | -| **lte** | **datetime** | End time of transaction. If not specified will list all dates. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DigitalPayoutChannelProperties.md b/docs/DigitalPayoutChannelProperties.md deleted file mode 100644 index da4bcf7c..00000000 --- a/docs/DigitalPayoutChannelProperties.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.payout.model.DigitalPayoutChannelProperties - -Channel information for digital destinations (banks, e-wallets) - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **account_number** | **str** | Registered account number | | -| **account_holder_name** | **str, none_type** | Registered account name | [optional] | -| **account_type** | [**ChannelAccountType**](ChannelAccountType.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebit.md b/docs/DirectDebit.md deleted file mode 100644 index 82b870df..00000000 --- a/docs/DirectDebit.md +++ /dev/null @@ -1,17 +0,0 @@ -# xendit.payment_request.model.DirectDebit - -Direct Debit Payment Method Details - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | | | -| **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | | | -| **type** | [**DirectDebitType**](DirectDebitType.md) | | | -| **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | [optional] | -| **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitAllOf.md b/docs/DirectDebitAllOf.md deleted file mode 100644 index cf9ad0a0..00000000 --- a/docs/DirectDebitAllOf.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.DirectDebitAllOf - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **type** | [**DirectDebitType**](DirectDebitType.md) | | | -| **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | [optional] | -| **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitBankAccount.md b/docs/DirectDebitBankAccount.md deleted file mode 100644 index 257a6531..00000000 --- a/docs/DirectDebitBankAccount.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.DirectDebitBankAccount - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **masked_bank_account_number** | **str, none_type** | | [optional] | -| **bank_account_hash** | **str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitChannelCode.md b/docs/DirectDebitChannelCode.md deleted file mode 100644 index 6d2005c0..00000000 --- a/docs/DirectDebitChannelCode.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.DirectDebitChannelCode - -Direct Debit Channel Code - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Direct Debit Channel Code | must be one of ["BCA_KLIKPAY", "BCA_ONEKLIK", "BRI", "BNI", "MANDIRI", "BPI", "BDO", "CIMBNIAGA", "MTB", "RCBC", "UBP", "AUTODEBIT_UBP", "CHINABANK", "BAY", "KTB", "BBL", "SCB", "KBANK_MB", "BAY_MB", "KTB_MB", "BBL_MB", "SCB_MB", "BDO_EPAY", "AFFIN_FPX", "AGRO_FPX", "ALLIANCE_FPX", "AMBANK_FPX", "ISLAM_FPX", "MUAMALAT_FPX", "BOC_FPX", "RAKYAT_FPX", "BSN_FPX", "CIMB_FPX", "HLB_FPX", "HSBC_FPX", "KFH_FPX", "MAYB2E_FPX", "MAYB2U_FPX", "OCBC_FPX", "PUBLIC_FPX", "RHB_FPX", "SCH_FPX", "UOB_FPX", "AFFIN_FPX_BUSINESS", "AGRO_FPX_BUSINESS", "ALLIANCE_FPX_BUSINESS", "AMBANK_FPX_BUSINESS", "ISLAM_FPX_BUSINESS", "MUAMALAT_FPX_BUSINESS", "BNP_FPX_BUSINESS", "CIMB_FPX_BUSINESS", "CITIBANK_FPX_BUSINESS", "DEUTSCHE_FPX_BUSINESS", "HLB_FPX_BUSINESS", "HSBC_FPX_BUSINESS", "RAKYAT_FPX_BUSINESS", "KFH_FPX_BUSINESS", "MAYB2E_FPX_BUSINESS", "OCBC_FPX_BUSINESS", "PUBLIC_FPX_BUSINESS", "RHB_FPX_BUSINESS", "SCH_FPX_BUSINESS", "UOB_FPX_BUSINESS", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitChannelProperties.md b/docs/DirectDebitChannelProperties.md deleted file mode 100644 index f2db2d75..00000000 --- a/docs/DirectDebitChannelProperties.md +++ /dev/null @@ -1,19 +0,0 @@ -# xendit.payment_request.model.DirectDebitChannelProperties - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **mobile_number** | **str** | Mobile number of the customer registered to the partner channel | [optional] | -| **success_return_url** | **str** | | [optional] | -| **failure_return_url** | **str** | | [optional] | -| **identity_document_number** | **str** | | [optional] | -| **account_number** | **str** | | [optional] | -| **card_last_four** | **str** | Last four digits of the debit card | [optional] | -| **card_expiry** | **str** | Expiry month and year of the debit card (in MM/YY format) | [optional] | -| **email** | **str** | Email address of the customer that is registered to the partner channel | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitChannelPropertiesBankAccount.md b/docs/DirectDebitChannelPropertiesBankAccount.md deleted file mode 100644 index 9f23e478..00000000 --- a/docs/DirectDebitChannelPropertiesBankAccount.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.payment_request.model.DirectDebitChannelPropertiesBankAccount - -Direct Debit Bank Account Channel Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **success_return_url** | **str** | | [optional] | -| **failure_return_url** | **str** | | [optional] | -| **mobile_number** | **str** | | [optional] | -| **identity_document_number** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitChannelPropertiesBankRedirect.md b/docs/DirectDebitChannelPropertiesBankRedirect.md deleted file mode 100644 index 85d7ccdf..00000000 --- a/docs/DirectDebitChannelPropertiesBankRedirect.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.payment_request.model.DirectDebitChannelPropertiesBankRedirect - -Direct Debit Bank Account Channel Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **mobile_number** | **str** | Mobile number of the customer that is registered to channel | [optional] | -| **success_return_url** | **str** | | [optional] | -| **failure_return_url** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitChannelPropertiesDebitCard.md b/docs/DirectDebitChannelPropertiesDebitCard.md deleted file mode 100644 index 482e7a5e..00000000 --- a/docs/DirectDebitChannelPropertiesDebitCard.md +++ /dev/null @@ -1,17 +0,0 @@ -# xendit.payment_request.model.DirectDebitChannelPropertiesDebitCard - -Direct Debit Debit Card Channel Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **mobile_number** | **str** | Mobile number of the customer registered to the partner channel | [optional] | -| **account_number** | **str** | | [optional] | -| **card_last_four** | **str** | Last four digits of the debit card | [optional] | -| **card_expiry** | **str** | Expiry month and year of the debit card (in MM/YY format) | [optional] | -| **email** | **str** | Email address of the customer that is registered to the partner channel | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitDebitCard.md b/docs/DirectDebitDebitCard.md deleted file mode 100644 index 464bd56f..00000000 --- a/docs/DirectDebitDebitCard.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.payment_request.model.DirectDebitDebitCard - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **mobile_number** | **str, none_type** | Mobile number of the customer registered to the partner channel | [optional] | -| **account_number** | **str** | | [optional] | -| **card_last_four** | **str, none_type** | Last four digits of the debit card | [optional] | -| **card_expiry** | **str, none_type** | Expiry month and year of the debit card (in MM/YY format) | [optional] | -| **email** | **str, none_type** | Email address of the customer that is registered to the partner channel | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitParameters.md b/docs/DirectDebitParameters.md deleted file mode 100644 index 990364b7..00000000 --- a/docs/DirectDebitParameters.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.DirectDebitParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | | | -| **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | | | -| **type** | [**DirectDebitType**](DirectDebitType.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DirectDebitType.md b/docs/DirectDebitType.md deleted file mode 100644 index 18ac06eb..00000000 --- a/docs/DirectDebitType.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.DirectDebitType - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["DEBIT_CARD", "BANK_ACCOUNT", "BANK_REDIRECT", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EWallet.md b/docs/EWallet.md deleted file mode 100644 index 9aa15186..00000000 --- a/docs/EWallet.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.payment_request.model.EWallet - -Ewallet Payment Method Details - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | | [optional] | -| **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | [optional] | -| **account** | [**EWalletAccount**](EWalletAccount.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EWalletAccount.md b/docs/EWalletAccount.md deleted file mode 100644 index 0b4acaeb..00000000 --- a/docs/EWalletAccount.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.payment_request.model.EWalletAccount - -EWallet Account Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **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 | [optional] | -| **account_details** | **str, none_type** | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | [optional] | -| **balance** | **float, none_type** | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | [optional] | -| **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 | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EWalletAllOf.md b/docs/EWalletAllOf.md deleted file mode 100644 index 96ccaa56..00000000 --- a/docs/EWalletAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.payment_request.model.EWalletAllOf - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **account** | [**EWalletAccount**](EWalletAccount.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EWalletChannelCode.md b/docs/EWalletChannelCode.md deleted file mode 100644 index aeb031e9..00000000 --- a/docs/EWalletChannelCode.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.EWalletChannelCode - -Ewallet Channel Code - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Ewallet Channel Code | must be one of ["GCASH", "GRABPAY", "PAYMAYA", "DANA", "OVO", "LINKAJA", "SHOPEEPAY", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EWalletChannelProperties.md b/docs/EWalletChannelProperties.md deleted file mode 100644 index cf4f7590..00000000 --- a/docs/EWalletChannelProperties.md +++ /dev/null @@ -1,18 +0,0 @@ -# xendit.payment_request.model.EWalletChannelProperties - -Ewallet Channel Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **success_return_url** | **str** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **failure_return_url** | **str** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **cancel_return_url** | **str** | URL where the end-customer is redirected if the authorization cancelled | [optional] | -| **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. | [optional] | -| **mobile_number** | **str** | | [optional] | -| **cashtag** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EWalletParameters.md b/docs/EWalletParameters.md deleted file mode 100644 index 881548a0..00000000 --- a/docs/EWalletParameters.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.EWalletParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | | [optional] | -| **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EmploymentDetail.md b/docs/EmploymentDetail.md deleted file mode 100644 index 4d9ead41..00000000 --- a/docs/EmploymentDetail.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.customer.model.EmploymentDetail - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **employer_name** | **str, none_type** | Name of employer | [optional] | -| **nature_of_business** | **str, none_type** | Industry or nature of business | [optional] | -| **role_description** | **str, none_type** | Occupation or title | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EndCustomerStatus.md b/docs/EndCustomerStatus.md deleted file mode 100644 index ccefe2bb..00000000 --- a/docs/EndCustomerStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.EndCustomerStatus - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["ACTIVE", "INACTIVE", "PENDING", "BLOCKED", "DELETED", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Error.md b/docs/Error.md deleted file mode 100644 index d87093c6..00000000 --- a/docs/Error.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.Error - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str, none_type** | | [optional] | -| **message** | **str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ErrorErrorsInner.md b/docs/ErrorErrorsInner.md deleted file mode 100644 index ad3a4c8c..00000000 --- a/docs/ErrorErrorsInner.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payout.model.ErrorErrorsInner - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **path** | **str** | Precise location of the error | | -| **message** | **str** | Specific description of the error | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Ewallet.md b/docs/Ewallet.md deleted file mode 100644 index ee7b24e1..00000000 --- a/docs/Ewallet.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.invoice.model.Ewallet - -An object representing e-wallet details for invoices. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ewallet_type** | [**EwalletType**](EwalletType.md) | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EwalletType.md b/docs/EwalletType.md deleted file mode 100644 index e59f9e8d..00000000 --- a/docs/EwalletType.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.EwalletType - -Representing the available eWallet channels used for invoice-related transactions. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing the available eWallet channels used for invoice-related transactions. | must be one of ["OVO", "DANA", "LINKAJA", "PAYMAYA", "SHOPEEPAY", "GCASH", "GRABPAY", "ASTRAPAY", "NEXCASH", "JENIUSPAY", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FeeResponse.md b/docs/FeeResponse.md deleted file mode 100644 index 70cf6657..00000000 --- a/docs/FeeResponse.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.balance_and_transaction.model.FeeResponse - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **xendit_fee** | **float** | Amount of the Xendit fee for this transaction. | | -| **value_added_tax** | **float** | Amount of the VAT for this transaction. | | -| **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. | [optional] | -| **third_party_withholding_tax** | **float** | Amount of the 3rd Party Withholding Tax for this transaction if applicable. 3rd party example: Bank | [optional] | -| **status** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ForbiddenError.md b/docs/ForbiddenError.md deleted file mode 100644 index 93862fe2..00000000 --- a/docs/ForbiddenError.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.ForbiddenError - -An error object used to indicate a 403 Forbidden response related to invoice operations. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **message** | **str** | A human-readable error message providing additional context about the 403 Forbidden response. | | -| **error_code** | **str** | The specific error code indicating that access to the invoice operation is suspended. | defaults to "ACCESS_SUSPENDED" | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetAllPaymentMethods400Response.md b/docs/GetAllPaymentMethods400Response.md deleted file mode 100644 index 6abab2fe..00000000 --- a/docs/GetAllPaymentMethods400Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.GetAllPaymentMethods400Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetAllPaymentMethods403Response.md b/docs/GetAllPaymentMethods403Response.md deleted file mode 100644 index 0e4040db..00000000 --- a/docs/GetAllPaymentMethods403Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.GetAllPaymentMethods403Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetAllPaymentMethods404Response.md b/docs/GetAllPaymentMethods404Response.md deleted file mode 100644 index 67550921..00000000 --- a/docs/GetAllPaymentMethods404Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.GetAllPaymentMethods404Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] if omitted the server will use the default value of "DATA_NOT_FOUND" | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetAllPaymentMethodsDefaultResponse.md b/docs/GetAllPaymentMethodsDefaultResponse.md deleted file mode 100644 index 162f919f..00000000 --- a/docs/GetAllPaymentMethodsDefaultResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.GetAllPaymentMethodsDefaultResponse - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetAllRefundsDefaultResponse.md b/docs/GetAllRefundsDefaultResponse.md deleted file mode 100644 index f6838072..00000000 --- a/docs/GetAllRefundsDefaultResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.refund.model.GetAllRefundsDefaultResponse - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetCustomerByReferenceID200Response.md b/docs/GetCustomerByReferenceID200Response.md deleted file mode 100644 index 82c7c778..00000000 --- a/docs/GetCustomerByReferenceID200Response.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.GetCustomerByReferenceID200Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **has_more** | **bool** | | [optional] | -| **data** | [**[Customer]**](Customer.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetCustomerByReferenceID400Response.md b/docs/GetCustomerByReferenceID400Response.md deleted file mode 100644 index 2af43902..00000000 --- a/docs/GetCustomerByReferenceID400Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.customer.model.GetCustomerByReferenceID400Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | | -| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | -| **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetCustomerByReferenceID400ResponseAllOf.md b/docs/GetCustomerByReferenceID400ResponseAllOf.md deleted file mode 100644 index 2c937414..00000000 --- a/docs/GetCustomerByReferenceID400ResponseAllOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.GetCustomerByReferenceID400ResponseAllOf - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetPayouts200Response.md b/docs/GetPayouts200Response.md deleted file mode 100644 index e321dc21..00000000 --- a/docs/GetPayouts200Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payout.model.GetPayouts200Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **data** | [**[GetPayouts200ResponseDataInner]**](GetPayouts200ResponseDataInner.md) | | [optional] | -| **has_more** | **bool** | | [optional] | -| **links** | [**GetPayouts200ResponseLinks**](GetPayouts200ResponseLinks.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetPayouts200ResponseDataInner.md b/docs/GetPayouts200ResponseDataInner.md deleted file mode 100644 index 20e59738..00000000 --- a/docs/GetPayouts200ResponseDataInner.md +++ /dev/null @@ -1,26 +0,0 @@ -# xendit.payout.model.GetPayouts200ResponseDataInner - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **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 | [optional] | -| **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Object of additional information you may use | [optional] | -| **failure_code** | **str** | If the Payout failed, we include a failure code for more details on the failure. | [optional] | -| **estimated_arrival_time** | **datetime** | Our estimated time on to when your payout is reflected to the destination account | [optional] | -| **reference_id** | **str** | A client defined payout identifier | [optional] | -| **channel_code** | **str** | Channel code of selected destination bank or e-wallet | [optional] | -| **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | | [optional] | -| **amount** | **float** | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | [optional] | -| **currency** | **str** | Currency of the destination channel using ISO-4217 currency code | [optional] | -| **id** | **str** | Xendit-generated unique identifier for each payout | [optional] | -| **created** | **datetime** | The time payout was created on Xendit's system, in ISO 8601 format | [optional] | -| **updated** | **datetime** | The time payout was last updated on Xendit's system, in ISO 8601 format | [optional] | -| **business_id** | **str** | Xendit Business ID | [optional] | -| **status** | **str** | Status of payout | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetPayouts200ResponseLinks.md b/docs/GetPayouts200ResponseLinks.md deleted file mode 100644 index ad7ee050..00000000 --- a/docs/GetPayouts200ResponseLinks.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payout.model.GetPayouts200ResponseLinks - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **href** | **str** | | [optional] | -| **rel** | **str** | | [optional] | -| **method** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/IdentityAccountRequest.md b/docs/IdentityAccountRequest.md deleted file mode 100644 index e0051e3c..00000000 --- a/docs/IdentityAccountRequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.customer.model.IdentityAccountRequest - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **type** | [**IdentityAccountType**](IdentityAccountType.md) | | [optional] | -| **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 | [optional] | -| **description** | **str** | Free text description of this account | [optional] | -| **country** | [**CountryCode**](CountryCode.md) | | [optional] | -| **properties** | [**IdentityAccountRequestProperties**](IdentityAccountRequestProperties.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/IdentityAccountRequestProperties.md b/docs/IdentityAccountRequestProperties.md deleted file mode 100644 index d13e7c3b..00000000 --- a/docs/IdentityAccountRequestProperties.md +++ /dev/null @@ -1,22 +0,0 @@ -# xendit.customer.model.IdentityAccountRequestProperties - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **account_number** | **str** | Unique account identifier as per the bank records. | [optional] | -| **account_holder_name** | **str, none_type** | Name of account holder as per the cardless credit account. | [optional] | -| **swift_code** | **str, none_type** | The SWIFT code for international payments | [optional] | -| **account_type** | **str, none_type** | Free text account type, e.g., Savings, Transaction, Virtual Account. | [optional] | -| **account_details** | **str, none_type** | Potentially masked account detail, for display purposes only. | [optional] | -| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] | -| **token_id** | **str** | The token id returned in tokenisation | [optional] | -| **account_id** | **str** | Alphanumeric string identifying this account. Usually an email address or phone number. | [optional] | -| **payment_code** | **str** | Complete fixed payment code (including prefix) | [optional] | -| **expires_at** | **str, none_type** | YYYY-MM-DD string with expiry date for the payment code | [optional] | -| **qr_string** | **str** | String representation of the QR Code image | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/IdentityAccountResponse.md b/docs/IdentityAccountResponse.md deleted file mode 100644 index 7a83c986..00000000 --- a/docs/IdentityAccountResponse.md +++ /dev/null @@ -1,20 +0,0 @@ -# xendit.customer.model.IdentityAccountResponse - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **company** | **str, none_type** | | | -| **description** | **str, none_type** | | | -| **country** | [**CountryCode**](CountryCode.md) | | | -| **type** | **str, none_type** | | | -| **properties** | [**IdentityAccountResponseProperties**](IdentityAccountResponseProperties.md) | | | -| **id** | **str** | | [optional] | -| **code** | **str, none_type** | | [optional] | -| **holder_name** | **str, none_type** | | [optional] | -| **created** | **datetime** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/IdentityAccountResponseProperties.md b/docs/IdentityAccountResponseProperties.md deleted file mode 100644 index a3084cf2..00000000 --- a/docs/IdentityAccountResponseProperties.md +++ /dev/null @@ -1,22 +0,0 @@ -# xendit.customer.model.IdentityAccountResponseProperties - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **account_number** | **str** | Unique account identifier as per the bank records. | [optional] | -| **account_holder_name** | **str, none_type** | Name of account holder as per the cardless credit account. | [optional] | -| **swift_code** | **str, none_type** | The SWIFT code for international payments | [optional] | -| **account_type** | **str, none_type** | Free text account type, e.g., Savings, Transaction, Virtual Account. | [optional] | -| **account_details** | **str, none_type** | Potentially masked account detail, for display purposes only. | [optional] | -| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] | -| **token_id** | **str** | The token id returned in tokenisation | [optional] | -| **payment_code** | **str** | Complete fixed payment code (including prefix) | [optional] | -| **expires_at** | **str, none_type** | YYYY-MM-DD string with expiry date for the payment code | [optional] | -| **qr_string** | **str** | String representation of the QR Code image | [optional] | -| **account_id** | **str** | Alphanumeric string identifying this account. Usually an email address or phone number. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/IdentityAccountType.md b/docs/IdentityAccountType.md deleted file mode 100644 index 8ec70d10..00000000 --- a/docs/IdentityAccountType.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.IdentityAccountType - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["BANK_ACCOUNT", "EWALLET", "CREDIT_CARD", "PAY_LATER", "OTC", "QR_CODE", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/IndividualDetail.md b/docs/IndividualDetail.md deleted file mode 100644 index e608e64e..00000000 --- a/docs/IndividualDetail.md +++ /dev/null @@ -1,22 +0,0 @@ -# xendit.customer.model.IndividualDetail - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **given_names** | **str** | | [optional] | -| **given_names_non_roman** | **str, none_type** | | [optional] | -| **middle_name** | **str, none_type** | | [optional] | -| **surname** | **str, none_type** | | [optional] | -| **surname_non_roman** | **str, none_type** | | [optional] | -| **mother_maiden_name** | **str, none_type** | | [optional] | -| **gender** | **str, none_type** | | [optional] | -| **date_of_birth** | **str, none_type** | | [optional] | -| **nationality** | [**CountryCode**](CountryCode.md) | | [optional] | -| **place_of_birth** | **str, none_type** | | [optional] | -| **employment** | [**EmploymentDetail**](EmploymentDetail.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Invoice.md b/docs/Invoice.md deleted file mode 100644 index 9a641a20..00000000 --- a/docs/Invoice.md +++ /dev/null @@ -1,45 +0,0 @@ -# xendit.invoice.model.Invoice - -An object representing details for an invoice. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **external_id** | **str** | The external identifier for the invoice. | | -| **user_id** | **str** | The user ID associated with the invoice. | | -| **status** | [**InvoiceStatus**](InvoiceStatus.md) | | | -| **merchant_name** | **str** | The name of the merchant. | | -| **merchant_profile_picture_url** | **str** | The URL of the merchant's profile picture. | | -| **amount** | **float** | The total amount of the invoice. | | -| **expiry_date** | **datetime** | Representing a date and time in ISO 8601 format. | | -| **invoice_url** | **str** | The URL to view the invoice. | | -| **available_banks** | [**[Bank]**](Bank.md) | An array of available banks for payment. | | -| **available_retail_outlets** | [**[RetailOutlet]**](RetailOutlet.md) | An array of available retail outlets for payment. | | -| **available_ewallets** | [**[Ewallet]**](Ewallet.md) | An array of available e-wallets for payment. | | -| **available_qr_codes** | [**[QrCode]**](QrCode.md) | An array of available QR codes for payment. | | -| **available_direct_debits** | [**[DirectDebit]**](DirectDebit.md) | An array of available direct debit options for payment. | | -| **available_paylaters** | [**[Paylater]**](Paylater.md) | An array of available pay-later options for payment. | | -| **should_send_email** | **bool** | Indicates whether email notifications should be sent. | | -| **created** | **datetime** | Representing a date and time in ISO 8601 format. | | -| **updated** | **datetime** | Representing a date and time in ISO 8601 format. | | -| **id** | **str** | The unique identifier for the invoice. | [optional] | -| **payer_email** | **str** | The email address of the payer. | [optional] | -| **description** | **str** | A description of the invoice. | [optional] | -| **payment_method** | [**InvoicePaymentMethod**](InvoicePaymentMethod.md) | | [optional] | -| **locale** | **str** | The locale or language used for the invoice. | [optional] | -| **should_exclude_credit_card** | **bool** | Indicates whether credit card payments should be excluded. | [optional] | -| **success_redirect_url** | **str** | The URL to redirect to on successful payment. | [optional] | -| **failure_redirect_url** | **str** | The URL to redirect to on payment failure. | [optional] | -| **should_authenticate_credit_card** | **bool** | Indicates whether credit card authentication is required. | [optional] | -| **currency** | [**InvoiceCurrency**](InvoiceCurrency.md) | | [optional] | -| **items** | [**[InvoiceItem]**](InvoiceItem.md) | An array of items included in the invoice. | [optional] | -| **fixed_va** | **bool** | Indicates whether the virtual account is fixed. | [optional] | -| **reminder_date** | **datetime** | Representing a date and time in ISO 8601 format. | [optional] | -| **customer** | [**CustomerObject**](CustomerObject.md) | | [optional] | -| **customer_notification_preference** | [**NotificationPreference**](NotificationPreference.md) | | [optional] | -| **fees** | [**[InvoiceFee]**](InvoiceFee.md) | An array of fees associated with the invoice. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceApi.md b/docs/InvoiceApi.md index b79eecb2..13bf297b 100644 --- a/docs/InvoiceApi.md +++ b/docs/InvoiceApi.md @@ -1,22 +1,60 @@ -# xendit.apis.InvoiceApi +# InvoiceApi + + +You can use the APIs below to interface with Xendit's `InvoiceApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```python +import time +import xendit +from xendit.apis import InvoiceApi + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() + +# Create an instance of the API class +api_instance = InvoiceApi(api_client) +``` All URIs are relative to *https://api.xendit.co* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_invoice**](InvoiceApi.md#create_invoice) | **POST** /v2/invoices/ | Create an invoice -[**get_invoice_by_id**](InvoiceApi.md#get_invoice_by_id) | **GET** /v2/invoices/{invoice_id} | Get invoice by invoice id -[**get_invoices**](InvoiceApi.md#get_invoices) | **GET** /v2/invoices | Get all Invoices -[**expire_invoice**](InvoiceApi.md#expire_invoice) | **POST** /invoices/{invoice_id}/expire! | Manually expire an invoice +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**create_invoice**](InvoiceApi.md#create_invoice-function) | **POST** /v2/invoices/ | Create an invoice | +| [**get_invoice_by_id**](InvoiceApi.md#get_invoice_by_id-function) | **GET** /v2/invoices/{invoice_id} | Get invoice by invoice id | +| [**get_invoices**](InvoiceApi.md#get_invoices-function) | **GET** /v2/invoices | Get all Invoices | +| [**expire_invoice**](InvoiceApi.md#expire_invoice-function) | **POST** /invoices/{invoice_id}/expire! | Manually expire an invoice | -# **create_invoice** +# `create_invoice()` Function > Invoice create_invoice(create_invoice_request) Create an invoice -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `create_invoice` | +| Request Parameters | [CreateInvoiceRequestParams](#request-parameters--CreateInvoiceRequestParams) | +| Return Type | [**Invoice**](invoice/Invoice.md) | + +### Request Parameters - CreateInvoiceRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **create_invoice_request** | [**CreateInvoiceRequest**](invoice/CreateInvoiceRequest.md) | ☑️ | | +| **for_user_id** | **str**| | | + +### Usage Example +#### Create Invoice Request ```python import time @@ -107,7 +145,8 @@ create_invoice_request = CreateInvoiceRequest( value=3.14, ), ], - ) # CreateInvoiceRequest | + ) # CreateInvoiceRequest +for_user_id = "62efe4c33e45694d63f585f8" # str | Business ID of the sub-account merchant (XP feature) # example passing only required values which don't have defaults set try: @@ -127,39 +166,25 @@ except xendit.XenditSdkException as e: print("Exception when calling InvoiceApi->create_invoice: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **create_invoice_request** | [**CreateInvoiceRequest**](CreateInvoiceRequest.md)| | - **for_user_id** | **str**| Business ID of the sub-account merchant (XP feature) | [optional] - -### Return type - -[**Invoice**](Invoice.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**400** | Bad request | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | -**404** | Not found | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_invoice_by_id** +# `get_invoice_by_id()` Function > Invoice get_invoice_by_id(invoice_id) Get invoice by invoice id -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_invoice_by_id` | +| Request Parameters | [GetInvoiceByIdRequestParams](#request-parameters--GetInvoiceByIdRequestParams) | +| Return Type | [**Invoice**](invoice/Invoice.md) | + +### Request Parameters - GetInvoiceByIdRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **invoice_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -179,6 +204,7 @@ api_client = xendit.ApiClient() # Create an instance of the API class api_instance = InvoiceApi(api_client) invoice_id = "62efe4c33e45294d63f585f2" # str | Invoice ID +for_user_id = "62efe4c33e45694d63f585f8" # str | Business ID of the sub-account merchant (XP feature) # example passing only required values which don't have defaults set try: @@ -198,38 +224,38 @@ except xendit.XenditSdkException as e: print("Exception when calling InvoiceApi->get_invoice_by_id: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| Invoice ID | - **for_user_id** | **str**| Business ID of the sub-account merchant (XP feature) | [optional] - -### Return type - -[**Invoice**](Invoice.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_invoices** +# `get_invoices()` Function > [Invoice] get_invoices() Get all Invoices -### Example - - +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_invoices` | +| Request Parameters | [GetInvoicesRequestParams](#request-parameters--GetInvoicesRequestParams) | +| Return Type | [**[Invoice]**](invoice/Invoice.md) | + +### Request Parameters - GetInvoicesRequestParams + +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **for_user_id** | **str**| | | +| **external_id** | **str**| | | +| **statuses** | [**[InvoiceStatus]**](invoice/InvoiceStatus.md)| | | +| **limit** | **float**| | | +| **created_after** | **datetime**| | | +| **created_before** | **datetime**| | | +| **paid_after** | **datetime**| | | +| **paid_before** | **datetime**| | | +| **expired_after** | **datetime**| | | +| **expired_before** | **datetime**| | | +| **last_invoice** | **str**| | | +| **client_types** | [**[InvoiceClientType]**](invoice/InvoiceClientType.md)| | | +| **payment_channels** | **[str]**| | | +| **on_demand_link** | **str**| | | +| **recurring_payment_id** | **str**| | | + +### Usage Example ```python import time import xendit @@ -249,6 +275,25 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = InvoiceApi(api_client) +for_user_id = "62efe4c33e45694d63f585f8" # str | Business ID of the sub-account merchant (XP feature) +external_id = "test-external" # str +statuses = [ + InvoiceStatus("["PENDING","SETTLED"]"), + ] # [InvoiceStatus] +limit = 10 # float +created_after = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +created_before = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +paid_after = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +paid_before = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +expired_after = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +expired_before = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +last_invoice = "62efe4c33e45294d63f585f2" # str +client_types = [ + InvoiceClientType("["API_GATEWAY","DASHBOARD"]"), + ] # [InvoiceClientType] +payment_channels = ["BNI","BRI"] # [str] +on_demand_link = "test-link" # str +recurring_payment_id = "62efe4c33e45294d63f585f2" # str # example passing only required values which don't have defaults set # and optional values @@ -260,50 +305,25 @@ except xendit.XenditSdkException as e: print("Exception when calling InvoiceApi->get_invoices: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **for_user_id** | **str**| Business ID of the sub-account merchant (XP feature) | [optional] - **external_id** | **str**| | [optional] - **statuses** | [**[InvoiceStatus]**](InvoiceStatus.md)| | [optional] - **limit** | **float**| | [optional] - **created_after** | **datetime**| | [optional] - **created_before** | **datetime**| | [optional] - **paid_after** | **datetime**| | [optional] - **paid_before** | **datetime**| | [optional] - **expired_after** | **datetime**| | [optional] - **expired_before** | **datetime**| | [optional] - **last_invoice** | **str**| | [optional] - **client_types** | [**[InvoiceClientType]**](InvoiceClientType.md)| | [optional] - **payment_channels** | **[str]**| | [optional] - **on_demand_link** | **str**| | [optional] - **recurring_payment_id** | **str**| | [optional] - -### Return type - -[**[Invoice]**](Invoice.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | -**500** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **expire_invoice** +# `expire_invoice()` Function > Invoice expire_invoice(invoice_id) Manually expire an invoice -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `expire_invoice` | +| Request Parameters | [ExpireInvoiceRequestParams](#request-parameters--ExpireInvoiceRequestParams) | +| Return Type | [**Invoice**](invoice/Invoice.md) | + +### Request Parameters - ExpireInvoiceRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **invoice_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -322,6 +342,7 @@ api_client = xendit.ApiClient() # Create an instance of the API class api_instance = InvoiceApi(api_client) invoice_id = "5f4708b7bd394b0400b96276" # str | Invoice ID to be expired +for_user_id = "62efe4c33e45694d63f585f8" # str | Business ID of the sub-account merchant (XP feature) # example passing only required values which don't have defaults set try: @@ -341,26 +362,4 @@ except xendit.XenditSdkException as e: print("Exception when calling InvoiceApi->expire_invoice: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| Invoice ID to be expired | - **for_user_id** | **str**| Business ID of the sub-account merchant (XP feature) | [optional] - -### Return type - -[**Invoice**](Invoice.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to README]](../README.md) diff --git a/docs/InvoiceClientType.md b/docs/InvoiceClientType.md deleted file mode 100644 index b31a564a..00000000 --- a/docs/InvoiceClientType.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.InvoiceClientType - -Representing the client type or source of an invoice. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing the client type or source of an invoice. | must be one of ["DASHBOARD", "API_GATEWAY", "INTEGRATION", "ON_DEMAND", "RECURRING", "MOBILE", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceCurrency.md b/docs/InvoiceCurrency.md deleted file mode 100644 index f97bdb3f..00000000 --- a/docs/InvoiceCurrency.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.InvoiceCurrency - -Representing the currency used for an invoice. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing the currency used for an invoice. | must be one of ["IDR", "USD", "THB", "VND", "PHP", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceError404ResponseDefinition.md b/docs/InvoiceError404ResponseDefinition.md deleted file mode 100644 index bffce42f..00000000 --- a/docs/InvoiceError404ResponseDefinition.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.InvoiceError404ResponseDefinition - -An error object used to indicate that the requested resource, in this case, an invoice, was not found. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **message** | **str** | A human-readable error message providing additional context about the resource not being found. | | -| **error_code** | **str** | The specific error code indicating that the requested invoice was not found. | defaults to "INVOICE_NOT_FOUND_ERROR" | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceFee.md b/docs/InvoiceFee.md deleted file mode 100644 index bd7a61b3..00000000 --- a/docs/InvoiceFee.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.InvoiceFee - -An object representing internal details for a fee associated with an invoice. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **type** | **str** | The type of fee. | | -| **value** | **float** | The value or amount of the fee. | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceItem.md b/docs/InvoiceItem.md deleted file mode 100644 index e3adae3b..00000000 --- a/docs/InvoiceItem.md +++ /dev/null @@ -1,18 +0,0 @@ -# xendit.invoice.model.InvoiceItem - -An object representing an item within an invoice. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **name** | **str** | The name of the item. | | -| **price** | **float** | The price of the item. | | -| **quantity** | **float** | The quantity of the item. Must be greater than or equal to 0. | | -| **reference_id** | **str** | The reference ID of the item. | [optional] | -| **url** | **str** | The URL associated with the item. | [optional] | -| **category** | **str** | The category of the item. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceNotFoundError.md b/docs/InvoiceNotFoundError.md deleted file mode 100644 index 7dd39181..00000000 --- a/docs/InvoiceNotFoundError.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.InvoiceNotFoundError - -Response definition for a 404 Not Found error when creating an invoice. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | The error code indicating the type of error that occurred. | | -| **message** | **str** | A human-readable error message that provides additional information about the error. | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoicePaymentMethod.md b/docs/InvoicePaymentMethod.md deleted file mode 100644 index dfddc28f..00000000 --- a/docs/InvoicePaymentMethod.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.InvoicePaymentMethod - -Representing the payment method used for an invoice. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing the payment method used for an invoice. | must be one of ["POOL", "CALLBACK_VIRTUAL_ACCOUNT", "CREDIT_CARD", "RETAIL_OUTLET", "QR_CODE", "QRIS", "EWALLET", "DIRECT_DEBIT", "BANK_TRANSFER", "PAYLATER", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceStatus.md b/docs/InvoiceStatus.md deleted file mode 100644 index 18690526..00000000 --- a/docs/InvoiceStatus.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.InvoiceStatus - -Representing the status of an invoice. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing the status of an invoice. | must be one of ["PENDING", "PAID", "SETTLED", "EXPIRED", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KYCDocumentRequest.md b/docs/KYCDocumentRequest.md deleted file mode 100644 index 3af9fff0..00000000 --- a/docs/KYCDocumentRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# xendit.customer.model.KYCDocumentRequest - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **country** | [**CountryCode**](CountryCode.md) | | [optional] | -| **type** | [**KYCDocumentType**](KYCDocumentType.md) | | [optional] | -| **sub_type** | [**KYCDocumentSubType**](KYCDocumentSubType.md) | | [optional] | -| **document_name** | **str** | | [optional] | -| **document_number** | **str** | | [optional] | -| **expires_at** | **str** | | [optional] | -| **holder_name** | **str** | | [optional] | -| **document_images** | **[str]** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KYCDocumentResponse.md b/docs/KYCDocumentResponse.md deleted file mode 100644 index 8f94e0cd..00000000 --- a/docs/KYCDocumentResponse.md +++ /dev/null @@ -1,19 +0,0 @@ -# xendit.customer.model.KYCDocumentResponse - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **country** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | -| **type** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | -| **sub_type** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | -| **document_name** | **str, none_type** | | | -| **document_number** | **str, none_type** | | | -| **expires_at** | **str, none_type** | | | -| **holder_name** | **str, none_type** | | | -| **document_images** | **[str], none_type** | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KYCDocumentSubType.md b/docs/KYCDocumentSubType.md deleted file mode 100644 index 90247eca..00000000 --- a/docs/KYCDocumentSubType.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.KYCDocumentSubType - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["NATIONAL_ID", "CONSULAR_ID", "VOTER_ID", "POSTAL_ID", "RESIDENCE_PERMIT", "TAX_ID", "STUDENT_ID", "MILITARY_ID", "MEDICAL_ID", "OTHERS", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KYCDocumentType.md b/docs/KYCDocumentType.md deleted file mode 100644 index f93afc26..00000000 --- a/docs/KYCDocumentType.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.KYCDocumentType - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["BIRTH_CERTIFICATE", "BANK_STATEMENT", "DRIVING_LICENSE", "IDENTITY_CARD", "PASSPORT", "VISA", "BUSINESS_REGISTRATION", "BUSINESS_LICENSE", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LinkItem.md b/docs/LinkItem.md deleted file mode 100644 index 4ad87417..00000000 --- a/docs/LinkItem.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.balance_and_transaction.model.LinkItem - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **href** | **str** | URI of target, this will be to the next link. | | -| **rel** | **str** | The relationship between source and target. The value will be `next`. | | -| **method** | **str** | The HTTP method, the value will be `GET`. | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NotificationChannel.md b/docs/NotificationChannel.md deleted file mode 100644 index a6b77ba1..00000000 --- a/docs/NotificationChannel.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.NotificationChannel - -Representing a notification channel for sending messages. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing a notification channel for sending messages. | must be one of ["email", "sms", "whatsapp", "viber", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NotificationPreference.md b/docs/NotificationPreference.md deleted file mode 100644 index 5fe04e19..00000000 --- a/docs/NotificationPreference.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.invoice.model.NotificationPreference - -An object representing notification preferences for different invoice events. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **invoice_created** | [**[NotificationChannel]**](NotificationChannel.md) | Notification channels for when an invoice is created. | [optional] | -| **invoice_reminder** | [**[NotificationChannel]**](NotificationChannel.md) | Notification channels for invoice reminders. | [optional] | -| **invoice_expired** | [**[NotificationChannel]**](NotificationChannel.md) | Notification channels for expired invoices. | [optional] | -| **invoice_paid** | [**[NotificationChannel]**](NotificationChannel.md) | Notification channels for when an invoice is paid. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OverTheCounter.md b/docs/OverTheCounter.md deleted file mode 100644 index 2df245ff..00000000 --- a/docs/OverTheCounter.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.payment_request.model.OverTheCounter - -Over the Counter Payment Method Details - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | | | -| **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | | | -| **amount** | **float, none_type** | | [optional] | -| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OverTheCounterChannelCode.md b/docs/OverTheCounterChannelCode.md deleted file mode 100644 index dac41c7a..00000000 --- a/docs/OverTheCounterChannelCode.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.OverTheCounterChannelCode - -Over The Counter Channel Code - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Over The Counter Channel Code | must be one of ["7ELEVEN", "7ELEVEN_CLIQQ", "CEBUANA", "ECPAY", "PALAWAN", "MLHUILLIER", "ECPAY_DRAGONLOAN", "LBC", "ECPAY_SCHOOL", "RD_PAWNSHOP", "CVM", "USSC", "SM_BILLS", "ROBINSONS_BILLS", "ALFAMART", "INDOMARET", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OverTheCounterChannelProperties.md b/docs/OverTheCounterChannelProperties.md deleted file mode 100644 index 351c2e97..00000000 --- a/docs/OverTheCounterChannelProperties.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.payment_request.model.OverTheCounterChannelProperties - -Over The Counter Channel Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **customer_name** | **str** | Name of customer. | | -| **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. | [optional] | -| **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. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OverTheCounterChannelPropertiesUpdate.md b/docs/OverTheCounterChannelPropertiesUpdate.md deleted file mode 100644 index 81107c99..00000000 --- a/docs/OverTheCounterChannelPropertiesUpdate.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_method.model.OverTheCounterChannelPropertiesUpdate - -Over The Counter Channel properties that can be updated - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **customer_name** | **str** | Name of customer. | [optional] | -| **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. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OverTheCounterParameters.md b/docs/OverTheCounterParameters.md deleted file mode 100644 index 91dc9fab..00000000 --- a/docs/OverTheCounterParameters.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.payment_request.model.OverTheCounterParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | | | -| **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | | | -| **amount** | **float, none_type** | | [optional] | -| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OverTheCounterUpdateParameters.md b/docs/OverTheCounterUpdateParameters.md deleted file mode 100644 index 79a5f7f9..00000000 --- a/docs/OverTheCounterUpdateParameters.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.OverTheCounterUpdateParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **amount** | **float, none_type** | | [optional] | -| **channel_properties** | [**OverTheCounterChannelPropertiesUpdate**](OverTheCounterChannelPropertiesUpdate.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PatchCustomer.md b/docs/PatchCustomer.md deleted file mode 100644 index ed207d8d..00000000 --- a/docs/PatchCustomer.md +++ /dev/null @@ -1,24 +0,0 @@ -# xendit.customer.model.PatchCustomer - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **client_name** | **str, none_type** | Entity's name for this client | [optional] | -| **reference_id** | **str, none_type** | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | [optional] | -| **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | | [optional] | -| **business_detail** | [**BusinessDetail**](BusinessDetail.md) | | [optional] | -| **description** | **str, none_type** | | [optional] | -| **email** | **str, none_type** | | [optional] | -| **mobile_number** | **str, none_type** | | [optional] | -| **phone_number** | **str, none_type** | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | -| **addresses** | [**[AddressRequest], none_type**](AddressRequest.md) | | [optional] | -| **identity_accounts** | [**[IdentityAccountRequest], none_type**](IdentityAccountRequest.md) | | [optional] | -| **kyc_documents** | [**[KYCDocumentRequest], none_type**](KYCDocumentRequest.md) | | [optional] | -| **status** | [**EndCustomerStatus**](EndCustomerStatus.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Paylater.md b/docs/Paylater.md deleted file mode 100644 index 6554140c..00000000 --- a/docs/Paylater.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.Paylater - -An object representing paylater details for invoices. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **paylater_type** | [**PaylaterType**](PaylaterType.md) | | | -| **should_exclude** | **bool** | Indicates whether this paylater option should be excluded. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaylaterType.md b/docs/PaylaterType.md deleted file mode 100644 index d14dc543..00000000 --- a/docs/PaylaterType.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.PaylaterType - -Representing the available paylater channels used for invoice-related transactions. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing the available paylater channels used for invoice-related transactions. | must be one of ["KREDIVO", "AKULAKU", "UANGME", "BILLEASE", "CASHALO", "ATOME", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethod.md b/docs/PaymentMethod.md deleted file mode 100644 index 33226c3f..00000000 --- a/docs/PaymentMethod.md +++ /dev/null @@ -1,26 +0,0 @@ -# xendit.payment_request.model.PaymentMethod - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **id** | **str** | | | -| **type** | [**PaymentMethodType**](PaymentMethodType.md) | | | -| **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | -| **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | -| **created** | **str** | | [optional] | -| **updated** | **str** | | [optional] | -| **description** | **str, none_type** | | [optional] | -| **reference_id** | **str** | | [optional] | -| **card** | [**Card**](Card.md) | | [optional] | -| **direct_debit** | [**DirectDebit**](DirectDebit.md) | | [optional] | -| **ewallet** | [**EWallet**](EWallet.md) | | [optional] | -| **over_the_counter** | [**OverTheCounter**](OverTheCounter.md) | | [optional] | -| **virtual_account** | [**VirtualAccount**](VirtualAccount.md) | | [optional] | -| **qr_code** | [**QRCode**](QRCode.md) | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodAction.md b/docs/PaymentMethodAction.md deleted file mode 100644 index c0112279..00000000 --- a/docs/PaymentMethodAction.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.payment_method.model.PaymentMethodAction - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **action** | **str** | | [optional] | -| **method** | **str** | | [optional] | -| **url** | **str** | | [optional] | -| **url_type** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodApi.md b/docs/PaymentMethodApi.md index ad9c5c72..0a2d9d68 100644 --- a/docs/PaymentMethodApi.md +++ b/docs/PaymentMethodApi.md @@ -1,28 +1,58 @@ -# xendit.apis.PaymentMethodApi +# PaymentMethodApi + + +You can use the APIs below to interface with Xendit's `PaymentMethodApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```python +import time +import xendit +from xendit.apis import PaymentMethodApi + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() + +# Create an instance of the API class +api_instance = PaymentMethodApi(api_client) +``` All URIs are relative to *https://api.xendit.co* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_payment_method**](PaymentMethodApi.md#create_payment_method) | **POST** /v2/payment_methods | Creates payment method -[**get_payment_method_by_id**](PaymentMethodApi.md#get_payment_method_by_id) | **GET** /v2/payment_methods/{paymentMethodId} | Get payment method by ID -[**get_payments_by_payment_method_id**](PaymentMethodApi.md#get_payments_by_payment_method_id) | **GET** /v2/payment_methods/{paymentMethodId}/payments | Returns payments with matching PaymentMethodID. -[**patch_payment_method**](PaymentMethodApi.md#patch_payment_method) | **PATCH** /v2/payment_methods/{paymentMethodId} | Patch payment methods -[**get_all_payment_methods**](PaymentMethodApi.md#get_all_payment_methods) | **GET** /v2/payment_methods | Get all payment methods by filters -[**expire_payment_method**](PaymentMethodApi.md#expire_payment_method) | **POST** /v2/payment_methods/{paymentMethodId}/expire | Expires a payment method -[**auth_payment_method**](PaymentMethodApi.md#auth_payment_method) | **POST** /v2/payment_methods/{paymentMethodId}/auth | Validate a payment method's linking OTP -[**simulate_payment**](PaymentMethodApi.md#simulate_payment) | **POST** /v2/payment_methods/{paymentMethodId}/payments/simulate | Makes payment with matching PaymentMethodID. +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**create_payment_method**](PaymentMethodApi.md#create_payment_method-function) | **POST** /v2/payment_methods | Creates payment method | +| [**get_payment_method_by_id**](PaymentMethodApi.md#get_payment_method_by_id-function) | **GET** /v2/payment_methods/{paymentMethodId} | Get payment method by ID | +| [**get_payments_by_payment_method_id**](PaymentMethodApi.md#get_payments_by_payment_method_id-function) | **GET** /v2/payment_methods/{paymentMethodId}/payments | Returns payments with matching PaymentMethodID. | +| [**patch_payment_method**](PaymentMethodApi.md#patch_payment_method-function) | **PATCH** /v2/payment_methods/{paymentMethodId} | Patch payment methods | +| [**get_all_payment_methods**](PaymentMethodApi.md#get_all_payment_methods-function) | **GET** /v2/payment_methods | Get all payment methods by filters | +| [**expire_payment_method**](PaymentMethodApi.md#expire_payment_method-function) | **POST** /v2/payment_methods/{paymentMethodId}/expire | Expires a payment method | +| [**auth_payment_method**](PaymentMethodApi.md#auth_payment_method-function) | **POST** /v2/payment_methods/{paymentMethodId}/auth | Validate a payment method's linking OTP | +| [**simulate_payment**](PaymentMethodApi.md#simulate_payment-function) | **POST** /v2/payment_methods/{paymentMethodId}/payments/simulate | Makes payment with matching PaymentMethodID. | -# **create_payment_method** +# `create_payment_method()` Function > PaymentMethod create_payment_method() Creates payment method -This endpoint initiates creation of payment method +| Name | Value | +|--------------------|:-------------:| +| Function Name | `create_payment_method` | +| Request Parameters | [CreatePaymentMethodRequestParams](#request-parameters--CreatePaymentMethodRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | + +### Request Parameters - CreatePaymentMethodRequestParams -### Example +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **for_user_id** | **str**| | | +| **payment_method_parameters** | [**PaymentMethodParameters**](payment_method/PaymentMethodParameters.md)| | | +### Usage Example +#### Account linking for E-Wallet ```python import time @@ -46,6 +76,30 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentMethodApi(api_client) +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_method_parameters = { + "type" : "EWALLET", + "reusability" : "MULTIPLE_USE", + "customer" : { + "reference_id" : "customer-123", + "type" : "INDIVIDUAL", + "individual_detail" : { + "given_names" : "John", + "surname" : "Doe" + } + }, + "ewallet" : { + "channel_code" : "OVO", + "channel_properties" : { + "success_return_url" : "https://redirect.me/success", + "failure_return_url" : "https://redirect.me/failure", + "cancel_return_url" : "https://redirect.me/cancel" + } + }, + "metadata" : { + "sku" : "example-1234" + } +} # PaymentMethodParameters # example passing only required values which don't have defaults set # and optional values @@ -56,44 +110,82 @@ try: except xendit.XenditSdkException as e: print("Exception when calling PaymentMethodApi->create_payment_method: %s\n" % e) ``` +#### Account linking for PH Direct Debit +```python +import time +import xendit +from xendit.apis import PaymentMethodApi +from xendit.payment_method.model.get_all_payment_methods403_response import GetAllPaymentMethods403Response +from xendit.payment_method.model.get_all_payment_methods400_response import GetAllPaymentMethods400Response +from xendit.payment_method.model.get_all_payment_methods404_response import GetAllPaymentMethods404Response +from xendit.payment_method.model.create_payment_method503_response import CreatePaymentMethod503Response +from xendit.payment_method.model.payment_method_parameters import PaymentMethodParameters +from xendit.payment_method.model.payment_method import PaymentMethod +from xendit.payment_method.model.create_payment_method409_response import CreatePaymentMethod409Response +from xendit.payment_method.model.get_all_payment_methods_default_response import GetAllPaymentMethodsDefaultResponse +from pprint import pprint -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **for_user_id** | **str**| | [optional] - **payment_method_parameters** | [**PaymentMethodParameters**](PaymentMethodParameters.md)| | [optional] - -### Return type - -[**PaymentMethod**](PaymentMethod.md) - +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Request successful | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**409** | Request causes conflict | - | -**503** | Service is unavailable due to dependencies | - | -**0** | Internal server error | - | +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() +# Create an instance of the API class +api_instance = PaymentMethodApi(api_client) +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_method_parameters = { + "type" : "DIRECT_DEBIT", + "direct_debit" : { + "channel_code" : "BPI", + "channel_properties" : { + "success_return_url" : "https://redirect.me/success", + "failure_return_url" : "https://redirect.me/failure" + } + }, + "reusability" : "MULTIPLE_USE", + "customer" : { + "reference_id" : "customer-123", + "type" : "INDIVIDUAL", + "individual_detail" : { + "given_names" : "John", + "surname" : "Doe" + } + }, + "email" : "testemail@email.com", + "mobile_number" : 628774494404 +} # PaymentMethodParameters -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# example passing only required values which don't have defaults set +# and optional values +try: + # Creates payment method + api_response = api_instance.create_payment_method(for_user_id=for_user_id, payment_method_parameters=payment_method_parameters) + pprint(api_response) +except xendit.XenditSdkException as e: + print("Exception when calling PaymentMethodApi->create_payment_method: %s\n" % e) +``` -# **get_payment_method_by_id** +# `get_payment_method_by_id()` Function > PaymentMethod get_payment_method_by_id(payment_method_id) Get payment method by ID -Get payment method by ID +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_payment_method_by_id` | +| Request Parameters | [GetPaymentMethodByIdRequestParams](#request-parameters--GetPaymentMethodByIdRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | -### Example +### Request Parameters - GetPaymentMethodByIdRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_method_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -113,7 +205,8 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentMethodApi(api_client) -payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str # example passing only required values which don't have defaults set try: @@ -133,41 +226,37 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentMethodApi->get_payment_method_by_id: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_method_id** | **str**| | - **for_user_id** | **str**| | [optional] - -### Return type - -[**PaymentMethod**](PaymentMethod.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_payments_by_payment_method_id** +# `get_payments_by_payment_method_id()` Function > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_payments_by_payment_method_id(payment_method_id) Returns payments with matching PaymentMethodID. -Returns payments with matching PaymentMethodID. - -### Example - - +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_payments_by_payment_method_id` | +| Request Parameters | [GetPaymentsByPaymentMethodIdRequestParams](#request-parameters--GetPaymentsByPaymentMethodIdRequestParams) | +| Return Type | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | + +### Request Parameters - GetPaymentsByPaymentMethodIdRequestParams + +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_method_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +| **payment_request_id** | **[str]**| | | +| **payment_method_id2** | **[str]**| | | +| **reference_id** | **[str]**| | | +| **payment_method_type** | [**[PaymentMethodType]**](payment_method/PaymentMethodType.md)| | | +| **channel_code** | **[str]**| | | +| **status** | **[str]**| | | +| **currency** | **[str]**| | | +| **created_gte** | **datetime**| | | +| **created_lte** | **datetime**| | | +| **updated_gte** | **datetime**| | | +| **updated_lte** | **datetime**| | | +| **limit** | **int**| | | + +### Usage Example ```python import time import xendit @@ -188,7 +277,34 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentMethodApi(api_client) -payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_request_id = [ + "payment_request_id_example", + ] # [str] +payment_method_id2 = [ + "payment_method_id_example", + ] # [str] +reference_id = [ + "reference_id_example", + ] # [str] +payment_method_type = [ + PaymentMethodType("CARD"), + ] # [PaymentMethodType] +channel_code = [ + "channel_code_example", + ] # [str] +status = [ + "status_example", + ] # [str] +currency = [ + "currency_example", + ] # [str] +created_gte = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +created_lte = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +updated_gte = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +updated_lte = dateutil_parser('2016-08-29T09:12:33.001Z') # datetime +limit = 1 # int # example passing only required values which don't have defaults set try: @@ -208,54 +324,26 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentMethodApi->get_payments_by_payment_method_id: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_method_id** | **str**| | - **for_user_id** | **str**| | [optional] - **payment_request_id** | **[str]**| | [optional] - **payment_method_id2** | **[str]**| | [optional] - **reference_id** | **[str]**| | [optional] - **payment_method_type** | [**[PaymentMethodType]**](PaymentMethodType.md)| | [optional] - **channel_code** | **[str]**| | [optional] - **status** | **[str]**| | [optional] - **currency** | **[str]**| | [optional] - **created_gte** | **datetime**| | [optional] - **created_lte** | **datetime**| | [optional] - **updated_gte** | **datetime**| | [optional] - **updated_lte** | **datetime**| | [optional] - **limit** | **int**| | [optional] - -### Return type - -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**503** | Service is unavailable due to dependencies | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_payment_method** +# `patch_payment_method()` Function > PaymentMethod patch_payment_method(payment_method_id) Patch payment methods -This endpoint is used to toggle the ```status``` of an e-Wallet or a Direct Debit payment method to ```ACTIVE``` or ```INACTIVE```. This is also used to update the details of an Over-the-Counter or a Virtual Account payment method. +| Name | Value | +|--------------------|:-------------:| +| Function Name | `patch_payment_method` | +| Request Parameters | [PatchPaymentMethodRequestParams](#request-parameters--PatchPaymentMethodRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | -### Example +### Request Parameters - PatchPaymentMethodRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_method_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +| **payment_method_update_parameters** | [**PaymentMethodUpdateParameters**](payment_method/PaymentMethodUpdateParameters.md)| | | +### Usage Example ```python import time import xendit @@ -276,7 +364,33 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentMethodApi(api_client) -payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_method_update_parameters = PaymentMethodUpdateParameters( + description="description_example", + reference_id="reference_id_example", + reusability=PaymentMethodReusability("MULTIPLE_USE"), + status=PaymentMethodStatus("ACTIVE"), + over_the_counter=OverTheCounterUpdateParameters( + amount=3.14, + channel_properties=OverTheCounterChannelPropertiesUpdate( + customer_name="Rika Sutanto", + expires_at=dateutil_parser('2022-01-01T00:00:00Z'), + ), + ), + virtual_account=VirtualAccountUpdateParameters( + amount=3.14, + min_amount=1, + max_amount=1, + channel_properties=VirtualAccountChannelPropertiesPatch( + expires_at=dateutil_parser('2022-01-01T00:00:00Z'), + suggested_amount=100000, + ), + alternative_display_types=[ + "QR_STRING", + ], + ), + ) # PaymentMethodUpdateParameters # example passing only required values which don't have defaults set try: @@ -296,42 +410,33 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentMethodApi->patch_payment_method: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_method_id** | **str**| | - **for_user_id** | **str**| | [optional] - **payment_method_update_parameters** | [**PaymentMethodUpdateParameters**](PaymentMethodUpdateParameters.md)| | [optional] - -### Return type - -[**PaymentMethod**](PaymentMethod.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_payment_methods** +# `get_all_payment_methods()` Function > PaymentMethodList get_all_payment_methods() Get all payment methods by filters -Get all payment methods by filters - -### Example - - +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_all_payment_methods` | +| Request Parameters | [GetAllPaymentMethodsRequestParams](#request-parameters--GetAllPaymentMethodsRequestParams) | +| Return Type | [**PaymentMethodList**](payment_method/PaymentMethodList.md) | + +### Request Parameters - GetAllPaymentMethodsRequestParams + +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **for_user_id** | **str**| | | +| **id** | **[str]**| | | +| **type** | **[str]**| | | +| **status** | [**[PaymentMethodStatus]**](payment_method/PaymentMethodStatus.md)| | | +| **reusability** | **PaymentMethodReusability**| | | +| **customer_id** | **str**| | | +| **reference_id** | **str**| | | +| **after_id** | **str**| | | +| **before_id** | **str**| | | +| **limit** | **int**| | | + +### Usage Example ```python import time import xendit @@ -353,6 +458,22 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentMethodApi(api_client) +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +id = [ + "id_example", + ] # [str] +type = [ + "type_example", + ] # [str] +status = [ + PaymentMethodStatus("ACTIVE"), + ] # [PaymentMethodStatus] +reusability = PaymentMethodReusability("MULTIPLE_USE") # PaymentMethodReusability +customer_id = "customer_id_example" # str +reference_id = "reference_id_example" # str +after_id = "after_id_example" # str +before_id = "before_id_example" # str +limit = 1 # int # example passing only required values which don't have defaults set # and optional values @@ -364,49 +485,26 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentMethodApi->get_all_payment_methods: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **for_user_id** | **str**| | [optional] - **id** | **[str]**| | [optional] - **type** | **[str]**| | [optional] - **status** | [**[PaymentMethodStatus]**](PaymentMethodStatus.md)| | [optional] - **reusability** | **PaymentMethodReusability**| | [optional] - **customer_id** | **str**| | [optional] - **reference_id** | **str**| | [optional] - **after_id** | **str**| | [optional] - **before_id** | **str**| | [optional] - **limit** | **int**| | [optional] - -### Return type - -[**PaymentMethodList**](PaymentMethodList.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **expire_payment_method** +# `expire_payment_method()` Function > PaymentMethod expire_payment_method(payment_method_id) Expires a payment method -This endpoint expires a payment method and performs unlinking if necessary +| Name | Value | +|--------------------|:-------------:| +| Function Name | `expire_payment_method` | +| Request Parameters | [ExpirePaymentMethodRequestParams](#request-parameters--ExpirePaymentMethodRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | -### Example +### Request Parameters - ExpirePaymentMethodRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_method_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +| **payment_method_expire_parameters** | [**PaymentMethodExpireParameters**](payment_method/PaymentMethodExpireParameters.md)| | | +### Usage Example ```python import time import xendit @@ -428,7 +526,12 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentMethodApi(api_client) -payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_method_expire_parameters = PaymentMethodExpireParameters( + success_return_url="success_return_url_example", + failure_return_url="failure_return_url_example", + ) # PaymentMethodExpireParameters # example passing only required values which don't have defaults set try: @@ -448,43 +551,26 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentMethodApi->expire_payment_method: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_method_id** | **str**| | - **for_user_id** | **str**| | [optional] - **payment_method_expire_parameters** | [**PaymentMethodExpireParameters**](PaymentMethodExpireParameters.md)| | [optional] - -### Return type - -[**PaymentMethod**](PaymentMethod.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**503** | Service is unavailable due to dependencies | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **auth_payment_method** +# `auth_payment_method()` Function > PaymentMethod auth_payment_method(payment_method_id) Validate a payment method's linking OTP -This endpoint validates a payment method linking OTP +| Name | Value | +|--------------------|:-------------:| +| Function Name | `auth_payment_method` | +| Request Parameters | [AuthPaymentMethodRequestParams](#request-parameters--AuthPaymentMethodRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | -### Example +### Request Parameters - AuthPaymentMethodRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_method_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +| **payment_method_auth_parameters** | [**PaymentMethodAuthParameters**](payment_method/PaymentMethodAuthParameters.md)| | | +### Usage Example ```python import time import xendit @@ -507,7 +593,11 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentMethodApi(api_client) -payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_method_auth_parameters = PaymentMethodAuthParameters( + auth_code="auth_code_example", + ) # PaymentMethodAuthParameters # example passing only required values which don't have defaults set try: @@ -527,44 +617,25 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentMethodApi->auth_payment_method: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_method_id** | **str**| | - **for_user_id** | **str**| | [optional] - **payment_method_auth_parameters** | [**PaymentMethodAuthParameters**](PaymentMethodAuthParameters.md)| | [optional] - -### Return type - -[**PaymentMethod**](PaymentMethod.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**409** | Request causes conflict | - | -**503** | Service is unavailable due to dependencies | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **simulate_payment** +# `simulate_payment()` Function > simulate_payment(payment_method_id) Makes payment with matching PaymentMethodID. -Makes payment with matching PaymentMethodID. +| Name | Value | +|--------------------|:-------------:| +| Function Name | `simulate_payment` | +| Request Parameters | [SimulatePaymentRequestParams](#request-parameters--SimulatePaymentRequestParams) | +| Return Type | void (empty response body) | -### Example +### Request Parameters - SimulatePaymentRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_method_id** | **str** | ☑️ | | +| **simulate_payment_request** | [**SimulatePaymentRequest**](payment_method/SimulatePaymentRequest.md)| | | +### Usage Example ```python import time import xendit @@ -585,7 +656,10 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentMethodApi(api_client) -payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +simulate_payment_request = SimulatePaymentRequest( + amount=3.14, + ) # SimulatePaymentRequest # example passing only required values which don't have defaults set try: @@ -603,29 +677,4 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentMethodApi->simulate_payment: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_method_id** | **str**| | - **simulate_payment_request** | [**SimulatePaymentRequest**](SimulatePaymentRequest.md)| | [optional] - -### Return type - -void (empty response body) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**503** | Service is unavailable due to dependencies | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to README]](../README.md) diff --git a/docs/PaymentMethodAuthParameters.md b/docs/PaymentMethodAuthParameters.md deleted file mode 100644 index aaa02a1a..00000000 --- a/docs/PaymentMethodAuthParameters.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.payment_method.model.PaymentMethodAuthParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **auth_code** | **str** | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodCountry.md b/docs/PaymentMethodCountry.md deleted file mode 100644 index 14b9b77a..00000000 --- a/docs/PaymentMethodCountry.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.PaymentMethodCountry - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["PH", "ID", "VN", "TH", "MY", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodExpireParameters.md b/docs/PaymentMethodExpireParameters.md deleted file mode 100644 index 7b0e141d..00000000 --- a/docs/PaymentMethodExpireParameters.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.PaymentMethodExpireParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **success_return_url** | **str, none_type** | URL where the end customer is redirected if the unlinking authorization is successful. | [optional] | -| **failure_return_url** | **str, none_type** | URL where the end customer is redirected if the unlinking authorization is failed. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodList.md b/docs/PaymentMethodList.md deleted file mode 100644 index 1389c732..00000000 --- a/docs/PaymentMethodList.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_method.model.PaymentMethodList - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **data** | [**[PaymentMethod]**](PaymentMethod.md) | | | -| **has_more** | **bool** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodParameters.md b/docs/PaymentMethodParameters.md deleted file mode 100644 index c64b02c9..00000000 --- a/docs/PaymentMethodParameters.md +++ /dev/null @@ -1,20 +0,0 @@ -# xendit.payment_request.model.PaymentMethodParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **type** | [**PaymentMethodType**](PaymentMethodType.md) | | | -| **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | -| **description** | **str, none_type** | | [optional] | -| **reference_id** | **str** | | [optional] | -| **direct_debit** | [**DirectDebitParameters**](DirectDebitParameters.md) | | [optional] | -| **ewallet** | [**EWalletParameters**](EWalletParameters.md) | | [optional] | -| **over_the_counter** | [**OverTheCounterParameters**](OverTheCounterParameters.md) | | [optional] | -| **virtual_account** | [**VirtualAccountParameters**](VirtualAccountParameters.md) | | [optional] | -| **qr_code** | [**QRCodeParameters**](QRCodeParameters.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodReusability.md b/docs/PaymentMethodReusability.md deleted file mode 100644 index 4d8b4cd5..00000000 --- a/docs/PaymentMethodReusability.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.PaymentMethodReusability - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["MULTIPLE_USE", "ONE_TIME_USE", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodStatus.md b/docs/PaymentMethodStatus.md deleted file mode 100644 index f3927db6..00000000 --- a/docs/PaymentMethodStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.PaymentMethodStatus - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["ACTIVE", "INACTIVE", "PENDING", "EXPIRED", "FAILED", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodType.md b/docs/PaymentMethodType.md deleted file mode 100644 index 0864cfe4..00000000 --- a/docs/PaymentMethodType.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.PaymentMethodType - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["CARD", "DIRECT_DEBIT", "EWALLET", "OVER_THE_COUNTER", "QR_CODE", "VIRTUAL_ACCOUNT", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodUpdateParameters.md b/docs/PaymentMethodUpdateParameters.md deleted file mode 100644 index 49b3a062..00000000 --- a/docs/PaymentMethodUpdateParameters.md +++ /dev/null @@ -1,17 +0,0 @@ -# xendit.payment_method.model.PaymentMethodUpdateParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **description** | **str** | | [optional] | -| **reference_id** | **str** | | [optional] | -| **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | [optional] | -| **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | | [optional] | -| **over_the_counter** | [**OverTheCounterUpdateParameters**](OverTheCounterUpdateParameters.md) | | [optional] | -| **virtual_account** | [**VirtualAccountUpdateParameters**](VirtualAccountUpdateParameters.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequest.md b/docs/PaymentRequest.md deleted file mode 100644 index 3503a9f2..00000000 --- a/docs/PaymentRequest.md +++ /dev/null @@ -1,34 +0,0 @@ -# xendit.payment_request.model.PaymentRequest - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **id** | **str** | | | -| **created** | **str** | | | -| **updated** | **str** | | | -| **reference_id** | **str** | | | -| **business_id** | **str** | | | -| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | -| **payment_method** | [**PaymentMethod**](PaymentMethod.md) | | | -| **status** | [**PaymentRequestStatus**](PaymentRequestStatus.md) | | | -| **customer_id** | **str, none_type** | | [optional] | -| **customer** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | -| **amount** | **float** | | [optional] | -| **min_amount** | **float, none_type** | | [optional] | -| **max_amount** | **float, none_type** | | [optional] | -| **country** | [**PaymentRequestCountry**](PaymentRequestCountry.md) | | [optional] | -| **description** | **str, none_type** | | [optional] | -| **failure_code** | **str, none_type** | | [optional] | -| **capture_method** | [**PaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | [optional] | -| **initiator** | [**PaymentRequestInitiator**](PaymentRequestInitiator.md) | | [optional] | -| **card_verification_results** | [**PaymentRequestCardVerificationResults**](PaymentRequestCardVerificationResults.md) | | [optional] | -| **actions** | [**[PaymentRequestAction]**](PaymentRequestAction.md) | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | -| **shipping_information** | [**PaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | [optional] | -| **items** | [**PaymentRequestBasket**](PaymentRequestBasket.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestAction.md b/docs/PaymentRequestAction.md deleted file mode 100644 index c1c7a158..00000000 --- a/docs/PaymentRequestAction.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.payment_request.model.PaymentRequestAction - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **action** | **str** | | | -| **url_type** | **str** | | | -| **method** | **str, none_type** | | | -| **url** | **str, none_type** | | | -| **qr_code** | **str, none_type** | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestApi.md b/docs/PaymentRequestApi.md index f9599fc5..b6fc8230 100644 --- a/docs/PaymentRequestApi.md +++ b/docs/PaymentRequestApi.md @@ -1,27 +1,58 @@ -# xendit.apis.PaymentRequestApi +# PaymentRequestApi + + +You can use the APIs below to interface with Xendit's `PaymentRequestApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```python +import time +import xendit +from xendit.apis import PaymentRequestApi + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() + +# Create an instance of the API class +api_instance = PaymentRequestApi(api_client) +``` All URIs are relative to *https://api.xendit.co* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_payment_request**](PaymentRequestApi.md#create_payment_request) | **POST** /payment_requests | Create Payment Request -[**get_payment_request_by_id**](PaymentRequestApi.md#get_payment_request_by_id) | **GET** /payment_requests/{paymentRequestId} | Get payment request by ID -[**get_payment_request_captures**](PaymentRequestApi.md#get_payment_request_captures) | **GET** /payment_requests/{paymentRequestId}/captures | Get Payment Request Capture -[**get_all_payment_requests**](PaymentRequestApi.md#get_all_payment_requests) | **GET** /payment_requests | Get all payment requests by filter -[**capture_payment_request**](PaymentRequestApi.md#capture_payment_request) | **POST** /payment_requests/{paymentRequestId}/captures | Payment Request Capture -[**authorize_payment_request**](PaymentRequestApi.md#authorize_payment_request) | **POST** /payment_requests/{paymentRequestId}/auth | Payment Request Authorize -[**resend_payment_request_auth**](PaymentRequestApi.md#resend_payment_request_auth) | **POST** /payment_requests/{paymentRequestId}/auth/resend | Payment Request Resend Auth +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**create_payment_request**](PaymentRequestApi.md#create_payment_request-function) | **POST** /payment_requests | Create Payment Request | +| [**get_payment_request_by_id**](PaymentRequestApi.md#get_payment_request_by_id-function) | **GET** /payment_requests/{paymentRequestId} | Get payment request by ID | +| [**get_payment_request_captures**](PaymentRequestApi.md#get_payment_request_captures-function) | **GET** /payment_requests/{paymentRequestId}/captures | Get Payment Request Capture | +| [**get_all_payment_requests**](PaymentRequestApi.md#get_all_payment_requests-function) | **GET** /payment_requests | Get all payment requests by filter | +| [**capture_payment_request**](PaymentRequestApi.md#capture_payment_request-function) | **POST** /payment_requests/{paymentRequestId}/captures | Payment Request Capture | +| [**authorize_payment_request**](PaymentRequestApi.md#authorize_payment_request-function) | **POST** /payment_requests/{paymentRequestId}/auth | Payment Request Authorize | +| [**resend_payment_request_auth**](PaymentRequestApi.md#resend_payment_request_auth-function) | **POST** /payment_requests/{paymentRequestId}/auth/resend | Payment Request Resend Auth | -# **create_payment_request** +# `create_payment_request()` Function > PaymentRequest create_payment_request() Create Payment Request -Create Payment Request +| Name | Value | +|--------------------|:-------------:| +| Function Name | `create_payment_request` | +| Request Parameters | [CreatePaymentRequestRequestParams](#request-parameters--CreatePaymentRequestRequestParams) | +| Return Type | [**PaymentRequest**](payment_request/PaymentRequest.md) | -### Example +### Request Parameters - CreatePaymentRequestRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **idempotency_key** | **str**| | | +| **for_user_id** | **str**| | | +| **payment_request_parameters** | [**PaymentRequestParameters**](payment_request/PaymentRequestParameters.md)| | | + +### Usage Example +#### E-Wallet One Time Payment via Redirect URL ```python import time @@ -40,6 +71,24 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentRequestApi(api_client) +idempotency_key = "5f9a3fbd571a1c4068aa40ce" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_request_parameters = { + "reference_id" : "example-ref-1234", + "amount" : 15000, + "currency" : "IDR", + "country" : "ID", + "payment_method" : { + "type" : "EWALLET", + "ewallet" : { + "channel_code" : "SHOPEEPAY", + "channel_properties" : { + "success_return_url" : "https://redirect.me/success" + } + }, + "reusability" : "ONE_TIME_USE" + } +} # PaymentRequestParameters # example passing only required values which don't have defaults set # and optional values @@ -50,43 +99,204 @@ try: except xendit.XenditSdkException as e: print("Exception when calling PaymentRequestApi->create_payment_request: %s\n" % e) ``` +#### Fixed amount dynamic QR +```python +import time +import xendit +from xendit.apis import PaymentRequestApi +from xendit.payment_request.model.payment_request_parameters import PaymentRequestParameters +from xendit.payment_request.model.error import Error +from xendit.payment_request.model.payment_request import PaymentRequest +from pprint import pprint -### Parameters +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **idempotency_key** | **str**| | [optional] - **for_user_id** | **str**| | [optional] - **payment_request_parameters** | [**PaymentRequestParameters**](PaymentRequestParameters.md)| | [optional] -### Return type +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() +# Create an instance of the API class +api_instance = PaymentRequestApi(api_client) +idempotency_key = "5f9a3fbd571a1c4068aa40ce" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_request_parameters = { + "reference_id" : "example-ref-1234", + "amount" : 15000, + "currency" : "IDR", + "payment_method" : { + "type" : "QR_CODE", + "reusability" : "ONE_TIME_USE", + "qr_code" : { + "channel_code" : "“QRIS”" + } + }, + "metadata" : { + "sku" : "example-sku-1234" + } +} # PaymentRequestParameters -[**PaymentRequest**](PaymentRequest.md) +# example passing only required values which don't have defaults set +# and optional values +try: + # Create Payment Request + api_response = api_instance.create_payment_request(idempotency_key=idempotency_key, for_user_id=for_user_id, payment_request_parameters=payment_request_parameters) + pprint(api_response) +except xendit.XenditSdkException as e: + print("Exception when calling PaymentRequestApi->create_payment_request: %s\n" % e) +``` +#### Fixed amount single use Virtual Account +```python +import time +import xendit +from xendit.apis import PaymentRequestApi +from xendit.payment_request.model.payment_request_parameters import PaymentRequestParameters +from xendit.payment_request.model.error import Error +from xendit.payment_request.model.payment_request import PaymentRequest +from pprint import pprint + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + + +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() +# Create an instance of the API class +api_instance = PaymentRequestApi(api_client) +idempotency_key = "5f9a3fbd571a1c4068aa40ce" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_request_parameters = { + "reference_id" : "example-ref-1234", + "currency" : "IDR", + "amount" : 15000, + "country" : "ID", + "payment_method" : { + "type" : "VIRTUAL_ACCOUNT", + "reusability" : "ONE_TIME_USE", + "reference_id" : "example-1234", + "virtual_account" : { + "channel_code" : "BNI", + "channel_properties" : { + "customer_name" : "Ahmad Gunawan", + "expires_at" : "2023-01-03T17:00:00Z" + } + } + }, + "metadata" : { + "sku" : "example-sku-1234" + } +} # PaymentRequestParameters + +# example passing only required values which don't have defaults set +# and optional values +try: + # Create Payment Request + api_response = api_instance.create_payment_request(idempotency_key=idempotency_key, for_user_id=for_user_id, payment_request_parameters=payment_request_parameters) + pprint(api_response) +except xendit.XenditSdkException as e: + print("Exception when calling PaymentRequestApi->create_payment_request: %s\n" % e) +``` +#### Subsequent PH Direct Debit payments after account linking + +```python +import time +import xendit +from xendit.apis import PaymentRequestApi +from xendit.payment_request.model.payment_request_parameters import PaymentRequestParameters +from xendit.payment_request.model.error import Error +from xendit.payment_request.model.payment_request import PaymentRequest +from pprint import pprint -### HTTP response details +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**201** | Request successful | - | -**400** | Errors | - | -**500** | Errors | - | -**0** | Errors | - | -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() +# Create an instance of the API class +api_instance = PaymentRequestApi(api_client) +idempotency_key = "5f9a3fbd571a1c4068aa40ce" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_request_parameters = { + "reference_id" : "example-ref-1234", + "amount" : 1500, + "currency" : "PHP", + "payment_method_id" : "pm-9685a196-81e9-4c73-8d62-97df5aab2762", + "metadata" : { + "sku" : "example-sku-1234" + } +} # PaymentRequestParameters -# **get_payment_request_by_id** +# example passing only required values which don't have defaults set +# and optional values +try: + # Create Payment Request + api_response = api_instance.create_payment_request(idempotency_key=idempotency_key, for_user_id=for_user_id, payment_request_parameters=payment_request_parameters) + pprint(api_response) +except xendit.XenditSdkException as e: + print("Exception when calling PaymentRequestApi->create_payment_request: %s\n" % e) +``` +#### Subsequent tokenized E-Wallet payments after account linking + +```python +import time +import xendit +from xendit.apis import PaymentRequestApi +from xendit.payment_request.model.payment_request_parameters import PaymentRequestParameters +from xendit.payment_request.model.error import Error +from xendit.payment_request.model.payment_request import PaymentRequest +from pprint import pprint + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + + +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() +# Create an instance of the API class +api_instance = PaymentRequestApi(api_client) +idempotency_key = "5f9a3fbd571a1c4068aa40ce" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_request_parameters = { + "reference_id" : "example-ref-1234", + "amount" : 15000, + "currency" : "IDR", + "payment_method_id" : "pm-2b2c6092-2100-4843-a7fc-f5c7edac7efd", + "metadata" : { + "sku" : "example-sku-1234" + } +} # PaymentRequestParameters + +# example passing only required values which don't have defaults set +# and optional values +try: + # Create Payment Request + api_response = api_instance.create_payment_request(idempotency_key=idempotency_key, for_user_id=for_user_id, payment_request_parameters=payment_request_parameters) + pprint(api_response) +except xendit.XenditSdkException as e: + print("Exception when calling PaymentRequestApi->create_payment_request: %s\n" % e) +``` + +# `get_payment_request_by_id()` Function > PaymentRequest get_payment_request_by_id(payment_request_id) Get payment request by ID -Get payment request by ID +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_payment_request_by_id` | +| Request Parameters | [GetPaymentRequestByIdRequestParams](#request-parameters--GetPaymentRequestByIdRequestParams) | +| Return Type | [**PaymentRequest**](payment_request/PaymentRequest.md) | -### Example +### Request Parameters - GetPaymentRequestByIdRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_request_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -103,7 +313,8 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentRequestApi(api_client) -payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str # example passing only required values which don't have defaults set try: @@ -123,40 +334,26 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentRequestApi->get_payment_request_by_id: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_request_id** | **str**| | - **for_user_id** | **str**| | [optional] - -### Return type - -[**PaymentRequest**](PaymentRequest.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**404** | Errors | - | -**500** | Errors | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_payment_request_captures** +# `get_payment_request_captures()` Function > CaptureListResponse get_payment_request_captures(payment_request_id) Get Payment Request Capture -Get Payment Request Capture +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_payment_request_captures` | +| Request Parameters | [GetPaymentRequestCapturesRequestParams](#request-parameters--GetPaymentRequestCapturesRequestParams) | +| Return Type | [**CaptureListResponse**](payment_request/CaptureListResponse.md) | -### Example +### Request Parameters - GetPaymentRequestCapturesRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_request_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +| **limit** | **int**| | | +### Usage Example ```python import time import xendit @@ -173,7 +370,9 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentRequestApi(api_client) -payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +limit = 1 # int # example passing only required values which don't have defaults set try: @@ -193,41 +392,30 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentRequestApi->get_payment_request_captures: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_request_id** | **str**| | - **for_user_id** | **str**| | [optional] - **limit** | **int**| | [optional] - -### Return type - -[**CaptureListResponse**](CaptureListResponse.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Errors | - | -**500** | Errors | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_payment_requests** +# `get_all_payment_requests()` Function > PaymentRequestListResponse get_all_payment_requests() Get all payment requests by filter -Get all payment requests by filter - -### Example - - +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_all_payment_requests` | +| Request Parameters | [GetAllPaymentRequestsRequestParams](#request-parameters--GetAllPaymentRequestsRequestParams) | +| Return Type | [**PaymentRequestListResponse**](payment_request/PaymentRequestListResponse.md) | + +### Request Parameters - GetAllPaymentRequestsRequestParams + +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **for_user_id** | **str**| | | +| **reference_id** | **[str]**| | | +| **id** | **[str]**| | | +| **customer_id** | **[str]**| | | +| **limit** | **int**| | | +| **before_id** | **str**| | | +| **after_id** | **str**| | | + +### Usage Example ```python import time import xendit @@ -244,6 +432,19 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentRequestApi(api_client) +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +reference_id = [ + "reference_id_example", + ] # [str] +id = [ + "id_example", + ] # [str] +customer_id = [ + "customer_id_example", + ] # [str] +limit = 1 # int +before_id = "before_id_example" # str +after_id = "after_id_example" # str # example passing only required values which don't have defaults set # and optional values @@ -255,45 +456,26 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentRequestApi->get_all_payment_requests: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **for_user_id** | **str**| | [optional] - **reference_id** | **[str]**| | [optional] - **id** | **[str]**| | [optional] - **customer_id** | **[str]**| | [optional] - **limit** | **int**| | [optional] - **before_id** | **str**| | [optional] - **after_id** | **str**| | [optional] - -### Return type - -[**PaymentRequestListResponse**](PaymentRequestListResponse.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**404** | Errors | - | -**500** | Errors | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **capture_payment_request** +# `capture_payment_request()` Function > Capture capture_payment_request(payment_request_id) Payment Request Capture -Payment Request Capture +| Name | Value | +|--------------------|:-------------:| +| Function Name | `capture_payment_request` | +| Request Parameters | [CapturePaymentRequestRequestParams](#request-parameters--CapturePaymentRequestRequestParams) | +| Return Type | [**Capture**](payment_request/Capture.md) | -### Example +### Request Parameters - CapturePaymentRequestRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_request_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +| **capture_parameters** | [**CaptureParameters**](payment_request/CaptureParameters.md)| | | +### Usage Example ```python import time import xendit @@ -311,7 +493,12 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentRequestApi(api_client) -payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +capture_parameters = CaptureParameters( + reference_id="reference_id_example", + capture_amount=3.14, + ) # CaptureParameters # example passing only required values which don't have defaults set try: @@ -331,41 +518,26 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentRequestApi->capture_payment_request: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_request_id** | **str**| | - **for_user_id** | **str**| | [optional] - **capture_parameters** | [**CaptureParameters**](CaptureParameters.md)| | [optional] - -### Return type - -[**Capture**](Capture.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Capture created | - | -**400** | Errors | - | -**500** | Errors | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **authorize_payment_request** +# `authorize_payment_request()` Function > PaymentRequest authorize_payment_request(payment_request_id) Payment Request Authorize -Payment Request Authorize +| Name | Value | +|--------------------|:-------------:| +| Function Name | `authorize_payment_request` | +| Request Parameters | [AuthorizePaymentRequestRequestParams](#request-parameters--AuthorizePaymentRequestRequestParams) | +| Return Type | [**PaymentRequest**](payment_request/PaymentRequest.md) | -### Example +### Request Parameters - AuthorizePaymentRequestRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_request_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +| **payment_request_auth_parameters** | [**PaymentRequestAuthParameters**](payment_request/PaymentRequestAuthParameters.md)| | | +### Usage Example ```python import time import xendit @@ -383,7 +555,11 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentRequestApi(api_client) -payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str +payment_request_auth_parameters = PaymentRequestAuthParameters( + auth_code="auth_code_example", + ) # PaymentRequestAuthParameters # example passing only required values which don't have defaults set try: @@ -403,41 +579,25 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentRequestApi->authorize_payment_request: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_request_id** | **str**| | - **for_user_id** | **str**| | [optional] - **payment_request_auth_parameters** | [**PaymentRequestAuthParameters**](PaymentRequestAuthParameters.md)| | [optional] - -### Return type - -[**PaymentRequest**](PaymentRequest.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Errors | - | -**500** | Errors | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **resend_payment_request_auth** +# `resend_payment_request_auth()` Function > PaymentRequest resend_payment_request_auth(payment_request_id) Payment Request Resend Auth -Payment Request Resend Auth +| Name | Value | +|--------------------|:-------------:| +| Function Name | `resend_payment_request_auth` | +| Request Parameters | [ResendPaymentRequestAuthRequestParams](#request-parameters--ResendPaymentRequestAuthRequestParams) | +| Return Type | [**PaymentRequest**](payment_request/PaymentRequest.md) | -### Example +### Request Parameters - ResendPaymentRequestAuthRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **payment_request_id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -454,7 +614,8 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PaymentRequestApi(api_client) -payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +for_user_id = "5f9a3fbd571a1c4068aa40cf" # str # example passing only required values which don't have defaults set try: @@ -474,27 +635,4 @@ except xendit.XenditSdkException as e: print("Exception when calling PaymentRequestApi->resend_payment_request_auth: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_request_id** | **str**| | - **for_user_id** | **str**| | [optional] - -### Return type - -[**PaymentRequest**](PaymentRequest.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successful | - | -**400** | Errors | - | -**500** | Errors | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to README]](../README.md) diff --git a/docs/PaymentRequestAuthParameters.md b/docs/PaymentRequestAuthParameters.md deleted file mode 100644 index fe88c768..00000000 --- a/docs/PaymentRequestAuthParameters.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.payment_request.model.PaymentRequestAuthParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **auth_code** | **str** | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestBasket.md b/docs/PaymentRequestBasket.md deleted file mode 100644 index 6e0cb94d..00000000 --- a/docs/PaymentRequestBasket.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.payment_request.model.PaymentRequestBasket - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | [**[PaymentRequestBasketItem], none_type**](PaymentRequestBasketItem.md) | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestBasketItem.md b/docs/PaymentRequestBasketItem.md deleted file mode 100644 index 03cc065c..00000000 --- a/docs/PaymentRequestBasketItem.md +++ /dev/null @@ -1,24 +0,0 @@ -# xendit.payment_request.model.PaymentRequestBasketItem - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **name** | **str** | | | -| **category** | **str** | | | -| **currency** | **str** | | | -| **quantity** | **float** | | | -| **price** | **float** | | | -| **reference_id** | **str** | | [optional] | -| **description** | **str** | | [optional] | -| **type** | **str** | | [optional] | -| **sub_category** | **str** | | [optional] | -| **payer_charged_currency** | **str** | | [optional] | -| **payer_charged_price** | **float** | | [optional] | -| **url** | **str** | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestCaptureMethod.md b/docs/PaymentRequestCaptureMethod.md deleted file mode 100644 index d297df9e..00000000 --- a/docs/PaymentRequestCaptureMethod.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.PaymentRequestCaptureMethod - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["AUTOMATIC", "MANUAL", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestCardVerificationResults.md b/docs/PaymentRequestCardVerificationResults.md deleted file mode 100644 index 17793b7f..00000000 --- a/docs/PaymentRequestCardVerificationResults.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.PaymentRequestCardVerificationResults - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **three_d_secure** | [**PaymentRequestCardVerificationResultsThreeDeeSecure**](PaymentRequestCardVerificationResultsThreeDeeSecure.md) | | | -| **cvv_result** | **str, none_type** | | [optional] | -| **address_verification_result** | **str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestCardVerificationResultsThreeDeeSecure.md b/docs/PaymentRequestCardVerificationResultsThreeDeeSecure.md deleted file mode 100644 index 3cc30a5c..00000000 --- a/docs/PaymentRequestCardVerificationResultsThreeDeeSecure.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.payment_request.model.PaymentRequestCardVerificationResultsThreeDeeSecure - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **three_d_secure_flow** | **str** | | [optional] | -| **eci_code** | **str** | | [optional] | -| **three_d_secure_result** | **str** | | [optional] | -| **three_d_secure_result_reason** | **str, none_type** | | [optional] | -| **three_d_secure_version** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestChannelProperties.md b/docs/PaymentRequestChannelProperties.md deleted file mode 100644 index 7cce47aa..00000000 --- a/docs/PaymentRequestChannelProperties.md +++ /dev/null @@ -1,18 +0,0 @@ -# xendit.payment_request.model.PaymentRequestChannelProperties - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **success_return_url** | **str** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **failure_return_url** | **str** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **cancel_return_url** | **str** | URL where the end-customer is redirected if the authorization cancelled | [optional] | -| **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. | [optional] | -| **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. | [optional] | -| **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 | [optional] | -| **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. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestCountry.md b/docs/PaymentRequestCountry.md deleted file mode 100644 index ea1d91c5..00000000 --- a/docs/PaymentRequestCountry.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.PaymentRequestCountry - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["ID", "PH", "VN", "TH", "MY", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestCurrency.md b/docs/PaymentRequestCurrency.md deleted file mode 100644 index a8dec1e2..00000000 --- a/docs/PaymentRequestCurrency.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.PaymentRequestCurrency - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["IDR", "PHP", "VND", "THB", "MYR", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestInitiator.md b/docs/PaymentRequestInitiator.md deleted file mode 100644 index 43aab677..00000000 --- a/docs/PaymentRequestInitiator.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.PaymentRequestInitiator - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["CUSTOMER", "MERCHANT", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestListResponse.md b/docs/PaymentRequestListResponse.md deleted file mode 100644 index ccbd2fa1..00000000 --- a/docs/PaymentRequestListResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.PaymentRequestListResponse - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **data** | [**[PaymentRequest]**](PaymentRequest.md) | | | -| **has_more** | **bool** | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestParameters.md b/docs/PaymentRequestParameters.md deleted file mode 100644 index e556bc84..00000000 --- a/docs/PaymentRequestParameters.md +++ /dev/null @@ -1,25 +0,0 @@ -# xendit.payment_request.model.PaymentRequestParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | -| **reference_id** | **str** | | [optional] | -| **amount** | **float** | | [optional] | -| **payment_method** | [**PaymentMethodParameters**](PaymentMethodParameters.md) | | [optional] | -| **description** | **str, none_type** | | [optional] | -| **capture_method** | [**PaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | [optional] | -| **initiator** | [**PaymentRequestInitiator**](PaymentRequestInitiator.md) | | [optional] | -| **payment_method_id** | **str** | | [optional] | -| **channel_properties** | [**PaymentRequestParametersChannelProperties**](PaymentRequestParametersChannelProperties.md) | | [optional] | -| **shipping_information** | [**PaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | [optional] | -| **items** | [**PaymentRequestBasket**](PaymentRequestBasket.md) | | [optional] | -| **customer_id** | **str, none_type** | | [optional] | -| **customer** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestParametersChannelProperties.md b/docs/PaymentRequestParametersChannelProperties.md deleted file mode 100644 index 026056b3..00000000 --- a/docs/PaymentRequestParametersChannelProperties.md +++ /dev/null @@ -1,19 +0,0 @@ -# xendit.payment_request.model.PaymentRequestParametersChannelProperties - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **success_return_url** | **str** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **failure_return_url** | **str** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **cancel_return_url** | **str** | URL where the end-customer is redirected if the authorization cancelled | [optional] | -| **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. | [optional] | -| **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. | [optional] | -| **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 | [optional] | -| **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. | [optional] | -| **cvv** | **str** | Three digit code written on the back of the card (usually called CVV/CVN). | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestParametersChannelPropertiesAllOf.md b/docs/PaymentRequestParametersChannelPropertiesAllOf.md deleted file mode 100644 index f0d229e8..00000000 --- a/docs/PaymentRequestParametersChannelPropertiesAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.payment_request.model.PaymentRequestParametersChannelPropertiesAllOf - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **cvv** | **str** | Three digit code written on the back of the card (usually called CVV/CVN). | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestShippingInformation.md b/docs/PaymentRequestShippingInformation.md deleted file mode 100644 index a7083f28..00000000 --- a/docs/PaymentRequestShippingInformation.md +++ /dev/null @@ -1,17 +0,0 @@ -# xendit.payment_request.model.PaymentRequestShippingInformation - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **country** | **str** | | | -| **street_line1** | **str** | | [optional] | -| **street_line2** | **str** | | [optional] | -| **city** | **str** | | [optional] | -| **province_state** | **str** | | [optional] | -| **postal_code** | **str** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRequestStatus.md b/docs/PaymentRequestStatus.md deleted file mode 100644 index 1fb637e3..00000000 --- a/docs/PaymentRequestStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.PaymentRequestStatus - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["PENDING", "REQUIRES_ACTION", "CANCELED", "SUCCEEDED", "FAILED", "VOIDED", "UNKNOWN", "AWAITING_CAPTURE", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Payout.md b/docs/Payout.md deleted file mode 100644 index e7c24156..00000000 --- a/docs/Payout.md +++ /dev/null @@ -1,26 +0,0 @@ -# xendit.payout.model.Payout - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **reference_id** | **str** | A client defined payout identifier | | -| **channel_code** | **str** | Channel code of selected destination bank or e-wallet | | -| **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | | | -| **amount** | **float** | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | -| **currency** | **str** | Currency of the destination channel using ISO-4217 currency code | | -| **id** | **str** | Xendit-generated unique identifier for each payout | | -| **created** | **datetime** | The time payout was created on Xendit's system, in ISO 8601 format | | -| **updated** | **datetime** | The time payout was last updated on Xendit's system, in ISO 8601 format | | -| **business_id** | **str** | Xendit Business ID | | -| **status** | **str** | Status of payout | | -| **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 | [optional] | -| **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Object of additional information you may use | [optional] | -| **failure_code** | **str** | If the Payout failed, we include a failure code for more details on the failure. | [optional] | -| **estimated_arrival_time** | **datetime** | Our estimated time on to when your payout is reflected to the destination account | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PayoutAllOf.md b/docs/PayoutAllOf.md deleted file mode 100644 index 869ee6a0..00000000 --- a/docs/PayoutAllOf.md +++ /dev/null @@ -1,18 +0,0 @@ -# xendit.payout.model.PayoutAllOf - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **id** | **str** | Xendit-generated unique identifier for each payout | | -| **created** | **datetime** | The time payout was created on Xendit's system, in ISO 8601 format | | -| **updated** | **datetime** | The time payout was last updated on Xendit's system, in ISO 8601 format | | -| **business_id** | **str** | Xendit Business ID | | -| **status** | **str** | Status of payout | | -| **failure_code** | **str** | If the Payout failed, we include a failure code for more details on the failure. | [optional] | -| **estimated_arrival_time** | **datetime** | Our estimated time on to when your payout is reflected to the destination account | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PayoutApi.md b/docs/PayoutApi.md index d4a6996c..49545c88 100644 --- a/docs/PayoutApi.md +++ b/docs/PayoutApi.md @@ -1,23 +1,56 @@ -# xendit.apis.PayoutApi +# PayoutApi + + +You can use the APIs below to interface with Xendit's `PayoutApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```python +import time +import xendit +from xendit.apis import PayoutApi + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() + +# Create an instance of the API class +api_instance = PayoutApi(api_client) +``` All URIs are relative to *https://api.xendit.co* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_payout**](PayoutApi.md#create_payout) | **POST** /v2/payouts | API to send money at scale to bank accounts & eWallets -[**get_payout_by_id**](PayoutApi.md#get_payout_by_id) | **GET** /v2/payouts/{id} | API to fetch the current status, or details of the payout -[**get_payout_channels**](PayoutApi.md#get_payout_channels) | **GET** /payouts_channels | API providing the current list of banks and e-wallets we support for payouts for both regions -[**get_payouts**](PayoutApi.md#get_payouts) | **GET** /v2/payouts | API to retrieve all matching payouts with reference ID -[**cancel_payout**](PayoutApi.md#cancel_payout) | **POST** /v2/payouts/{id}/cancel | API to cancel requested payouts that have not yet been sent to partner banks and e-wallets. Cancellation is possible if the payout has not been sent out via our partner and when payout status is ACCEPTED. +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**create_payout**](PayoutApi.md#create_payout-function) | **POST** /v2/payouts | API to send money at scale to bank accounts & eWallets | +| [**get_payout_by_id**](PayoutApi.md#get_payout_by_id-function) | **GET** /v2/payouts/{id} | API to fetch the current status, or details of the payout | +| [**get_payout_channels**](PayoutApi.md#get_payout_channels-function) | **GET** /payouts_channels | API providing the current list of banks and e-wallets we support for payouts for both regions | +| [**get_payouts**](PayoutApi.md#get_payouts-function) | **GET** /v2/payouts | API to retrieve all matching payouts with reference ID | +| [**cancel_payout**](PayoutApi.md#cancel_payout-function) | **POST** /v2/payouts/{id}/cancel | API to cancel requested payouts that have not yet been sent to partner banks and e-wallets. Cancellation is possible if the payout has not been sent out via our partner and when payout status is ACCEPTED. | -# **create_payout** +# `create_payout()` Function > GetPayouts200ResponseDataInner create_payout(idempotency_key) API to send money at scale to bank accounts & eWallets -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `create_payout` | +| Request Parameters | [CreatePayoutRequestParams](#request-parameters--CreatePayoutRequestParams) | +| Return Type | [**GetPayouts200ResponseDataInner**](payout/GetPayouts200ResponseDataInner.md) | +### Request Parameters - CreatePayoutRequestParams + +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **idempotency_key** | **str** | ☑️ | | +| **for_user_id** | **str**| | | +| **create_payout_request** | [**CreatePayoutRequest**](payout/CreatePayoutRequest.md)| | | + +### Usage Example +#### Bank or EWallet Payout ```python import time @@ -37,6 +70,19 @@ api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PayoutApi(api_client) idempotency_key = "DISB-1234" # str | A unique key to prevent duplicate requests from pushing through our system. No expiration. +for_user_id = "5f9a3fbd571a1c4068aa40ce" # str | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. +create_payout_request = { + "reference_id" : "DISB-001", + "currency" : "PHP", + "channel_code" : "PH_BDO", + "channel_properties" : { + "account_holder_name" : "John Doe", + "account_number" : "000000" + }, + "amount" : 90000, + "description" : "Test Bank Payout", + "type" : "DIRECT_DISBURSEMENT" +} # CreatePayoutRequest # example passing only required values which don't have defaults set try: @@ -56,41 +102,25 @@ except xendit.XenditSdkException as e: print("Exception when calling PayoutApi->create_payout: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **idempotency_key** | **str**| A unique key to prevent duplicate requests from pushing through our system. No expiration. | - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | [optional] - **create_payout_request** | [**CreatePayoutRequest**](CreatePayoutRequest.md)| | [optional] - -### Return type - -[**GetPayouts200ResponseDataInner**](GetPayouts200ResponseDataInner.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Created payout | - | -**400** | Error when creating payout, see error_code for more details | - | -**401** | Invalid API key | - | -**403** | API key in use does not have necessary permissions to perform the request. Please assign proper permissions for the key. | - | -**409** | Duplicate Error, payout already exists | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_payout_by_id** +# `get_payout_by_id()` Function > GetPayouts200ResponseDataInner get_payout_by_id(id) API to fetch the current status, or details of the payout -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_payout_by_id` | +| Request Parameters | [GetPayoutByIdRequestParams](#request-parameters--GetPayoutByIdRequestParams) | +| Return Type | [**GetPayouts200ResponseDataInner**](payout/GetPayouts200ResponseDataInner.md) | +### Request Parameters - GetPayoutByIdRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | + +### Usage Example ```python import time import xendit @@ -108,6 +138,7 @@ api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PayoutApi(api_client) id = "disb-7baa7335-a0b2-4678-bb8c-318c0167f332" # str | Payout id returned from the response of /v2/payouts +for_user_id = "5f9a3fbd571a1c4068aa40ce" # str | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. # example passing only required values which don't have defaults set try: @@ -127,39 +158,27 @@ except xendit.XenditSdkException as e: print("Exception when calling PayoutApi->get_payout_by_id: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Payout id returned from the response of /v2/payouts | - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | [optional] - -### Return type - -[**GetPayouts200ResponseDataInner**](GetPayouts200ResponseDataInner.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | The Payout object | - | -**401** | Invalid API key | - | -**403** | API key in use does not have necessary permissions to perform the request. Please assign proper permissions for the key. | - | -**404** | Payout Not Found | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_payout_channels** +# `get_payout_channels()` Function > [Channel] get_payout_channels() API providing the current list of banks and e-wallets we support for payouts for both regions -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_payout_channels` | +| Request Parameters | [GetPayoutChannelsRequestParams](#request-parameters--GetPayoutChannelsRequestParams) | +| Return Type | [**[Channel]**](payout/Channel.md) | + +### Request Parameters - GetPayoutChannelsRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **currency** | **str**| | | +| **channel_category** | [**[ChannelCategory]**](payout/ChannelCategory.md)| | | +| **channel_code** | **str**| | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -177,6 +196,12 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PayoutApi(api_client) +currency = "IDR, PHP" # str | Filter channels by currency from ISO-4217 values +channel_category = [ + ChannelCategory("BANK"), + ] # [ChannelCategory] | Filter channels by category +channel_code = "ID_MANDIRI, PH_GCASH" # str | Filter channels by channel code, prefixed by ISO-3166 country code +for_user_id = "5f9a3fbd571a1c4068aa40ce" # str | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. # example passing only required values which don't have defaults set # and optional values @@ -188,38 +213,28 @@ except xendit.XenditSdkException as e: print("Exception when calling PayoutApi->get_payout_channels: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currency** | **str**| Filter channels by currency from ISO-4217 values | [optional] - **channel_category** | [**[ChannelCategory]**](ChannelCategory.md)| Filter channels by category | [optional] - **channel_code** | **str**| Filter channels by channel code, prefixed by ISO-3166 country code | [optional] - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | [optional] - -### Return type - -[**[Channel]**](Channel.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Current list of banks and e-wallets supported for payouts for all regions | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_payouts** +# `get_payouts()` Function > GetPayouts200Response get_payouts(reference_id) API to retrieve all matching payouts with reference ID -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_payouts` | +| Request Parameters | [GetPayoutsRequestParams](#request-parameters--GetPayoutsRequestParams) | +| Return Type | [**GetPayouts200Response**](payout/GetPayouts200Response.md) | + +### Request Parameters - GetPayoutsRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **reference_id** | **str** | ☑️ | | +| **limit** | **float**| | | +| **after_id** | **str**| | | +| **before_id** | **str**| | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -237,6 +252,10 @@ api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PayoutApi(api_client) reference_id = "DISB-123" # str | Reference_id provided when creating the payout +limit = 10 # float | Number of records to fetch per API call +after_id = "disb-7baa7335-a0b2-4678-bb8c-318c0167f332" # str | Used to fetch record after this payout unique id +before_id = "disb-7baa7335-a0b2-4678-bb8c-318c0167f332" # str | Used to fetch record before this payout unique id +for_user_id = "5f9a3fbd571a1c4068aa40ce" # str | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. # example passing only required values which don't have defaults set try: @@ -256,40 +275,25 @@ except xendit.XenditSdkException as e: print("Exception when calling PayoutApi->get_payouts: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **reference_id** | **str**| Reference_id provided when creating the payout | - **limit** | **float**| Number of records to fetch per API call | [optional] - **after_id** | **str**| Used to fetch record after this payout unique id | [optional] - **before_id** | **str**| Used to fetch record before this payout unique id | [optional] - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | [optional] - -### Return type - -[**GetPayouts200Response**](GetPayouts200Response.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | An array of Payout objects sorted by created time in desc order. \"data\" will be an empty array and \"has_more' will be equal to false when there are no matching data. | - | -**403** | API key in use does not have necessary permissions to perform the request. Please assign proper permissions for the key. | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **cancel_payout** +# `cancel_payout()` Function > GetPayouts200ResponseDataInner cancel_payout(id) API to cancel requested payouts that have not yet been sent to partner banks and e-wallets. Cancellation is possible if the payout has not been sent out via our partner and when payout status is ACCEPTED. -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `cancel_payout` | +| Request Parameters | [CancelPayoutRequestParams](#request-parameters--CancelPayoutRequestParams) | +| Return Type | [**GetPayouts200ResponseDataInner**](payout/GetPayouts200ResponseDataInner.md) | +### Request Parameters - CancelPayoutRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **id** | **str** | ☑️ | | +| **for_user_id** | **str**| | | + +### Usage Example ```python import time import xendit @@ -307,6 +311,7 @@ api_client = xendit.ApiClient() # Create an instance of the API class api_instance = PayoutApi(api_client) id = "disb-7baa7335-a0b2-4678-bb8c-318c0167f332" # str | Payout id returned from the response of /v2/payouts +for_user_id = "5f9a3fbd571a1c4068aa40ce" # str | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. # example passing only required values which don't have defaults set try: @@ -326,27 +331,4 @@ except xendit.XenditSdkException as e: print("Exception when calling PayoutApi->cancel_payout: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Payout id returned from the response of /v2/payouts | - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | [optional] - -### Return type - -[**GetPayouts200ResponseDataInner**](GetPayouts200ResponseDataInner.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Cancelled Successfully | - | -**400** | Unable to Cancel | - | -**404** | Invalid Payout ID | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to README]](../README.md) diff --git a/docs/QRCode.md b/docs/QRCode.md deleted file mode 100644 index 85a0d2e7..00000000 --- a/docs/QRCode.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.QRCode - -QRCode Payment Method Details - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | [optional] | -| **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/QRCodeChannelCode.md b/docs/QRCodeChannelCode.md deleted file mode 100644 index cebcceec..00000000 --- a/docs/QRCodeChannelCode.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.QRCodeChannelCode - -QR Code Channel Code - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | QR Code Channel Code | must be one of ["DANA", "RCBC", "LINKAJA", "PROMPTPAY", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/QRCodeChannelProperties.md b/docs/QRCodeChannelProperties.md deleted file mode 100644 index 70128573..00000000 --- a/docs/QRCodeChannelProperties.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.QRCodeChannelProperties - -QR Code Channel Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **qr_string** | **str** | | [optional] | -| **expires_at** | **datetime** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/QRCodeParameters.md b/docs/QRCodeParameters.md deleted file mode 100644 index 6e1cf9d1..00000000 --- a/docs/QRCodeParameters.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.payment_request.model.QRCodeParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | [optional] | -| **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/QrCode.md b/docs/QrCode.md deleted file mode 100644 index 1edefa82..00000000 --- a/docs/QrCode.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.invoice.model.QrCode - -An object representing QR code details for invoices. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **qr_code_type** | [**QrCodeType**](QrCodeType.md) | | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/QrCodeType.md b/docs/QrCodeType.md deleted file mode 100644 index aed7db8e..00000000 --- a/docs/QrCodeType.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.QrCodeType - -Representing the available QR Code channels used for invoice-related transactions. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing the available QR Code channels used for invoice-related transactions. | must be one of ["QRIS", "PROMPTPAY", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ReceiptNotification.md b/docs/ReceiptNotification.md deleted file mode 100644 index c75edef5..00000000 --- a/docs/ReceiptNotification.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.payout.model.ReceiptNotification - -Additional notification for completed payout - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **email_to** | **[str], none_type** | Valid email address to send the payout receipt | [optional] | -| **email_cc** | **[str], none_type** | Valid email address to cc the payout receipt | [optional] | -| **email_bcc** | **[str], none_type** | Valid email address to bcc the payout receipt | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Refund.md b/docs/Refund.md deleted file mode 100644 index 143e8e8c..00000000 --- a/docs/Refund.md +++ /dev/null @@ -1,23 +0,0 @@ -# xendit.refund.model.Refund - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **id** | **str** | | [optional] | -| **payment_request_id** | **str** | | [optional] | -| **amount** | **float** | | [optional] | -| **channel_code** | **str** | | [optional] | -| **country** | **str** | | [optional] | -| **currency** | **str** | | [optional] | -| **reference_id** | **str, none_type** | | [optional] | -| **failure_code** | **str, none_type** | | [optional] | -| **refund_fee_amount** | **float, none_type** | | [optional] | -| **created** | **str** | | [optional] | -| **updated** | **str** | | [optional] | -| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RefundApi.md b/docs/RefundApi.md index b34d613b..6ee3ccf6 100644 --- a/docs/RefundApi.md +++ b/docs/RefundApi.md @@ -1,23 +1,54 @@ -# xendit.apis.RefundApi +# RefundApi + + +You can use the APIs below to interface with Xendit's `RefundApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```python +import time +import xendit +from xendit.apis import RefundApi + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() + +# Create an instance of the API class +api_instance = RefundApi(api_client) +``` All URIs are relative to *https://api.xendit.co* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_refund**](RefundApi.md#create_refund) | **POST** /refunds | -[**get_refund**](RefundApi.md#get_refund) | **GET** /refunds/{refundID} | -[**get_all_refunds**](RefundApi.md#get_all_refunds) | **GET** /refunds | -[**cancel_refund**](RefundApi.md#cancel_refund) | **POST** /refunds/{refundID}/cancel | +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**create_refund**](RefundApi.md#create_refund-function) | **POST** /refunds | | +| [**get_refund**](RefundApi.md#get_refund-function) | **GET** /refunds/{refundID} | | +| [**get_all_refunds**](RefundApi.md#get_all_refunds-function) | **GET** /refunds | | +| [**cancel_refund**](RefundApi.md#cancel_refund-function) | **POST** /refunds/{refundID}/cancel | | -# **create_refund** +# `create_refund()` Function > Refund create_refund() -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `create_refund` | +| Request Parameters | [CreateRefundRequestParams](#request-parameters--CreateRefundRequestParams) | +| Return Type | [**Refund**](refund/Refund.md) | +### Request Parameters - CreateRefundRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **idempotency_key** | **str**| | | +| **for_user_id** | **str**| | | +| **create_refund** | [**CreateRefund**](refund/CreateRefund.md)| | | + +### Usage Example ```python import time import xendit @@ -40,6 +71,17 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = RefundApi(api_client) +idempotency_key = "9797b5a6-54ad-4511-80a4-ec451346808b" # str +for_user_id = "5f9a3fbd571a1c4068aa40ce" # str +create_refund = CreateRefund( + payment_request_id="pr-3ece8615-41b7-4983-a3f0-a037430b6036", + invoice_id="7a2c81d4f9e052a870bf37d2", + reference_id="order-1234", + amount=1500, + currency="PHP", + reason="CANCELLATION", + metadata={}, + ) # CreateRefund # example passing only required values which don't have defaults set # and optional values @@ -50,42 +92,26 @@ except xendit.XenditSdkException as e: print("Exception when calling RefundApi->create_refund: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **idempotency_key** | **str**| | [optional] - **for_user_id** | **str**| | [optional] - **create_refund** | [**CreateRefund**](CreateRefund.md)| | [optional] - -### Return type - -[**Refund**](Refund.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**409** | Request causes conflict | - | -**503** | Service is unavailable due to dependencies | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_refund** +# `get_refund()` Function > Refund get_refund(refund_id) -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_refund` | +| Request Parameters | [GetRefundRequestParams](#request-parameters--GetRefundRequestParams) | +| Return Type | [**Refund**](refund/Refund.md) | + +### Request Parameters - GetRefundRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **refund_id** | **str** | ☑️ | | +| **idempotency_key** | **str**| | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -102,7 +128,9 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = RefundApi(api_client) -refund_id = "rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +refund_id = "rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +idempotency_key = "9797b5a6-54ad-4511-80a4-ec451346808b" # str +for_user_id = "5f9a3fbd571a1c4068aa40ce" # str # example passing only required values which don't have defaults set try: @@ -120,37 +148,31 @@ except xendit.XenditSdkException as e: print("Exception when calling RefundApi->get_refund: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **refund_id** | **str**| | - **idempotency_key** | **str**| | [optional] - **for_user_id** | **str**| | [optional] - -### Return type - -[**Refund**](Refund.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_refunds** +# `get_all_refunds()` Function > RefundList get_all_refunds() -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_all_refunds` | +| Request Parameters | [GetAllRefundsRequestParams](#request-parameters--GetAllRefundsRequestParams) | +| Return Type | [**RefundList**](refund/RefundList.md) | + +### Request Parameters - GetAllRefundsRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **for_user_id** | **str**| | | +| **payment_request_id** | **str**| | | +| **invoice_id** | **str**| | | +| **payment_method_type** | **str**| | | +| **channel_code** | **str**| | | +| **limit** | **float**| | | +| **after_id** | **str**| | | +| **before_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -167,6 +189,14 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = RefundApi(api_client) +for_user_id = "5f9a3fbd571a1c4068aa40ce" # str +payment_request_id = "payment_request_id_example" # str +invoice_id = "invoice_id_example" # str +payment_method_type = "payment_method_type_example" # str +channel_code = "channel_code_example" # str +limit = 3.14 # float +after_id = "after_id_example" # str +before_id = "before_id_example" # str # example passing only required values which don't have defaults set # and optional values @@ -177,42 +207,26 @@ except xendit.XenditSdkException as e: print("Exception when calling RefundApi->get_all_refunds: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **for_user_id** | **str**| | [optional] - **payment_request_id** | **str**| | [optional] - **invoice_id** | **str**| | [optional] - **payment_method_type** | **str**| | [optional] - **channel_code** | **str**| | [optional] - **limit** | **float**| | [optional] - **after_id** | **str**| | [optional] - **before_id** | **str**| | [optional] - -### Return type - -[**RefundList**](RefundList.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **cancel_refund** +# `cancel_refund()` Function > Refund cancel_refund(refund_id) -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `cancel_refund` | +| Request Parameters | [CancelRefundRequestParams](#request-parameters--CancelRefundRequestParams) | +| Return Type | [**Refund**](refund/Refund.md) | +### Request Parameters - CancelRefundRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **refund_id** | **str** | ☑️ | | +| **idempotency_key** | **str**| | | +| **for_user_id** | **str**| | | + +### Usage Example ```python import time import xendit @@ -232,7 +246,9 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = RefundApi(api_client) -refund_id = "rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str | +refund_id = "rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822" # str +idempotency_key = "9797b5a6-54ad-4511-80a4-ec451346808b" # str +for_user_id = "5f9a3fbd571a1c4068aa40ce" # str # example passing only required values which don't have defaults set try: @@ -250,29 +266,4 @@ except xendit.XenditSdkException as e: print("Exception when calling RefundApi->cancel_refund: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **refund_id** | **str**| | - **idempotency_key** | **str**| | [optional] - **for_user_id** | **str**| | [optional] - -### Return type - -[**Refund**](Refund.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**400** | Bad request | - | -**403** | Forbidden due to permissions | - | -**404** | Data not found | - | -**0** | Internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to README]](../README.md) diff --git a/docs/RefundList.md b/docs/RefundList.md deleted file mode 100644 index 040244a6..00000000 --- a/docs/RefundList.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.refund.model.RefundList - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **data** | [**[Refund]**](Refund.md) | | | -| **has_more** | **bool** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ResponseDataNotFound.md b/docs/ResponseDataNotFound.md deleted file mode 100644 index 6d257dde..00000000 --- a/docs/ResponseDataNotFound.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.ResponseDataNotFound - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RetailOutlet.md b/docs/RetailOutlet.md deleted file mode 100644 index db303434..00000000 --- a/docs/RetailOutlet.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.invoice.model.RetailOutlet - -An object representing retail outlet details for invoices. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **retail_outlet_name** | [**RetailOutletName**](RetailOutletName.md) | | | -| **payment_code** | **str** | The payment code. | [optional] | -| **transfer_amount** | **float** | The transfer amount. | [optional] | -| **merchant_name** | **str** | The name of the merchant. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RetailOutletName.md b/docs/RetailOutletName.md deleted file mode 100644 index 73b80f46..00000000 --- a/docs/RetailOutletName.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.RetailOutletName - -Representing the available retail outlet channels used for invoice-related transactions. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Representing the available retail outlet channels used for invoice-related transactions. | must be one of ["ALFAMART", "INDOMARET", "7ELEVEN", "CEBUANA", "DP_ECPAY_LOAN", "DP_MLHUILLIER", "DP_PALAWAN", "DP_ECPAY_SCHOOL", "LBC", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ServerError.md b/docs/ServerError.md deleted file mode 100644 index 9721a284..00000000 --- a/docs/ServerError.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.invoice.model.ServerError - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **message** | **str** | | | -| **error_code** | **str** | | defaults to "SERVER_ERROR" | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SimulatePaymentRequest.md b/docs/SimulatePaymentRequest.md deleted file mode 100644 index b8eb5752..00000000 --- a/docs/SimulatePaymentRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.payment_method.model.SimulatePaymentRequest - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **amount** | **float** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TokenizedCardInformation.md b/docs/TokenizedCardInformation.md deleted file mode 100644 index 3c1ce69f..00000000 --- a/docs/TokenizedCardInformation.md +++ /dev/null @@ -1,22 +0,0 @@ -# xendit.payment_method.model.TokenizedCardInformation - -Tokenized Card Information - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **token_id** | **str** | | | -| **masked_card_number** | **str** | 1st 6 and last 4 digits of the card | | -| **expiry_month** | **str** | Card expiry month in MM format | | -| **expiry_year** | **str** | Card expiry month in YY format | | -| **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. | | -| **type** | **str** | Whether the card is a credit or debit card | | -| **network** | **str** | Card network - VISA, MASTERCARD, JCB, AMEX, DISCOVER, BCA | | -| **country** | **str** | Country where the card was issued ISO 3166-1 Alpha-2 | | -| **issuer** | **str** | Issuer of the card, most often an issuing bank For example, “BCA”, “MANDIRI” | | -| **cardholder_name** | **str, none_type** | Cardholder name is optional but recommended for 3DS 2 / AVS verification | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TransactionApi.md b/docs/TransactionApi.md index b7d887e4..3bb3afe2 100644 --- a/docs/TransactionApi.md +++ b/docs/TransactionApi.md @@ -1,23 +1,51 @@ -# xendit.apis.TransactionApi +# TransactionApi + + +You can use the APIs below to interface with Xendit's `TransactionApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```python +import time +import xendit +from xendit.apis import TransactionApi + +# See configuration.py for a list of all supported configuration parameters. +xendit.set_api_key('XENDIT API KEY') + +# Enter a context with an instance of the API client +api_client = xendit.ApiClient() + +# Create an instance of the API class +api_instance = TransactionApi(api_client) +``` All URIs are relative to *https://api.xendit.co* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_transaction_by_id**](TransactionApi.md#get_transaction_by_id) | **GET** /transactions/{id} | Get a transaction based on its id -[**get_all_transactions**](TransactionApi.md#get_all_transactions) | **GET** /transactions | Get a list of transactions +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**get_transaction_by_id**](TransactionApi.md#get_transaction_by_id-function) | **GET** /transactions/{id} | Get a transaction based on its id | +| [**get_all_transactions**](TransactionApi.md#get_all_transactions-function) | **GET** /transactions | Get a list of transactions | -# **get_transaction_by_id** +# `get_transaction_by_id()` Function > TransactionResponse get_transaction_by_id(id) Get a transaction based on its id -Get single specific transaction by transaction id. +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_transaction_by_id` | +| Request Parameters | [GetTransactionByIdRequestParams](#request-parameters--GetTransactionByIdRequestParams) | +| Return Type | [**TransactionResponse**](balance_and_transaction/TransactionResponse.md) | -### Example +### Request Parameters - GetTransactionByIdRequestParams +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **id** | **TransactionId** | ☑️ | | +| **for_user_id** | **str**| | | +### Usage Example ```python import time import xendit @@ -35,7 +63,8 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = TransactionApi(api_client) -id = TransactionId("txn_438e4b61-7c4c-4dbb-bbba-94a896bff333") # TransactionId | +id = TransactionId("txn_438e4b61-7c4c-4dbb-bbba-94a896bff333") # TransactionId +for_user_id = "5dbf20d7c8eb0c0896f811b6" # str | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information # example passing only required values which don't have defaults set try: @@ -55,39 +84,37 @@ except xendit.XenditSdkException as e: print("Exception when calling TransactionApi->get_transaction_by_id: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **TransactionId**| | - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information | [optional] - -### Return type - -[**TransactionResponse**](TransactionResponse.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**400** | invalid input, object invalid | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_transactions** +# `get_all_transactions()` Function > TransactionsResponse get_all_transactions() Get a list of transactions -Get a list of all transactions based on filter and search parameters. - -### Example - - +| Name | Value | +|--------------------|:-------------:| +| Function Name | `get_all_transactions` | +| Request Parameters | [GetAllTransactionsRequestParams](#request-parameters--GetAllTransactionsRequestParams) | +| Return Type | [**TransactionsResponse**](balance_and_transaction/TransactionsResponse.md) | + +### Request Parameters - GetAllTransactionsRequestParams + +| Name | Type | Required | Default | +|-------------|:-------------:|:-------------:|-------------| +| **for_user_id** | **str**| | | +| **types** | [**[TransactionTypes]**](balance_and_transaction/TransactionTypes.md)| | | +| **statuses** | [**[TransactionStatuses]**](balance_and_transaction/TransactionStatuses.md)| | | +| **channel_categories** | [**[ChannelsCategories]**](balance_and_transaction/ChannelsCategories.md)| | | +| **reference_id** | **str**| | | +| **product_id** | **str**| | | +| **account_identifier** | **str**| | | +| **amount** | **float**| | | +| **currency** | **Currency**| | | +| **created** | **DateRangeFilter**| | | +| **updated** | **DateRangeFilter**| | | +| **limit** | **float**| | 10 | +| **after_id** | **TransactionId**| | | +| **before_id** | **TransactionId**| | | + +### Usage Example ```python import time import xendit @@ -110,6 +137,32 @@ xendit.set_api_key('XENDIT API KEY') api_client = xendit.ApiClient() # Create an instance of the API class api_instance = TransactionApi(api_client) +for_user_id = "5dbf20d7c8eb0c0896f811b6" # str | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information +types = [ + TransactionTypes("["DISBURSEMENT","PAYMENT"]"), + ] # [TransactionTypes] | Transaction types that will be included in the result. Default is to include all transaction types +statuses = [ + TransactionStatuses("["SUCCESS","PENDING"]"), + ] # [TransactionStatuses] | Status of the transaction. Default is to include all status. +channel_categories = [ + ChannelsCategories("["BANK","INVOICE"]"), + ] # [ChannelsCategories] | Payment channels in which the transaction is carried out. Default is to include all channels. +reference_id = "ref23232" # str | To filter the result for transactions with matching reference given (case sensitive) +product_id = "d290f1ee-6c54-4b01-90e6-d701748f0701" # str | To filter the result for transactions with matching product_id (a.k.a payment_id) given (case sensitive) +account_identifier = "123123123" # str | Account identifier of transaction. The format will be different from each channel. For example, on `BANK` channel it will be account number and on `CARD` it will be masked card number. +amount = 100 # float | Specific transaction amount to search for +currency = Currency("IDR") # Currency +created = DateRangeFilter( + gte=dateutil_parser('2020-08-29T17:00:00Z'), + lte=dateutil_parser('2020-08-29T17:00:00Z'), + ) # DateRangeFilter | Filter time of transaction by created date. If not specified will list all dates. +updated = DateRangeFilter( + gte=dateutil_parser('2020-08-29T17:00:00Z'), + lte=dateutil_parser('2020-08-29T17:00:00Z'), + ) # DateRangeFilter | Filter time of transaction by updated date. If not specified will list all dates. +limit = 10 # float | number of items in the result per page. Another name for \"results_per_page\" +after_id = TransactionId("txn_438e4b61-7c4c-4dbb-bbba-94a896bff333") # TransactionId +before_id = TransactionId("txn_438e4b61-7c4c-4dbb-bbba-94a896bff333") # TransactionId # example passing only required values which don't have defaults set # and optional values @@ -121,38 +174,4 @@ except xendit.XenditSdkException as e: print("Exception when calling TransactionApi->get_all_transactions: %s\n" % e) ``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **for_user_id** | **str**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information | [optional] - **types** | [**[TransactionTypes]**](TransactionTypes.md)| Transaction types that will be included in the result. Default is to include all transaction types | [optional] - **statuses** | [**[TransactionStatuses]**](TransactionStatuses.md)| Status of the transaction. Default is to include all status. | [optional] - **channel_categories** | [**[ChannelsCategories]**](ChannelsCategories.md)| Payment channels in which the transaction is carried out. Default is to include all channels. | [optional] - **reference_id** | **str**| To filter the result for transactions with matching reference given (case sensitive) | [optional] - **product_id** | **str**| To filter the result for transactions with matching product_id (a.k.a payment_id) given (case sensitive) | [optional] - **account_identifier** | **str**| Account identifier of transaction. The format will be different from each channel. For example, on `BANK` channel it will be account number and on `CARD` it will be masked card number. | [optional] - **amount** | **float**| Specific transaction amount to search for | [optional] - **currency** | **Currency**| | [optional] - **created** | **DateRangeFilter**| Filter time of transaction by created date. If not specified will list all dates. | [optional] - **updated** | **DateRangeFilter**| Filter time of transaction by updated date. If not specified will list all dates. | [optional] - **limit** | **float**| number of items in the result per page. Another name for \"results_per_page\" | [optional] if omitted the server will use the default value of 10 - **after_id** | **TransactionId**| | [optional] - **before_id** | **TransactionId**| | [optional] - -### Return type - -[**TransactionsResponse**](TransactionsResponse.md) - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of transaction object | - | -**400** | invalid input, object invalid | - | -**0** | Errors | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to README]](../README.md) diff --git a/docs/TransactionId.md b/docs/TransactionId.md deleted file mode 100644 index 4faa316b..00000000 --- a/docs/TransactionId.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.balance_and_transaction.model.TransactionId - -The unique id of a transaction. It will have `txn_` as prefix - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | The unique id of a transaction. It will have `txn_` as prefix | | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TransactionResponse.md b/docs/TransactionResponse.md deleted file mode 100644 index 7e534041..00000000 --- a/docs/TransactionResponse.md +++ /dev/null @@ -1,28 +0,0 @@ -# xendit.balance_and_transaction.model.TransactionResponse - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **id** | [**TransactionId**](TransactionId.md) | | | -| **product_id** | **str** | The product_id of the transaction. Product id will have a different prefix for each product. You can use this id to match the transaction from this API to each product API. | | -| **type** | [**TransactionResponseType**](TransactionResponseType.md) | | | -| **status** | [**TransactionStatuses**](TransactionStatuses.md) | | | -| **channel_category** | [**ChannelsCategories**](ChannelsCategories.md) | | | -| **channel_code** | **str, none_type** | The channel of the transaction that is used. See [channel codes](https://docs.xendit.co/xendisburse/channel-codes) for the list of available per channel categories. | | -| **account_identifier** | **str, none_type** | Account identifier of transaction. The format will be different from each channel. | | -| **reference_id** | **str** | customer supplied reference/external_id | | -| **currency** | [**Currency**](Currency.md) | | | -| **amount** | **float** | The transaction amount. The number of decimal places will be different for each currency according to ISO 4217. | | -| **cashflow** | **str** | Representing whether the transaction is money in or money out For transfer, the transfer out side it will shows up as money out and on transfer in side in will shows up as money-in. Available values are `MONEY_IN` for money in and `MONEY_OUT` for money out. | | -| **business_id** | **str** | The id of business where this transaction belong to | | -| **fee** | [**FeeResponse**](FeeResponse.md) | | | -| **created** | **datetime** | Transaction created timestamp (UTC+0) | | -| **updated** | **datetime** | Transaction updated timestamp (UTC+0) | | -| **settlement_status** | **str, none_type** | The settlement status of the transaction. `PENDING` - Transaction amount has not been settled to merchant's balance. `SETTLED` - Transaction has been settled to merchant's balance | [optional] | -| **estimated_settlement_time** | **datetime, none_type** | Estimated settlement time will only apply to money-in transactions. For money-out transaction, the value will be `NULL`. Estimated settlement time in which transaction amount will be settled to merchant's balance. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TransactionResponseType.md b/docs/TransactionResponseType.md deleted file mode 100644 index 5d6aee7f..00000000 --- a/docs/TransactionResponseType.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.balance_and_transaction.model.TransactionResponseType - -The type of the transactions. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TransactionStatuses.md b/docs/TransactionStatuses.md deleted file mode 100644 index f7289fad..00000000 --- a/docs/TransactionStatuses.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.balance_and_transaction.model.TransactionStatuses - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["SUCCESS", "PENDING", "FAILED", "REVERSED", "VOIDED", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TransactionTypes.md b/docs/TransactionTypes.md deleted file mode 100644 index a842fd08..00000000 --- a/docs/TransactionTypes.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.balance_and_transaction.model.TransactionTypes - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | | must be one of ["BATCH_DISBURSEMENT", "DISBURSEMENT", "PAYMENT", "REMITTANCE", "REMITTANCE_PAYOUT", "REMITTANCE_COLLECTION", "TRANSFER", "PLATFORM_FEE", "REFUND", "CASHBACK", "TOPUP", "WITHDRAWAL", "OTHER", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TransactionsResponse.md b/docs/TransactionsResponse.md deleted file mode 100644 index 05ff66b8..00000000 --- a/docs/TransactionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.balance_and_transaction.model.TransactionsResponse - -Returns an array of Transaction Objects. Returns empty array when there is no result. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **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. | | -| **data** | [**[TransactionResponse]**](TransactionResponse.md) | | | -| **links** | [**[LinkItem]**](LinkItem.md) | The links to the next page based on LinkItem if there is next result. | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UnauthorizedError.md b/docs/UnauthorizedError.md deleted file mode 100644 index 658280d8..00000000 --- a/docs/UnauthorizedError.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.invoice.model.UnauthorizedError - -An error object used to indicate unauthorized access to an invoice-related resource. - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **message** | **str** | A human-readable error message providing additional context about the unauthorized access. | | -| **error_code** | **str** | The specific error code associated with the unauthorized access. | defaults to "INVALID_API_KEY" | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UpdateCustomer400Response.md b/docs/UpdateCustomer400Response.md deleted file mode 100644 index 91fd3652..00000000 --- a/docs/UpdateCustomer400Response.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.customer.model.UpdateCustomer400Response - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | | -| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | -| **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UpdateCustomer400ResponseAllOf.md b/docs/UpdateCustomer400ResponseAllOf.md deleted file mode 100644 index 7a2bd35e..00000000 --- a/docs/UpdateCustomer400ResponseAllOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# xendit.customer.model.UpdateCustomer400ResponseAllOf - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **error_code** | **str** | | [optional] | -| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ValidationError.md b/docs/ValidationError.md deleted file mode 100644 index ddc98ffc..00000000 --- a/docs/ValidationError.md +++ /dev/null @@ -1,15 +0,0 @@ -# xendit.balance_and_transaction.model.ValidationError - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **status_code** | **float** | | | -| **error** | **str** | | | -| **message** | **str** | | | -| **validation** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VirtualAccount.md b/docs/VirtualAccount.md deleted file mode 100644 index 2a33e7b9..00000000 --- a/docs/VirtualAccount.md +++ /dev/null @@ -1,20 +0,0 @@ -# xendit.payment_request.model.VirtualAccount - -Virtual Account Payment Method Details - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | | | -| **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | | | -| **min_amount** | **float, none_type** | | [optional] | -| **max_amount** | **float, none_type** | | [optional] | -| **amount** | **float, none_type** | | [optional] | -| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | [optional] | -| **alternative_display_types** | **[str]** | Alternative display requested for the virtual account | [optional] | -| **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VirtualAccountAllOf.md b/docs/VirtualAccountAllOf.md deleted file mode 100644 index 54c03b7f..00000000 --- a/docs/VirtualAccountAllOf.md +++ /dev/null @@ -1,12 +0,0 @@ -# xendit.payment_request.model.VirtualAccountAllOf - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VirtualAccountAlternativeDisplay.md b/docs/VirtualAccountAlternativeDisplay.md deleted file mode 100644 index 0ef294e2..00000000 --- a/docs/VirtualAccountAlternativeDisplay.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.VirtualAccountAlternativeDisplay - -Alternative Display Object - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **type** | **str** | Type of the alternative display | [optional] [readonly] if omitted the server will use the default value of "QR_STRING" | -| **data** | **str** | Data payload of the given alternative display | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VirtualAccountChannelCode.md b/docs/VirtualAccountChannelCode.md deleted file mode 100644 index a4dd4168..00000000 --- a/docs/VirtualAccountChannelCode.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_request.model.VirtualAccountChannelCode - -Virtual Account Channel Code - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **value** | **str** | Virtual Account Channel Code | must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", "UNKNOWN_ENUM_VALUE"] | - -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. - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VirtualAccountChannelProperties.md b/docs/VirtualAccountChannelProperties.md deleted file mode 100644 index a8bfa7ae..00000000 --- a/docs/VirtualAccountChannelProperties.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.payment_request.model.VirtualAccountChannelProperties - -Virtual Account Channel Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **customer_name** | **str** | Name of customer. | | -| **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. | [optional] | -| **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. | [optional] | -| **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) | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VirtualAccountChannelPropertiesPatch.md b/docs/VirtualAccountChannelPropertiesPatch.md deleted file mode 100644 index 850f4505..00000000 --- a/docs/VirtualAccountChannelPropertiesPatch.md +++ /dev/null @@ -1,14 +0,0 @@ -# xendit.payment_method.model.VirtualAccountChannelPropertiesPatch - -Virtual Account Channel Properties - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **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. | [optional] | -| **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) | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VirtualAccountParameters.md b/docs/VirtualAccountParameters.md deleted file mode 100644 index 096a3611..00000000 --- a/docs/VirtualAccountParameters.md +++ /dev/null @@ -1,18 +0,0 @@ -# xendit.payment_request.model.VirtualAccountParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | | | -| **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | | | -| **min_amount** | **float, none_type** | | [optional] | -| **max_amount** | **float, none_type** | | [optional] | -| **amount** | **float, none_type** | | [optional] | -| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | [optional] | -| **alternative_display_types** | **[str]** | Alternative display requested for the virtual account | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VirtualAccountUpdateParameters.md b/docs/VirtualAccountUpdateParameters.md deleted file mode 100644 index efc9a879..00000000 --- a/docs/VirtualAccountUpdateParameters.md +++ /dev/null @@ -1,16 +0,0 @@ -# xendit.payment_method.model.VirtualAccountUpdateParameters - - -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **amount** | **float, none_type** | | [optional] | -| **min_amount** | **float, none_type** | | [optional] | -| **max_amount** | **float, none_type** | | [optional] | -| **channel_properties** | [**VirtualAccountChannelPropertiesPatch**](VirtualAccountChannelPropertiesPatch.md) | | [optional] | -| **alternative_display_types** | **[str]** | For payments in Vietnam only, alternative display requested for the virtual account | [optional] | - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/balance_and_transaction/Balance.md b/docs/balance_and_transaction/Balance.md new file mode 100644 index 00000000..49ab3161 --- /dev/null +++ b/docs/balance_and_transaction/Balance.md @@ -0,0 +1,14 @@ +# Balance +> xendit.balance_and_transaction.model.Balance + +The balance remaining in your account + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **balance** | **float** | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/ChannelsCategories.md b/docs/balance_and_transaction/ChannelsCategories.md new file mode 100644 index 00000000..aa6c99e9 --- /dev/null +++ b/docs/balance_and_transaction/ChannelsCategories.md @@ -0,0 +1,43 @@ +# ChannelsCategories +> xendit.balance_and_transaction.model.ChannelsCategories + + + +## Enum + + + * `BANK` (value: `"BANK"`) + + * `CARDLESS_CREDIT` (value: `"CARDLESS_CREDIT"`) + + * `PAYLATER` (value: `"PAYLATER"`) + + * `CARDS` (value: `"CARDS"`) + + * `CASH` (value: `"CASH"`) + + * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `INVOICE` (value: `"INVOICE"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `RETAIL_OUTLET` (value: `"RETAIL_OUTLET"`) + + * `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) + + * `XENPLATFORM` (value: `"XENPLATFORM"`) + + * `DIRECT_BANK_TRANSFER` (value: `"DIRECT_BANK_TRANSFER"`) + + * `OTHER` (value: `"OTHER"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/Currency.md b/docs/balance_and_transaction/Currency.md new file mode 100644 index 00000000..529ed5e2 --- /dev/null +++ b/docs/balance_and_transaction/Currency.md @@ -0,0 +1,339 @@ +# Currency +> xendit.balance_and_transaction.model.Currency + + + +## Enum + + + * `IDR` (value: `"IDR"`) + + * `PHP` (value: `"PHP"`) + + * `USD` (value: `"USD"`) + + * `JPY` (value: `"JPY"`) + + * `VND` (value: `"VND"`) + + * `SGD` (value: `"SGD"`) + + * `AED` (value: `"AED"`) + + * `AFN` (value: `"AFN"`) + + * `ALL` (value: `"ALL"`) + + * `AMD` (value: `"AMD"`) + + * `ANG` (value: `"ANG"`) + + * `AOA` (value: `"AOA"`) + + * `ARS` (value: `"ARS"`) + + * `AUD` (value: `"AUD"`) + + * `AWG` (value: `"AWG"`) + + * `AZN` (value: `"AZN"`) + + * `BAM` (value: `"BAM"`) + + * `BBD` (value: `"BBD"`) + + * `BDT` (value: `"BDT"`) + + * `BGN` (value: `"BGN"`) + + * `BHD` (value: `"BHD"`) + + * `BIF` (value: `"BIF"`) + + * `BMD` (value: `"BMD"`) + + * `BND` (value: `"BND"`) + + * `BOB` (value: `"BOB"`) + + * `BRL` (value: `"BRL"`) + + * `BSD` (value: `"BSD"`) + + * `BTN` (value: `"BTN"`) + + * `BWP` (value: `"BWP"`) + + * `BYN` (value: `"BYN"`) + + * `BZD` (value: `"BZD"`) + + * `CAD` (value: `"CAD"`) + + * `CDF` (value: `"CDF"`) + + * `CHF` (value: `"CHF"`) + + * `CLP` (value: `"CLP"`) + + * `CNY` (value: `"CNY"`) + + * `COP` (value: `"COP"`) + + * `CRC` (value: `"CRC"`) + + * `CUC` (value: `"CUC"`) + + * `CUP` (value: `"CUP"`) + + * `CVE` (value: `"CVE"`) + + * `CZK` (value: `"CZK"`) + + * `DJF` (value: `"DJF"`) + + * `DKK` (value: `"DKK"`) + + * `DOP` (value: `"DOP"`) + + * `DZD` (value: `"DZD"`) + + * `EGP` (value: `"EGP"`) + + * `ERN` (value: `"ERN"`) + + * `ETB` (value: `"ETB"`) + + * `EUR` (value: `"EUR"`) + + * `FJD` (value: `"FJD"`) + + * `FKP` (value: `"FKP"`) + + * `GBP` (value: `"GBP"`) + + * `GEL` (value: `"GEL"`) + + * `GGP` (value: `"GGP"`) + + * `GHS` (value: `"GHS"`) + + * `GIP` (value: `"GIP"`) + + * `GMD` (value: `"GMD"`) + + * `GNF` (value: `"GNF"`) + + * `GTQ` (value: `"GTQ"`) + + * `GYD` (value: `"GYD"`) + + * `HKD` (value: `"HKD"`) + + * `HNL` (value: `"HNL"`) + + * `HRK` (value: `"HRK"`) + + * `HTG` (value: `"HTG"`) + + * `HUF` (value: `"HUF"`) + + * `ILS` (value: `"ILS"`) + + * `IMP` (value: `"IMP"`) + + * `INR` (value: `"INR"`) + + * `IQD` (value: `"IQD"`) + + * `IRR` (value: `"IRR"`) + + * `ISK` (value: `"ISK"`) + + * `JEP` (value: `"JEP"`) + + * `JMD` (value: `"JMD"`) + + * `JOD` (value: `"JOD"`) + + * `KES` (value: `"KES"`) + + * `KGS` (value: `"KGS"`) + + * `KHR` (value: `"KHR"`) + + * `KMF` (value: `"KMF"`) + + * `KPW` (value: `"KPW"`) + + * `KRW` (value: `"KRW"`) + + * `KWD` (value: `"KWD"`) + + * `KYD` (value: `"KYD"`) + + * `KZT` (value: `"KZT"`) + + * `LAK` (value: `"LAK"`) + + * `LBP` (value: `"LBP"`) + + * `LKR` (value: `"LKR"`) + + * `LRD` (value: `"LRD"`) + + * `LSL` (value: `"LSL"`) + + * `LYD` (value: `"LYD"`) + + * `MAD` (value: `"MAD"`) + + * `MDL` (value: `"MDL"`) + + * `MGA` (value: `"MGA"`) + + * `MKD` (value: `"MKD"`) + + * `MMK` (value: `"MMK"`) + + * `MNT` (value: `"MNT"`) + + * `MOP` (value: `"MOP"`) + + * `MRU` (value: `"MRU"`) + + * `MUR` (value: `"MUR"`) + + * `MVR` (value: `"MVR"`) + + * `MWK` (value: `"MWK"`) + + * `MXN` (value: `"MXN"`) + + * `MYR` (value: `"MYR"`) + + * `MZN` (value: `"MZN"`) + + * `NAD` (value: `"NAD"`) + + * `NGN` (value: `"NGN"`) + + * `NIO` (value: `"NIO"`) + + * `NOK` (value: `"NOK"`) + + * `NPR` (value: `"NPR"`) + + * `NZD` (value: `"NZD"`) + + * `OMR` (value: `"OMR"`) + + * `PAB` (value: `"PAB"`) + + * `PEN` (value: `"PEN"`) + + * `PGK` (value: `"PGK"`) + + * `PKR` (value: `"PKR"`) + + * `PLN` (value: `"PLN"`) + + * `PYG` (value: `"PYG"`) + + * `QAR` (value: `"QAR"`) + + * `RON` (value: `"RON"`) + + * `RSD` (value: `"RSD"`) + + * `RUB` (value: `"RUB"`) + + * `RWF` (value: `"RWF"`) + + * `SAR` (value: `"SAR"`) + + * `SBD` (value: `"SBD"`) + + * `SCR` (value: `"SCR"`) + + * `SDG` (value: `"SDG"`) + + * `SEK` (value: `"SEK"`) + + * `SHP` (value: `"SHP"`) + + * `SLL` (value: `"SLL"`) + + * `SOS` (value: `"SOS"`) + + * `SPL` (value: `"SPL"`) + + * `SRD` (value: `"SRD"`) + + * `STN` (value: `"STN"`) + + * `SVC` (value: `"SVC"`) + + * `SYP` (value: `"SYP"`) + + * `SZL` (value: `"SZL"`) + + * `THB` (value: `"THB"`) + + * `TJS` (value: `"TJS"`) + + * `TMT` (value: `"TMT"`) + + * `TND` (value: `"TND"`) + + * `TOP` (value: `"TOP"`) + + * `TRY` (value: `"TRY"`) + + * `TTD` (value: `"TTD"`) + + * `TVD` (value: `"TVD"`) + + * `TWD` (value: `"TWD"`) + + * `TZS` (value: `"TZS"`) + + * `UAH` (value: `"UAH"`) + + * `UGX` (value: `"UGX"`) + + * `UYU` (value: `"UYU"`) + + * `UZS` (value: `"UZS"`) + + * `VEF` (value: `"VEF"`) + + * `VUV` (value: `"VUV"`) + + * `WST` (value: `"WST"`) + + * `XAF` (value: `"XAF"`) + + * `XCD` (value: `"XCD"`) + + * `XDR` (value: `"XDR"`) + + * `XOF` (value: `"XOF"`) + + * `XPF` (value: `"XPF"`) + + * `YER` (value: `"YER"`) + + * `ZAR` (value: `"ZAR"`) + + * `ZMW` (value: `"ZMW"`) + + * `ZWD` (value: `"ZWD"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/DateRangeFilter.md b/docs/balance_and_transaction/DateRangeFilter.md new file mode 100644 index 00000000..754703a8 --- /dev/null +++ b/docs/balance_and_transaction/DateRangeFilter.md @@ -0,0 +1,14 @@ +# DateRangeFilter +> xendit.balance_and_transaction.model.DateRangeFilter + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **gte** | **datetime** | | Start time of transaction. If not specified will list all dates. | | +| **lte** | **datetime** | | End time of transaction. If not specified will list all dates. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/FeeResponse.md b/docs/balance_and_transaction/FeeResponse.md new file mode 100644 index 00000000..ab368cd5 --- /dev/null +++ b/docs/balance_and_transaction/FeeResponse.md @@ -0,0 +1,17 @@ +# FeeResponse +> xendit.balance_and_transaction.model.FeeResponse + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **xendit_fee** | **float** | ☑️ | Amount of the Xendit fee for this transaction. | | | +| **value_added_tax** | **float** | ☑️ | Amount of the VAT for this transaction. | | | +| **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. | | +| **third_party_withholding_tax** | **float** | | Amount of the 3rd Party Withholding Tax for this transaction if applicable. 3rd party example: Bank | | +| **status** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/LinkItem.md b/docs/balance_and_transaction/LinkItem.md new file mode 100644 index 00000000..a0af3a14 --- /dev/null +++ b/docs/balance_and_transaction/LinkItem.md @@ -0,0 +1,15 @@ +# LinkItem +> xendit.balance_and_transaction.model.LinkItem + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **href** | **str** | ☑️ | URI of target, this will be to the next link. | | | +| **rel** | **str** | ☑️ | The relationship between source and target. The value will be `next`. | | | +| **method** | **str** | ☑️ | The HTTP method, the value will be `GET`. | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/ServerError.md b/docs/balance_and_transaction/ServerError.md new file mode 100644 index 00000000..3ac78936 --- /dev/null +++ b/docs/balance_and_transaction/ServerError.md @@ -0,0 +1,15 @@ +# ServerError +> xendit.balance_and_transaction.model.ServerError + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **status_code** | **float** | ☑️ | | | | +| **error** | **str** | ☑️ | | | | +| **message** | **str** | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/TransactionId.md b/docs/balance_and_transaction/TransactionId.md new file mode 100644 index 00000000..18205d9b --- /dev/null +++ b/docs/balance_and_transaction/TransactionId.md @@ -0,0 +1,14 @@ +# TransactionId +> xendit.balance_and_transaction.model.TransactionId + +The unique id of a transaction. It will have `txn_` as prefix + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **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 | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/TransactionResponse.md b/docs/balance_and_transaction/TransactionResponse.md new file mode 100644 index 00000000..617dd498 --- /dev/null +++ b/docs/balance_and_transaction/TransactionResponse.md @@ -0,0 +1,29 @@ +# TransactionResponse +> xendit.balance_and_transaction.model.TransactionResponse + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **id** | [**TransactionId**](TransactionId.md) | ☑️ | | | | +| **product_id** | **str** | ☑️ | The product_id of the transaction. Product id will have a different prefix for each product. You can use this id to match the transaction from this API to each product API. | | | +| **type** | [**TransactionResponseType**](TransactionResponseType.md) | ☑️ | | | | +| **status** | [**TransactionStatuses**](TransactionStatuses.md) | ☑️ | | | | +| **channel_category** | [**ChannelsCategories**](ChannelsCategories.md) | ☑️ | | | | +| **channel_code** | **str, none_type** | ☑️ | The channel of the transaction that is used. See [channel codes](https://docs.xendit.co/xendisburse/channel-codes) for the list of available per channel categories. | | | +| **account_identifier** | **str, none_type** | ☑️ | Account identifier of transaction. The format will be different from each channel. | | | +| **reference_id** | **str** | ☑️ | customer supplied reference/external_id | | | +| **currency** | [**Currency**](Currency.md) | ☑️ | | | | +| **amount** | **float** | ☑️ | The transaction amount. The number of decimal places will be different for each currency according to ISO 4217. | | | +| **cashflow** | **str** | ☑️ | Representing whether the transaction is money in or money out For transfer, the transfer out side it will shows up as money out and on transfer in side in will shows up as money-in. Available values are `MONEY_IN` for money in and `MONEY_OUT` for money out. | | | +| **business_id** | **str** | ☑️ | The id of business where this transaction belong to | | | +| **fee** | [**FeeResponse**](FeeResponse.md) | ☑️ | | | | +| **created** | **datetime** | ☑️ | Transaction created timestamp (UTC+0) | | | +| **updated** | **datetime** | ☑️ | Transaction updated timestamp (UTC+0) | | | +| **settlement_status** | **str, none_type** | | The settlement status of the transaction. `PENDING` - Transaction amount has not been settled to merchant's balance. `SETTLED` - Transaction has been settled to merchant's balance | | +| **estimated_settlement_time** | **datetime, none_type** | | Estimated settlement time will only apply to money-in transactions. For money-out transaction, the value will be `NULL`. Estimated settlement time in which transaction amount will be settled to merchant's balance. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/TransactionResponseType.md b/docs/balance_and_transaction/TransactionResponseType.md new file mode 100644 index 00000000..859aa4e5 --- /dev/null +++ b/docs/balance_and_transaction/TransactionResponseType.md @@ -0,0 +1,13 @@ +# TransactionResponseType +> xendit.balance_and_transaction.model.TransactionResponseType + +The type of the transactions. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| + + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/TransactionStatuses.md b/docs/balance_and_transaction/TransactionStatuses.md new file mode 100644 index 00000000..10de7202 --- /dev/null +++ b/docs/balance_and_transaction/TransactionStatuses.md @@ -0,0 +1,25 @@ +# TransactionStatuses +> xendit.balance_and_transaction.model.TransactionStatuses + + + +## Enum + + + * `SUCCESS` (value: `"SUCCESS"`) + + * `PENDING` (value: `"PENDING"`) + + * `FAILED` (value: `"FAILED"`) + + * `REVERSED` (value: `"REVERSED"`) + + * `VOIDED` (value: `"VOIDED"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/TransactionTypes.md b/docs/balance_and_transaction/TransactionTypes.md new file mode 100644 index 00000000..8df072f5 --- /dev/null +++ b/docs/balance_and_transaction/TransactionTypes.md @@ -0,0 +1,41 @@ +# TransactionTypes +> xendit.balance_and_transaction.model.TransactionTypes + + + +## Enum + + + * `BATCH_DISBURSEMENT` (value: `"BATCH_DISBURSEMENT"`) + + * `DISBURSEMENT` (value: `"DISBURSEMENT"`) + + * `PAYMENT` (value: `"PAYMENT"`) + + * `REMITTANCE` (value: `"REMITTANCE"`) + + * `REMITTANCE_PAYOUT` (value: `"REMITTANCE_PAYOUT"`) + + * `REMITTANCE_COLLECTION` (value: `"REMITTANCE_COLLECTION"`) + + * `TRANSFER` (value: `"TRANSFER"`) + + * `PLATFORM_FEE` (value: `"PLATFORM_FEE"`) + + * `REFUND` (value: `"REFUND"`) + + * `CASHBACK` (value: `"CASHBACK"`) + + * `TOPUP` (value: `"TOPUP"`) + + * `WITHDRAWAL` (value: `"WITHDRAWAL"`) + + * `OTHER` (value: `"OTHER"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/TransactionsResponse.md b/docs/balance_and_transaction/TransactionsResponse.md new file mode 100644 index 00000000..ea336530 --- /dev/null +++ b/docs/balance_and_transaction/TransactionsResponse.md @@ -0,0 +1,16 @@ +# TransactionsResponse +> xendit.balance_and_transaction.model.TransactionsResponse + +Returns an array of Transaction Objects. Returns empty array when there is no result. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **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. | | | +| **data** | [**[TransactionResponse]**](TransactionResponse.md) | ☑️ | | | | +| **links** | [**[LinkItem]**](LinkItem.md) | | The links to the next page based on LinkItem if there is next result. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/balance_and_transaction/ValidationError.md b/docs/balance_and_transaction/ValidationError.md new file mode 100644 index 00000000..ad40912a --- /dev/null +++ b/docs/balance_and_transaction/ValidationError.md @@ -0,0 +1,16 @@ +# ValidationError +> xendit.balance_and_transaction.model.ValidationError + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **status_code** | **float** | ☑️ | | | | +| **error** | **str** | ☑️ | | | | +| **message** | **str** | ☑️ | | | | +| **validation** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/AccountBank.md b/docs/customer/AccountBank.md new file mode 100644 index 00000000..769bb5b7 --- /dev/null +++ b/docs/customer/AccountBank.md @@ -0,0 +1,18 @@ +# AccountBank +> xendit.customer.model.AccountBank + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **account_number** | **str** | | Unique account identifier as per the bank records. | | +| **account_holder_name** | **str, none_type** | | Name of account holder as per the bank records. Needs to match the registered account name exactly. . | | +| **swift_code** | **str, none_type** | | The SWIFT code for international payments | | +| **account_type** | **str, none_type** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | | +| **account_details** | **str, none_type** | | Potentially masked account detail, for display purposes only. | | +| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/AccountCard.md b/docs/customer/AccountCard.md new file mode 100644 index 00000000..85b9e06b --- /dev/null +++ b/docs/customer/AccountCard.md @@ -0,0 +1,13 @@ +# AccountCard +> xendit.customer.model.AccountCard + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **token_id** | **str** | | The token id returned in tokenisation | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/AccountEwallet.md b/docs/customer/AccountEwallet.md new file mode 100644 index 00000000..3b9710a6 --- /dev/null +++ b/docs/customer/AccountEwallet.md @@ -0,0 +1,15 @@ +# AccountEwallet +> xendit.customer.model.AccountEwallet + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **account_number** | **str** | | Unique account identifier as per the bank records. | | +| **account_holder_name** | **str, none_type** | | Name of account holder as per the bank records. Needs to match the registered account name exactly. | | +| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/AccountOTC.md b/docs/customer/AccountOTC.md new file mode 100644 index 00000000..4399184b --- /dev/null +++ b/docs/customer/AccountOTC.md @@ -0,0 +1,14 @@ +# AccountOTC +> xendit.customer.model.AccountOTC + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **payment_code** | **str** | | Complete fixed payment code (including prefix) | | +| **expires_at** | **str, none_type** | | YYYY-MM-DD string with expiry date for the payment code | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/AccountPayLater.md b/docs/customer/AccountPayLater.md new file mode 100644 index 00000000..913ad31f --- /dev/null +++ b/docs/customer/AccountPayLater.md @@ -0,0 +1,15 @@ +# AccountPayLater +> xendit.customer.model.AccountPayLater + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **account_id** | **str** | | Alphanumeric string identifying this account. Usually an email address or phone number. | | +| **account_holder_name** | **str, none_type** | | Name of account holder as per the cardless credit account. | | +| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/AccountQRCode.md b/docs/customer/AccountQRCode.md new file mode 100644 index 00000000..ef95aa2a --- /dev/null +++ b/docs/customer/AccountQRCode.md @@ -0,0 +1,13 @@ +# AccountQRCode +> xendit.customer.model.AccountQRCode + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **qr_string** | **str** | | String representation of the QR Code image | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/Address.md b/docs/customer/Address.md new file mode 100644 index 00000000..712cff63 --- /dev/null +++ b/docs/customer/Address.md @@ -0,0 +1,25 @@ +# Address +> xendit.customer.model.Address + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **category** | **str, none_type** | ☑️ | | | | +| **country** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | +| **province_state** | **str, none_type** | ☑️ | | | | +| **city** | **str, none_type** | ☑️ | | | | +| **postal_code** | **str, none_type** | ☑️ | | | | +| **street_line1** | **str, none_type** | ☑️ | | | | +| **street_line2** | **str, none_type** | ☑️ | | | | +| **is_primary** | **bool, none_type** | ☑️ | | | | +| **id** | **str** | | | | +| **status** | [**AddressStatus**](AddressStatus.md) | | | | +| **meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | +| **created** | **datetime** | | | | +| **updated** | **datetime** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/AddressRequest.md b/docs/customer/AddressRequest.md new file mode 100644 index 00000000..fc6045c5 --- /dev/null +++ b/docs/customer/AddressRequest.md @@ -0,0 +1,22 @@ +# AddressRequest +> xendit.customer.model.AddressRequest + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **category** | **str** | | Home, work or provincial | | +| **country_code** | [**CountryCode**](CountryCode.md) | | | | +| **province_state** | **str** | | | | +| **city** | **str** | | | | +| **suburb** | **str** | | | | +| **postal_code** | **str** | | | | +| **line_1** | **str** | | | | +| **line_2** | **str** | | | | +| **status** | [**AddressStatus**](AddressStatus.md) | | | | +| **is_primary** | **bool** | | | False | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/AddressStatus.md b/docs/customer/AddressStatus.md new file mode 100644 index 00000000..bcf467c5 --- /dev/null +++ b/docs/customer/AddressStatus.md @@ -0,0 +1,19 @@ +# AddressStatus +> xendit.customer.model.AddressStatus + + + +## Enum + + + * `ACTIVE` (value: `"ACTIVE"`) + + * `DELETED` (value: `"DELETED"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/BusinessDetail.md b/docs/customer/BusinessDetail.md new file mode 100644 index 00000000..ab6bf32e --- /dev/null +++ b/docs/customer/BusinessDetail.md @@ -0,0 +1,17 @@ +# BusinessDetail +> xendit.customer.model.BusinessDetail + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **business_name** | **str** | | | | +| **business_type** | **str, none_type** | | | | +| **date_of_registration** | **str, none_type** | | | | +| **nature_of_business** | **str, none_type** | | | | +| **business_domicile** | [**CountryCode**](CountryCode.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/CountryCode.md b/docs/customer/CountryCode.md new file mode 100644 index 00000000..c5635d68 --- /dev/null +++ b/docs/customer/CountryCode.md @@ -0,0 +1,14 @@ +# CountryCode +> xendit.customer.model.CountryCode + +ISO3166-2 country code + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **value** | **str** | ISO3166-2 country code | ☑️ | ISO3166-2 country code | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/CreateCustomer400Response.md b/docs/customer/CreateCustomer400Response.md new file mode 100644 index 00000000..ab837f7d --- /dev/null +++ b/docs/customer/CreateCustomer400Response.md @@ -0,0 +1,15 @@ +# CreateCustomer400Response +> xendit.customer.model.CreateCustomer400Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | ☑️ | | | | +| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | +| **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/CreateCustomer400ResponseAllOf.md b/docs/customer/CreateCustomer400ResponseAllOf.md new file mode 100644 index 00000000..b3b72a69 --- /dev/null +++ b/docs/customer/CreateCustomer400ResponseAllOf.md @@ -0,0 +1,14 @@ +# CreateCustomer400ResponseAllOf +> xendit.customer.model.CreateCustomer400ResponseAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/Customer.md b/docs/customer/Customer.md new file mode 100644 index 00000000..37a3d1d3 --- /dev/null +++ b/docs/customer/Customer.md @@ -0,0 +1,28 @@ +# Customer +> xendit.customer.model.Customer + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **reference_id** | **str** | ☑️ | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | | +| **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | ☑️ | | | | +| **business_detail** | [**BusinessDetail**](BusinessDetail.md) | ☑️ | | | | +| **description** | **str, none_type** | ☑️ | | | | +| **email** | **str, none_type** | ☑️ | | | | +| **mobile_number** | **str, none_type** | ☑️ | | | | +| **phone_number** | **str, none_type** | ☑️ | | | | +| **addresses** | [**[Address], none_type**](Address.md) | ☑️ | | | | +| **identity_accounts** | [**[IdentityAccountResponse], none_type**](IdentityAccountResponse.md) | ☑️ | | | | +| **kyc_documents** | [**[KYCDocumentResponse], none_type**](KYCDocumentResponse.md) | ☑️ | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | ☑️ | | | | +| **id** | **str** | ☑️ | | | | +| **created** | **datetime** | ☑️ | | | | +| **updated** | **datetime** | ☑️ | | | | +| **type** | **str** | ☑️ | | | "INDIVIDUAL" | +| **status** | [**EndCustomerStatus**](EndCustomerStatus.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/CustomerRequest.md b/docs/customer/CustomerRequest.md new file mode 100644 index 00000000..db272b8e --- /dev/null +++ b/docs/customer/CustomerRequest.md @@ -0,0 +1,25 @@ +# CustomerRequest +> xendit.customer.model.CustomerRequest + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **reference_id** | **str** | ☑️ | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | | +| **client_name** | **str** | | Entity's name for this client | | +| **type** | **str** | | | "INDIVIDUAL" | +| **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | | | | +| **business_detail** | [**BusinessDetail**](BusinessDetail.md) | | | | +| **description** | **str, none_type** | | | | +| **email** | **str** | | | | +| **mobile_number** | **str** | | | | +| **phone_number** | **str** | | | | +| **addresses** | [**[AddressRequest]**](AddressRequest.md) | | | | +| **identity_accounts** | [**[IdentityAccountRequest]**](IdentityAccountRequest.md) | | | | +| **kyc_documents** | [**[KYCDocumentRequest]**](KYCDocumentRequest.md) | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/EmploymentDetail.md b/docs/customer/EmploymentDetail.md new file mode 100644 index 00000000..7edb71fa --- /dev/null +++ b/docs/customer/EmploymentDetail.md @@ -0,0 +1,15 @@ +# EmploymentDetail +> xendit.customer.model.EmploymentDetail + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **employer_name** | **str, none_type** | | Name of employer | | +| **nature_of_business** | **str, none_type** | | Industry or nature of business | | +| **role_description** | **str, none_type** | | Occupation or title | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/EndCustomerStatus.md b/docs/customer/EndCustomerStatus.md new file mode 100644 index 00000000..301406b2 --- /dev/null +++ b/docs/customer/EndCustomerStatus.md @@ -0,0 +1,25 @@ +# EndCustomerStatus +> xendit.customer.model.EndCustomerStatus + + + +## Enum + + + * `ACTIVE` (value: `"ACTIVE"`) + + * `INACTIVE` (value: `"INACTIVE"`) + + * `PENDING` (value: `"PENDING"`) + + * `BLOCKED` (value: `"BLOCKED"`) + + * `DELETED` (value: `"DELETED"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/Error.md b/docs/customer/Error.md new file mode 100644 index 00000000..795e7531 --- /dev/null +++ b/docs/customer/Error.md @@ -0,0 +1,15 @@ +# Error +> xendit.customer.model.Error + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | ☑️ | | | | +| **message** | **str** | ☑️ | | | | +| **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/GetCustomerByReferenceID200Response.md b/docs/customer/GetCustomerByReferenceID200Response.md new file mode 100644 index 00000000..fad68475 --- /dev/null +++ b/docs/customer/GetCustomerByReferenceID200Response.md @@ -0,0 +1,14 @@ +# GetCustomerByReferenceID200Response +> xendit.customer.model.GetCustomerByReferenceID200Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **has_more** | **bool** | | | | +| **data** | [**[Customer]**](Customer.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/GetCustomerByReferenceID400Response.md b/docs/customer/GetCustomerByReferenceID400Response.md new file mode 100644 index 00000000..4fe417b9 --- /dev/null +++ b/docs/customer/GetCustomerByReferenceID400Response.md @@ -0,0 +1,15 @@ +# GetCustomerByReferenceID400Response +> xendit.customer.model.GetCustomerByReferenceID400Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | ☑️ | | | | +| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | +| **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/GetCustomerByReferenceID400ResponseAllOf.md b/docs/customer/GetCustomerByReferenceID400ResponseAllOf.md new file mode 100644 index 00000000..714f7c83 --- /dev/null +++ b/docs/customer/GetCustomerByReferenceID400ResponseAllOf.md @@ -0,0 +1,14 @@ +# GetCustomerByReferenceID400ResponseAllOf +> xendit.customer.model.GetCustomerByReferenceID400ResponseAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/IdentityAccountRequest.md b/docs/customer/IdentityAccountRequest.md new file mode 100644 index 00000000..54e61efe --- /dev/null +++ b/docs/customer/IdentityAccountRequest.md @@ -0,0 +1,17 @@ +# IdentityAccountRequest +> xendit.customer.model.IdentityAccountRequest + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **type** | [**IdentityAccountType**](IdentityAccountType.md) | | | | +| **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 | | +| **description** | **str** | | Free text description of this account | | +| **country** | [**CountryCode**](CountryCode.md) | | | | +| **properties** | [**IdentityAccountRequestProperties**](IdentityAccountRequestProperties.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/IdentityAccountRequestProperties.md b/docs/customer/IdentityAccountRequestProperties.md new file mode 100644 index 00000000..490b5169 --- /dev/null +++ b/docs/customer/IdentityAccountRequestProperties.md @@ -0,0 +1,23 @@ +# IdentityAccountRequestProperties +> xendit.customer.model.IdentityAccountRequestProperties + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **account_number** | **str** | | Unique account identifier as per the bank records. | | +| **account_holder_name** | **str, none_type** | | Name of account holder as per the cardless credit account. | | +| **swift_code** | **str, none_type** | | The SWIFT code for international payments | | +| **account_type** | **str, none_type** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | | +| **account_details** | **str, none_type** | | Potentially masked account detail, for display purposes only. | | +| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | +| **token_id** | **str** | | The token id returned in tokenisation | | +| **account_id** | **str** | | Alphanumeric string identifying this account. Usually an email address or phone number. | | +| **payment_code** | **str** | | Complete fixed payment code (including prefix) | | +| **expires_at** | **str, none_type** | | YYYY-MM-DD string with expiry date for the payment code | | +| **qr_string** | **str** | | String representation of the QR Code image | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/IdentityAccountResponse.md b/docs/customer/IdentityAccountResponse.md new file mode 100644 index 00000000..6b94f5ca --- /dev/null +++ b/docs/customer/IdentityAccountResponse.md @@ -0,0 +1,21 @@ +# IdentityAccountResponse +> xendit.customer.model.IdentityAccountResponse + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **company** | **str, none_type** | ☑️ | | | | +| **description** | **str, none_type** | ☑️ | | | | +| **country** | [**CountryCode**](CountryCode.md) | ☑️ | | | | +| **type** | **str, none_type** | ☑️ | | | | +| **properties** | [**IdentityAccountResponseProperties**](IdentityAccountResponseProperties.md) | ☑️ | | | | +| **id** | **str** | | | | +| **code** | **str, none_type** | | | | +| **holder_name** | **str, none_type** | | | | +| **created** | **datetime** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/IdentityAccountResponseProperties.md b/docs/customer/IdentityAccountResponseProperties.md new file mode 100644 index 00000000..c3399f03 --- /dev/null +++ b/docs/customer/IdentityAccountResponseProperties.md @@ -0,0 +1,23 @@ +# IdentityAccountResponseProperties +> xendit.customer.model.IdentityAccountResponseProperties + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **account_number** | **str** | | Unique account identifier as per the bank records. | | +| **account_holder_name** | **str, none_type** | | Name of account holder as per the cardless credit account. | | +| **swift_code** | **str, none_type** | | The SWIFT code for international payments | | +| **account_type** | **str, none_type** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | | +| **account_details** | **str, none_type** | | Potentially masked account detail, for display purposes only. | | +| **currency** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | +| **token_id** | **str** | | The token id returned in tokenisation | | +| **payment_code** | **str** | | Complete fixed payment code (including prefix) | | +| **expires_at** | **str, none_type** | | YYYY-MM-DD string with expiry date for the payment code | | +| **qr_string** | **str** | | String representation of the QR Code image | | +| **account_id** | **str** | | Alphanumeric string identifying this account. Usually an email address or phone number. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/IdentityAccountType.md b/docs/customer/IdentityAccountType.md new file mode 100644 index 00000000..82145b93 --- /dev/null +++ b/docs/customer/IdentityAccountType.md @@ -0,0 +1,27 @@ +# IdentityAccountType +> xendit.customer.model.IdentityAccountType + + + +## Enum + + + * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `CREDIT_CARD` (value: `"CREDIT_CARD"`) + + * `PAY_LATER` (value: `"PAY_LATER"`) + + * `OTC` (value: `"OTC"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/IndividualDetail.md b/docs/customer/IndividualDetail.md new file mode 100644 index 00000000..acc17634 --- /dev/null +++ b/docs/customer/IndividualDetail.md @@ -0,0 +1,23 @@ +# IndividualDetail +> xendit.customer.model.IndividualDetail + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **given_names** | **str** | | | | +| **given_names_non_roman** | **str, none_type** | | | | +| **middle_name** | **str, none_type** | | | | +| **surname** | **str, none_type** | | | | +| **surname_non_roman** | **str, none_type** | | | | +| **mother_maiden_name** | **str, none_type** | | | | +| **gender** | **str, none_type** | | | | +| **date_of_birth** | **str, none_type** | | | | +| **nationality** | [**CountryCode**](CountryCode.md) | | | | +| **place_of_birth** | **str, none_type** | | | | +| **employment** | [**EmploymentDetail**](EmploymentDetail.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/KYCDocumentRequest.md b/docs/customer/KYCDocumentRequest.md new file mode 100644 index 00000000..905fdd41 --- /dev/null +++ b/docs/customer/KYCDocumentRequest.md @@ -0,0 +1,20 @@ +# KYCDocumentRequest +> xendit.customer.model.KYCDocumentRequest + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **country** | [**CountryCode**](CountryCode.md) | | | | +| **type** | [**KYCDocumentType**](KYCDocumentType.md) | | | | +| **sub_type** | [**KYCDocumentSubType**](KYCDocumentSubType.md) | | | | +| **document_name** | **str** | | | | +| **document_number** | **str** | | | | +| **expires_at** | **str** | | | | +| **holder_name** | **str** | | | | +| **document_images** | **[str]** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/KYCDocumentResponse.md b/docs/customer/KYCDocumentResponse.md new file mode 100644 index 00000000..28a9b57a --- /dev/null +++ b/docs/customer/KYCDocumentResponse.md @@ -0,0 +1,20 @@ +# KYCDocumentResponse +> xendit.customer.model.KYCDocumentResponse + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **country** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | +| **type** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | +| **sub_type** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | +| **document_name** | **str, none_type** | ☑️ | | | | +| **document_number** | **str, none_type** | ☑️ | | | | +| **expires_at** | **str, none_type** | ☑️ | | | | +| **holder_name** | **str, none_type** | ☑️ | | | | +| **document_images** | **[str], none_type** | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/KYCDocumentSubType.md b/docs/customer/KYCDocumentSubType.md new file mode 100644 index 00000000..4200358a --- /dev/null +++ b/docs/customer/KYCDocumentSubType.md @@ -0,0 +1,35 @@ +# KYCDocumentSubType +> xendit.customer.model.KYCDocumentSubType + + + +## Enum + + + * `NATIONAL_ID` (value: `"NATIONAL_ID"`) + + * `CONSULAR_ID` (value: `"CONSULAR_ID"`) + + * `VOTER_ID` (value: `"VOTER_ID"`) + + * `POSTAL_ID` (value: `"POSTAL_ID"`) + + * `RESIDENCE_PERMIT` (value: `"RESIDENCE_PERMIT"`) + + * `TAX_ID` (value: `"TAX_ID"`) + + * `STUDENT_ID` (value: `"STUDENT_ID"`) + + * `MILITARY_ID` (value: `"MILITARY_ID"`) + + * `MEDICAL_ID` (value: `"MEDICAL_ID"`) + + * `OTHERS` (value: `"OTHERS"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/KYCDocumentType.md b/docs/customer/KYCDocumentType.md new file mode 100644 index 00000000..b3d9d004 --- /dev/null +++ b/docs/customer/KYCDocumentType.md @@ -0,0 +1,31 @@ +# KYCDocumentType +> xendit.customer.model.KYCDocumentType + + + +## Enum + + + * `BIRTH_CERTIFICATE` (value: `"BIRTH_CERTIFICATE"`) + + * `BANK_STATEMENT` (value: `"BANK_STATEMENT"`) + + * `DRIVING_LICENSE` (value: `"DRIVING_LICENSE"`) + + * `IDENTITY_CARD` (value: `"IDENTITY_CARD"`) + + * `PASSPORT` (value: `"PASSPORT"`) + + * `VISA` (value: `"VISA"`) + + * `BUSINESS_REGISTRATION` (value: `"BUSINESS_REGISTRATION"`) + + * `BUSINESS_LICENSE` (value: `"BUSINESS_LICENSE"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/PatchCustomer.md b/docs/customer/PatchCustomer.md new file mode 100644 index 00000000..79cc16a3 --- /dev/null +++ b/docs/customer/PatchCustomer.md @@ -0,0 +1,25 @@ +# PatchCustomer +> xendit.customer.model.PatchCustomer + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **client_name** | **str, none_type** | | Entity's name for this client | | +| **reference_id** | **str, none_type** | | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | +| **individual_detail** | [**IndividualDetail**](IndividualDetail.md) | | | | +| **business_detail** | [**BusinessDetail**](BusinessDetail.md) | | | | +| **description** | **str, none_type** | | | | +| **email** | **str, none_type** | | | | +| **mobile_number** | **str, none_type** | | | | +| **phone_number** | **str, none_type** | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | +| **addresses** | [**[AddressRequest], none_type**](AddressRequest.md) | | | | +| **identity_accounts** | [**[IdentityAccountRequest], none_type**](IdentityAccountRequest.md) | | | | +| **kyc_documents** | [**[KYCDocumentRequest], none_type**](KYCDocumentRequest.md) | | | | +| **status** | [**EndCustomerStatus**](EndCustomerStatus.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/ResponseDataNotFound.md b/docs/customer/ResponseDataNotFound.md new file mode 100644 index 00000000..0c3bac18 --- /dev/null +++ b/docs/customer/ResponseDataNotFound.md @@ -0,0 +1,14 @@ +# ResponseDataNotFound +> xendit.customer.model.ResponseDataNotFound + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/UpdateCustomer400Response.md b/docs/customer/UpdateCustomer400Response.md new file mode 100644 index 00000000..04bb8570 --- /dev/null +++ b/docs/customer/UpdateCustomer400Response.md @@ -0,0 +1,15 @@ +# UpdateCustomer400Response +> xendit.customer.model.UpdateCustomer400Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | ☑️ | | | | +| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | ☑️ | | | | +| **errors** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/customer/UpdateCustomer400ResponseAllOf.md b/docs/customer/UpdateCustomer400ResponseAllOf.md new file mode 100644 index 00000000..a3ceb2e2 --- /dev/null +++ b/docs/customer/UpdateCustomer400ResponseAllOf.md @@ -0,0 +1,14 @@ +# UpdateCustomer400ResponseAllOf +> xendit.customer.model.UpdateCustomer400ResponseAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **bool, date, datetime, dict, float, int, list, str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/AddressObject.md b/docs/invoice/AddressObject.md new file mode 100644 index 00000000..fef36ab0 --- /dev/null +++ b/docs/invoice/AddressObject.md @@ -0,0 +1,20 @@ +# AddressObject +> xendit.invoice.model.AddressObject + +An object representing an address with various properties. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **country** | **str, none_type** | | The country where the address is located. | | +| **street_line1** | **str, none_type** | | The first line of the street address. | | +| **street_line2** | **str, none_type** | | The second line of the street address. | | +| **city** | **str, none_type** | | The city or locality within the address. | | +| **province** | **str, none_type** | | The province or region within the country. | | +| **state** | **str, none_type** | | The state or administrative division within the country. | | +| **postal_code** | **str, none_type** | | The postal code or ZIP code for the address. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/AlternativeDisplayItem.md b/docs/invoice/AlternativeDisplayItem.md new file mode 100644 index 00000000..c42f9cf2 --- /dev/null +++ b/docs/invoice/AlternativeDisplayItem.md @@ -0,0 +1,15 @@ +# AlternativeDisplayItem +> xendit.invoice.model.AlternativeDisplayItem + +An object representing alternative display of a VA. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **type** | **str** | | Represent type of alternative display. | | +| **value** | **str** | | Represent value of alternative display value. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/BadRequestError.md b/docs/invoice/BadRequestError.md new file mode 100644 index 00000000..44859899 --- /dev/null +++ b/docs/invoice/BadRequestError.md @@ -0,0 +1,15 @@ +# BadRequestError +> xendit.invoice.model.BadRequestError + +Response definition for a 400 Bad Request error when creating an invoice. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | ☑️ | The error code indicating the type of error that occurred. | | | +| **message** | **str** | ☑️ | A human-readable error message that provides additional information about the error. | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/Bank.md b/docs/invoice/Bank.md new file mode 100644 index 00000000..00fb20f0 --- /dev/null +++ b/docs/invoice/Bank.md @@ -0,0 +1,20 @@ +# Bank +> xendit.invoice.model.Bank + +An object representing bank details for invoices. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **bank_code** | [**BankCode**](BankCode.md) | ☑️ | | | | +| **collection_type** | **str** | ☑️ | The collection type for the bank details. | | | +| **account_holder_name** | **str** | ☑️ | The name of the account holder. | | | +| **bank_branch** | **str** | | The branch of the bank. | | +| **bank_account_number** | **str** | | The bank account number. | | +| **transfer_amount** | **float** | | The transfer amount. | | +| **alternative_displays** | [**[AlternativeDisplayItem]**](AlternativeDisplayItem.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/BankCode.md b/docs/invoice/BankCode.md new file mode 100644 index 00000000..edd4511a --- /dev/null +++ b/docs/invoice/BankCode.md @@ -0,0 +1,36 @@ +# BankCode +> xendit.invoice.model.BankCode + +Representing the available bank channels used for invoice-related transactions. + + +## Enum + + + * `BCA` (value: `"BCA"`) + + * `BNI` (value: `"BNI"`) + + * `BRI` (value: `"BRI"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `PERMATA` (value: `"PERMATA"`) + + * `BSI` (value: `"BSI"`) + + * `BJB` (value: `"BJB"`) + + * `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) + + * `CIMB` (value: `"CIMB"`) + + * `BNC` (value: `"BNC"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/CreateInvoiceRequest.md b/docs/invoice/CreateInvoiceRequest.md new file mode 100644 index 00000000..c79fc2c9 --- /dev/null +++ b/docs/invoice/CreateInvoiceRequest.md @@ -0,0 +1,33 @@ +# CreateInvoiceRequest +> xendit.invoice.model.CreateInvoiceRequest + +An object representing for an invoice creation request. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **external_id** | **str** | ☑️ | The external ID of the invoice. | | | +| **amount** | **float** | ☑️ | The invoice amount. | | | +| **payer_email** | **str** | | The email address of the payer. | | +| **description** | **str** | | A description of the payment. | | +| **invoice_duration** | **str** | | The duration of the invoice. | | +| **callback_virtual_account_id** | **str** | | The ID of the callback virtual account. | | +| **should_send_email** | **bool** | | Indicates whether email notifications should be sent. | | +| **customer** | [**CustomerObject**](CustomerObject.md) | | | | +| **customer_notification_preference** | [**NotificationPreference**](NotificationPreference.md) | | | | +| **success_redirect_url** | **str** | | The URL to redirect to on successful payment. | | +| **failure_redirect_url** | **str** | | The URL to redirect to on payment failure. | | +| **payment_methods** | **[str]** | | An array of available payment methods. | | +| **mid_label** | **str** | | The middle label. | | +| **should_authenticate_credit_card** | **bool** | | Indicates whether credit card authentication is required. | | +| **currency** | **str** | | The currency of the invoice. | | +| **reminder_time** | **float** | | The reminder time. | | +| **local** | **str** | | The local. | | +| **reminder_time_unit** | **str** | | The unit of the reminder time. | | +| **items** | [**[InvoiceItem]**](InvoiceItem.md) | | An array of items included in the invoice. | | +| **fees** | [**[InvoiceFee]**](InvoiceFee.md) | | An array of fees associated with the invoice. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/CustomerObject.md b/docs/invoice/CustomerObject.md new file mode 100644 index 00000000..4a1f70c3 --- /dev/null +++ b/docs/invoice/CustomerObject.md @@ -0,0 +1,21 @@ +# CustomerObject +> xendit.invoice.model.CustomerObject + +An object representing a customer with various properties, including addresses. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **id** | **str, none_type** | | The unique identifier for the customer. | | +| **phone_number** | **str, none_type** | | The customer's phone number. | | +| **given_names** | **str, none_type** | | The customer's given names or first names. | | +| **surname** | **str, none_type** | | The customer's surname or last name. | | +| **email** | **str, none_type** | | The customer's email address. | | +| **mobile_number** | **str, none_type** | | The customer's mobile phone number. | | +| **customer_id** | **str, none_type** | | An additional identifier for the customer. | | +| **addresses** | [**[AddressObject], none_type**](AddressObject.md) | | An array of addresses associated with the customer. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/DirectDebit.md b/docs/invoice/DirectDebit.md new file mode 100644 index 00000000..28cc802e --- /dev/null +++ b/docs/invoice/DirectDebit.md @@ -0,0 +1,14 @@ +# DirectDebit +> xendit.invoice.model.DirectDebit + +An object representing direct debit details for invoices. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **direct_debit_type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/DirectDebitType.md b/docs/invoice/DirectDebitType.md new file mode 100644 index 00000000..cdc45dc3 --- /dev/null +++ b/docs/invoice/DirectDebitType.md @@ -0,0 +1,54 @@ +# DirectDebitType +> xendit.invoice.model.DirectDebitType + +Representing the available Direct Debit channels used for invoice-related transactions. + + +## Enum + + + * `BA_BRI` (value: `"BA_BRI"`) + + * `DC_BRI` (value: `"DC_BRI"`) + + * `DD_BRI` (value: `"DD_BRI"`) + + * `DD_MANDIRI` (value: `"DD_MANDIRI"`) + + * `BA_BPI` (value: `"BA_BPI"`) + + * `DC_BPI` (value: `"DC_BPI"`) + + * `DD_BPI` (value: `"DD_BPI"`) + + * `BA_UBP` (value: `"BA_UBP"`) + + * `DC_UBP` (value: `"DC_UBP"`) + + * `DD_UBP` (value: `"DD_UBP"`) + + * `BCA_KLIKPAY` (value: `"BCA_KLIKPAY"`) + + * `BA_BCA_KLIKPAY` (value: `"BA_BCA_KLIKPAY"`) + + * `DC_BCA_KLIKPAY` (value: `"DC_BCA_KLIKPAY"`) + + * `DD_BCA_KLIKPAY` (value: `"DD_BCA_KLIKPAY"`) + + * `DD_BDO_EPAY` (value: `"DD_BDO_EPAY"`) + + * `DD_RCBC` (value: `"DD_RCBC"`) + + * `DD_CHINABANK` (value: `"DD_CHINABANK"`) + + * `BA_CHINABANK` (value: `"BA_CHINABANK"`) + + * `DC_CHINABANK` (value: `"DC_CHINABANK"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/Ewallet.md b/docs/invoice/Ewallet.md new file mode 100644 index 00000000..2bfc0a55 --- /dev/null +++ b/docs/invoice/Ewallet.md @@ -0,0 +1,14 @@ +# Ewallet +> xendit.invoice.model.Ewallet + +An object representing e-wallet details for invoices. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ewallet_type** | [**EwalletType**](EwalletType.md) | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/EwalletType.md b/docs/invoice/EwalletType.md new file mode 100644 index 00000000..61911095 --- /dev/null +++ b/docs/invoice/EwalletType.md @@ -0,0 +1,36 @@ +# EwalletType +> xendit.invoice.model.EwalletType + +Representing the available eWallet channels used for invoice-related transactions. + + +## Enum + + + * `OVO` (value: `"OVO"`) + + * `DANA` (value: `"DANA"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `PAYMAYA` (value: `"PAYMAYA"`) + + * `SHOPEEPAY` (value: `"SHOPEEPAY"`) + + * `GCASH` (value: `"GCASH"`) + + * `GRABPAY` (value: `"GRABPAY"`) + + * `ASTRAPAY` (value: `"ASTRAPAY"`) + + * `NEXCASH` (value: `"NEXCASH"`) + + * `JENIUSPAY` (value: `"JENIUSPAY"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/ForbiddenError.md b/docs/invoice/ForbiddenError.md new file mode 100644 index 00000000..66a6f756 --- /dev/null +++ b/docs/invoice/ForbiddenError.md @@ -0,0 +1,15 @@ +# ForbiddenError +> xendit.invoice.model.ForbiddenError + +An error object used to indicate a 403 Forbidden response related to invoice operations. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **message** | **str** | ☑️ | A human-readable error message providing additional context about the 403 Forbidden response. | | | +| **error_code** | **str** | ☑️ | The specific error code indicating that access to the invoice operation is suspended. | | "ACCESS_SUSPENDED" | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/Invoice.md b/docs/invoice/Invoice.md new file mode 100644 index 00000000..570e6a5c --- /dev/null +++ b/docs/invoice/Invoice.md @@ -0,0 +1,46 @@ +# Invoice +> xendit.invoice.model.Invoice + +An object representing details for an invoice. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **external_id** | **str** | ☑️ | The external identifier for the invoice. | | | +| **user_id** | **str** | ☑️ | The user ID associated with the invoice. | | | +| **status** | [**InvoiceStatus**](InvoiceStatus.md) | ☑️ | | | | +| **merchant_name** | **str** | ☑️ | The name of the merchant. | | | +| **merchant_profile_picture_url** | **str** | ☑️ | The URL of the merchant's profile picture. | | | +| **amount** | **float** | ☑️ | The total amount of the invoice. | | | +| **expiry_date** | **datetime** | ☑️ | Representing a date and time in ISO 8601 format. | | | +| **invoice_url** | **str** | ☑️ | The URL to view the invoice. | | | +| **available_banks** | [**[Bank]**](Bank.md) | ☑️ | An array of available banks for payment. | | | +| **available_retail_outlets** | [**[RetailOutlet]**](RetailOutlet.md) | ☑️ | An array of available retail outlets for payment. | | | +| **available_ewallets** | [**[Ewallet]**](Ewallet.md) | ☑️ | An array of available e-wallets for payment. | | | +| **available_qr_codes** | [**[QrCode]**](QrCode.md) | ☑️ | An array of available QR codes for payment. | | | +| **available_direct_debits** | [**[DirectDebit]**](DirectDebit.md) | ☑️ | An array of available direct debit options for payment. | | | +| **available_paylaters** | [**[Paylater]**](Paylater.md) | ☑️ | An array of available pay-later options for payment. | | | +| **should_send_email** | **bool** | ☑️ | Indicates whether email notifications should be sent. | | | +| **created** | **datetime** | ☑️ | Representing a date and time in ISO 8601 format. | | | +| **updated** | **datetime** | ☑️ | Representing a date and time in ISO 8601 format. | | | +| **id** | **str** | | The unique identifier for the invoice. | | +| **payer_email** | **str** | | The email address of the payer. | | +| **description** | **str** | | A description of the invoice. | | +| **payment_method** | [**InvoicePaymentMethod**](InvoicePaymentMethod.md) | | | | +| **locale** | **str** | | The locale or language used for the invoice. | | +| **should_exclude_credit_card** | **bool** | | Indicates whether credit card payments should be excluded. | | +| **success_redirect_url** | **str** | | The URL to redirect to on successful payment. | | +| **failure_redirect_url** | **str** | | The URL to redirect to on payment failure. | | +| **should_authenticate_credit_card** | **bool** | | Indicates whether credit card authentication is required. | | +| **currency** | [**InvoiceCurrency**](InvoiceCurrency.md) | | | | +| **items** | [**[InvoiceItem]**](InvoiceItem.md) | | An array of items included in the invoice. | | +| **fixed_va** | **bool** | | Indicates whether the virtual account is fixed. | | +| **reminder_date** | **datetime** | | Representing a date and time in ISO 8601 format. | | +| **customer** | [**CustomerObject**](CustomerObject.md) | | | | +| **customer_notification_preference** | [**NotificationPreference**](NotificationPreference.md) | | | | +| **fees** | [**[InvoiceFee]**](InvoiceFee.md) | | An array of fees associated with the invoice. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/InvoiceClientType.md b/docs/invoice/InvoiceClientType.md new file mode 100644 index 00000000..247acfcb --- /dev/null +++ b/docs/invoice/InvoiceClientType.md @@ -0,0 +1,28 @@ +# InvoiceClientType +> xendit.invoice.model.InvoiceClientType + +Representing the client type or source of an invoice. + + +## Enum + + + * `DASHBOARD` (value: `"DASHBOARD"`) + + * `API_GATEWAY` (value: `"API_GATEWAY"`) + + * `INTEGRATION` (value: `"INTEGRATION"`) + + * `ON_DEMAND` (value: `"ON_DEMAND"`) + + * `RECURRING` (value: `"RECURRING"`) + + * `MOBILE` (value: `"MOBILE"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/InvoiceCurrency.md b/docs/invoice/InvoiceCurrency.md new file mode 100644 index 00000000..1830dd68 --- /dev/null +++ b/docs/invoice/InvoiceCurrency.md @@ -0,0 +1,26 @@ +# InvoiceCurrency +> xendit.invoice.model.InvoiceCurrency + +Representing the currency used for an invoice. + + +## Enum + + + * `IDR` (value: `"IDR"`) + + * `USD` (value: `"USD"`) + + * `THB` (value: `"THB"`) + + * `VND` (value: `"VND"`) + + * `PHP` (value: `"PHP"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/InvoiceError404ResponseDefinition.md b/docs/invoice/InvoiceError404ResponseDefinition.md new file mode 100644 index 00000000..f2187d41 --- /dev/null +++ b/docs/invoice/InvoiceError404ResponseDefinition.md @@ -0,0 +1,15 @@ +# InvoiceError404ResponseDefinition +> xendit.invoice.model.InvoiceError404ResponseDefinition + +An error object used to indicate that the requested resource, in this case, an invoice, was not found. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **message** | **str** | ☑️ | A human-readable error message providing additional context about the resource not being found. | | | +| **error_code** | **str** | ☑️ | The specific error code indicating that the requested invoice was not found. | | "INVOICE_NOT_FOUND_ERROR" | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/InvoiceFee.md b/docs/invoice/InvoiceFee.md new file mode 100644 index 00000000..4a859b16 --- /dev/null +++ b/docs/invoice/InvoiceFee.md @@ -0,0 +1,15 @@ +# InvoiceFee +> xendit.invoice.model.InvoiceFee + +An object representing internal details for a fee associated with an invoice. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **type** | **str** | ☑️ | The type of fee. | | | +| **value** | **float** | ☑️ | The value or amount of the fee. | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/InvoiceItem.md b/docs/invoice/InvoiceItem.md new file mode 100644 index 00000000..0734b816 --- /dev/null +++ b/docs/invoice/InvoiceItem.md @@ -0,0 +1,19 @@ +# InvoiceItem +> xendit.invoice.model.InvoiceItem + +An object representing an item within an invoice. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **name** | **str** | ☑️ | The name of the item. | | | +| **price** | **float** | ☑️ | The price of the item. | | | +| **quantity** | **float** | ☑️ | The quantity of the item. Must be greater than or equal to 0. | | | +| **reference_id** | **str** | | The reference ID of the item. | | +| **url** | **str** | | The URL associated with the item. | | +| **category** | **str** | | The category of the item. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/InvoiceNotFoundError.md b/docs/invoice/InvoiceNotFoundError.md new file mode 100644 index 00000000..a3b3db8e --- /dev/null +++ b/docs/invoice/InvoiceNotFoundError.md @@ -0,0 +1,15 @@ +# InvoiceNotFoundError +> xendit.invoice.model.InvoiceNotFoundError + +Response definition for a 404 Not Found error when creating an invoice. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | ☑️ | The error code indicating the type of error that occurred. | | | +| **message** | **str** | ☑️ | A human-readable error message that provides additional information about the error. | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/InvoicePaymentMethod.md b/docs/invoice/InvoicePaymentMethod.md new file mode 100644 index 00000000..9b185e5a --- /dev/null +++ b/docs/invoice/InvoicePaymentMethod.md @@ -0,0 +1,36 @@ +# InvoicePaymentMethod +> xendit.invoice.model.InvoicePaymentMethod + +Representing the payment method used for an invoice. + + +## Enum + + + * `POOL` (value: `"POOL"`) + + * `CALLBACK_VIRTUAL_ACCOUNT` (value: `"CALLBACK_VIRTUAL_ACCOUNT"`) + + * `CREDIT_CARD` (value: `"CREDIT_CARD"`) + + * `RETAIL_OUTLET` (value: `"RETAIL_OUTLET"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `QRIS` (value: `"QRIS"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) + + * `BANK_TRANSFER` (value: `"BANK_TRANSFER"`) + + * `PAYLATER` (value: `"PAYLATER"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/InvoiceStatus.md b/docs/invoice/InvoiceStatus.md new file mode 100644 index 00000000..9dcb0c00 --- /dev/null +++ b/docs/invoice/InvoiceStatus.md @@ -0,0 +1,24 @@ +# InvoiceStatus +> xendit.invoice.model.InvoiceStatus + +Representing the status of an invoice. + + +## Enum + + + * `PENDING` (value: `"PENDING"`) + + * `PAID` (value: `"PAID"`) + + * `SETTLED` (value: `"SETTLED"`) + + * `EXPIRED` (value: `"EXPIRED"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/NotificationChannel.md b/docs/invoice/NotificationChannel.md new file mode 100644 index 00000000..4436cd3d --- /dev/null +++ b/docs/invoice/NotificationChannel.md @@ -0,0 +1,24 @@ +# NotificationChannel +> xendit.invoice.model.NotificationChannel + +Representing a notification channel for sending messages. + + +## Enum + + + * `EMAIL` (value: `"email"`) + + * `SMS` (value: `"sms"`) + + * `WHATSAPP` (value: `"whatsapp"`) + + * `VIBER` (value: `"viber"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/NotificationPreference.md b/docs/invoice/NotificationPreference.md new file mode 100644 index 00000000..5a2b3247 --- /dev/null +++ b/docs/invoice/NotificationPreference.md @@ -0,0 +1,17 @@ +# NotificationPreference +> xendit.invoice.model.NotificationPreference + +An object representing notification preferences for different invoice events. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **invoice_created** | [**[NotificationChannel]**](NotificationChannel.md) | | Notification channels for when an invoice is created. | | +| **invoice_reminder** | [**[NotificationChannel]**](NotificationChannel.md) | | Notification channels for invoice reminders. | | +| **invoice_expired** | [**[NotificationChannel]**](NotificationChannel.md) | | Notification channels for expired invoices. | | +| **invoice_paid** | [**[NotificationChannel]**](NotificationChannel.md) | | Notification channels for when an invoice is paid. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/Paylater.md b/docs/invoice/Paylater.md new file mode 100644 index 00000000..36bbf827 --- /dev/null +++ b/docs/invoice/Paylater.md @@ -0,0 +1,15 @@ +# Paylater +> xendit.invoice.model.Paylater + +An object representing paylater details for invoices. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **paylater_type** | [**PaylaterType**](PaylaterType.md) | ☑️ | | | | +| **should_exclude** | **bool** | | Indicates whether this paylater option should be excluded. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/PaylaterType.md b/docs/invoice/PaylaterType.md new file mode 100644 index 00000000..a9189d84 --- /dev/null +++ b/docs/invoice/PaylaterType.md @@ -0,0 +1,28 @@ +# PaylaterType +> xendit.invoice.model.PaylaterType + +Representing the available paylater channels used for invoice-related transactions. + + +## Enum + + + * `KREDIVO` (value: `"KREDIVO"`) + + * `AKULAKU` (value: `"AKULAKU"`) + + * `UANGME` (value: `"UANGME"`) + + * `BILLEASE` (value: `"BILLEASE"`) + + * `CASHALO` (value: `"CASHALO"`) + + * `ATOME` (value: `"ATOME"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/QrCode.md b/docs/invoice/QrCode.md new file mode 100644 index 00000000..dd0a0230 --- /dev/null +++ b/docs/invoice/QrCode.md @@ -0,0 +1,14 @@ +# QrCode +> xendit.invoice.model.QrCode + +An object representing QR code details for invoices. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **qr_code_type** | [**QrCodeType**](QrCodeType.md) | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/QrCodeType.md b/docs/invoice/QrCodeType.md new file mode 100644 index 00000000..e1577774 --- /dev/null +++ b/docs/invoice/QrCodeType.md @@ -0,0 +1,20 @@ +# QrCodeType +> xendit.invoice.model.QrCodeType + +Representing the available QR Code channels used for invoice-related transactions. + + +## Enum + + + * `QRIS` (value: `"QRIS"`) + + * `PROMPTPAY` (value: `"PROMPTPAY"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/RetailOutlet.md b/docs/invoice/RetailOutlet.md new file mode 100644 index 00000000..3001dd75 --- /dev/null +++ b/docs/invoice/RetailOutlet.md @@ -0,0 +1,17 @@ +# RetailOutlet +> xendit.invoice.model.RetailOutlet + +An object representing retail outlet details for invoices. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **retail_outlet_name** | [**RetailOutletName**](RetailOutletName.md) | ☑️ | | | | +| **payment_code** | **str** | | The payment code. | | +| **transfer_amount** | **float** | | The transfer amount. | | +| **merchant_name** | **str** | | The name of the merchant. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/RetailOutletName.md b/docs/invoice/RetailOutletName.md new file mode 100644 index 00000000..acb532a7 --- /dev/null +++ b/docs/invoice/RetailOutletName.md @@ -0,0 +1,34 @@ +# RetailOutletName +> xendit.invoice.model.RetailOutletName + +Representing the available retail outlet channels used for invoice-related transactions. + + +## Enum + + + * `ALFAMART` (value: `"ALFAMART"`) + + * `INDOMARET` (value: `"INDOMARET"`) + + * `7ELEVEN` (value: `"7ELEVEN"`) + + * `CEBUANA` (value: `"CEBUANA"`) + + * `DP_ECPAY_LOAN` (value: `"DP_ECPAY_LOAN"`) + + * `DP_MLHUILLIER` (value: `"DP_MLHUILLIER"`) + + * `DP_PALAWAN` (value: `"DP_PALAWAN"`) + + * `DP_ECPAY_SCHOOL` (value: `"DP_ECPAY_SCHOOL"`) + + * `LBC` (value: `"LBC"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/ServerError.md b/docs/invoice/ServerError.md new file mode 100644 index 00000000..42a17e5e --- /dev/null +++ b/docs/invoice/ServerError.md @@ -0,0 +1,14 @@ +# ServerError +> xendit.invoice.model.ServerError + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **message** | **str** | ☑️ | | | | +| **error_code** | **str** | ☑️ | | | "SERVER_ERROR" | + + +[[Back to README]](../../README.md) + + diff --git a/docs/invoice/UnauthorizedError.md b/docs/invoice/UnauthorizedError.md new file mode 100644 index 00000000..a96dc5d0 --- /dev/null +++ b/docs/invoice/UnauthorizedError.md @@ -0,0 +1,15 @@ +# UnauthorizedError +> xendit.invoice.model.UnauthorizedError + +An error object used to indicate unauthorized access to an invoice-related resource. + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **message** | **str** | ☑️ | A human-readable error message providing additional context about the unauthorized access. | | | +| **error_code** | **str** | ☑️ | The specific error code associated with the unauthorized access. | | "INVALID_API_KEY" | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/BillingInformation.md b/docs/payment_method/BillingInformation.md new file mode 100644 index 00000000..ba774384 --- /dev/null +++ b/docs/payment_method/BillingInformation.md @@ -0,0 +1,19 @@ +# BillingInformation +> xendit.payment_method.model.BillingInformation + +Billing Information + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **country** | **str** | ☑️ | | | | +| **street_line1** | **str, none_type** | | | | +| **street_line2** | **str, none_type** | | | | +| **city** | **str, none_type** | | | | +| **province_state** | **str, none_type** | | | | +| **postal_code** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/Card.md b/docs/payment_method/Card.md new file mode 100644 index 00000000..fef6be29 --- /dev/null +++ b/docs/payment_method/Card.md @@ -0,0 +1,17 @@ +# Card +> xendit.payment_method.model.Card + +Card Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **currency** | **str, none_type** | ☑️ | | | | +| **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | ☑️ | | | | +| **card_information** | [**TokenizedCardInformation**](TokenizedCardInformation.md) | | | | +| **card_verification_results** | [**CardVerificationResults**](CardVerificationResults.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/CardChannelProperties.md b/docs/payment_method/CardChannelProperties.md new file mode 100644 index 00000000..d11b4e93 --- /dev/null +++ b/docs/payment_method/CardChannelProperties.md @@ -0,0 +1,17 @@ +# CardChannelProperties +> xendit.payment_method.model.CardChannelProperties + +Card Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **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. | | +| **success_return_url** | **str, none_type** | | URL where the end-customer is redirected if the authorization is successful | | +| **failure_return_url** | **str, none_type** | | URL where the end-customer is redirected if the authorization failed | | +| **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. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/CardParameters.md b/docs/payment_method/CardParameters.md new file mode 100644 index 00000000..83350fb9 --- /dev/null +++ b/docs/payment_method/CardParameters.md @@ -0,0 +1,15 @@ +# CardParameters +> xendit.payment_method.model.CardParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **currency** | **str** | ☑️ | | | | +| **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | | | | +| **card_information** | [**CardParametersCardInformation**](CardParametersCardInformation.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/CardParametersCardInformation.md b/docs/payment_method/CardParametersCardInformation.md new file mode 100644 index 00000000..cba0c072 --- /dev/null +++ b/docs/payment_method/CardParametersCardInformation.md @@ -0,0 +1,18 @@ +# CardParametersCardInformation +> xendit.payment_method.model.CardParametersCardInformation + +Card Information + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **card_number** | **str** | ☑️ | | | | +| **expiry_month** | **str** | ☑️ | Card expiry month in MM format | | | +| **expiry_year** | **str** | ☑️ | Card expiry month in YY format | | | +| **cardholder_name** | **str, none_type** | | Cardholder name | | +| **cvv** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/CardVerificationResults.md b/docs/payment_method/CardVerificationResults.md new file mode 100644 index 00000000..051c79dd --- /dev/null +++ b/docs/payment_method/CardVerificationResults.md @@ -0,0 +1,15 @@ +# CardVerificationResults +> xendit.payment_method.model.CardVerificationResults + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **three_d_secure** | [**CardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | ☑️ | | | | +| **cvv_result** | **str, none_type** | | | | +| **address_verification_result** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/CardVerificationResultsThreeDSecure.md b/docs/payment_method/CardVerificationResultsThreeDSecure.md new file mode 100644 index 00000000..fb103c60 --- /dev/null +++ b/docs/payment_method/CardVerificationResultsThreeDSecure.md @@ -0,0 +1,17 @@ +# CardVerificationResultsThreeDSecure +> xendit.payment_method.model.CardVerificationResultsThreeDSecure + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **three_d_secure_flow** | **str, none_type** | | | | +| **eci_code** | **str, none_type** | | | | +| **three_d_secure_result** | **str, none_type** | | | | +| **three_d_secure_result_reason** | **str, none_type** | | | | +| **three_d_secure_version** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/CreatePaymentMethod409Response.md b/docs/payment_method/CreatePaymentMethod409Response.md new file mode 100644 index 00000000..cc5e7bd6 --- /dev/null +++ b/docs/payment_method/CreatePaymentMethod409Response.md @@ -0,0 +1,14 @@ +# CreatePaymentMethod409Response +> xendit.payment_method.model.CreatePaymentMethod409Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/CreatePaymentMethod503Response.md b/docs/payment_method/CreatePaymentMethod503Response.md new file mode 100644 index 00000000..65603aeb --- /dev/null +++ b/docs/payment_method/CreatePaymentMethod503Response.md @@ -0,0 +1,14 @@ +# CreatePaymentMethod503Response +> xendit.payment_method.model.CreatePaymentMethod503Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/DirectDebit.md b/docs/payment_method/DirectDebit.md new file mode 100644 index 00000000..61d12ca2 --- /dev/null +++ b/docs/payment_method/DirectDebit.md @@ -0,0 +1,18 @@ +# DirectDebit +> xendit.payment_method.model.DirectDebit + +Direct Debit Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | | +| **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | +| **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | +| **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/DirectDebitAllOf.md b/docs/payment_method/DirectDebitAllOf.md new file mode 100644 index 00000000..8934c7a5 --- /dev/null +++ b/docs/payment_method/DirectDebitAllOf.md @@ -0,0 +1,15 @@ +# DirectDebitAllOf +> xendit.payment_method.model.DirectDebitAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | +| **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | +| **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/DirectDebitBankAccount.md b/docs/payment_method/DirectDebitBankAccount.md new file mode 100644 index 00000000..5e8c1a6f --- /dev/null +++ b/docs/payment_method/DirectDebitBankAccount.md @@ -0,0 +1,16 @@ +# DirectDebitBankAccount +> xendit.payment_method.model.DirectDebitBankAccount + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **masked_bank_account_number** | **str, none_type** | | | | +| **bank_account_hash** | **str, none_type** | | | | +| **mobile_number** | **str, none_type** | | Mobile number of the customer registered to the partner channel | | +| **identity_document_number** | **str, none_type** | | Identity number of the customer registered to the partner channel | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/DirectDebitChannelCode.md b/docs/payment_method/DirectDebitChannelCode.md new file mode 100644 index 00000000..de6e97ad --- /dev/null +++ b/docs/payment_method/DirectDebitChannelCode.md @@ -0,0 +1,142 @@ +# DirectDebitChannelCode +> xendit.payment_method.model.DirectDebitChannelCode + +Direct Debit Channel Code + + +## Enum + + + * `BCA_KLIKPAY` (value: `"BCA_KLIKPAY"`) + + * `BCA_ONEKLIK` (value: `"BCA_ONEKLIK"`) + + * `BDO` (value: `"BDO"`) + + * `BPI` (value: `"BPI"`) + + * `BRI` (value: `"BRI"`) + + * `BNI` (value: `"BNI"`) + + * `CHINABANK` (value: `"CHINABANK"`) + + * `CIMBNIAGA` (value: `"CIMBNIAGA"`) + + * `MTB` (value: `"MTB"`) + + * `RCBC` (value: `"RCBC"`) + + * `UBP` (value: `"UBP"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `BBL` (value: `"BBL"`) + + * `SCB` (value: `"SCB"`) + + * `KTB` (value: `"KTB"`) + + * `BAY` (value: `"BAY"`) + + * `KBANK_MB` (value: `"KBANK_MB"`) + + * `BAY_MB` (value: `"BAY_MB"`) + + * `KTB_MB` (value: `"KTB_MB"`) + + * `BBL_MB` (value: `"BBL_MB"`) + + * `SCB_MB` (value: `"SCB_MB"`) + + * `BDO_EPAY` (value: `"BDO_EPAY"`) + + * `AUTODEBIT_UBP` (value: `"AUTODEBIT_UBP"`) + + * `AFFIN_FPX` (value: `"AFFIN_FPX"`) + + * `AGRO_FPX` (value: `"AGRO_FPX"`) + + * `ALLIANCE_FPX` (value: `"ALLIANCE_FPX"`) + + * `AMBANK_FPX` (value: `"AMBANK_FPX"`) + + * `ISLAM_FPX` (value: `"ISLAM_FPX"`) + + * `MUAMALAT_FPX` (value: `"MUAMALAT_FPX"`) + + * `BOC_FPX` (value: `"BOC_FPX"`) + + * `RAKYAT_FPX` (value: `"RAKYAT_FPX"`) + + * `BSN_FPX` (value: `"BSN_FPX"`) + + * `CIMB_FPX` (value: `"CIMB_FPX"`) + + * `HLB_FPX` (value: `"HLB_FPX"`) + + * `HSBC_FPX` (value: `"HSBC_FPX"`) + + * `KFH_FPX` (value: `"KFH_FPX"`) + + * `MAYB2E_FPX` (value: `"MAYB2E_FPX"`) + + * `MAYB2U_FPX` (value: `"MAYB2U_FPX"`) + + * `OCBC_FPX` (value: `"OCBC_FPX"`) + + * `PUBLIC_FPX` (value: `"PUBLIC_FPX"`) + + * `RHB_FPX` (value: `"RHB_FPX"`) + + * `SCH_FPX` (value: `"SCH_FPX"`) + + * `UOB_FPX` (value: `"UOB_FPX"`) + + * `AFFIN_FPX_BUSINESS` (value: `"AFFIN_FPX_BUSINESS"`) + + * `AGRO_FPX_BUSINESS` (value: `"AGRO_FPX_BUSINESS"`) + + * `ALLIANCE_FPX_BUSINESS` (value: `"ALLIANCE_FPX_BUSINESS"`) + + * `AMBANK_FPX_BUSINESS` (value: `"AMBANK_FPX_BUSINESS"`) + + * `ISLAM_FPX_BUSINESS` (value: `"ISLAM_FPX_BUSINESS"`) + + * `MUAMALAT_FPX_BUSINESS` (value: `"MUAMALAT_FPX_BUSINESS"`) + + * `BNP_FPX_BUSINESS` (value: `"BNP_FPX_BUSINESS"`) + + * `CIMB_FPX_BUSINESS` (value: `"CIMB_FPX_BUSINESS"`) + + * `CITIBANK_FPX_BUSINESS` (value: `"CITIBANK_FPX_BUSINESS"`) + + * `DEUTSCHE_FPX_BUSINESS` (value: `"DEUTSCHE_FPX_BUSINESS"`) + + * `HLB_FPX_BUSINESS` (value: `"HLB_FPX_BUSINESS"`) + + * `HSBC_FPX_BUSINESS` (value: `"HSBC_FPX_BUSINESS"`) + + * `RAKYAT_FPX_BUSINESS` (value: `"RAKYAT_FPX_BUSINESS"`) + + * `KFH_FPX_BUSINESS` (value: `"KFH_FPX_BUSINESS"`) + + * `MAYB2E_FPX_BUSINESS` (value: `"MAYB2E_FPX_BUSINESS"`) + + * `OCBC_FPX_BUSINESS` (value: `"OCBC_FPX_BUSINESS"`) + + * `PUBLIC_FPX_BUSINESS` (value: `"PUBLIC_FPX_BUSINESS"`) + + * `RHB_FPX_BUSINESS` (value: `"RHB_FPX_BUSINESS"`) + + * `SCH_FPX_BUSINESS` (value: `"SCH_FPX_BUSINESS"`) + + * `UOB_FPX_BUSINESS` (value: `"UOB_FPX_BUSINESS"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/DirectDebitChannelProperties.md b/docs/payment_method/DirectDebitChannelProperties.md new file mode 100644 index 00000000..055cd7de --- /dev/null +++ b/docs/payment_method/DirectDebitChannelProperties.md @@ -0,0 +1,22 @@ +# DirectDebitChannelProperties +> xendit.payment_method.model.DirectDebitChannelProperties + +Direct Debit Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **success_return_url** | **str** | | | | +| **failure_return_url** | **str, none_type** | | | | +| **mobile_number** | **str, none_type** | | Mobile number of the customer registered to the partner channel | | +| **card_last_four** | **str, none_type** | | Last four digits of the debit card | | +| **card_expiry** | **str, none_type** | | Expiry month and year of the debit card (in MM/YY format) | | +| **email** | **str, none_type** | | Email address of the customer that is registered to the partner channel | | +| **identity_document_number** | **str, none_type** | | Identity number of the customer registered to the partner channel | | +| **require_auth** | **bool, none_type** | | | | +| **account_number** | **str, none_type** | | Account number of the customer | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/DirectDebitDebitCard.md b/docs/payment_method/DirectDebitDebitCard.md new file mode 100644 index 00000000..05ff33dc --- /dev/null +++ b/docs/payment_method/DirectDebitDebitCard.md @@ -0,0 +1,17 @@ +# DirectDebitDebitCard +> xendit.payment_method.model.DirectDebitDebitCard + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **mobile_number** | **str, none_type** | | Mobile number of the customer registered to the partner channel | | +| **card_last_four** | **str, none_type** | | Last four digits of the debit card | | +| **card_expiry** | **str, none_type** | | Expiry month and year of the debit card (in MM/YY format) | | +| **email** | **str, none_type** | | Email address of the customer that is registered to the partner channel | | +| **account_number** | **str, none_type** | | Account number of the customer | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/DirectDebitParameters.md b/docs/payment_method/DirectDebitParameters.md new file mode 100644 index 00000000..30cdae37 --- /dev/null +++ b/docs/payment_method/DirectDebitParameters.md @@ -0,0 +1,14 @@ +# DirectDebitParameters +> xendit.payment_method.model.DirectDebitParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/DirectDebitType.md b/docs/payment_method/DirectDebitType.md new file mode 100644 index 00000000..c7bb6cec --- /dev/null +++ b/docs/payment_method/DirectDebitType.md @@ -0,0 +1,21 @@ +# DirectDebitType +> xendit.payment_method.model.DirectDebitType + + + +## Enum + + + * `DEBIT_CARD` (value: `"DEBIT_CARD"`) + + * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) + + * `BANK_REDIRECT` (value: `"BANK_REDIRECT"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/EWallet.md b/docs/payment_method/EWallet.md new file mode 100644 index 00000000..b1d25ca2 --- /dev/null +++ b/docs/payment_method/EWallet.md @@ -0,0 +1,16 @@ +# EWallet +> xendit.payment_method.model.EWallet + +Ewallet Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | +| **account** | [**EWalletAccount**](EWalletAccount.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/EWalletAccount.md b/docs/payment_method/EWalletAccount.md new file mode 100644 index 00000000..11bb28a3 --- /dev/null +++ b/docs/payment_method/EWalletAccount.md @@ -0,0 +1,17 @@ +# EWalletAccount +> xendit.payment_method.model.EWalletAccount + +EWallet Account Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **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 | | +| **account_details** | **str, none_type** | | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | | +| **balance** | **float, none_type** | | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | | +| **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 | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/EWalletChannelCode.md b/docs/payment_method/EWalletChannelCode.md new file mode 100644 index 00000000..81d2ec48 --- /dev/null +++ b/docs/payment_method/EWalletChannelCode.md @@ -0,0 +1,58 @@ +# EWalletChannelCode +> xendit.payment_method.model.EWalletChannelCode + +EWallet Channel Code + + +## Enum + + + * `GCASH` (value: `"GCASH"`) + + * `GRABPAY` (value: `"GRABPAY"`) + + * `PAYMAYA` (value: `"PAYMAYA"`) + + * `OVO` (value: `"OVO"`) + + * `DANA` (value: `"DANA"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `SHOPEEPAY` (value: `"SHOPEEPAY"`) + + * `SAKUKU` (value: `"SAKUKU"`) + + * `NEXCASH` (value: `"NEXCASH"`) + + * `ASTRAPAY` (value: `"ASTRAPAY"`) + + * `JENIUSPAY` (value: `"JENIUSPAY"`) + + * `APPOTA` (value: `"APPOTA"`) + + * `MOMO` (value: `"MOMO"`) + + * `VNPTWALLET` (value: `"VNPTWALLET"`) + + * `VIETTELPAY` (value: `"VIETTELPAY"`) + + * `ZALOPAY` (value: `"ZALOPAY"`) + + * `WECHATPAY` (value: `"WECHATPAY"`) + + * `LINEPAY` (value: `"LINEPAY"`) + + * `TRUEMONEY` (value: `"TRUEMONEY"`) + + * `ALIPAY` (value: `"ALIPAY"`) + + * `TOUCHANDGO` (value: `"TOUCHANDGO"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/EWalletChannelProperties.md b/docs/payment_method/EWalletChannelProperties.md new file mode 100644 index 00000000..6d9a9a15 --- /dev/null +++ b/docs/payment_method/EWalletChannelProperties.md @@ -0,0 +1,19 @@ +# EWalletChannelProperties +> xendit.payment_method.model.EWalletChannelProperties + +EWallet Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **success_return_url** | **str** | | URL where the end-customer is redirected if the authorization is successful | | +| **failure_return_url** | **str** | | URL where the end-customer is redirected if the authorization failed | | +| **cancel_return_url** | **str** | | URL where the end-customer is redirected if the authorization cancelled | | +| **mobile_number** | **str** | | Mobile number of customer in E.164 format (e.g. +628123123123). For OVO one time payment use only. | | +| **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. | | +| **cashtag** | **str** | | Available for JENIUSPAY only | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/EWalletParameters.md b/docs/payment_method/EWalletParameters.md new file mode 100644 index 00000000..5932ab30 --- /dev/null +++ b/docs/payment_method/EWalletParameters.md @@ -0,0 +1,15 @@ +# EWalletParameters +> xendit.payment_method.model.EWalletParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | +| **account** | [**EWalletAccount**](EWalletAccount.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/GetAllPaymentMethods400Response.md b/docs/payment_method/GetAllPaymentMethods400Response.md new file mode 100644 index 00000000..0c4c3be5 --- /dev/null +++ b/docs/payment_method/GetAllPaymentMethods400Response.md @@ -0,0 +1,14 @@ +# GetAllPaymentMethods400Response +> xendit.payment_method.model.GetAllPaymentMethods400Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/GetAllPaymentMethods403Response.md b/docs/payment_method/GetAllPaymentMethods403Response.md new file mode 100644 index 00000000..f6b6d4a1 --- /dev/null +++ b/docs/payment_method/GetAllPaymentMethods403Response.md @@ -0,0 +1,14 @@ +# GetAllPaymentMethods403Response +> xendit.payment_method.model.GetAllPaymentMethods403Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/GetAllPaymentMethods404Response.md b/docs/payment_method/GetAllPaymentMethods404Response.md new file mode 100644 index 00000000..67dba671 --- /dev/null +++ b/docs/payment_method/GetAllPaymentMethods404Response.md @@ -0,0 +1,14 @@ +# GetAllPaymentMethods404Response +> xendit.payment_method.model.GetAllPaymentMethods404Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | "DATA_NOT_FOUND" | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/GetAllPaymentMethodsDefaultResponse.md b/docs/payment_method/GetAllPaymentMethodsDefaultResponse.md new file mode 100644 index 00000000..d8bf567c --- /dev/null +++ b/docs/payment_method/GetAllPaymentMethodsDefaultResponse.md @@ -0,0 +1,14 @@ +# GetAllPaymentMethodsDefaultResponse +> xendit.payment_method.model.GetAllPaymentMethodsDefaultResponse + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/OverTheCounter.md b/docs/payment_method/OverTheCounter.md new file mode 100644 index 00000000..11db4bc1 --- /dev/null +++ b/docs/payment_method/OverTheCounter.md @@ -0,0 +1,17 @@ +# OverTheCounter +> xendit.payment_method.model.OverTheCounter + +Over The Counter Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | | +| **amount** | **float, none_type** | | | | +| **currency** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/OverTheCounterChannelCode.md b/docs/payment_method/OverTheCounterChannelCode.md new file mode 100644 index 00000000..2db666da --- /dev/null +++ b/docs/payment_method/OverTheCounterChannelCode.md @@ -0,0 +1,48 @@ +# OverTheCounterChannelCode +> xendit.payment_method.model.OverTheCounterChannelCode + +Over The Counter Channel Code + + +## Enum + + + * `7ELEVEN` (value: `"7ELEVEN"`) + + * `7ELEVEN_CLIQQ` (value: `"7ELEVEN_CLIQQ"`) + + * `CEBUANA` (value: `"CEBUANA"`) + + * `ECPAY` (value: `"ECPAY"`) + + * `PALAWAN` (value: `"PALAWAN"`) + + * `MLHUILLIER` (value: `"MLHUILLIER"`) + + * `ECPAY_DRAGONLOAN` (value: `"ECPAY_DRAGONLOAN"`) + + * `LBC` (value: `"LBC"`) + + * `ECPAY_SCHOOL` (value: `"ECPAY_SCHOOL"`) + + * `RD_PAWNSHOP` (value: `"RD_PAWNSHOP"`) + + * `CVM` (value: `"CVM"`) + + * `USSC` (value: `"USSC"`) + + * `SM_BILLS` (value: `"SM_BILLS"`) + + * `ROBINSONS_BILLS` (value: `"ROBINSONS_BILLS"`) + + * `ALFAMART` (value: `"ALFAMART"`) + + * `INDOMARET` (value: `"INDOMARET"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/OverTheCounterChannelProperties.md b/docs/payment_method/OverTheCounterChannelProperties.md new file mode 100644 index 00000000..eaeb65d1 --- /dev/null +++ b/docs/payment_method/OverTheCounterChannelProperties.md @@ -0,0 +1,16 @@ +# OverTheCounterChannelProperties +> xendit.payment_method.model.OverTheCounterChannelProperties + +Over The Counter Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **customer_name** | **str** | ☑️ | Name of customer. | | | +| **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. | | +| **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. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/OverTheCounterChannelPropertiesUpdate.md b/docs/payment_method/OverTheCounterChannelPropertiesUpdate.md new file mode 100644 index 00000000..3cb4bdfc --- /dev/null +++ b/docs/payment_method/OverTheCounterChannelPropertiesUpdate.md @@ -0,0 +1,15 @@ +# OverTheCounterChannelPropertiesUpdate +> xendit.payment_method.model.OverTheCounterChannelPropertiesUpdate + +Over The Counter Channel properties that can be updated + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **customer_name** | **str** | | Name of customer. | | +| **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. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/OverTheCounterParameters.md b/docs/payment_method/OverTheCounterParameters.md new file mode 100644 index 00000000..b6e67584 --- /dev/null +++ b/docs/payment_method/OverTheCounterParameters.md @@ -0,0 +1,16 @@ +# OverTheCounterParameters +> xendit.payment_method.model.OverTheCounterParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | | +| **amount** | **float, none_type** | | | | +| **currency** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/OverTheCounterUpdateParameters.md b/docs/payment_method/OverTheCounterUpdateParameters.md new file mode 100644 index 00000000..b9d20cd4 --- /dev/null +++ b/docs/payment_method/OverTheCounterUpdateParameters.md @@ -0,0 +1,14 @@ +# OverTheCounterUpdateParameters +> xendit.payment_method.model.OverTheCounterUpdateParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **amount** | **float, none_type** | | | | +| **channel_properties** | [**OverTheCounterChannelPropertiesUpdate**](OverTheCounterChannelPropertiesUpdate.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethod.md b/docs/payment_method/PaymentMethod.md new file mode 100644 index 00000000..00c36aff --- /dev/null +++ b/docs/payment_method/PaymentMethod.md @@ -0,0 +1,34 @@ +# PaymentMethod +> xendit.payment_method.model.PaymentMethod + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **id** | **str** | ☑️ | | | | +| **business_id** | **str** | | | | +| **type** | [**PaymentMethodType**](PaymentMethodType.md) | | | | +| **country** | [**PaymentMethodCountry**](PaymentMethodCountry.md) | | | | +| **customer_id** | **str, none_type** | | | | +| **customer** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | +| **reference_id** | **str** | | | | +| **description** | **str, none_type** | | | | +| **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | | +| **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | | +| **actions** | [**[PaymentMethodAction]**](PaymentMethodAction.md) | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | +| **billing_information** | [**BillingInformation**](BillingInformation.md) | | | | +| **failure_code** | **str, none_type** | | | | +| **created** | **datetime** | | | | +| **updated** | **datetime** | | | | +| **ewallet** | [**EWallet**](EWallet.md) | | | | +| **direct_debit** | [**DirectDebit**](DirectDebit.md) | | | | +| **over_the_counter** | [**OverTheCounter**](OverTheCounter.md) | | | | +| **card** | [**Card**](Card.md) | | | | +| **qr_code** | [**QRCode**](QRCode.md) | | | | +| **virtual_account** | [**VirtualAccount**](VirtualAccount.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodAction.md b/docs/payment_method/PaymentMethodAction.md new file mode 100644 index 00000000..f3f2e716 --- /dev/null +++ b/docs/payment_method/PaymentMethodAction.md @@ -0,0 +1,16 @@ +# PaymentMethodAction +> xendit.payment_method.model.PaymentMethodAction + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **action** | **str** | | | | +| **method** | **str** | | | | +| **url** | **str** | | | | +| **url_type** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodAuthParameters.md b/docs/payment_method/PaymentMethodAuthParameters.md new file mode 100644 index 00000000..7c399973 --- /dev/null +++ b/docs/payment_method/PaymentMethodAuthParameters.md @@ -0,0 +1,13 @@ +# PaymentMethodAuthParameters +> xendit.payment_method.model.PaymentMethodAuthParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **auth_code** | **str** | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodCountry.md b/docs/payment_method/PaymentMethodCountry.md new file mode 100644 index 00000000..a1148d16 --- /dev/null +++ b/docs/payment_method/PaymentMethodCountry.md @@ -0,0 +1,27 @@ +# PaymentMethodCountry +> xendit.payment_method.model.PaymentMethodCountry + + + +## Enum + + + * `PH` (value: `"PH"`) + + * `ID` (value: `"ID"`) + + * `VN` (value: `"VN"`) + + * `TH` (value: `"TH"`) + + * `MY` (value: `"MY"`) + + * `US` (value: `"US"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodExpireParameters.md b/docs/payment_method/PaymentMethodExpireParameters.md new file mode 100644 index 00000000..8dc1bbdf --- /dev/null +++ b/docs/payment_method/PaymentMethodExpireParameters.md @@ -0,0 +1,14 @@ +# PaymentMethodExpireParameters +> xendit.payment_method.model.PaymentMethodExpireParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **success_return_url** | **str, none_type** | | URL where the end customer is redirected if the unlinking authorization is successful. | | +| **failure_return_url** | **str, none_type** | | URL where the end customer is redirected if the unlinking authorization is failed. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodList.md b/docs/payment_method/PaymentMethodList.md new file mode 100644 index 00000000..a24a0f96 --- /dev/null +++ b/docs/payment_method/PaymentMethodList.md @@ -0,0 +1,14 @@ +# PaymentMethodList +> xendit.payment_method.model.PaymentMethodList + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **data** | [**[PaymentMethod]**](PaymentMethod.md) | ☑️ | | | | +| **has_more** | **bool** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodParameters.md b/docs/payment_method/PaymentMethodParameters.md new file mode 100644 index 00000000..f0f687e3 --- /dev/null +++ b/docs/payment_method/PaymentMethodParameters.md @@ -0,0 +1,26 @@ +# PaymentMethodParameters +> xendit.payment_method.model.PaymentMethodParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | | | +| **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | | | +| **country** | **str, none_type** | | | | +| **customer_id** | **str, none_type** | | | | +| **reference_id** | **str** | | | | +| **description** | **str, none_type** | | | | +| **card** | [**CardParameters**](CardParameters.md) | | | | +| **direct_debit** | [**DirectDebitParameters**](DirectDebitParameters.md) | | | | +| **ewallet** | [**EWalletParameters**](EWalletParameters.md) | | | | +| **over_the_counter** | [**OverTheCounterParameters**](OverTheCounterParameters.md) | | | | +| **virtual_account** | [**VirtualAccountParameters**](VirtualAccountParameters.md) | | | | +| **qr_code** | [**QRCodeParameters**](QRCodeParameters.md) | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | +| **billing_information** | [**BillingInformation**](BillingInformation.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodReusability.md b/docs/payment_method/PaymentMethodReusability.md new file mode 100644 index 00000000..947f1909 --- /dev/null +++ b/docs/payment_method/PaymentMethodReusability.md @@ -0,0 +1,19 @@ +# PaymentMethodReusability +> xendit.payment_method.model.PaymentMethodReusability + + + +## Enum + + + * `MULTIPLE_USE` (value: `"MULTIPLE_USE"`) + + * `ONE_TIME_USE` (value: `"ONE_TIME_USE"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodStatus.md b/docs/payment_method/PaymentMethodStatus.md new file mode 100644 index 00000000..11588197 --- /dev/null +++ b/docs/payment_method/PaymentMethodStatus.md @@ -0,0 +1,27 @@ +# PaymentMethodStatus +> xendit.payment_method.model.PaymentMethodStatus + + + +## Enum + + + * `ACTIVE` (value: `"ACTIVE"`) + + * `EXPIRED` (value: `"EXPIRED"`) + + * `INACTIVE` (value: `"INACTIVE"`) + + * `PENDING` (value: `"PENDING"`) + + * `REQUIRES_ACTION` (value: `"REQUIRES_ACTION"`) + + * `FAILED` (value: `"FAILED"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodType.md b/docs/payment_method/PaymentMethodType.md new file mode 100644 index 00000000..b7c33272 --- /dev/null +++ b/docs/payment_method/PaymentMethodType.md @@ -0,0 +1,31 @@ +# PaymentMethodType +> xendit.payment_method.model.PaymentMethodType + + + +## Enum + + + * `CARD` (value: `"CARD"`) + + * `CRYPTOCURRENCY` (value: `"CRYPTOCURRENCY"`) + + * `DIRECT_BANK_TRANSFER` (value: `"DIRECT_BANK_TRANSFER"`) + + * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `OVER_THE_COUNTER` (value: `"OVER_THE_COUNTER"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/PaymentMethodUpdateParameters.md b/docs/payment_method/PaymentMethodUpdateParameters.md new file mode 100644 index 00000000..88a0336e --- /dev/null +++ b/docs/payment_method/PaymentMethodUpdateParameters.md @@ -0,0 +1,18 @@ +# PaymentMethodUpdateParameters +> xendit.payment_method.model.PaymentMethodUpdateParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **description** | **str** | | | | +| **reference_id** | **str** | | | | +| **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | | +| **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | | +| **over_the_counter** | [**OverTheCounterUpdateParameters**](OverTheCounterUpdateParameters.md) | | | | +| **virtual_account** | [**VirtualAccountUpdateParameters**](VirtualAccountUpdateParameters.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/QRCode.md b/docs/payment_method/QRCode.md new file mode 100644 index 00000000..7734ffba --- /dev/null +++ b/docs/payment_method/QRCode.md @@ -0,0 +1,17 @@ +# QRCode +> xendit.payment_method.model.QRCode + +QR Code Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **amount** | **float, none_type** | | | | +| **currency** | **str** | | | | +| **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | | +| **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/QRCodeChannelCode.md b/docs/payment_method/QRCodeChannelCode.md new file mode 100644 index 00000000..22145489 --- /dev/null +++ b/docs/payment_method/QRCodeChannelCode.md @@ -0,0 +1,26 @@ +# QRCodeChannelCode +> xendit.payment_method.model.QRCodeChannelCode + +QR Code Channel Code + + +## Enum + + + * `QRIS` (value: `"QRIS"`) + + * `DANA` (value: `"DANA"`) + + * `RCBC` (value: `"RCBC"`) + + * `PROMPTPAY` (value: `"PROMPTPAY"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/QRCodeChannelProperties.md b/docs/payment_method/QRCodeChannelProperties.md new file mode 100644 index 00000000..6f1b34cc --- /dev/null +++ b/docs/payment_method/QRCodeChannelProperties.md @@ -0,0 +1,15 @@ +# QRCodeChannelProperties +> xendit.payment_method.model.QRCodeChannelProperties + +QR Code Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **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) | | +| **expires_at** | **datetime** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/QRCodeParameters.md b/docs/payment_method/QRCodeParameters.md new file mode 100644 index 00000000..090b0dce --- /dev/null +++ b/docs/payment_method/QRCodeParameters.md @@ -0,0 +1,16 @@ +# QRCodeParameters +> xendit.payment_method.model.QRCodeParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **amount** | **float, none_type** | | | | +| **currency** | **str** | | | | +| **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | | +| **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/SimulatePaymentRequest.md b/docs/payment_method/SimulatePaymentRequest.md new file mode 100644 index 00000000..e5cd2b22 --- /dev/null +++ b/docs/payment_method/SimulatePaymentRequest.md @@ -0,0 +1,13 @@ +# SimulatePaymentRequest +> xendit.payment_method.model.SimulatePaymentRequest + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **amount** | **float** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/TokenizedCardInformation.md b/docs/payment_method/TokenizedCardInformation.md new file mode 100644 index 00000000..f59d710a --- /dev/null +++ b/docs/payment_method/TokenizedCardInformation.md @@ -0,0 +1,23 @@ +# TokenizedCardInformation +> xendit.payment_method.model.TokenizedCardInformation + +Tokenized Card Information + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **token_id** | **str** | ☑️ | | | | +| **masked_card_number** | **str** | ☑️ | 1st 6 and last 4 digits of the card | | | +| **expiry_month** | **str** | ☑️ | Card expiry month in MM format | | | +| **expiry_year** | **str** | ☑️ | Card expiry month in YY format | | | +| **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. | | | +| **type** | **str** | ☑️ | Whether the card is a credit or debit card | | | +| **network** | **str** | ☑️ | Card network - VISA, MASTERCARD, JCB, AMEX, DISCOVER, BCA | | | +| **country** | **str** | ☑️ | Country where the card was issued ISO 3166-1 Alpha-2 | | | +| **issuer** | **str** | ☑️ | Issuer of the card, most often an issuing bank For example, “BCA”, “MANDIRI” | | | +| **cardholder_name** | **str, none_type** | | Cardholder name is optional but recommended for 3DS 2 / AVS verification | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/VirtualAccount.md b/docs/payment_method/VirtualAccount.md new file mode 100644 index 00000000..05505293 --- /dev/null +++ b/docs/payment_method/VirtualAccount.md @@ -0,0 +1,21 @@ +# VirtualAccount +> xendit.payment_method.model.VirtualAccount + +Virtual Account Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | | +| **amount** | **float, none_type** | | | | +| **min_amount** | **float, none_type** | | | | +| **max_amount** | **float, none_type** | | | | +| **currency** | **str** | | | | +| **alternative_display_types** | **[str]** | | For payments in Vietnam only, alternative display requested for the virtual account | | +| **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/VirtualAccountAllOf.md b/docs/payment_method/VirtualAccountAllOf.md new file mode 100644 index 00000000..7417e7a3 --- /dev/null +++ b/docs/payment_method/VirtualAccountAllOf.md @@ -0,0 +1,13 @@ +# VirtualAccountAllOf +> xendit.payment_method.model.VirtualAccountAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/VirtualAccountAlternativeDisplay.md b/docs/payment_method/VirtualAccountAlternativeDisplay.md new file mode 100644 index 00000000..6935b6ff --- /dev/null +++ b/docs/payment_method/VirtualAccountAlternativeDisplay.md @@ -0,0 +1,15 @@ +# VirtualAccountAlternativeDisplay +> xendit.payment_method.model.VirtualAccountAlternativeDisplay + +Alternative Display Object + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **type** | **str** | | Type of the alternative display [readonly] | "QR_STRING" | +| **data** | **str** | | Data payload of the given alternative display | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/VirtualAccountChannelCode.md b/docs/payment_method/VirtualAccountChannelCode.md new file mode 100644 index 00000000..31961083 --- /dev/null +++ b/docs/payment_method/VirtualAccountChannelCode.md @@ -0,0 +1,48 @@ +# VirtualAccountChannelCode +> xendit.payment_method.model.VirtualAccountChannelCode + +Virtual Account Channel Code + + +## Enum + + + * `BCA` (value: `"BCA"`) + + * `BJB` (value: `"BJB"`) + + * `BNI` (value: `"BNI"`) + + * `BRI` (value: `"BRI"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `PERMATA` (value: `"PERMATA"`) + + * `BSI` (value: `"BSI"`) + + * `CIMB` (value: `"CIMB"`) + + * `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) + + * `ARTAJASA` (value: `"ARTAJASA"`) + + * `PV` (value: `"PV"`) + + * `VIETCAPITAL` (value: `"VIETCAPITAL"`) + + * `WOORI` (value: `"WOORI"`) + + * `MSB` (value: `"MSB"`) + + * `STANDARD_CHARTERED` (value: `"STANDARD_CHARTERED"`) + + * `AMBANK` (value: `"AMBANK"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/VirtualAccountChannelProperties.md b/docs/payment_method/VirtualAccountChannelProperties.md new file mode 100644 index 00000000..fa1cd4b6 --- /dev/null +++ b/docs/payment_method/VirtualAccountChannelProperties.md @@ -0,0 +1,17 @@ +# VirtualAccountChannelProperties +> xendit.payment_method.model.VirtualAccountChannelProperties + +Virtual Account Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **customer_name** | **str** | | Name of customer. | | +| **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. | | +| **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. | | +| **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) | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/VirtualAccountChannelPropertiesPatch.md b/docs/payment_method/VirtualAccountChannelPropertiesPatch.md new file mode 100644 index 00000000..d21da071 --- /dev/null +++ b/docs/payment_method/VirtualAccountChannelPropertiesPatch.md @@ -0,0 +1,15 @@ +# VirtualAccountChannelPropertiesPatch +> xendit.payment_method.model.VirtualAccountChannelPropertiesPatch + +Virtual Account Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **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. | | +| **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) | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/VirtualAccountParameters.md b/docs/payment_method/VirtualAccountParameters.md new file mode 100644 index 00000000..bb454081 --- /dev/null +++ b/docs/payment_method/VirtualAccountParameters.md @@ -0,0 +1,19 @@ +# VirtualAccountParameters +> xendit.payment_method.model.VirtualAccountParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | | +| **amount** | **float, none_type** | | | | +| **min_amount** | **float, none_type** | | | | +| **max_amount** | **float, none_type** | | | | +| **currency** | **str** | | | | +| **alternative_display_types** | **[str]** | | For payments in Vietnam only, alternative display requested for the virtual account | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_method/VirtualAccountUpdateParameters.md b/docs/payment_method/VirtualAccountUpdateParameters.md new file mode 100644 index 00000000..a25200f9 --- /dev/null +++ b/docs/payment_method/VirtualAccountUpdateParameters.md @@ -0,0 +1,17 @@ +# VirtualAccountUpdateParameters +> xendit.payment_method.model.VirtualAccountUpdateParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **amount** | **float, none_type** | | | | +| **min_amount** | **float, none_type** | | | | +| **max_amount** | **float, none_type** | | | | +| **channel_properties** | [**VirtualAccountChannelPropertiesPatch**](VirtualAccountChannelPropertiesPatch.md) | | | | +| **alternative_display_types** | **[str]** | | For payments in Vietnam only, alternative display requested for the virtual account | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/Capture.md b/docs/payment_request/Capture.md new file mode 100644 index 00000000..e98c2784 --- /dev/null +++ b/docs/payment_request/Capture.md @@ -0,0 +1,27 @@ +# Capture +> xendit.payment_request.model.Capture + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **id** | **str** | ☑️ | | | | +| **payment_request_id** | **str** | ☑️ | | | | +| **payment_id** | **str** | ☑️ | | | | +| **reference_id** | **str** | ☑️ | | | | +| **currency** | **str** | ☑️ | | | | +| **authorized_amount** | **float** | ☑️ | | | | +| **captured_amount** | **float** | ☑️ | | | | +| **status** | **str** | ☑️ | | | | +| **payment_method** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | | | +| **failure_code** | **str, none_type** | ☑️ | | | | +| **customer_id** | **str, none_type** | ☑️ | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | ☑️ | | | | +| **channel_properties** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | ☑️ | | | | +| **created** | **str** | ☑️ | | | | +| **updated** | **str** | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/CaptureList.md b/docs/payment_request/CaptureList.md new file mode 100644 index 00000000..e163ed8c --- /dev/null +++ b/docs/payment_request/CaptureList.md @@ -0,0 +1,13 @@ +# CaptureList +> xendit.payment_request.model.CaptureList + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **value** | [**[Capture]**](Capture.md) | | ☑️ | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/CaptureListResponse.md b/docs/payment_request/CaptureListResponse.md new file mode 100644 index 00000000..ad6d4de0 --- /dev/null +++ b/docs/payment_request/CaptureListResponse.md @@ -0,0 +1,14 @@ +# CaptureListResponse +> xendit.payment_request.model.CaptureListResponse + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **data** | [**CaptureList**](CaptureList.md) | ☑️ | | | | +| **has_more** | **bool** | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/CaptureParameters.md b/docs/payment_request/CaptureParameters.md new file mode 100644 index 00000000..7a0d2190 --- /dev/null +++ b/docs/payment_request/CaptureParameters.md @@ -0,0 +1,14 @@ +# CaptureParameters +> xendit.payment_request.model.CaptureParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **capture_amount** | **float** | ☑️ | | | | +| **reference_id** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/Card.md b/docs/payment_request/Card.md new file mode 100644 index 00000000..06d540d5 --- /dev/null +++ b/docs/payment_request/Card.md @@ -0,0 +1,16 @@ +# Card +> xendit.payment_request.model.Card + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | | | +| **channel_properties** | [**CardChannelProperties**](CardChannelProperties.md) | ☑️ | | | | +| **card_information** | [**CardInformation**](CardInformation.md) | ☑️ | | | | +| **card_verification_results** | [**CardVerificationResults**](CardVerificationResults.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/CardChannelProperties.md b/docs/payment_request/CardChannelProperties.md new file mode 100644 index 00000000..d5c8539e --- /dev/null +++ b/docs/payment_request/CardChannelProperties.md @@ -0,0 +1,18 @@ +# CardChannelProperties +> xendit.payment_request.model.CardChannelProperties + +Card Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **skip_three_d_secure** | **bool, none_type** | | To indicate whether to perform 3DS during the linking phase | | +| **success_return_url** | **str, none_type** | | URL where the end-customer is redirected if the authorization is successful | | +| **failure_return_url** | **str, none_type** | | URL where the end-customer is redirected if the authorization failed | | +| **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. | | +| **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 | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/CardInformation.md b/docs/payment_request/CardInformation.md new file mode 100644 index 00000000..2777e82d --- /dev/null +++ b/docs/payment_request/CardInformation.md @@ -0,0 +1,23 @@ +# CardInformation +> xendit.payment_request.model.CardInformation + +Card Information + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **token_id** | **str** | ☑️ | | | | +| **masked_card_number** | **str** | ☑️ | 1st 6 and last 4 digits of the card | | | +| **expiry_month** | **str** | ☑️ | Card expiry month in MM format | | | +| **expiry_year** | **str** | ☑️ | Card expiry month in YY format | | | +| **cardholder_name** | **str, none_type** | | Cardholder name | | +| **fingerprint** | **str** | | | | +| **type** | **str** | | | | +| **network** | **str** | | | | +| **country** | **str** | | | | +| **issuer** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/CardVerificationResults.md b/docs/payment_request/CardVerificationResults.md new file mode 100644 index 00000000..6c9f7c21 --- /dev/null +++ b/docs/payment_request/CardVerificationResults.md @@ -0,0 +1,15 @@ +# CardVerificationResults +> xendit.payment_request.model.CardVerificationResults + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **three_d_secure** | [**CardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | | | | +| **cvv_result** | **str, none_type** | | | | +| **address_verification_result** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/CardVerificationResultsThreeDSecure.md b/docs/payment_request/CardVerificationResultsThreeDSecure.md new file mode 100644 index 00000000..e907e143 --- /dev/null +++ b/docs/payment_request/CardVerificationResultsThreeDSecure.md @@ -0,0 +1,17 @@ +# CardVerificationResultsThreeDSecure +> xendit.payment_request.model.CardVerificationResultsThreeDSecure + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **three_d_secure_flow** | **str, none_type** | | | | +| **eci_code** | **str, none_type** | | | | +| **three_d_secure_result** | **str, none_type** | | | | +| **three_d_secure_result_reason** | **str, none_type** | | | | +| **three_d_secure_version** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebit.md b/docs/payment_request/DirectDebit.md new file mode 100644 index 00000000..62526cfa --- /dev/null +++ b/docs/payment_request/DirectDebit.md @@ -0,0 +1,18 @@ +# DirectDebit +> xendit.payment_request.model.DirectDebit + +Direct Debit Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | | +| **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | +| **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | +| **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitAllOf.md b/docs/payment_request/DirectDebitAllOf.md new file mode 100644 index 00000000..974e76d2 --- /dev/null +++ b/docs/payment_request/DirectDebitAllOf.md @@ -0,0 +1,15 @@ +# DirectDebitAllOf +> xendit.payment_request.model.DirectDebitAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | | +| **bank_account** | [**DirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | +| **debit_card** | [**DirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitBankAccount.md b/docs/payment_request/DirectDebitBankAccount.md new file mode 100644 index 00000000..e4c819fa --- /dev/null +++ b/docs/payment_request/DirectDebitBankAccount.md @@ -0,0 +1,14 @@ +# DirectDebitBankAccount +> xendit.payment_request.model.DirectDebitBankAccount + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **masked_bank_account_number** | **str, none_type** | | | | +| **bank_account_hash** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitChannelCode.md b/docs/payment_request/DirectDebitChannelCode.md new file mode 100644 index 00000000..82930500 --- /dev/null +++ b/docs/payment_request/DirectDebitChannelCode.md @@ -0,0 +1,142 @@ +# DirectDebitChannelCode +> xendit.payment_request.model.DirectDebitChannelCode + +Direct Debit Channel Code + + +## Enum + + + * `BCA_KLIKPAY` (value: `"BCA_KLIKPAY"`) + + * `BCA_ONEKLIK` (value: `"BCA_ONEKLIK"`) + + * `BRI` (value: `"BRI"`) + + * `BNI` (value: `"BNI"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `BPI` (value: `"BPI"`) + + * `BDO` (value: `"BDO"`) + + * `CIMBNIAGA` (value: `"CIMBNIAGA"`) + + * `MTB` (value: `"MTB"`) + + * `RCBC` (value: `"RCBC"`) + + * `UBP` (value: `"UBP"`) + + * `AUTODEBIT_UBP` (value: `"AUTODEBIT_UBP"`) + + * `CHINABANK` (value: `"CHINABANK"`) + + * `BAY` (value: `"BAY"`) + + * `KTB` (value: `"KTB"`) + + * `BBL` (value: `"BBL"`) + + * `SCB` (value: `"SCB"`) + + * `KBANK_MB` (value: `"KBANK_MB"`) + + * `BAY_MB` (value: `"BAY_MB"`) + + * `KTB_MB` (value: `"KTB_MB"`) + + * `BBL_MB` (value: `"BBL_MB"`) + + * `SCB_MB` (value: `"SCB_MB"`) + + * `BDO_EPAY` (value: `"BDO_EPAY"`) + + * `AFFIN_FPX` (value: `"AFFIN_FPX"`) + + * `AGRO_FPX` (value: `"AGRO_FPX"`) + + * `ALLIANCE_FPX` (value: `"ALLIANCE_FPX"`) + + * `AMBANK_FPX` (value: `"AMBANK_FPX"`) + + * `ISLAM_FPX` (value: `"ISLAM_FPX"`) + + * `MUAMALAT_FPX` (value: `"MUAMALAT_FPX"`) + + * `BOC_FPX` (value: `"BOC_FPX"`) + + * `RAKYAT_FPX` (value: `"RAKYAT_FPX"`) + + * `BSN_FPX` (value: `"BSN_FPX"`) + + * `CIMB_FPX` (value: `"CIMB_FPX"`) + + * `HLB_FPX` (value: `"HLB_FPX"`) + + * `HSBC_FPX` (value: `"HSBC_FPX"`) + + * `KFH_FPX` (value: `"KFH_FPX"`) + + * `MAYB2E_FPX` (value: `"MAYB2E_FPX"`) + + * `MAYB2U_FPX` (value: `"MAYB2U_FPX"`) + + * `OCBC_FPX` (value: `"OCBC_FPX"`) + + * `PUBLIC_FPX` (value: `"PUBLIC_FPX"`) + + * `RHB_FPX` (value: `"RHB_FPX"`) + + * `SCH_FPX` (value: `"SCH_FPX"`) + + * `UOB_FPX` (value: `"UOB_FPX"`) + + * `AFFIN_FPX_BUSINESS` (value: `"AFFIN_FPX_BUSINESS"`) + + * `AGRO_FPX_BUSINESS` (value: `"AGRO_FPX_BUSINESS"`) + + * `ALLIANCE_FPX_BUSINESS` (value: `"ALLIANCE_FPX_BUSINESS"`) + + * `AMBANK_FPX_BUSINESS` (value: `"AMBANK_FPX_BUSINESS"`) + + * `ISLAM_FPX_BUSINESS` (value: `"ISLAM_FPX_BUSINESS"`) + + * `MUAMALAT_FPX_BUSINESS` (value: `"MUAMALAT_FPX_BUSINESS"`) + + * `BNP_FPX_BUSINESS` (value: `"BNP_FPX_BUSINESS"`) + + * `CIMB_FPX_BUSINESS` (value: `"CIMB_FPX_BUSINESS"`) + + * `CITIBANK_FPX_BUSINESS` (value: `"CITIBANK_FPX_BUSINESS"`) + + * `DEUTSCHE_FPX_BUSINESS` (value: `"DEUTSCHE_FPX_BUSINESS"`) + + * `HLB_FPX_BUSINESS` (value: `"HLB_FPX_BUSINESS"`) + + * `HSBC_FPX_BUSINESS` (value: `"HSBC_FPX_BUSINESS"`) + + * `RAKYAT_FPX_BUSINESS` (value: `"RAKYAT_FPX_BUSINESS"`) + + * `KFH_FPX_BUSINESS` (value: `"KFH_FPX_BUSINESS"`) + + * `MAYB2E_FPX_BUSINESS` (value: `"MAYB2E_FPX_BUSINESS"`) + + * `OCBC_FPX_BUSINESS` (value: `"OCBC_FPX_BUSINESS"`) + + * `PUBLIC_FPX_BUSINESS` (value: `"PUBLIC_FPX_BUSINESS"`) + + * `RHB_FPX_BUSINESS` (value: `"RHB_FPX_BUSINESS"`) + + * `SCH_FPX_BUSINESS` (value: `"SCH_FPX_BUSINESS"`) + + * `UOB_FPX_BUSINESS` (value: `"UOB_FPX_BUSINESS"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitChannelProperties.md b/docs/payment_request/DirectDebitChannelProperties.md new file mode 100644 index 00000000..a784f17e --- /dev/null +++ b/docs/payment_request/DirectDebitChannelProperties.md @@ -0,0 +1,20 @@ +# DirectDebitChannelProperties +> xendit.payment_request.model.DirectDebitChannelProperties + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **mobile_number** | **str** | | Mobile number of the customer registered to the partner channel | | +| **success_return_url** | **str** | | | | +| **failure_return_url** | **str** | | | | +| **identity_document_number** | **str** | | | | +| **account_number** | **str** | | | | +| **card_last_four** | **str** | | Last four digits of the debit card | | +| **card_expiry** | **str** | | Expiry month and year of the debit card (in MM/YY format) | | +| **email** | **str** | | Email address of the customer that is registered to the partner channel | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitChannelPropertiesBankAccount.md b/docs/payment_request/DirectDebitChannelPropertiesBankAccount.md new file mode 100644 index 00000000..af521df7 --- /dev/null +++ b/docs/payment_request/DirectDebitChannelPropertiesBankAccount.md @@ -0,0 +1,17 @@ +# DirectDebitChannelPropertiesBankAccount +> xendit.payment_request.model.DirectDebitChannelPropertiesBankAccount + +Direct Debit Bank Account Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **success_return_url** | **str** | | | | +| **failure_return_url** | **str** | | | | +| **mobile_number** | **str** | | | | +| **identity_document_number** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md b/docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md new file mode 100644 index 00000000..ab5bf430 --- /dev/null +++ b/docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md @@ -0,0 +1,16 @@ +# DirectDebitChannelPropertiesBankRedirect +> xendit.payment_request.model.DirectDebitChannelPropertiesBankRedirect + +Direct Debit Bank Account Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **mobile_number** | **str** | | Mobile number of the customer that is registered to channel | | +| **success_return_url** | **str** | | | | +| **failure_return_url** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitChannelPropertiesDebitCard.md b/docs/payment_request/DirectDebitChannelPropertiesDebitCard.md new file mode 100644 index 00000000..ca27448a --- /dev/null +++ b/docs/payment_request/DirectDebitChannelPropertiesDebitCard.md @@ -0,0 +1,18 @@ +# DirectDebitChannelPropertiesDebitCard +> xendit.payment_request.model.DirectDebitChannelPropertiesDebitCard + +Direct Debit Debit Card Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **mobile_number** | **str** | | Mobile number of the customer registered to the partner channel | | +| **account_number** | **str** | | | | +| **card_last_four** | **str** | | Last four digits of the debit card | | +| **card_expiry** | **str** | | Expiry month and year of the debit card (in MM/YY format) | | +| **email** | **str** | | Email address of the customer that is registered to the partner channel | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitDebitCard.md b/docs/payment_request/DirectDebitDebitCard.md new file mode 100644 index 00000000..fd62c7fb --- /dev/null +++ b/docs/payment_request/DirectDebitDebitCard.md @@ -0,0 +1,17 @@ +# DirectDebitDebitCard +> xendit.payment_request.model.DirectDebitDebitCard + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **mobile_number** | **str, none_type** | | Mobile number of the customer registered to the partner channel | | +| **account_number** | **str** | | | | +| **card_last_four** | **str, none_type** | | Last four digits of the debit card | | +| **card_expiry** | **str, none_type** | | Expiry month and year of the debit card (in MM/YY format) | | +| **email** | **str, none_type** | | Email address of the customer that is registered to the partner channel | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitParameters.md b/docs/payment_request/DirectDebitParameters.md new file mode 100644 index 00000000..e5231989 --- /dev/null +++ b/docs/payment_request/DirectDebitParameters.md @@ -0,0 +1,15 @@ +# DirectDebitParameters +> xendit.payment_request.model.DirectDebitParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**DirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | | +| **type** | [**DirectDebitType**](DirectDebitType.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/DirectDebitType.md b/docs/payment_request/DirectDebitType.md new file mode 100644 index 00000000..1642d578 --- /dev/null +++ b/docs/payment_request/DirectDebitType.md @@ -0,0 +1,21 @@ +# DirectDebitType +> xendit.payment_request.model.DirectDebitType + + + +## Enum + + + * `DEBIT_CARD` (value: `"DEBIT_CARD"`) + + * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) + + * `BANK_REDIRECT` (value: `"BANK_REDIRECT"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/EWallet.md b/docs/payment_request/EWallet.md new file mode 100644 index 00000000..d3faa9b8 --- /dev/null +++ b/docs/payment_request/EWallet.md @@ -0,0 +1,16 @@ +# EWallet +> xendit.payment_request.model.EWallet + +Ewallet Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | | | | +| **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | +| **account** | [**EWalletAccount**](EWalletAccount.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/EWalletAccount.md b/docs/payment_request/EWalletAccount.md new file mode 100644 index 00000000..8c3c61e5 --- /dev/null +++ b/docs/payment_request/EWalletAccount.md @@ -0,0 +1,17 @@ +# EWalletAccount +> xendit.payment_request.model.EWalletAccount + +EWallet Account Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **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 | | +| **account_details** | **str, none_type** | | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | | +| **balance** | **float, none_type** | | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | | +| **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 | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/EWalletAllOf.md b/docs/payment_request/EWalletAllOf.md new file mode 100644 index 00000000..6dbe6196 --- /dev/null +++ b/docs/payment_request/EWalletAllOf.md @@ -0,0 +1,13 @@ +# EWalletAllOf +> xendit.payment_request.model.EWalletAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **account** | [**EWalletAccount**](EWalletAccount.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/EWalletChannelCode.md b/docs/payment_request/EWalletChannelCode.md new file mode 100644 index 00000000..377aaa9c --- /dev/null +++ b/docs/payment_request/EWalletChannelCode.md @@ -0,0 +1,56 @@ +# EWalletChannelCode +> xendit.payment_request.model.EWalletChannelCode + +Ewallet Channel Code + + +## Enum + + + * `GCASH` (value: `"GCASH"`) + + * `GRABPAY` (value: `"GRABPAY"`) + + * `PAYMAYA` (value: `"PAYMAYA"`) + + * `DANA` (value: `"DANA"`) + + * `OVO` (value: `"OVO"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `SHOPEEPAY` (value: `"SHOPEEPAY"`) + + * `NEXCASH` (value: `"NEXCASH"`) + + * `ASTRAPAY` (value: `"ASTRAPAY"`) + + * `JENIUSPAY` (value: `"JENIUSPAY"`) + + * `APPOTA` (value: `"APPOTA"`) + + * `MOMO` (value: `"MOMO"`) + + * `VNPTWALLET` (value: `"VNPTWALLET"`) + + * `VIETTELPAY` (value: `"VIETTELPAY"`) + + * `ZALOPAY` (value: `"ZALOPAY"`) + + * `WECHATPAY` (value: `"WECHATPAY"`) + + * `LINEPAY` (value: `"LINEPAY"`) + + * `TRUEMONEY` (value: `"TRUEMONEY"`) + + * `ALIPAY` (value: `"ALIPAY"`) + + * `TOUCHANDGO` (value: `"TOUCHANDGO"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/EWalletChannelProperties.md b/docs/payment_request/EWalletChannelProperties.md new file mode 100644 index 00000000..9b4b4bf2 --- /dev/null +++ b/docs/payment_request/EWalletChannelProperties.md @@ -0,0 +1,19 @@ +# EWalletChannelProperties +> xendit.payment_request.model.EWalletChannelProperties + +Ewallet Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **success_return_url** | **str** | | URL where the end-customer is redirected if the authorization is successful | | +| **failure_return_url** | **str** | | URL where the end-customer is redirected if the authorization failed | | +| **cancel_return_url** | **str** | | URL where the end-customer is redirected if the authorization cancelled | | +| **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. | | +| **mobile_number** | **str** | | | | +| **cashtag** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/EWalletParameters.md b/docs/payment_request/EWalletParameters.md new file mode 100644 index 00000000..551c21bb --- /dev/null +++ b/docs/payment_request/EWalletParameters.md @@ -0,0 +1,14 @@ +# EWalletParameters +> xendit.payment_request.model.EWalletParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**EWalletChannelCode**](EWalletChannelCode.md) | | | | +| **channel_properties** | [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/Error.md b/docs/payment_request/Error.md new file mode 100644 index 00000000..386ca176 --- /dev/null +++ b/docs/payment_request/Error.md @@ -0,0 +1,14 @@ +# Error +> xendit.payment_request.model.Error + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str, none_type** | | | | +| **message** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/OverTheCounter.md b/docs/payment_request/OverTheCounter.md new file mode 100644 index 00000000..df5d31c4 --- /dev/null +++ b/docs/payment_request/OverTheCounter.md @@ -0,0 +1,17 @@ +# OverTheCounter +> xendit.payment_request.model.OverTheCounter + +Over the Counter Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | | +| **amount** | **float, none_type** | | | | +| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/OverTheCounterChannelCode.md b/docs/payment_request/OverTheCounterChannelCode.md new file mode 100644 index 00000000..766dd183 --- /dev/null +++ b/docs/payment_request/OverTheCounterChannelCode.md @@ -0,0 +1,48 @@ +# OverTheCounterChannelCode +> xendit.payment_request.model.OverTheCounterChannelCode + +Over The Counter Channel Code + + +## Enum + + + * `7ELEVEN` (value: `"7ELEVEN"`) + + * `7ELEVEN_CLIQQ` (value: `"7ELEVEN_CLIQQ"`) + + * `CEBUANA` (value: `"CEBUANA"`) + + * `ECPAY` (value: `"ECPAY"`) + + * `PALAWAN` (value: `"PALAWAN"`) + + * `MLHUILLIER` (value: `"MLHUILLIER"`) + + * `ECPAY_DRAGONLOAN` (value: `"ECPAY_DRAGONLOAN"`) + + * `LBC` (value: `"LBC"`) + + * `ECPAY_SCHOOL` (value: `"ECPAY_SCHOOL"`) + + * `RD_PAWNSHOP` (value: `"RD_PAWNSHOP"`) + + * `CVM` (value: `"CVM"`) + + * `USSC` (value: `"USSC"`) + + * `SM_BILLS` (value: `"SM_BILLS"`) + + * `ROBINSONS_BILLS` (value: `"ROBINSONS_BILLS"`) + + * `ALFAMART` (value: `"ALFAMART"`) + + * `INDOMARET` (value: `"INDOMARET"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/OverTheCounterChannelProperties.md b/docs/payment_request/OverTheCounterChannelProperties.md new file mode 100644 index 00000000..b286ffa0 --- /dev/null +++ b/docs/payment_request/OverTheCounterChannelProperties.md @@ -0,0 +1,16 @@ +# OverTheCounterChannelProperties +> xendit.payment_request.model.OverTheCounterChannelProperties + +Over The Counter Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **customer_name** | **str** | ☑️ | Name of customer. | | | +| **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. | | +| **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. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/OverTheCounterParameters.md b/docs/payment_request/OverTheCounterParameters.md new file mode 100644 index 00000000..0e5fffeb --- /dev/null +++ b/docs/payment_request/OverTheCounterParameters.md @@ -0,0 +1,16 @@ +# OverTheCounterParameters +> xendit.payment_request.model.OverTheCounterParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | | +| **amount** | **float, none_type** | | | | +| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentMethod.md b/docs/payment_request/PaymentMethod.md new file mode 100644 index 00000000..2b9ef751 --- /dev/null +++ b/docs/payment_request/PaymentMethod.md @@ -0,0 +1,27 @@ +# PaymentMethod +> xendit.payment_request.model.PaymentMethod + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **id** | **str** | ☑️ | | | | +| **type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | | | +| **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | | | +| **status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | ☑️ | | | | +| **created** | **str** | | | | +| **updated** | **str** | | | | +| **description** | **str, none_type** | | | | +| **reference_id** | **str** | | | | +| **card** | [**Card**](Card.md) | | | | +| **direct_debit** | [**DirectDebit**](DirectDebit.md) | | | | +| **ewallet** | [**EWallet**](EWallet.md) | | | | +| **over_the_counter** | [**OverTheCounter**](OverTheCounter.md) | | | | +| **virtual_account** | [**VirtualAccount**](VirtualAccount.md) | | | | +| **qr_code** | [**QRCode**](QRCode.md) | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentMethodParameters.md b/docs/payment_request/PaymentMethodParameters.md new file mode 100644 index 00000000..f37dc2c3 --- /dev/null +++ b/docs/payment_request/PaymentMethodParameters.md @@ -0,0 +1,21 @@ +# PaymentMethodParameters +> xendit.payment_request.model.PaymentMethodParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | | | +| **reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | | | +| **description** | **str, none_type** | | | | +| **reference_id** | **str** | | | | +| **direct_debit** | [**DirectDebitParameters**](DirectDebitParameters.md) | | | | +| **ewallet** | [**EWalletParameters**](EWalletParameters.md) | | | | +| **over_the_counter** | [**OverTheCounterParameters**](OverTheCounterParameters.md) | | | | +| **virtual_account** | [**VirtualAccountParameters**](VirtualAccountParameters.md) | | | | +| **qr_code** | [**QRCodeParameters**](QRCodeParameters.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentMethodReusability.md b/docs/payment_request/PaymentMethodReusability.md new file mode 100644 index 00000000..5693f440 --- /dev/null +++ b/docs/payment_request/PaymentMethodReusability.md @@ -0,0 +1,19 @@ +# PaymentMethodReusability +> xendit.payment_request.model.PaymentMethodReusability + + + +## Enum + + + * `MULTIPLE_USE` (value: `"MULTIPLE_USE"`) + + * `ONE_TIME_USE` (value: `"ONE_TIME_USE"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentMethodStatus.md b/docs/payment_request/PaymentMethodStatus.md new file mode 100644 index 00000000..0e298ac0 --- /dev/null +++ b/docs/payment_request/PaymentMethodStatus.md @@ -0,0 +1,25 @@ +# PaymentMethodStatus +> xendit.payment_request.model.PaymentMethodStatus + + + +## Enum + + + * `ACTIVE` (value: `"ACTIVE"`) + + * `INACTIVE` (value: `"INACTIVE"`) + + * `PENDING` (value: `"PENDING"`) + + * `EXPIRED` (value: `"EXPIRED"`) + + * `FAILED` (value: `"FAILED"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentMethodType.md b/docs/payment_request/PaymentMethodType.md new file mode 100644 index 00000000..854c1b8d --- /dev/null +++ b/docs/payment_request/PaymentMethodType.md @@ -0,0 +1,27 @@ +# PaymentMethodType +> xendit.payment_request.model.PaymentMethodType + + + +## Enum + + + * `CARD` (value: `"CARD"`) + + * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `OVER_THE_COUNTER` (value: `"OVER_THE_COUNTER"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequest.md b/docs/payment_request/PaymentRequest.md new file mode 100644 index 00000000..49d8799c --- /dev/null +++ b/docs/payment_request/PaymentRequest.md @@ -0,0 +1,35 @@ +# PaymentRequest +> xendit.payment_request.model.PaymentRequest + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **id** | **str** | ☑️ | | | | +| **created** | **str** | ☑️ | | | | +| **updated** | **str** | ☑️ | | | | +| **reference_id** | **str** | ☑️ | | | | +| **business_id** | **str** | ☑️ | | | | +| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | | | +| **payment_method** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | | | +| **status** | [**PaymentRequestStatus**](PaymentRequestStatus.md) | ☑️ | | | | +| **customer_id** | **str, none_type** | | | | +| **customer** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | +| **amount** | **float** | | | | +| **min_amount** | **float, none_type** | | | | +| **max_amount** | **float, none_type** | | | | +| **country** | [**PaymentRequestCountry**](PaymentRequestCountry.md) | | | | +| **description** | **str, none_type** | | | | +| **failure_code** | **str, none_type** | | | | +| **capture_method** | [**PaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | | | +| **initiator** | [**PaymentRequestInitiator**](PaymentRequestInitiator.md) | | | | +| **card_verification_results** | [**PaymentRequestCardVerificationResults**](PaymentRequestCardVerificationResults.md) | | | | +| **actions** | [**[PaymentRequestAction]**](PaymentRequestAction.md) | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | +| **shipping_information** | [**PaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | | | +| **items** | [**PaymentRequestBasket**](PaymentRequestBasket.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestAction.md b/docs/payment_request/PaymentRequestAction.md new file mode 100644 index 00000000..8b6042a9 --- /dev/null +++ b/docs/payment_request/PaymentRequestAction.md @@ -0,0 +1,17 @@ +# PaymentRequestAction +> xendit.payment_request.model.PaymentRequestAction + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **action** | **str** | ☑️ | | | | +| **url_type** | **str** | ☑️ | | | | +| **method** | **str, none_type** | ☑️ | | | | +| **url** | **str, none_type** | ☑️ | | | | +| **qr_code** | **str, none_type** | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestAuthParameters.md b/docs/payment_request/PaymentRequestAuthParameters.md new file mode 100644 index 00000000..e23449ce --- /dev/null +++ b/docs/payment_request/PaymentRequestAuthParameters.md @@ -0,0 +1,13 @@ +# PaymentRequestAuthParameters +> xendit.payment_request.model.PaymentRequestAuthParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **auth_code** | **str** | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestBasket.md b/docs/payment_request/PaymentRequestBasket.md new file mode 100644 index 00000000..aaa1159a --- /dev/null +++ b/docs/payment_request/PaymentRequestBasket.md @@ -0,0 +1,13 @@ +# PaymentRequestBasket +> xendit.payment_request.model.PaymentRequestBasket + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **value** | [**[PaymentRequestBasketItem], none_type**](PaymentRequestBasketItem.md) | | ☑️ | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestBasketItem.md b/docs/payment_request/PaymentRequestBasketItem.md new file mode 100644 index 00000000..5474d11e --- /dev/null +++ b/docs/payment_request/PaymentRequestBasketItem.md @@ -0,0 +1,25 @@ +# PaymentRequestBasketItem +> xendit.payment_request.model.PaymentRequestBasketItem + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **name** | **str** | ☑️ | | | | +| **category** | **str** | ☑️ | | | | +| **currency** | **str** | ☑️ | | | | +| **quantity** | **float** | ☑️ | | | | +| **price** | **float** | ☑️ | | | | +| **reference_id** | **str** | | | | +| **description** | **str** | | | | +| **type** | **str** | | | | +| **sub_category** | **str** | | | | +| **payer_charged_currency** | **str** | | | | +| **payer_charged_price** | **float** | | | | +| **url** | **str** | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestCaptureMethod.md b/docs/payment_request/PaymentRequestCaptureMethod.md new file mode 100644 index 00000000..64f43778 --- /dev/null +++ b/docs/payment_request/PaymentRequestCaptureMethod.md @@ -0,0 +1,19 @@ +# PaymentRequestCaptureMethod +> xendit.payment_request.model.PaymentRequestCaptureMethod + + + +## Enum + + + * `AUTOMATIC` (value: `"AUTOMATIC"`) + + * `MANUAL` (value: `"MANUAL"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestCardVerificationResults.md b/docs/payment_request/PaymentRequestCardVerificationResults.md new file mode 100644 index 00000000..b1e04374 --- /dev/null +++ b/docs/payment_request/PaymentRequestCardVerificationResults.md @@ -0,0 +1,15 @@ +# PaymentRequestCardVerificationResults +> xendit.payment_request.model.PaymentRequestCardVerificationResults + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **three_d_secure** | [**PaymentRequestCardVerificationResultsThreeDeeSecure**](PaymentRequestCardVerificationResultsThreeDeeSecure.md) | ☑️ | | | | +| **cvv_result** | **str, none_type** | | | | +| **address_verification_result** | **str, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md b/docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md new file mode 100644 index 00000000..c9f5310a --- /dev/null +++ b/docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md @@ -0,0 +1,17 @@ +# PaymentRequestCardVerificationResultsThreeDeeSecure +> xendit.payment_request.model.PaymentRequestCardVerificationResultsThreeDeeSecure + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **three_d_secure_flow** | **str** | | | | +| **eci_code** | **str** | | | | +| **three_d_secure_result** | **str** | | | | +| **three_d_secure_result_reason** | **str, none_type** | | | | +| **three_d_secure_version** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestChannelProperties.md b/docs/payment_request/PaymentRequestChannelProperties.md new file mode 100644 index 00000000..ebd6e7ab --- /dev/null +++ b/docs/payment_request/PaymentRequestChannelProperties.md @@ -0,0 +1,19 @@ +# PaymentRequestChannelProperties +> xendit.payment_request.model.PaymentRequestChannelProperties + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **success_return_url** | **str** | | URL where the end-customer is redirected if the authorization is successful | | +| **failure_return_url** | **str** | | URL where the end-customer is redirected if the authorization failed | | +| **cancel_return_url** | **str** | | URL where the end-customer is redirected if the authorization cancelled | | +| **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. | | +| **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. | | +| **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 | | +| **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. | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestCountry.md b/docs/payment_request/PaymentRequestCountry.md new file mode 100644 index 00000000..cf5bcb99 --- /dev/null +++ b/docs/payment_request/PaymentRequestCountry.md @@ -0,0 +1,25 @@ +# PaymentRequestCountry +> xendit.payment_request.model.PaymentRequestCountry + + + +## Enum + + + * `ID` (value: `"ID"`) + + * `PH` (value: `"PH"`) + + * `VN` (value: `"VN"`) + + * `TH` (value: `"TH"`) + + * `MY` (value: `"MY"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestCurrency.md b/docs/payment_request/PaymentRequestCurrency.md new file mode 100644 index 00000000..d700476b --- /dev/null +++ b/docs/payment_request/PaymentRequestCurrency.md @@ -0,0 +1,27 @@ +# PaymentRequestCurrency +> xendit.payment_request.model.PaymentRequestCurrency + + + +## Enum + + + * `IDR` (value: `"IDR"`) + + * `PHP` (value: `"PHP"`) + + * `VND` (value: `"VND"`) + + * `THB` (value: `"THB"`) + + * `MYR` (value: `"MYR"`) + + * `USD` (value: `"USD"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestInitiator.md b/docs/payment_request/PaymentRequestInitiator.md new file mode 100644 index 00000000..196af727 --- /dev/null +++ b/docs/payment_request/PaymentRequestInitiator.md @@ -0,0 +1,19 @@ +# PaymentRequestInitiator +> xendit.payment_request.model.PaymentRequestInitiator + + + +## Enum + + + * `CUSTOMER` (value: `"CUSTOMER"`) + + * `MERCHANT` (value: `"MERCHANT"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestListResponse.md b/docs/payment_request/PaymentRequestListResponse.md new file mode 100644 index 00000000..88df1b61 --- /dev/null +++ b/docs/payment_request/PaymentRequestListResponse.md @@ -0,0 +1,14 @@ +# PaymentRequestListResponse +> xendit.payment_request.model.PaymentRequestListResponse + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **data** | [**[PaymentRequest]**](PaymentRequest.md) | ☑️ | | | | +| **has_more** | **bool** | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestParameters.md b/docs/payment_request/PaymentRequestParameters.md new file mode 100644 index 00000000..90282a5d --- /dev/null +++ b/docs/payment_request/PaymentRequestParameters.md @@ -0,0 +1,26 @@ +# PaymentRequestParameters +> xendit.payment_request.model.PaymentRequestParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | | | +| **reference_id** | **str** | | | | +| **amount** | **float** | | | | +| **payment_method** | [**PaymentMethodParameters**](PaymentMethodParameters.md) | | | | +| **description** | **str, none_type** | | | | +| **capture_method** | [**PaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | | | +| **initiator** | [**PaymentRequestInitiator**](PaymentRequestInitiator.md) | | | | +| **payment_method_id** | **str** | | | | +| **channel_properties** | [**PaymentRequestParametersChannelProperties**](PaymentRequestParametersChannelProperties.md) | | | | +| **shipping_information** | [**PaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | | | +| **items** | [**PaymentRequestBasket**](PaymentRequestBasket.md) | | | | +| **customer_id** | **str, none_type** | | | | +| **customer** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestParametersChannelProperties.md b/docs/payment_request/PaymentRequestParametersChannelProperties.md new file mode 100644 index 00000000..5889c03b --- /dev/null +++ b/docs/payment_request/PaymentRequestParametersChannelProperties.md @@ -0,0 +1,20 @@ +# PaymentRequestParametersChannelProperties +> xendit.payment_request.model.PaymentRequestParametersChannelProperties + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **success_return_url** | **str** | | URL where the end-customer is redirected if the authorization is successful | | +| **failure_return_url** | **str** | | URL where the end-customer is redirected if the authorization failed | | +| **cancel_return_url** | **str** | | URL where the end-customer is redirected if the authorization cancelled | | +| **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. | | +| **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. | | +| **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 | | +| **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. | | +| **cvv** | **str** | | Three digit code written on the back of the card (usually called CVV/CVN). | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md b/docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md new file mode 100644 index 00000000..b9eace28 --- /dev/null +++ b/docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md @@ -0,0 +1,13 @@ +# PaymentRequestParametersChannelPropertiesAllOf +> xendit.payment_request.model.PaymentRequestParametersChannelPropertiesAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **cvv** | **str** | | Three digit code written on the back of the card (usually called CVV/CVN). | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestShippingInformation.md b/docs/payment_request/PaymentRequestShippingInformation.md new file mode 100644 index 00000000..4a71f7c9 --- /dev/null +++ b/docs/payment_request/PaymentRequestShippingInformation.md @@ -0,0 +1,18 @@ +# PaymentRequestShippingInformation +> xendit.payment_request.model.PaymentRequestShippingInformation + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **country** | **str** | ☑️ | | | | +| **street_line1** | **str** | | | | +| **street_line2** | **str** | | | | +| **city** | **str** | | | | +| **province_state** | **str** | | | | +| **postal_code** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/PaymentRequestStatus.md b/docs/payment_request/PaymentRequestStatus.md new file mode 100644 index 00000000..ea6ae153 --- /dev/null +++ b/docs/payment_request/PaymentRequestStatus.md @@ -0,0 +1,31 @@ +# PaymentRequestStatus +> xendit.payment_request.model.PaymentRequestStatus + + + +## Enum + + + * `PENDING` (value: `"PENDING"`) + + * `REQUIRES_ACTION` (value: `"REQUIRES_ACTION"`) + + * `CANCELED` (value: `"CANCELED"`) + + * `SUCCEEDED` (value: `"SUCCEEDED"`) + + * `FAILED` (value: `"FAILED"`) + + * `VOIDED` (value: `"VOIDED"`) + + * `UNKNOWN` (value: `"UNKNOWN"`) + + * `AWAITING_CAPTURE` (value: `"AWAITING_CAPTURE"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/QRCode.md b/docs/payment_request/QRCode.md new file mode 100644 index 00000000..76b511d0 --- /dev/null +++ b/docs/payment_request/QRCode.md @@ -0,0 +1,15 @@ +# QRCode +> xendit.payment_request.model.QRCode + +QRCode Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | | +| **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/QRCodeChannelCode.md b/docs/payment_request/QRCodeChannelCode.md new file mode 100644 index 00000000..14c45709 --- /dev/null +++ b/docs/payment_request/QRCodeChannelCode.md @@ -0,0 +1,24 @@ +# QRCodeChannelCode +> xendit.payment_request.model.QRCodeChannelCode + +QR Code Channel Code + + +## Enum + + + * `DANA` (value: `"DANA"`) + + * `RCBC` (value: `"RCBC"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `PROMPTPAY` (value: `"PROMPTPAY"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/QRCodeChannelProperties.md b/docs/payment_request/QRCodeChannelProperties.md new file mode 100644 index 00000000..9180e942 --- /dev/null +++ b/docs/payment_request/QRCodeChannelProperties.md @@ -0,0 +1,15 @@ +# QRCodeChannelProperties +> xendit.payment_request.model.QRCodeChannelProperties + +QR Code Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **qr_string** | **str** | | | | +| **expires_at** | **datetime** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/QRCodeParameters.md b/docs/payment_request/QRCodeParameters.md new file mode 100644 index 00000000..3a125f28 --- /dev/null +++ b/docs/payment_request/QRCodeParameters.md @@ -0,0 +1,14 @@ +# QRCodeParameters +> xendit.payment_request.model.QRCodeParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**QRCodeChannelCode**](QRCodeChannelCode.md) | | | | +| **channel_properties** | [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/VirtualAccount.md b/docs/payment_request/VirtualAccount.md new file mode 100644 index 00000000..6d34b49d --- /dev/null +++ b/docs/payment_request/VirtualAccount.md @@ -0,0 +1,21 @@ +# VirtualAccount +> xendit.payment_request.model.VirtualAccount + +Virtual Account Payment Method Details + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | | +| **min_amount** | **float, none_type** | | | | +| **max_amount** | **float, none_type** | | | | +| **amount** | **float, none_type** | | | | +| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | +| **alternative_display_types** | **[str]** | | Alternative display requested for the virtual account | | +| **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/VirtualAccountAllOf.md b/docs/payment_request/VirtualAccountAllOf.md new file mode 100644 index 00000000..d66664f6 --- /dev/null +++ b/docs/payment_request/VirtualAccountAllOf.md @@ -0,0 +1,13 @@ +# VirtualAccountAllOf +> xendit.payment_request.model.VirtualAccountAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **alternative_displays** | [**[VirtualAccountAlternativeDisplay]**](VirtualAccountAlternativeDisplay.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/VirtualAccountAlternativeDisplay.md b/docs/payment_request/VirtualAccountAlternativeDisplay.md new file mode 100644 index 00000000..ac8d3126 --- /dev/null +++ b/docs/payment_request/VirtualAccountAlternativeDisplay.md @@ -0,0 +1,15 @@ +# VirtualAccountAlternativeDisplay +> xendit.payment_request.model.VirtualAccountAlternativeDisplay + +Alternative Display Object + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **type** | **str** | | Type of the alternative display [readonly] | "QR_STRING" | +| **data** | **str** | | Data payload of the given alternative display | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/VirtualAccountChannelCode.md b/docs/payment_request/VirtualAccountChannelCode.md new file mode 100644 index 00000000..23f35de1 --- /dev/null +++ b/docs/payment_request/VirtualAccountChannelCode.md @@ -0,0 +1,48 @@ +# VirtualAccountChannelCode +> xendit.payment_request.model.VirtualAccountChannelCode + +Virtual Account Channel Code + + +## Enum + + + * `BCA` (value: `"BCA"`) + + * `BJB` (value: `"BJB"`) + + * `BNI` (value: `"BNI"`) + + * `BRI` (value: `"BRI"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `PERMATA` (value: `"PERMATA"`) + + * `BSI` (value: `"BSI"`) + + * `CIMB` (value: `"CIMB"`) + + * `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) + + * `ARTAJASA` (value: `"ARTAJASA"`) + + * `PV` (value: `"PV"`) + + * `VIETCAPITAL` (value: `"VIETCAPITAL"`) + + * `WOORI` (value: `"WOORI"`) + + * `MSB` (value: `"MSB"`) + + * `STANDARD_CHARTERED` (value: `"STANDARD_CHARTERED"`) + + * `AMBANK` (value: `"AMBANK"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/VirtualAccountChannelProperties.md b/docs/payment_request/VirtualAccountChannelProperties.md new file mode 100644 index 00000000..f9385236 --- /dev/null +++ b/docs/payment_request/VirtualAccountChannelProperties.md @@ -0,0 +1,17 @@ +# VirtualAccountChannelProperties +> xendit.payment_request.model.VirtualAccountChannelProperties + +Virtual Account Channel Properties + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **customer_name** | **str** | ☑️ | Name of customer. | | | +| **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. | | +| **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. | | +| **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) | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payment_request/VirtualAccountParameters.md b/docs/payment_request/VirtualAccountParameters.md new file mode 100644 index 00000000..b4e7e57b --- /dev/null +++ b/docs/payment_request/VirtualAccountParameters.md @@ -0,0 +1,19 @@ +# VirtualAccountParameters +> xendit.payment_request.model.VirtualAccountParameters + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | | +| **channel_properties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | | +| **min_amount** | **float, none_type** | | | | +| **max_amount** | **float, none_type** | | | | +| **amount** | **float, none_type** | | | | +| **currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | +| **alternative_display_types** | **[str]** | | Alternative display requested for the virtual account | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/Channel.md b/docs/payout/Channel.md new file mode 100644 index 00000000..5e0dfcf8 --- /dev/null +++ b/docs/payout/Channel.md @@ -0,0 +1,18 @@ +# Channel +> xendit.payout.model.Channel + +Channel information where you can send the money to + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **channel_code** | **str** | ☑️ | Destination channel to send the money to, prefixed by ISO-3166 country code | | | +| **channel_category** | [**ChannelCategory**](ChannelCategory.md) | ☑️ | | | | +| **currency** | **str** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | | +| **channel_name** | **str** | ☑️ | Name of the destination channel | | | +| **amount_limits** | [**ChannelAmountLimits**](ChannelAmountLimits.md) | ☑️ | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/ChannelAccountType.md b/docs/payout/ChannelAccountType.md new file mode 100644 index 00000000..01b679c8 --- /dev/null +++ b/docs/payout/ChannelAccountType.md @@ -0,0 +1,26 @@ +# ChannelAccountType +> xendit.payout.model.ChannelAccountType + +Available account types (applicable for MY_DUITNOW) + + +## Enum + + + * `NATIONAL_ID` (value: `"NATIONAL_ID"`) + + * `MOBILE_NO` (value: `"MOBILE_NO"`) + + * `PASSPORT` (value: `"PASSPORT"`) + + * `BUSINESS_REGISTRATION` (value: `"BUSINESS_REGISTRATION"`) + + * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/ChannelAmountLimits.md b/docs/payout/ChannelAmountLimits.md new file mode 100644 index 00000000..93328a6a --- /dev/null +++ b/docs/payout/ChannelAmountLimits.md @@ -0,0 +1,16 @@ +# ChannelAmountLimits +> xendit.payout.model.ChannelAmountLimits + +Supported amount ranges for payouts to this channel + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **minimum** | **float** | ☑️ | Lowest amount supported for a payout to this channel | | | +| **maximum** | **float** | ☑️ | Highest amount supported for a payout to this channel | | | +| **minimum_increment** | **float** | ☑️ | Supported increments | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/ChannelCategory.md b/docs/payout/ChannelCategory.md new file mode 100644 index 00000000..b688de63 --- /dev/null +++ b/docs/payout/ChannelCategory.md @@ -0,0 +1,22 @@ +# ChannelCategory +> xendit.payout.model.ChannelCategory + +Category of channel code, as some channels might require more fields during processing + + +## Enum + + + * `BANK` (value: `"BANK"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `OTC` (value: `"OTC"`) + + * `XenditEnumDefaultFallback` (value: `UNKNOWN_ENUM_VALUE`) + +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. + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/CreatePayoutRequest.md b/docs/payout/CreatePayoutRequest.md new file mode 100644 index 00000000..70d190b6 --- /dev/null +++ b/docs/payout/CreatePayoutRequest.md @@ -0,0 +1,21 @@ +# CreatePayoutRequest +> xendit.payout.model.CreatePayoutRequest + +Information needed by Xendit to send money to the destination channel provided + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **reference_id** | **str** | ☑️ | A client defined payout identifier | | | +| **channel_code** | **str** | ☑️ | Channel code of selected destination bank or e-wallet | | | +| **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | ☑️ | | | | +| **amount** | **float** | ☑️ | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | | +| **currency** | **str** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | | +| **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 | | +| **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | Object of additional information you may use | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/DigitalPayoutChannelProperties.md b/docs/payout/DigitalPayoutChannelProperties.md new file mode 100644 index 00000000..dd1fb59a --- /dev/null +++ b/docs/payout/DigitalPayoutChannelProperties.md @@ -0,0 +1,16 @@ +# DigitalPayoutChannelProperties +> xendit.payout.model.DigitalPayoutChannelProperties + +Channel information for digital destinations (banks, e-wallets) + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **account_number** | **str** | ☑️ | Registered account number | | | +| **account_holder_name** | **str, none_type** | | Registered account name | | +| **account_type** | [**ChannelAccountType**](ChannelAccountType.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/Error.md b/docs/payout/Error.md new file mode 100644 index 00000000..2ae6e4af --- /dev/null +++ b/docs/payout/Error.md @@ -0,0 +1,15 @@ +# Error +> xendit.payout.model.Error + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **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 | | | +| **message** | **str** | ☑️ | Human readable error message | | | +| **errors** | [**[ErrorErrorsInner]**](ErrorErrorsInner.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/ErrorErrorsInner.md b/docs/payout/ErrorErrorsInner.md new file mode 100644 index 00000000..2430b165 --- /dev/null +++ b/docs/payout/ErrorErrorsInner.md @@ -0,0 +1,14 @@ +# ErrorErrorsInner +> xendit.payout.model.ErrorErrorsInner + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **path** | **str** | ☑️ | Precise location of the error | | | +| **message** | **str** | ☑️ | Specific description of the error | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/GetPayouts200Response.md b/docs/payout/GetPayouts200Response.md new file mode 100644 index 00000000..2f4237ac --- /dev/null +++ b/docs/payout/GetPayouts200Response.md @@ -0,0 +1,15 @@ +# GetPayouts200Response +> xendit.payout.model.GetPayouts200Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **data** | [**[GetPayouts200ResponseDataInner]**](GetPayouts200ResponseDataInner.md) | | | | +| **has_more** | **bool** | | | | +| **links** | [**GetPayouts200ResponseLinks**](GetPayouts200ResponseLinks.md) | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/GetPayouts200ResponseDataInner.md b/docs/payout/GetPayouts200ResponseDataInner.md new file mode 100644 index 00000000..ed5d122c --- /dev/null +++ b/docs/payout/GetPayouts200ResponseDataInner.md @@ -0,0 +1,27 @@ +# GetPayouts200ResponseDataInner +> xendit.payout.model.GetPayouts200ResponseDataInner + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **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 | | +| **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | Object of additional information you may use | | +| **failure_code** | **str** | | If the Payout failed, we include a failure code for more details on the failure. | | +| **estimated_arrival_time** | **datetime** | | Our estimated time on to when your payout is reflected to the destination account | | +| **reference_id** | **str** | | A client defined payout identifier | | +| **channel_code** | **str** | | Channel code of selected destination bank or e-wallet | | +| **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | | | | +| **amount** | **float** | | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | +| **currency** | **str** | | Currency of the destination channel using ISO-4217 currency code | | +| **id** | **str** | | Xendit-generated unique identifier for each payout | | +| **created** | **datetime** | | The time payout was created on Xendit's system, in ISO 8601 format | | +| **updated** | **datetime** | | The time payout was last updated on Xendit's system, in ISO 8601 format | | +| **business_id** | **str** | | Xendit Business ID | | +| **status** | **str** | | Status of payout | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/GetPayouts200ResponseLinks.md b/docs/payout/GetPayouts200ResponseLinks.md new file mode 100644 index 00000000..915157fd --- /dev/null +++ b/docs/payout/GetPayouts200ResponseLinks.md @@ -0,0 +1,15 @@ +# GetPayouts200ResponseLinks +> xendit.payout.model.GetPayouts200ResponseLinks + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **href** | **str** | | | | +| **rel** | **str** | | | | +| **method** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/Payout.md b/docs/payout/Payout.md new file mode 100644 index 00000000..43c01554 --- /dev/null +++ b/docs/payout/Payout.md @@ -0,0 +1,27 @@ +# Payout +> xendit.payout.model.Payout + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **reference_id** | **str** | ☑️ | A client defined payout identifier | | | +| **channel_code** | **str** | ☑️ | Channel code of selected destination bank or e-wallet | | | +| **channel_properties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | ☑️ | | | | +| **amount** | **float** | ☑️ | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | | +| **currency** | **str** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | | +| **id** | **str** | ☑️ | Xendit-generated unique identifier for each payout | | | +| **created** | **datetime** | ☑️ | The time payout was created on Xendit's system, in ISO 8601 format | | | +| **updated** | **datetime** | ☑️ | The time payout was last updated on Xendit's system, in ISO 8601 format | | | +| **business_id** | **str** | ☑️ | Xendit Business ID | | | +| **status** | **str** | ☑️ | Status of payout | | | +| **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 | | +| **receipt_notification** | [**ReceiptNotification**](ReceiptNotification.md) | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | Object of additional information you may use | | +| **failure_code** | **str** | | If the Payout failed, we include a failure code for more details on the failure. | | +| **estimated_arrival_time** | **datetime** | | Our estimated time on to when your payout is reflected to the destination account | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/PayoutAllOf.md b/docs/payout/PayoutAllOf.md new file mode 100644 index 00000000..2e441836 --- /dev/null +++ b/docs/payout/PayoutAllOf.md @@ -0,0 +1,19 @@ +# PayoutAllOf +> xendit.payout.model.PayoutAllOf + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **id** | **str** | ☑️ | Xendit-generated unique identifier for each payout | | | +| **created** | **datetime** | ☑️ | The time payout was created on Xendit's system, in ISO 8601 format | | | +| **updated** | **datetime** | ☑️ | The time payout was last updated on Xendit's system, in ISO 8601 format | | | +| **business_id** | **str** | ☑️ | Xendit Business ID | | | +| **status** | **str** | ☑️ | Status of payout | | | +| **failure_code** | **str** | | If the Payout failed, we include a failure code for more details on the failure. | | +| **estimated_arrival_time** | **datetime** | | Our estimated time on to when your payout is reflected to the destination account | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/payout/ReceiptNotification.md b/docs/payout/ReceiptNotification.md new file mode 100644 index 00000000..0eea1a7b --- /dev/null +++ b/docs/payout/ReceiptNotification.md @@ -0,0 +1,16 @@ +# ReceiptNotification +> xendit.payout.model.ReceiptNotification + +Additional notification for completed payout + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **email_to** | **[str], none_type** | | Valid email address to send the payout receipt | | +| **email_cc** | **[str], none_type** | | Valid email address to cc the payout receipt | | +| **email_bcc** | **[str], none_type** | | Valid email address to bcc the payout receipt | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/refund/CreateRefund.md b/docs/refund/CreateRefund.md new file mode 100644 index 00000000..dd15b1b9 --- /dev/null +++ b/docs/refund/CreateRefund.md @@ -0,0 +1,19 @@ +# CreateRefund +> xendit.refund.model.CreateRefund + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **payment_request_id** | **str** | | | | +| **invoice_id** | **str** | | | | +| **reference_id** | **str** | | | | +| **amount** | **float** | | | | +| **currency** | **str** | | | | +| **reason** | **str** | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/refund/CreateRefund400Response.md b/docs/refund/CreateRefund400Response.md new file mode 100644 index 00000000..71727244 --- /dev/null +++ b/docs/refund/CreateRefund400Response.md @@ -0,0 +1,14 @@ +# CreateRefund400Response +> xendit.refund.model.CreateRefund400Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/refund/CreateRefund403Response.md b/docs/refund/CreateRefund403Response.md new file mode 100644 index 00000000..ddb84da3 --- /dev/null +++ b/docs/refund/CreateRefund403Response.md @@ -0,0 +1,14 @@ +# CreateRefund403Response +> xendit.refund.model.CreateRefund403Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | "UNAUTHORIZED" | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/refund/CreateRefund404Response.md b/docs/refund/CreateRefund404Response.md new file mode 100644 index 00000000..707cce78 --- /dev/null +++ b/docs/refund/CreateRefund404Response.md @@ -0,0 +1,14 @@ +# CreateRefund404Response +> xendit.refund.model.CreateRefund404Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | "DATA_NOT_FOUND" | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/refund/CreateRefund409Response.md b/docs/refund/CreateRefund409Response.md new file mode 100644 index 00000000..6cdc46e1 --- /dev/null +++ b/docs/refund/CreateRefund409Response.md @@ -0,0 +1,14 @@ +# CreateRefund409Response +> xendit.refund.model.CreateRefund409Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/refund/CreateRefund503Response.md b/docs/refund/CreateRefund503Response.md new file mode 100644 index 00000000..800595f6 --- /dev/null +++ b/docs/refund/CreateRefund503Response.md @@ -0,0 +1,14 @@ +# CreateRefund503Response +> xendit.refund.model.CreateRefund503Response + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/refund/GetAllRefundsDefaultResponse.md b/docs/refund/GetAllRefundsDefaultResponse.md new file mode 100644 index 00000000..d0c0eac3 --- /dev/null +++ b/docs/refund/GetAllRefundsDefaultResponse.md @@ -0,0 +1,14 @@ +# GetAllRefundsDefaultResponse +> xendit.refund.model.GetAllRefundsDefaultResponse + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **error_code** | **str** | | | | +| **message** | **str** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/refund/Refund.md b/docs/refund/Refund.md new file mode 100644 index 00000000..fc040e71 --- /dev/null +++ b/docs/refund/Refund.md @@ -0,0 +1,24 @@ +# Refund +> xendit.refund.model.Refund + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **id** | **str** | | | | +| **payment_request_id** | **str** | | | | +| **amount** | **float** | | | | +| **channel_code** | **str** | | | | +| **country** | **str** | | | | +| **currency** | **str** | | | | +| **reference_id** | **str, none_type** | | | | +| **failure_code** | **str, none_type** | | | | +| **refund_fee_amount** | **float, none_type** | | | | +| **created** | **str** | | | | +| **updated** | **str** | | | | +| **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/refund/RefundList.md b/docs/refund/RefundList.md new file mode 100644 index 00000000..5460589b --- /dev/null +++ b/docs/refund/RefundList.md @@ -0,0 +1,14 @@ +# RefundList +> xendit.refund.model.RefundList + + +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **data** | [**[Refund]**](Refund.md) | ☑️ | | | | +| **has_more** | **bool** | | | | + + +[[Back to README]](../../README.md) + + diff --git a/docs/header.jpg b/images/header.jpg similarity index 100% rename from docs/header.jpg rename to images/header.jpg diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..9caec711 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,34 @@ +[tool.poetry] +name = "xendit-python" +version = "3.6.0" +description = "Xendit REST API Client for Python - Invoice, Payment Request, Payment Method, Refund, Balance, Transaction, Customer, and Payout Services https://xendit.github.io/apireference/" +authors = ["DevX Team "] +license = "MIT" +repository = "https://github.com/xendit/xendit-python" +readme = "README.md" +keywords = ["xendit", "sdk"] +classifiers = [ + "Intended Audience :: Developers", + "Operating System :: OS Independent", + "Programming Language :: Python :: 3.10" +] +packages = [ + { include = "xendit" } +] + +[tool.poetry.dependencies] +python = "^3.10" +requests = "^2.23.0" + +[tool.poetry.dev-dependencies] +black = "^19.10b0" +pytest = "^5.4.3" +flake8 = "^3.8.3" +pytest-mock = "^3.1.1" +pre-commit = "^2.5.1" +responses = "^0.10.15" +pytest-cov = "^2.10.0" + +[build-system] +requires = ["poetry-core>=1.0.0a5"] +build-backend = "poetry.core.masonry.api" \ No newline at end of file diff --git a/setup.py b/setup.py index 060570db..e050ceca 100644 --- a/setup.py +++ b/setup.py @@ -1,12 +1,12 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ from setuptools import setup, find_packages # noqa: H301 NAME = "xendit" -VERSION = "3.4.0" +VERSION = "3.6.0" # To install the library, run the following # # python setup.py install diff --git a/test/test_balance.py b/test/test_balance.py index 970d86ca..00b05e0a 100644 --- a/test/test_balance.py +++ b/test/test_balance.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_balance_api.py b/test/test_balance_api.py index 113d9897..b34421b8 100644 --- a/test/test_balance_api.py +++ b/test/test_balance_api.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_billing_information.py b/test/test_billing_information.py index 8eefb474..ae4a70e3 100644 --- a/test/test_billing_information.py +++ b/test/test_billing_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_capture.py b/test/test_capture.py index d7e3dada..67b5fae3 100644 --- a/test/test_capture.py +++ b/test/test_capture.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_capture_list.py b/test/test_capture_list.py index c243aea3..73f1c73e 100644 --- a/test/test_capture_list.py +++ b/test/test_capture_list.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_capture_list_response.py b/test/test_capture_list_response.py index 5379cf2f..e7e7bd5e 100644 --- a/test/test_capture_list_response.py +++ b/test/test_capture_list_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_capture_parameters.py b/test/test_capture_parameters.py index f9f2ecab..162b05ff 100644 --- a/test/test_capture_parameters.py +++ b/test/test_capture_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_card.py b/test/test_card.py index 202b73a4..408df511 100644 --- a/test/test_card.py +++ b/test/test_card.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_card_channel_properties.py b/test/test_card_channel_properties.py index c4cd53ce..41ea4cc6 100644 --- a/test/test_card_channel_properties.py +++ b/test/test_card_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_card_information.py b/test/test_card_information.py index f8ebb0b2..24106cdd 100644 --- a/test/test_card_information.py +++ b/test/test_card_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_card_parameters.py b/test/test_card_parameters.py index 3d5bf2e4..9fbb7667 100644 --- a/test/test_card_parameters.py +++ b/test/test_card_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_card_parameters_card_information.py b/test/test_card_parameters_card_information.py index ec8042c3..7fa78efa 100644 --- a/test/test_card_parameters_card_information.py +++ b/test/test_card_parameters_card_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_card_verification_results.py b/test/test_card_verification_results.py index db032502..7d98e5d6 100644 --- a/test/test_card_verification_results.py +++ b/test/test_card_verification_results.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_card_verification_results_three_d_secure.py b/test/test_card_verification_results_three_d_secure.py index d0c429e6..ddf2749d 100644 --- a/test/test_card_verification_results_three_d_secure.py +++ b/test/test_card_verification_results_three_d_secure.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_channels_categories.py b/test/test_channels_categories.py index 2c8d3739..f97aedf6 100644 --- a/test/test_channels_categories.py +++ b/test/test_channels_categories.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_create_payment_method409_response.py b/test/test_create_payment_method409_response.py index 2013789a..9d156b3e 100644 --- a/test/test_create_payment_method409_response.py +++ b/test/test_create_payment_method409_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_create_payment_method503_response.py b/test/test_create_payment_method503_response.py index ee98515c..172b10f4 100644 --- a/test/test_create_payment_method503_response.py +++ b/test/test_create_payment_method503_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_currency.py b/test/test_currency.py index bcdadeb3..caba098c 100644 --- a/test/test_currency.py +++ b/test/test_currency.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_date_range_filter.py b/test/test_date_range_filter.py index 91b95a84..e58a048c 100644 --- a/test/test_date_range_filter.py +++ b/test/test_date_range_filter.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_direct_debit_all_of.py b/test/test_direct_debit_all_of.py index e6a3a4cf..d7873e17 100644 --- a/test/test_direct_debit_all_of.py +++ b/test/test_direct_debit_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_direct_debit_bank_account.py b/test/test_direct_debit_bank_account.py index 718a94b9..d3b50464 100644 --- a/test/test_direct_debit_bank_account.py +++ b/test/test_direct_debit_bank_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_direct_debit_channel_code.py b/test/test_direct_debit_channel_code.py index 76230407..0030f831 100644 --- a/test/test_direct_debit_channel_code.py +++ b/test/test_direct_debit_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_direct_debit_channel_properties.py b/test/test_direct_debit_channel_properties.py index a3d5964b..88017a4b 100644 --- a/test/test_direct_debit_channel_properties.py +++ b/test/test_direct_debit_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_direct_debit_channel_properties_bank_account.py b/test/test_direct_debit_channel_properties_bank_account.py index 65818763..3d7e4b13 100644 --- a/test/test_direct_debit_channel_properties_bank_account.py +++ b/test/test_direct_debit_channel_properties_bank_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_direct_debit_channel_properties_bank_redirect.py b/test/test_direct_debit_channel_properties_bank_redirect.py index 0d2a7e3f..d544899d 100644 --- a/test/test_direct_debit_channel_properties_bank_redirect.py +++ b/test/test_direct_debit_channel_properties_bank_redirect.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_direct_debit_channel_properties_debit_card.py b/test/test_direct_debit_channel_properties_debit_card.py index cf5a8e0d..c79d80ec 100644 --- a/test/test_direct_debit_channel_properties_debit_card.py +++ b/test/test_direct_debit_channel_properties_debit_card.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_direct_debit_debit_card.py b/test/test_direct_debit_debit_card.py index afa9318b..4af4e34e 100644 --- a/test/test_direct_debit_debit_card.py +++ b/test/test_direct_debit_debit_card.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_direct_debit_parameters.py b/test/test_direct_debit_parameters.py index 931e4c51..2e3ecb26 100644 --- a/test/test_direct_debit_parameters.py +++ b/test/test_direct_debit_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_e_wallet.py b/test/test_e_wallet.py index eeea99aa..b85a75e8 100644 --- a/test/test_e_wallet.py +++ b/test/test_e_wallet.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_e_wallet_account.py b/test/test_e_wallet_account.py index 3bd7aa7d..e65b3d7a 100644 --- a/test/test_e_wallet_account.py +++ b/test/test_e_wallet_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_e_wallet_all_of.py b/test/test_e_wallet_all_of.py index fd702628..3f8eda7f 100644 --- a/test/test_e_wallet_all_of.py +++ b/test/test_e_wallet_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_e_wallet_channel_code.py b/test/test_e_wallet_channel_code.py index c2fc01c1..cdfe24c7 100644 --- a/test/test_e_wallet_channel_code.py +++ b/test/test_e_wallet_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_e_wallet_channel_properties.py b/test/test_e_wallet_channel_properties.py index de46eaf9..3639ae84 100644 --- a/test/test_e_wallet_channel_properties.py +++ b/test/test_e_wallet_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_e_wallet_parameters.py b/test/test_e_wallet_parameters.py index 4dc5fcbd..3b95e264 100644 --- a/test/test_e_wallet_parameters.py +++ b/test/test_e_wallet_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_fee_response.py b/test/test_fee_response.py index f614de2c..fb109c7d 100644 --- a/test/test_fee_response.py +++ b/test/test_fee_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_get_all_payment_methods400_response.py b/test/test_get_all_payment_methods400_response.py index df296b1a..7b1a37d9 100644 --- a/test/test_get_all_payment_methods400_response.py +++ b/test/test_get_all_payment_methods400_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_get_all_payment_methods403_response.py b/test/test_get_all_payment_methods403_response.py index 118bbf35..d38331b1 100644 --- a/test/test_get_all_payment_methods403_response.py +++ b/test/test_get_all_payment_methods403_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_get_all_payment_methods404_response.py b/test/test_get_all_payment_methods404_response.py index c891f2bc..ee415fe6 100644 --- a/test/test_get_all_payment_methods404_response.py +++ b/test/test_get_all_payment_methods404_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_get_all_payment_methods_default_response.py b/test/test_get_all_payment_methods_default_response.py index a2e9932a..cb849a02 100644 --- a/test/test_get_all_payment_methods_default_response.py +++ b/test/test_get_all_payment_methods_default_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_link_item.py b/test/test_link_item.py index 38aefe4f..6e761d18 100644 --- a/test/test_link_item.py +++ b/test/test_link_item.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_over_the_counter.py b/test/test_over_the_counter.py index 7009a2ba..8f3e7962 100644 --- a/test/test_over_the_counter.py +++ b/test/test_over_the_counter.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_over_the_counter_channel_code.py b/test/test_over_the_counter_channel_code.py index 64fa3a33..0ddb6449 100644 --- a/test/test_over_the_counter_channel_code.py +++ b/test/test_over_the_counter_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_over_the_counter_channel_properties.py b/test/test_over_the_counter_channel_properties.py index 1b404610..d8e1edda 100644 --- a/test/test_over_the_counter_channel_properties.py +++ b/test/test_over_the_counter_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_over_the_counter_channel_properties_update.py b/test/test_over_the_counter_channel_properties_update.py index 59cb6c17..7cbe1d31 100644 --- a/test/test_over_the_counter_channel_properties_update.py +++ b/test/test_over_the_counter_channel_properties_update.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_over_the_counter_parameters.py b/test/test_over_the_counter_parameters.py index 8c603722..dff153f5 100644 --- a/test/test_over_the_counter_parameters.py +++ b/test/test_over_the_counter_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_over_the_counter_update_parameters.py b/test/test_over_the_counter_update_parameters.py index ed788ffa..e8588149 100644 --- a/test/test_over_the_counter_update_parameters.py +++ b/test/test_over_the_counter_update_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method.py b/test/test_payment_method.py index feb3e14e..ae722210 100644 --- a/test/test_payment_method.py +++ b/test/test_payment_method.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_action.py b/test/test_payment_method_action.py index 52cd3fbb..99dbc78c 100644 --- a/test/test_payment_method_action.py +++ b/test/test_payment_method_action.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_api.py b/test/test_payment_method_api.py index 0cae02fc..67db12a6 100644 --- a/test/test_payment_method_api.py +++ b/test/test_payment_method_api.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_auth_parameters.py b/test/test_payment_method_auth_parameters.py index cbfccea4..18a6a137 100644 --- a/test/test_payment_method_auth_parameters.py +++ b/test/test_payment_method_auth_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_country.py b/test/test_payment_method_country.py index 3be887d8..028acce7 100644 --- a/test/test_payment_method_country.py +++ b/test/test_payment_method_country.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_expire_parameters.py b/test/test_payment_method_expire_parameters.py index 319a7a26..13e63f54 100644 --- a/test/test_payment_method_expire_parameters.py +++ b/test/test_payment_method_expire_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_list.py b/test/test_payment_method_list.py index f7803ac5..054ec224 100644 --- a/test/test_payment_method_list.py +++ b/test/test_payment_method_list.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_parameters.py b/test/test_payment_method_parameters.py index cbe976fa..292f10b2 100644 --- a/test/test_payment_method_parameters.py +++ b/test/test_payment_method_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_reusability.py b/test/test_payment_method_reusability.py index 5e1207d0..19dc4756 100644 --- a/test/test_payment_method_reusability.py +++ b/test/test_payment_method_reusability.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_status.py b/test/test_payment_method_status.py index 537b1535..31708fee 100644 --- a/test/test_payment_method_status.py +++ b/test/test_payment_method_status.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_type.py b/test/test_payment_method_type.py index 678cc140..a80a3d60 100644 --- a/test/test_payment_method_type.py +++ b/test/test_payment_method_type.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_method_update_parameters.py b/test/test_payment_method_update_parameters.py index 602076b8..be8e00f7 100644 --- a/test/test_payment_method_update_parameters.py +++ b/test/test_payment_method_update_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_payment_request.py b/test/test_payment_request.py index 8603cf84..ff8ba1da 100644 --- a/test/test_payment_request.py +++ b/test/test_payment_request.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_action.py b/test/test_payment_request_action.py index 367089aa..da78421a 100644 --- a/test/test_payment_request_action.py +++ b/test/test_payment_request_action.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_api.py b/test/test_payment_request_api.py index bac0710d..b443219b 100644 --- a/test/test_payment_request_api.py +++ b/test/test_payment_request_api.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_auth_parameters.py b/test/test_payment_request_auth_parameters.py index aca870e5..5575ba9c 100644 --- a/test/test_payment_request_auth_parameters.py +++ b/test/test_payment_request_auth_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_basket.py b/test/test_payment_request_basket.py index e6cbb5ad..8a49c424 100644 --- a/test/test_payment_request_basket.py +++ b/test/test_payment_request_basket.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_basket_item.py b/test/test_payment_request_basket_item.py index c20a6b0c..ac8f289b 100644 --- a/test/test_payment_request_basket_item.py +++ b/test/test_payment_request_basket_item.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_capture_method.py b/test/test_payment_request_capture_method.py index 7c1c73d0..49c95b7e 100644 --- a/test/test_payment_request_capture_method.py +++ b/test/test_payment_request_capture_method.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_card_verification_results.py b/test/test_payment_request_card_verification_results.py index f5784be0..fd262a98 100644 --- a/test/test_payment_request_card_verification_results.py +++ b/test/test_payment_request_card_verification_results.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_card_verification_results_three_dee_secure.py b/test/test_payment_request_card_verification_results_three_dee_secure.py index f5f803ab..8c317298 100644 --- a/test/test_payment_request_card_verification_results_three_dee_secure.py +++ b/test/test_payment_request_card_verification_results_three_dee_secure.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_channel_properties.py b/test/test_payment_request_channel_properties.py index 8af6c369..19c862f4 100644 --- a/test/test_payment_request_channel_properties.py +++ b/test/test_payment_request_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_country.py b/test/test_payment_request_country.py index f2b96a4a..5608b9eb 100644 --- a/test/test_payment_request_country.py +++ b/test/test_payment_request_country.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_currency.py b/test/test_payment_request_currency.py index 3aa96c85..0f043ce3 100644 --- a/test/test_payment_request_currency.py +++ b/test/test_payment_request_currency.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_initiator.py b/test/test_payment_request_initiator.py index 9f10995a..1b91557e 100644 --- a/test/test_payment_request_initiator.py +++ b/test/test_payment_request_initiator.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_list_response.py b/test/test_payment_request_list_response.py index a6801167..7ec882c8 100644 --- a/test/test_payment_request_list_response.py +++ b/test/test_payment_request_list_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_parameters.py b/test/test_payment_request_parameters.py index e63ea346..06554f45 100644 --- a/test/test_payment_request_parameters.py +++ b/test/test_payment_request_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_parameters_channel_properties.py b/test/test_payment_request_parameters_channel_properties.py index 339e3552..925e6c4b 100644 --- a/test/test_payment_request_parameters_channel_properties.py +++ b/test/test_payment_request_parameters_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_parameters_channel_properties_all_of.py b/test/test_payment_request_parameters_channel_properties_all_of.py index 1b5f5551..90cc78d5 100644 --- a/test/test_payment_request_parameters_channel_properties_all_of.py +++ b/test/test_payment_request_parameters_channel_properties_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_shipping_information.py b/test/test_payment_request_shipping_information.py index ebdbf8d5..41498a39 100644 --- a/test/test_payment_request_shipping_information.py +++ b/test/test_payment_request_shipping_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_payment_request_status.py b/test/test_payment_request_status.py index 9360fe33..6a3682b8 100644 --- a/test/test_payment_request_status.py +++ b/test/test_payment_request_status.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/test/test_qr_code_channel_code.py b/test/test_qr_code_channel_code.py index bf010269..1734949e 100644 --- a/test/test_qr_code_channel_code.py +++ b/test/test_qr_code_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_qr_code_channel_properties.py b/test/test_qr_code_channel_properties.py index 754b4dc3..2629d301 100644 --- a/test/test_qr_code_channel_properties.py +++ b/test/test_qr_code_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_qr_code_parameters.py b/test/test_qr_code_parameters.py index 7adf5094..6ebc35b2 100644 --- a/test/test_qr_code_parameters.py +++ b/test/test_qr_code_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_server_error.py b/test/test_server_error.py index 1d995010..c371e42e 100644 --- a/test/test_server_error.py +++ b/test/test_server_error.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_simulate_payment_request.py b/test/test_simulate_payment_request.py index eaed17d6..9eb63695 100644 --- a/test/test_simulate_payment_request.py +++ b/test/test_simulate_payment_request.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_tokenized_card_information.py b/test/test_tokenized_card_information.py index 43802f5c..651b62c8 100644 --- a/test/test_tokenized_card_information.py +++ b/test/test_tokenized_card_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_transaction_api.py b/test/test_transaction_api.py index 364a9a29..bbc6490b 100644 --- a/test/test_transaction_api.py +++ b/test/test_transaction_api.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_transaction_id.py b/test/test_transaction_id.py index 87dc541f..1db895dc 100644 --- a/test/test_transaction_id.py +++ b/test/test_transaction_id.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_transaction_response.py b/test/test_transaction_response.py index e5597c61..064a9e19 100644 --- a/test/test_transaction_response.py +++ b/test/test_transaction_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_transaction_response_type.py b/test/test_transaction_response_type.py index d16fc3aa..e6d953a3 100644 --- a/test/test_transaction_response_type.py +++ b/test/test_transaction_response_type.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_transaction_statuses.py b/test/test_transaction_statuses.py index f1e5b314..4e275d8f 100644 --- a/test/test_transaction_statuses.py +++ b/test/test_transaction_statuses.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_transaction_types.py b/test/test_transaction_types.py index fd5fc188..9012bcd7 100644 --- a/test/test_transaction_types.py +++ b/test/test_transaction_types.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_transactions_response.py b/test/test_transactions_response.py index 67ef9be6..d5946592 100644 --- a/test/test_transactions_response.py +++ b/test/test_transactions_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_validation_error.py b/test/test_validation_error.py index f4910b03..b097e603 100644 --- a/test/test_validation_error.py +++ b/test/test_validation_error.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/test/test_virtual_account.py b/test/test_virtual_account.py index 7b91958d..30226301 100644 --- a/test/test_virtual_account.py +++ b/test/test_virtual_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_virtual_account_all_of.py b/test/test_virtual_account_all_of.py index 329680d1..01594256 100644 --- a/test/test_virtual_account_all_of.py +++ b/test/test_virtual_account_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_virtual_account_alternative_display.py b/test/test_virtual_account_alternative_display.py index c6f0dbf7..32e39fe9 100644 --- a/test/test_virtual_account_alternative_display.py +++ b/test/test_virtual_account_alternative_display.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_virtual_account_channel_code.py b/test/test_virtual_account_channel_code.py index 4f8be622..3ed73f5e 100644 --- a/test/test_virtual_account_channel_code.py +++ b/test/test_virtual_account_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_virtual_account_channel_properties.py b/test/test_virtual_account_channel_properties.py index dbdb13b6..28c71cb1 100644 --- a/test/test_virtual_account_channel_properties.py +++ b/test/test_virtual_account_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_virtual_account_channel_properties_patch.py b/test/test_virtual_account_channel_properties_patch.py index 7ca9e9a6..a61e29a3 100644 --- a/test/test_virtual_account_channel_properties_patch.py +++ b/test/test_virtual_account_channel_properties_patch.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_virtual_account_parameters.py b/test/test_virtual_account_parameters.py index 350a71a0..06e4f8c2 100644 --- a/test/test_virtual_account_parameters.py +++ b/test/test_virtual_account_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/test/test_virtual_account_update_parameters.py b/test/test_virtual_account_update_parameters.py index 617e1169..6163a639 100644 --- a/test/test_virtual_account_update_parameters.py +++ b/test/test_virtual_account_update_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/__init__.py b/xendit/__init__.py index 7ee790f1..c4e3ad63 100644 --- a/xendit/__init__.py +++ b/xendit/__init__.py @@ -1,11 +1,11 @@ # flake8: noqa """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ -__version__ = "3.4.0" +__version__ = "3.6.0" # import ApiClient from xendit.api_client import ApiClient diff --git a/xendit/api_client.py b/xendit/api_client.py index 534b416d..7246bd92 100644 --- a/xendit/api_client.py +++ b/xendit/api_client.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ @@ -74,11 +74,11 @@ def __init__(self, configuration=None, header_name=None, header_value=None, # XENDIT headers self.default_headers['xendit-lib'] = 'python' - self.default_headers['xendit-lib-ver'] = '3.4.0' + self.default_headers['xendit-lib-ver'] = '3.6.0' self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/3.4.0/python' + self.user_agent = 'OpenAPI-Generator/3.6.0/python' def __enter__(self): return self diff --git a/xendit/balance_and_transaction/balance_api.py b/xendit/balance_and_transaction/balance_api.py index eda94a60..57ba6d20 100644 --- a/xendit/balance_and_transaction/balance_api.py +++ b/xendit/balance_and_transaction/balance_api.py @@ -3,7 +3,7 @@ # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint # noqa: E501 - The version of the OpenAPI document: 3.4.3 + The version of the OpenAPI document: 3.5.0 """ import re # noqa: F401 diff --git a/xendit/balance_and_transaction/model/balance.py b/xendit/balance_and_transaction/model/balance.py index 059328b3..dac356c5 100644 --- a/xendit/balance_and_transaction/model/balance.py +++ b/xendit/balance_and_transaction/model/balance.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/channels_categories.py b/xendit/balance_and_transaction/model/channels_categories.py index 92011ce4..9c494d53 100644 --- a/xendit/balance_and_transaction/model/channels_categories.py +++ b/xendit/balance_and_transaction/model/channels_categories.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/currency.py b/xendit/balance_and_transaction/model/currency.py index 0c07119d..f1581fb3 100644 --- a/xendit/balance_and_transaction/model/currency.py +++ b/xendit/balance_and_transaction/model/currency.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/date_range_filter.py b/xendit/balance_and_transaction/model/date_range_filter.py index 734ee6fd..1f10e099 100644 --- a/xendit/balance_and_transaction/model/date_range_filter.py +++ b/xendit/balance_and_transaction/model/date_range_filter.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/fee_response.py b/xendit/balance_and_transaction/model/fee_response.py index df473f06..1f2bc11f 100644 --- a/xendit/balance_and_transaction/model/fee_response.py +++ b/xendit/balance_and_transaction/model/fee_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/link_item.py b/xendit/balance_and_transaction/model/link_item.py index 93c58bb5..857d9a23 100644 --- a/xendit/balance_and_transaction/model/link_item.py +++ b/xendit/balance_and_transaction/model/link_item.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/server_error.py b/xendit/balance_and_transaction/model/server_error.py index 965a04ff..f75a1005 100644 --- a/xendit/balance_and_transaction/model/server_error.py +++ b/xendit/balance_and_transaction/model/server_error.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/transaction_id.py b/xendit/balance_and_transaction/model/transaction_id.py index 31ae7942..eccae1d7 100644 --- a/xendit/balance_and_transaction/model/transaction_id.py +++ b/xendit/balance_and_transaction/model/transaction_id.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/transaction_response.py b/xendit/balance_and_transaction/model/transaction_response.py index 1c1ca5c6..35a7d220 100644 --- a/xendit/balance_and_transaction/model/transaction_response.py +++ b/xendit/balance_and_transaction/model/transaction_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/transaction_response_type.py b/xendit/balance_and_transaction/model/transaction_response_type.py index eebc5ba8..a3564cfd 100644 --- a/xendit/balance_and_transaction/model/transaction_response_type.py +++ b/xendit/balance_and_transaction/model/transaction_response_type.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/transaction_statuses.py b/xendit/balance_and_transaction/model/transaction_statuses.py index 29a0171a..9337c005 100644 --- a/xendit/balance_and_transaction/model/transaction_statuses.py +++ b/xendit/balance_and_transaction/model/transaction_statuses.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/transaction_types.py b/xendit/balance_and_transaction/model/transaction_types.py index 4275f5a8..e9e1d22c 100644 --- a/xendit/balance_and_transaction/model/transaction_types.py +++ b/xendit/balance_and_transaction/model/transaction_types.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/transactions_response.py b/xendit/balance_and_transaction/model/transactions_response.py index 755fa265..fce8e7e8 100644 --- a/xendit/balance_and_transaction/model/transactions_response.py +++ b/xendit/balance_and_transaction/model/transactions_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/model/validation_error.py b/xendit/balance_and_transaction/model/validation_error.py index 9be7e79b..0eb435c5 100644 --- a/xendit/balance_and_transaction/model/validation_error.py +++ b/xendit/balance_and_transaction/model/validation_error.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 3.4.3 + The version of the XENDIT API: 3.5.0 """ diff --git a/xendit/balance_and_transaction/transaction_api.py b/xendit/balance_and_transaction/transaction_api.py index a8ced215..25e8bb25 100644 --- a/xendit/balance_and_transaction/transaction_api.py +++ b/xendit/balance_and_transaction/transaction_api.py @@ -3,7 +3,7 @@ # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint # noqa: E501 - The version of the OpenAPI document: 3.4.3 + The version of the OpenAPI document: 3.5.0 """ import re # noqa: F401 diff --git a/xendit/configuration.py b/xendit/configuration.py index 030037d0..40cafca0 100644 --- a/xendit/configuration.py +++ b/xendit/configuration.py @@ -364,8 +364,8 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.44.1\n"\ - "SDK Package Version: 3.4.0".\ + "Version of the API: 1.45.1\n"\ + "SDK Package Version: 3.6.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/xendit/exceptions.py b/xendit/exceptions.py index bebb60c7..7c4b0772 100644 --- a/xendit/exceptions.py +++ b/xendit/exceptions.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ import json diff --git a/xendit/model_utils.py b/xendit/model_utils.py index 4f8be948..0aafa35c 100644 --- a/xendit/model_utils.py +++ b/xendit/model_utils.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_method/model/billing_information.py b/xendit/payment_method/model/billing_information.py index 4bd5c08d..660fa3dd 100644 --- a/xendit/payment_method/model/billing_information.py +++ b/xendit/payment_method/model/billing_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/card.py b/xendit/payment_method/model/card.py index 7b7da3c2..3d48322b 100644 --- a/xendit/payment_method/model/card.py +++ b/xendit/payment_method/model/card.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/card_channel_properties.py b/xendit/payment_method/model/card_channel_properties.py index 91ebbf2d..5f737bf6 100644 --- a/xendit/payment_method/model/card_channel_properties.py +++ b/xendit/payment_method/model/card_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/card_parameters.py b/xendit/payment_method/model/card_parameters.py index b1073629..e4f10809 100644 --- a/xendit/payment_method/model/card_parameters.py +++ b/xendit/payment_method/model/card_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/card_parameters_card_information.py b/xendit/payment_method/model/card_parameters_card_information.py index eaabbeeb..a3ee6a15 100644 --- a/xendit/payment_method/model/card_parameters_card_information.py +++ b/xendit/payment_method/model/card_parameters_card_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/card_verification_results.py b/xendit/payment_method/model/card_verification_results.py index 66229a2b..572ee154 100644 --- a/xendit/payment_method/model/card_verification_results.py +++ b/xendit/payment_method/model/card_verification_results.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/card_verification_results_three_d_secure.py b/xendit/payment_method/model/card_verification_results_three_d_secure.py index a816d81a..03d43a88 100644 --- a/xendit/payment_method/model/card_verification_results_three_d_secure.py +++ b/xendit/payment_method/model/card_verification_results_three_d_secure.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/create_payment_method409_response.py b/xendit/payment_method/model/create_payment_method409_response.py index a4b35992..e06ca37d 100644 --- a/xendit/payment_method/model/create_payment_method409_response.py +++ b/xendit/payment_method/model/create_payment_method409_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/create_payment_method503_response.py b/xendit/payment_method/model/create_payment_method503_response.py index b7373875..4174245c 100644 --- a/xendit/payment_method/model/create_payment_method503_response.py +++ b/xendit/payment_method/model/create_payment_method503_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/direct_debit.py b/xendit/payment_method/model/direct_debit.py index b5568164..2ee466e5 100644 --- a/xendit/payment_method/model/direct_debit.py +++ b/xendit/payment_method/model/direct_debit.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/direct_debit_all_of.py b/xendit/payment_method/model/direct_debit_all_of.py index 1bb201e3..814b3815 100644 --- a/xendit/payment_method/model/direct_debit_all_of.py +++ b/xendit/payment_method/model/direct_debit_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/direct_debit_bank_account.py b/xendit/payment_method/model/direct_debit_bank_account.py index 3e70318c..40af4998 100644 --- a/xendit/payment_method/model/direct_debit_bank_account.py +++ b/xendit/payment_method/model/direct_debit_bank_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/direct_debit_channel_code.py b/xendit/payment_method/model/direct_debit_channel_code.py index 045e468a..3f32736c 100644 --- a/xendit/payment_method/model/direct_debit_channel_code.py +++ b/xendit/payment_method/model/direct_debit_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/direct_debit_channel_properties.py b/xendit/payment_method/model/direct_debit_channel_properties.py index 481822ee..86b50ec9 100644 --- a/xendit/payment_method/model/direct_debit_channel_properties.py +++ b/xendit/payment_method/model/direct_debit_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ @@ -87,6 +87,7 @@ def openapi_types(): 'email': (str, none_type, none_type), # noqa: E501 'identity_document_number': (str, none_type, none_type), # noqa: E501 'require_auth': (bool, none_type, none_type), # noqa: E501 + 'account_number': (str, none_type, none_type), # noqa: E501 } @cached_property @@ -103,6 +104,7 @@ def discriminator(): 'email': 'email', # noqa: E501 'identity_document_number': 'identity_document_number', # noqa: E501 'require_auth': 'require_auth', # noqa: E501 + 'account_number': 'account_number', # noqa: E501 } read_only_vars = { @@ -154,6 +156,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 email (str, none_type): Email address of the customer that is registered to the partner channel. [optional] # noqa: E501 identity_document_number (str, none_type): Identity number of the customer registered to the partner channel. [optional] # noqa: E501 require_auth (bool, none_type): [optional] # noqa: E501 + account_number (str, none_type): Account number of the customer. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -216,6 +219,7 @@ def __init__(self, email: str | None = None, identity_document_number: str | None = None, require_auth: bool | None = None, + account_number: str | None = None, *args, **kwargs ): # noqa: E501 """DirectDebitChannelProperties - a model defined in OpenAPI @@ -260,6 +264,7 @@ def __init__(self, email (str, none_type): Email address of the customer that is registered to the partner channel. [optional] # noqa: E501 identity_document_number (str, none_type): Identity number of the customer registered to the partner channel. [optional] # noqa: E501 require_auth (bool, none_type): [optional] # noqa: E501 + account_number (str, none_type): Account number of the customer. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -307,6 +312,8 @@ def __init__(self, self.identity_document_number = identity_document_number if require_auth is not None: self.require_auth = require_auth + if account_number is not None: + self.account_number = account_number for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/xendit/payment_method/model/direct_debit_debit_card.py b/xendit/payment_method/model/direct_debit_debit_card.py index 5413b998..e4261143 100644 --- a/xendit/payment_method/model/direct_debit_debit_card.py +++ b/xendit/payment_method/model/direct_debit_debit_card.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ @@ -83,6 +83,7 @@ def openapi_types(): 'card_last_four': (str, none_type, none_type), # noqa: E501 'card_expiry': (str, none_type, none_type), # noqa: E501 'email': (str, none_type, none_type), # noqa: E501 + 'account_number': (str, none_type, none_type), # noqa: E501 } @cached_property @@ -95,6 +96,7 @@ def discriminator(): 'card_last_four': 'card_last_four', # noqa: E501 'card_expiry': 'card_expiry', # noqa: E501 'email': 'email', # noqa: E501 + 'account_number': 'account_number', # noqa: E501 } read_only_vars = { @@ -142,6 +144,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 card_last_four (str, none_type): Last four digits of the debit card. [optional] # noqa: E501 card_expiry (str, none_type): Expiry month and year of the debit card (in MM/YY format). [optional] # noqa: E501 email (str, none_type): Email address of the customer that is registered to the partner channel. [optional] # noqa: E501 + account_number (str, none_type): Account number of the customer. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -200,6 +203,7 @@ def __init__(self, card_last_four: str | None = None, card_expiry: str | None = None, email: str | None = None, + account_number: str | None = None, *args, **kwargs ): # noqa: E501 """DirectDebitDebitCard - a model defined in OpenAPI @@ -240,6 +244,7 @@ def __init__(self, card_last_four (str, none_type): Last four digits of the debit card. [optional] # noqa: E501 card_expiry (str, none_type): Expiry month and year of the debit card (in MM/YY format). [optional] # noqa: E501 email (str, none_type): Email address of the customer that is registered to the partner channel. [optional] # noqa: E501 + account_number (str, none_type): Account number of the customer. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -279,6 +284,8 @@ def __init__(self, self.card_expiry = card_expiry if email is not None: self.email = email + if account_number is not None: + self.account_number = account_number for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/xendit/payment_method/model/direct_debit_parameters.py b/xendit/payment_method/model/direct_debit_parameters.py index 8970c7e2..fc294ad6 100644 --- a/xendit/payment_method/model/direct_debit_parameters.py +++ b/xendit/payment_method/model/direct_debit_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/direct_debit_type.py b/xendit/payment_method/model/direct_debit_type.py index 10d0446f..810f6c72 100644 --- a/xendit/payment_method/model/direct_debit_type.py +++ b/xendit/payment_method/model/direct_debit_type.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/e_wallet.py b/xendit/payment_method/model/e_wallet.py index 048f0eca..70970f0d 100644 --- a/xendit/payment_method/model/e_wallet.py +++ b/xendit/payment_method/model/e_wallet.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/e_wallet_account.py b/xendit/payment_method/model/e_wallet_account.py index e0018da4..58f089c7 100644 --- a/xendit/payment_method/model/e_wallet_account.py +++ b/xendit/payment_method/model/e_wallet_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/e_wallet_channel_code.py b/xendit/payment_method/model/e_wallet_channel_code.py index 013a22d6..f8663e2b 100644 --- a/xendit/payment_method/model/e_wallet_channel_code.py +++ b/xendit/payment_method/model/e_wallet_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ @@ -70,6 +70,7 @@ class EWalletChannelCode(ModelSimple): 'LINEPAY': "LINEPAY", 'TRUEMONEY': "TRUEMONEY", 'ALIPAY': "ALIPAY", + 'TOUCHANDGO': "TOUCHANDGO", 'XENDIT_ENUM_DEFAULT_FALLBACK': 'UNKNOWN_ENUM_VALUE', }, } @@ -122,10 +123,10 @@ def __init__(self, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str): EWallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "OVO", "DANA", "LINKAJA", "SHOPEEPAY", "SAKUKU", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", ] # noqa: E501 + args[0] (str): EWallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "OVO", "DANA", "LINKAJA", "SHOPEEPAY", "SAKUKU", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", "TOUCHANDGO", ] # noqa: E501 Keyword Args: - value (str): EWallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "OVO", "DANA", "LINKAJA", "SHOPEEPAY", "SAKUKU", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", ] # noqa: E501 + value (str): EWallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "OVO", "DANA", "LINKAJA", "SHOPEEPAY", "SAKUKU", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", "TOUCHANDGO", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -218,10 +219,10 @@ def _from_openapi_data(cls, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str): EWallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "OVO", "DANA", "LINKAJA", "SHOPEEPAY", "SAKUKU", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", ] # noqa: E501 + args[0] (str): EWallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "OVO", "DANA", "LINKAJA", "SHOPEEPAY", "SAKUKU", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", "TOUCHANDGO", ] # noqa: E501 Keyword Args: - value (str): EWallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "OVO", "DANA", "LINKAJA", "SHOPEEPAY", "SAKUKU", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", ] # noqa: E501 + value (str): EWallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "OVO", "DANA", "LINKAJA", "SHOPEEPAY", "SAKUKU", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", "TOUCHANDGO", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/xendit/payment_method/model/e_wallet_channel_properties.py b/xendit/payment_method/model/e_wallet_channel_properties.py index 122aea32..5933fdbf 100644 --- a/xendit/payment_method/model/e_wallet_channel_properties.py +++ b/xendit/payment_method/model/e_wallet_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/e_wallet_parameters.py b/xendit/payment_method/model/e_wallet_parameters.py index 1b9e3260..ad2faca3 100644 --- a/xendit/payment_method/model/e_wallet_parameters.py +++ b/xendit/payment_method/model/e_wallet_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/get_all_payment_methods400_response.py b/xendit/payment_method/model/get_all_payment_methods400_response.py index d098e15c..8a9802d8 100644 --- a/xendit/payment_method/model/get_all_payment_methods400_response.py +++ b/xendit/payment_method/model/get_all_payment_methods400_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/get_all_payment_methods403_response.py b/xendit/payment_method/model/get_all_payment_methods403_response.py index 50d9a8de..79456075 100644 --- a/xendit/payment_method/model/get_all_payment_methods403_response.py +++ b/xendit/payment_method/model/get_all_payment_methods403_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/get_all_payment_methods404_response.py b/xendit/payment_method/model/get_all_payment_methods404_response.py index 1632ff30..a6390f9b 100644 --- a/xendit/payment_method/model/get_all_payment_methods404_response.py +++ b/xendit/payment_method/model/get_all_payment_methods404_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/get_all_payment_methods_default_response.py b/xendit/payment_method/model/get_all_payment_methods_default_response.py index 1711f099..ebd8f979 100644 --- a/xendit/payment_method/model/get_all_payment_methods_default_response.py +++ b/xendit/payment_method/model/get_all_payment_methods_default_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/over_the_counter.py b/xendit/payment_method/model/over_the_counter.py index 75406a5d..c24b14bc 100644 --- a/xendit/payment_method/model/over_the_counter.py +++ b/xendit/payment_method/model/over_the_counter.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/over_the_counter_channel_code.py b/xendit/payment_method/model/over_the_counter_channel_code.py index 3bc27a67..41ac9bee 100644 --- a/xendit/payment_method/model/over_the_counter_channel_code.py +++ b/xendit/payment_method/model/over_the_counter_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/over_the_counter_channel_properties.py b/xendit/payment_method/model/over_the_counter_channel_properties.py index 3085e217..53114a2c 100644 --- a/xendit/payment_method/model/over_the_counter_channel_properties.py +++ b/xendit/payment_method/model/over_the_counter_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/over_the_counter_channel_properties_update.py b/xendit/payment_method/model/over_the_counter_channel_properties_update.py index 36e6ec82..018c34cb 100644 --- a/xendit/payment_method/model/over_the_counter_channel_properties_update.py +++ b/xendit/payment_method/model/over_the_counter_channel_properties_update.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/over_the_counter_parameters.py b/xendit/payment_method/model/over_the_counter_parameters.py index 4e55878e..14f8c492 100644 --- a/xendit/payment_method/model/over_the_counter_parameters.py +++ b/xendit/payment_method/model/over_the_counter_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/over_the_counter_update_parameters.py b/xendit/payment_method/model/over_the_counter_update_parameters.py index b93ebb65..e604a893 100644 --- a/xendit/payment_method/model/over_the_counter_update_parameters.py +++ b/xendit/payment_method/model/over_the_counter_update_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method.py b/xendit/payment_method/model/payment_method.py index 18dcb64e..1699c1e5 100644 --- a/xendit/payment_method/model/payment_method.py +++ b/xendit/payment_method/model/payment_method.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method_action.py b/xendit/payment_method/model/payment_method_action.py index 840a9b18..de783ab1 100644 --- a/xendit/payment_method/model/payment_method_action.py +++ b/xendit/payment_method/model/payment_method_action.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method_auth_parameters.py b/xendit/payment_method/model/payment_method_auth_parameters.py index da4975fc..cfc62a13 100644 --- a/xendit/payment_method/model/payment_method_auth_parameters.py +++ b/xendit/payment_method/model/payment_method_auth_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method_country.py b/xendit/payment_method/model/payment_method_country.py index 5bed39ba..053d41df 100644 --- a/xendit/payment_method/model/payment_method_country.py +++ b/xendit/payment_method/model/payment_method_country.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ @@ -55,6 +55,7 @@ class PaymentMethodCountry(ModelSimple): 'VN': "VN", 'TH': "TH", 'MY': "MY", + 'US': "US", 'XENDIT_ENUM_DEFAULT_FALLBACK': 'UNKNOWN_ENUM_VALUE', }, } @@ -107,10 +108,10 @@ def __init__(self, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str):, must be one of ["PH", "ID", "VN", "TH", "MY", ] # noqa: E501 + args[0] (str):, must be one of ["PH", "ID", "VN", "TH", "MY", "US", ] # noqa: E501 Keyword Args: - value (str):, must be one of ["PH", "ID", "VN", "TH", "MY", ] # noqa: E501 + value (str):, must be one of ["PH", "ID", "VN", "TH", "MY", "US", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -203,10 +204,10 @@ def _from_openapi_data(cls, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str):, must be one of ["PH", "ID", "VN", "TH", "MY", ] # noqa: E501 + args[0] (str):, must be one of ["PH", "ID", "VN", "TH", "MY", "US", ] # noqa: E501 Keyword Args: - value (str):, must be one of ["PH", "ID", "VN", "TH", "MY", ] # noqa: E501 + value (str):, must be one of ["PH", "ID", "VN", "TH", "MY", "US", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/xendit/payment_method/model/payment_method_expire_parameters.py b/xendit/payment_method/model/payment_method_expire_parameters.py index 1a14a406..7ae1d216 100644 --- a/xendit/payment_method/model/payment_method_expire_parameters.py +++ b/xendit/payment_method/model/payment_method_expire_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method_list.py b/xendit/payment_method/model/payment_method_list.py index 38b3fc8a..3eb6f1fe 100644 --- a/xendit/payment_method/model/payment_method_list.py +++ b/xendit/payment_method/model/payment_method_list.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method_parameters.py b/xendit/payment_method/model/payment_method_parameters.py index 827c32ab..f798f02c 100644 --- a/xendit/payment_method/model/payment_method_parameters.py +++ b/xendit/payment_method/model/payment_method_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method_reusability.py b/xendit/payment_method/model/payment_method_reusability.py index 7b4213f5..8ce55582 100644 --- a/xendit/payment_method/model/payment_method_reusability.py +++ b/xendit/payment_method/model/payment_method_reusability.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method_status.py b/xendit/payment_method/model/payment_method_status.py index 24e82366..3573947a 100644 --- a/xendit/payment_method/model/payment_method_status.py +++ b/xendit/payment_method/model/payment_method_status.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method_type.py b/xendit/payment_method/model/payment_method_type.py index c9876743..5e2517c8 100644 --- a/xendit/payment_method/model/payment_method_type.py +++ b/xendit/payment_method/model/payment_method_type.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/payment_method_update_parameters.py b/xendit/payment_method/model/payment_method_update_parameters.py index 63cb8043..a350138e 100644 --- a/xendit/payment_method/model/payment_method_update_parameters.py +++ b/xendit/payment_method/model/payment_method_update_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/qr_code.py b/xendit/payment_method/model/qr_code.py index 76a0e5c1..b4f04a03 100644 --- a/xendit/payment_method/model/qr_code.py +++ b/xendit/payment_method/model/qr_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/qr_code_channel_code.py b/xendit/payment_method/model/qr_code_channel_code.py index 463fac51..105cfee1 100644 --- a/xendit/payment_method/model/qr_code_channel_code.py +++ b/xendit/payment_method/model/qr_code_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/qr_code_channel_properties.py b/xendit/payment_method/model/qr_code_channel_properties.py index 5fd00b36..391ed6a3 100644 --- a/xendit/payment_method/model/qr_code_channel_properties.py +++ b/xendit/payment_method/model/qr_code_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/qr_code_parameters.py b/xendit/payment_method/model/qr_code_parameters.py index 1bbbf437..48635ede 100644 --- a/xendit/payment_method/model/qr_code_parameters.py +++ b/xendit/payment_method/model/qr_code_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/simulate_payment_request.py b/xendit/payment_method/model/simulate_payment_request.py index 021dcff6..e85bf5dd 100644 --- a/xendit/payment_method/model/simulate_payment_request.py +++ b/xendit/payment_method/model/simulate_payment_request.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/tokenized_card_information.py b/xendit/payment_method/model/tokenized_card_information.py index 239a01a7..e67fbf6f 100644 --- a/xendit/payment_method/model/tokenized_card_information.py +++ b/xendit/payment_method/model/tokenized_card_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/virtual_account.py b/xendit/payment_method/model/virtual_account.py index 6f057d0a..b7cddc2e 100644 --- a/xendit/payment_method/model/virtual_account.py +++ b/xendit/payment_method/model/virtual_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/virtual_account_all_of.py b/xendit/payment_method/model/virtual_account_all_of.py index e068b42e..90f4b4e6 100644 --- a/xendit/payment_method/model/virtual_account_all_of.py +++ b/xendit/payment_method/model/virtual_account_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/virtual_account_alternative_display.py b/xendit/payment_method/model/virtual_account_alternative_display.py index 65439933..2428b399 100644 --- a/xendit/payment_method/model/virtual_account_alternative_display.py +++ b/xendit/payment_method/model/virtual_account_alternative_display.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/virtual_account_channel_code.py b/xendit/payment_method/model/virtual_account_channel_code.py index 413e8441..79748cd9 100644 --- a/xendit/payment_method/model/virtual_account_channel_code.py +++ b/xendit/payment_method/model/virtual_account_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ @@ -65,6 +65,7 @@ class VirtualAccountChannelCode(ModelSimple): 'WOORI': "WOORI", 'MSB': "MSB", 'STANDARD_CHARTERED': "STANDARD_CHARTERED", + 'AMBANK': "AMBANK", 'XENDIT_ENUM_DEFAULT_FALLBACK': 'UNKNOWN_ENUM_VALUE', }, } @@ -117,10 +118,10 @@ def __init__(self, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", ] # noqa: E501 + args[0] (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", "AMBANK", ] # noqa: E501 Keyword Args: - value (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", ] # noqa: E501 + value (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", "AMBANK", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -213,10 +214,10 @@ def _from_openapi_data(cls, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", ] # noqa: E501 + args[0] (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", "AMBANK", ] # noqa: E501 Keyword Args: - value (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", ] # noqa: E501 + value (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", "AMBANK", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/xendit/payment_method/model/virtual_account_channel_properties.py b/xendit/payment_method/model/virtual_account_channel_properties.py index 84345acc..b378fd5c 100644 --- a/xendit/payment_method/model/virtual_account_channel_properties.py +++ b/xendit/payment_method/model/virtual_account_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/virtual_account_channel_properties_patch.py b/xendit/payment_method/model/virtual_account_channel_properties_patch.py index 569a2fdc..2dc4a0de 100644 --- a/xendit/payment_method/model/virtual_account_channel_properties_patch.py +++ b/xendit/payment_method/model/virtual_account_channel_properties_patch.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/virtual_account_parameters.py b/xendit/payment_method/model/virtual_account_parameters.py index a8b8627e..3ddbbf4a 100644 --- a/xendit/payment_method/model/virtual_account_parameters.py +++ b/xendit/payment_method/model/virtual_account_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/model/virtual_account_update_parameters.py b/xendit/payment_method/model/virtual_account_update_parameters.py index f53bed74..6d311e71 100644 --- a/xendit/payment_method/model/virtual_account_update_parameters.py +++ b/xendit/payment_method/model/virtual_account_update_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 2.89.2 + The version of the XENDIT API: 2.91.2 """ diff --git a/xendit/payment_method/payment_method_api.py b/xendit/payment_method/payment_method_api.py index 450b7b29..d595406c 100644 --- a/xendit/payment_method/payment_method_api.py +++ b/xendit/payment_method/payment_method_api.py @@ -3,7 +3,7 @@ This API is used for Payment Method Service v2 # noqa: E501 - The version of the OpenAPI document: 2.89.2 + The version of the OpenAPI document: 2.91.2 """ import re # noqa: F401 diff --git a/xendit/payment_request/model/capture.py b/xendit/payment_request/model/capture.py index c4e99f94..40243a39 100644 --- a/xendit/payment_request/model/capture.py +++ b/xendit/payment_request/model/capture.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/capture_list.py b/xendit/payment_request/model/capture_list.py index 8ebc3bc9..1ee1e9fb 100644 --- a/xendit/payment_request/model/capture_list.py +++ b/xendit/payment_request/model/capture_list.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/capture_list_response.py b/xendit/payment_request/model/capture_list_response.py index 74712174..25e41165 100644 --- a/xendit/payment_request/model/capture_list_response.py +++ b/xendit/payment_request/model/capture_list_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/capture_parameters.py b/xendit/payment_request/model/capture_parameters.py index a757aa88..15c66135 100644 --- a/xendit/payment_request/model/capture_parameters.py +++ b/xendit/payment_request/model/capture_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/card.py b/xendit/payment_request/model/card.py index 5e20d1a9..d24230b8 100644 --- a/xendit/payment_request/model/card.py +++ b/xendit/payment_request/model/card.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/card_channel_properties.py b/xendit/payment_request/model/card_channel_properties.py index a1546eea..d37f687a 100644 --- a/xendit/payment_request/model/card_channel_properties.py +++ b/xendit/payment_request/model/card_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/card_information.py b/xendit/payment_request/model/card_information.py index c4c45ba1..a73de543 100644 --- a/xendit/payment_request/model/card_information.py +++ b/xendit/payment_request/model/card_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/card_verification_results.py b/xendit/payment_request/model/card_verification_results.py index 34d1420a..88c505d2 100644 --- a/xendit/payment_request/model/card_verification_results.py +++ b/xendit/payment_request/model/card_verification_results.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/card_verification_results_three_d_secure.py b/xendit/payment_request/model/card_verification_results_three_d_secure.py index 55501667..cf23bba2 100644 --- a/xendit/payment_request/model/card_verification_results_three_d_secure.py +++ b/xendit/payment_request/model/card_verification_results_three_d_secure.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit.py b/xendit/payment_request/model/direct_debit.py index b89257aa..ecb033dc 100644 --- a/xendit/payment_request/model/direct_debit.py +++ b/xendit/payment_request/model/direct_debit.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_all_of.py b/xendit/payment_request/model/direct_debit_all_of.py index 28f04927..800bdc97 100644 --- a/xendit/payment_request/model/direct_debit_all_of.py +++ b/xendit/payment_request/model/direct_debit_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_bank_account.py b/xendit/payment_request/model/direct_debit_bank_account.py index 142c80ed..4ff1a680 100644 --- a/xendit/payment_request/model/direct_debit_bank_account.py +++ b/xendit/payment_request/model/direct_debit_bank_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_channel_code.py b/xendit/payment_request/model/direct_debit_channel_code.py index 6d382272..101867ba 100644 --- a/xendit/payment_request/model/direct_debit_channel_code.py +++ b/xendit/payment_request/model/direct_debit_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_channel_properties.py b/xendit/payment_request/model/direct_debit_channel_properties.py index ae921727..a7d70ecb 100644 --- a/xendit/payment_request/model/direct_debit_channel_properties.py +++ b/xendit/payment_request/model/direct_debit_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_channel_properties_bank_account.py b/xendit/payment_request/model/direct_debit_channel_properties_bank_account.py index 6a2550be..14977cb3 100644 --- a/xendit/payment_request/model/direct_debit_channel_properties_bank_account.py +++ b/xendit/payment_request/model/direct_debit_channel_properties_bank_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_channel_properties_bank_redirect.py b/xendit/payment_request/model/direct_debit_channel_properties_bank_redirect.py index 57f33885..675f82db 100644 --- a/xendit/payment_request/model/direct_debit_channel_properties_bank_redirect.py +++ b/xendit/payment_request/model/direct_debit_channel_properties_bank_redirect.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_channel_properties_debit_card.py b/xendit/payment_request/model/direct_debit_channel_properties_debit_card.py index 54a08d0c..3b1db848 100644 --- a/xendit/payment_request/model/direct_debit_channel_properties_debit_card.py +++ b/xendit/payment_request/model/direct_debit_channel_properties_debit_card.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_debit_card.py b/xendit/payment_request/model/direct_debit_debit_card.py index 47763006..3507f46c 100644 --- a/xendit/payment_request/model/direct_debit_debit_card.py +++ b/xendit/payment_request/model/direct_debit_debit_card.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_parameters.py b/xendit/payment_request/model/direct_debit_parameters.py index 7cfba9f4..1fc4331e 100644 --- a/xendit/payment_request/model/direct_debit_parameters.py +++ b/xendit/payment_request/model/direct_debit_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/direct_debit_type.py b/xendit/payment_request/model/direct_debit_type.py index 98e903d7..45f82f76 100644 --- a/xendit/payment_request/model/direct_debit_type.py +++ b/xendit/payment_request/model/direct_debit_type.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/e_wallet.py b/xendit/payment_request/model/e_wallet.py index 26f3a68b..536122d3 100644 --- a/xendit/payment_request/model/e_wallet.py +++ b/xendit/payment_request/model/e_wallet.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/e_wallet_account.py b/xendit/payment_request/model/e_wallet_account.py index 3604c2d1..e7a68b7f 100644 --- a/xendit/payment_request/model/e_wallet_account.py +++ b/xendit/payment_request/model/e_wallet_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/e_wallet_all_of.py b/xendit/payment_request/model/e_wallet_all_of.py index b29619dc..012fdad0 100644 --- a/xendit/payment_request/model/e_wallet_all_of.py +++ b/xendit/payment_request/model/e_wallet_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/e_wallet_channel_code.py b/xendit/payment_request/model/e_wallet_channel_code.py index 8e6be5d3..373ac732 100644 --- a/xendit/payment_request/model/e_wallet_channel_code.py +++ b/xendit/payment_request/model/e_wallet_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ @@ -69,6 +69,7 @@ class EWalletChannelCode(ModelSimple): 'LINEPAY': "LINEPAY", 'TRUEMONEY': "TRUEMONEY", 'ALIPAY': "ALIPAY", + 'TOUCHANDGO': "TOUCHANDGO", 'XENDIT_ENUM_DEFAULT_FALLBACK': 'UNKNOWN_ENUM_VALUE', }, } @@ -121,10 +122,10 @@ def __init__(self, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str): Ewallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "DANA", "OVO", "LINKAJA", "SHOPEEPAY", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", ] # noqa: E501 + args[0] (str): Ewallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "DANA", "OVO", "LINKAJA", "SHOPEEPAY", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", "TOUCHANDGO", ] # noqa: E501 Keyword Args: - value (str): Ewallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "DANA", "OVO", "LINKAJA", "SHOPEEPAY", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", ] # noqa: E501 + value (str): Ewallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "DANA", "OVO", "LINKAJA", "SHOPEEPAY", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", "TOUCHANDGO", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -217,10 +218,10 @@ def _from_openapi_data(cls, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str): Ewallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "DANA", "OVO", "LINKAJA", "SHOPEEPAY", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", ] # noqa: E501 + args[0] (str): Ewallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "DANA", "OVO", "LINKAJA", "SHOPEEPAY", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", "TOUCHANDGO", ] # noqa: E501 Keyword Args: - value (str): Ewallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "DANA", "OVO", "LINKAJA", "SHOPEEPAY", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", ] # noqa: E501 + value (str): Ewallet Channel Code., must be one of ["GCASH", "GRABPAY", "PAYMAYA", "DANA", "OVO", "LINKAJA", "SHOPEEPAY", "NEXCASH", "ASTRAPAY", "JENIUSPAY", "APPOTA", "MOMO", "VNPTWALLET", "VIETTELPAY", "ZALOPAY", "WECHATPAY", "LINEPAY", "TRUEMONEY", "ALIPAY", "TOUCHANDGO", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/xendit/payment_request/model/e_wallet_channel_properties.py b/xendit/payment_request/model/e_wallet_channel_properties.py index b3bcef12..6c51213b 100644 --- a/xendit/payment_request/model/e_wallet_channel_properties.py +++ b/xendit/payment_request/model/e_wallet_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/e_wallet_parameters.py b/xendit/payment_request/model/e_wallet_parameters.py index 5d8d9bba..21ce1062 100644 --- a/xendit/payment_request/model/e_wallet_parameters.py +++ b/xendit/payment_request/model/e_wallet_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/error.py b/xendit/payment_request/model/error.py index c484c211..11195a0f 100644 --- a/xendit/payment_request/model/error.py +++ b/xendit/payment_request/model/error.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/over_the_counter.py b/xendit/payment_request/model/over_the_counter.py index 2c26e12a..c319ab2a 100644 --- a/xendit/payment_request/model/over_the_counter.py +++ b/xendit/payment_request/model/over_the_counter.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/over_the_counter_channel_code.py b/xendit/payment_request/model/over_the_counter_channel_code.py index 8189f57b..612fb5bd 100644 --- a/xendit/payment_request/model/over_the_counter_channel_code.py +++ b/xendit/payment_request/model/over_the_counter_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/over_the_counter_channel_properties.py b/xendit/payment_request/model/over_the_counter_channel_properties.py index a9f2539e..0b3c6bcd 100644 --- a/xendit/payment_request/model/over_the_counter_channel_properties.py +++ b/xendit/payment_request/model/over_the_counter_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/over_the_counter_parameters.py b/xendit/payment_request/model/over_the_counter_parameters.py index 50e5d10d..a4dce611 100644 --- a/xendit/payment_request/model/over_the_counter_parameters.py +++ b/xendit/payment_request/model/over_the_counter_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_method.py b/xendit/payment_request/model/payment_method.py index c4ee5c52..7eca5d9c 100644 --- a/xendit/payment_request/model/payment_method.py +++ b/xendit/payment_request/model/payment_method.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_method_parameters.py b/xendit/payment_request/model/payment_method_parameters.py index 5ed7838f..43cfe1e8 100644 --- a/xendit/payment_request/model/payment_method_parameters.py +++ b/xendit/payment_request/model/payment_method_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_method_reusability.py b/xendit/payment_request/model/payment_method_reusability.py index ca7e6ed7..6388c622 100644 --- a/xendit/payment_request/model/payment_method_reusability.py +++ b/xendit/payment_request/model/payment_method_reusability.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_method_status.py b/xendit/payment_request/model/payment_method_status.py index 07d22288..0e5d36e0 100644 --- a/xendit/payment_request/model/payment_method_status.py +++ b/xendit/payment_request/model/payment_method_status.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_method_type.py b/xendit/payment_request/model/payment_method_type.py index 49c65948..0da560ac 100644 --- a/xendit/payment_request/model/payment_method_type.py +++ b/xendit/payment_request/model/payment_method_type.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request.py b/xendit/payment_request/model/payment_request.py index 6825bb85..1bf7fc1d 100644 --- a/xendit/payment_request/model/payment_request.py +++ b/xendit/payment_request/model/payment_request.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_action.py b/xendit/payment_request/model/payment_request_action.py index ba60db2b..8cf24562 100644 --- a/xendit/payment_request/model/payment_request_action.py +++ b/xendit/payment_request/model/payment_request_action.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_auth_parameters.py b/xendit/payment_request/model/payment_request_auth_parameters.py index 89fdbd0a..c390269d 100644 --- a/xendit/payment_request/model/payment_request_auth_parameters.py +++ b/xendit/payment_request/model/payment_request_auth_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_basket.py b/xendit/payment_request/model/payment_request_basket.py index edc024cd..c93048d8 100644 --- a/xendit/payment_request/model/payment_request_basket.py +++ b/xendit/payment_request/model/payment_request_basket.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_basket_item.py b/xendit/payment_request/model/payment_request_basket_item.py index ceb38b7a..f61f7534 100644 --- a/xendit/payment_request/model/payment_request_basket_item.py +++ b/xendit/payment_request/model/payment_request_basket_item.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_capture_method.py b/xendit/payment_request/model/payment_request_capture_method.py index 23e889e4..2424639c 100644 --- a/xendit/payment_request/model/payment_request_capture_method.py +++ b/xendit/payment_request/model/payment_request_capture_method.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_card_verification_results.py b/xendit/payment_request/model/payment_request_card_verification_results.py index d3ef033f..a0870448 100644 --- a/xendit/payment_request/model/payment_request_card_verification_results.py +++ b/xendit/payment_request/model/payment_request_card_verification_results.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_card_verification_results_three_dee_secure.py b/xendit/payment_request/model/payment_request_card_verification_results_three_dee_secure.py index 168c43bc..f01e676e 100644 --- a/xendit/payment_request/model/payment_request_card_verification_results_three_dee_secure.py +++ b/xendit/payment_request/model/payment_request_card_verification_results_three_dee_secure.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_channel_properties.py b/xendit/payment_request/model/payment_request_channel_properties.py index b80db562..770d737d 100644 --- a/xendit/payment_request/model/payment_request_channel_properties.py +++ b/xendit/payment_request/model/payment_request_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_country.py b/xendit/payment_request/model/payment_request_country.py index 6d332a90..e3e56bb1 100644 --- a/xendit/payment_request/model/payment_request_country.py +++ b/xendit/payment_request/model/payment_request_country.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_currency.py b/xendit/payment_request/model/payment_request_currency.py index 7d598c54..e2d73361 100644 --- a/xendit/payment_request/model/payment_request_currency.py +++ b/xendit/payment_request/model/payment_request_currency.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ @@ -55,6 +55,7 @@ class PaymentRequestCurrency(ModelSimple): 'VND': "VND", 'THB': "THB", 'MYR': "MYR", + 'USD': "USD", 'XENDIT_ENUM_DEFAULT_FALLBACK': 'UNKNOWN_ENUM_VALUE', }, } @@ -107,10 +108,10 @@ def __init__(self, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str):, must be one of ["IDR", "PHP", "VND", "THB", "MYR", ] # noqa: E501 + args[0] (str):, must be one of ["IDR", "PHP", "VND", "THB", "MYR", "USD", ] # noqa: E501 Keyword Args: - value (str):, must be one of ["IDR", "PHP", "VND", "THB", "MYR", ] # noqa: E501 + value (str):, must be one of ["IDR", "PHP", "VND", "THB", "MYR", "USD", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -203,10 +204,10 @@ def _from_openapi_data(cls, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str):, must be one of ["IDR", "PHP", "VND", "THB", "MYR", ] # noqa: E501 + args[0] (str):, must be one of ["IDR", "PHP", "VND", "THB", "MYR", "USD", ] # noqa: E501 Keyword Args: - value (str):, must be one of ["IDR", "PHP", "VND", "THB", "MYR", ] # noqa: E501 + value (str):, must be one of ["IDR", "PHP", "VND", "THB", "MYR", "USD", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/xendit/payment_request/model/payment_request_initiator.py b/xendit/payment_request/model/payment_request_initiator.py index e982244f..b69d7446 100644 --- a/xendit/payment_request/model/payment_request_initiator.py +++ b/xendit/payment_request/model/payment_request_initiator.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_list_response.py b/xendit/payment_request/model/payment_request_list_response.py index b2c1ef05..520a7f03 100644 --- a/xendit/payment_request/model/payment_request_list_response.py +++ b/xendit/payment_request/model/payment_request_list_response.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_parameters.py b/xendit/payment_request/model/payment_request_parameters.py index 8baff99d..8dbb5df7 100644 --- a/xendit/payment_request/model/payment_request_parameters.py +++ b/xendit/payment_request/model/payment_request_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_parameters_channel_properties.py b/xendit/payment_request/model/payment_request_parameters_channel_properties.py index d6ba6347..a55cc1ee 100644 --- a/xendit/payment_request/model/payment_request_parameters_channel_properties.py +++ b/xendit/payment_request/model/payment_request_parameters_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_parameters_channel_properties_all_of.py b/xendit/payment_request/model/payment_request_parameters_channel_properties_all_of.py index 8d7dd19c..b6c4ff7c 100644 --- a/xendit/payment_request/model/payment_request_parameters_channel_properties_all_of.py +++ b/xendit/payment_request/model/payment_request_parameters_channel_properties_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_shipping_information.py b/xendit/payment_request/model/payment_request_shipping_information.py index 8017d48c..2e8c442c 100644 --- a/xendit/payment_request/model/payment_request_shipping_information.py +++ b/xendit/payment_request/model/payment_request_shipping_information.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/payment_request_status.py b/xendit/payment_request/model/payment_request_status.py index 5fd1749e..b8ce60e9 100644 --- a/xendit/payment_request/model/payment_request_status.py +++ b/xendit/payment_request/model/payment_request_status.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/qr_code.py b/xendit/payment_request/model/qr_code.py index e6d9e1f0..55937668 100644 --- a/xendit/payment_request/model/qr_code.py +++ b/xendit/payment_request/model/qr_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/qr_code_channel_code.py b/xendit/payment_request/model/qr_code_channel_code.py index 99e40b85..f5a996ce 100644 --- a/xendit/payment_request/model/qr_code_channel_code.py +++ b/xendit/payment_request/model/qr_code_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/qr_code_channel_properties.py b/xendit/payment_request/model/qr_code_channel_properties.py index d966a6f9..4de666b5 100644 --- a/xendit/payment_request/model/qr_code_channel_properties.py +++ b/xendit/payment_request/model/qr_code_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/qr_code_parameters.py b/xendit/payment_request/model/qr_code_parameters.py index e8680620..059c1fbc 100644 --- a/xendit/payment_request/model/qr_code_parameters.py +++ b/xendit/payment_request/model/qr_code_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/virtual_account.py b/xendit/payment_request/model/virtual_account.py index f7e65dcc..1f50bd74 100644 --- a/xendit/payment_request/model/virtual_account.py +++ b/xendit/payment_request/model/virtual_account.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/virtual_account_all_of.py b/xendit/payment_request/model/virtual_account_all_of.py index 85b2435f..77b0fb2e 100644 --- a/xendit/payment_request/model/virtual_account_all_of.py +++ b/xendit/payment_request/model/virtual_account_all_of.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/virtual_account_alternative_display.py b/xendit/payment_request/model/virtual_account_alternative_display.py index b934522b..5b039d5d 100644 --- a/xendit/payment_request/model/virtual_account_alternative_display.py +++ b/xendit/payment_request/model/virtual_account_alternative_display.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/virtual_account_channel_code.py b/xendit/payment_request/model/virtual_account_channel_code.py index 2fe5a260..4f7aa1c6 100644 --- a/xendit/payment_request/model/virtual_account_channel_code.py +++ b/xendit/payment_request/model/virtual_account_channel_code.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ @@ -65,6 +65,7 @@ class VirtualAccountChannelCode(ModelSimple): 'WOORI': "WOORI", 'MSB': "MSB", 'STANDARD_CHARTERED': "STANDARD_CHARTERED", + 'AMBANK': "AMBANK", 'XENDIT_ENUM_DEFAULT_FALLBACK': 'UNKNOWN_ENUM_VALUE', }, } @@ -117,10 +118,10 @@ def __init__(self, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", ] # noqa: E501 + args[0] (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", "AMBANK", ] # noqa: E501 Keyword Args: - value (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", ] # noqa: E501 + value (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", "AMBANK", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -213,10 +214,10 @@ def _from_openapi_data(cls, *args, **kwargs): Note that value can be passed either in args or in kwargs, but not in both. Args: - args[0] (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", ] # noqa: E501 + args[0] (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", "AMBANK", ] # noqa: E501 Keyword Args: - value (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", ] # noqa: E501 + value (str): Virtual Account Channel Code., must be one of ["BCA", "BJB", "BNI", "BRI", "MANDIRI", "PERMATA", "BSI", "CIMB", "SAHABAT_SAMPOERNA", "ARTAJASA", "PV", "VIETCAPITAL", "WOORI", "MSB", "STANDARD_CHARTERED", "AMBANK", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/xendit/payment_request/model/virtual_account_channel_properties.py b/xendit/payment_request/model/virtual_account_channel_properties.py index 9e0ed112..4ababa05 100644 --- a/xendit/payment_request/model/virtual_account_channel_properties.py +++ b/xendit/payment_request/model/virtual_account_channel_properties.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/model/virtual_account_parameters.py b/xendit/payment_request/model/virtual_account_parameters.py index b54eff85..09bbedab 100644 --- a/xendit/payment_request/model/virtual_account_parameters.py +++ b/xendit/payment_request/model/virtual_account_parameters.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """ diff --git a/xendit/payment_request/payment_request_api.py b/xendit/payment_request/payment_request_api.py index d9d02884..ae78cd58 100644 --- a/xendit/payment_request/payment_request_api.py +++ b/xendit/payment_request/payment_request_api.py @@ -3,7 +3,7 @@ This API is used for Payment Requests # noqa: E501 - The version of the OpenAPI document: 1.44.1 + The version of the OpenAPI document: 1.45.1 """ import re # noqa: F401 diff --git a/xendit/rest.py b/xendit/rest.py index d4203718..6c0647f5 100644 --- a/xendit/rest.py +++ b/xendit/rest.py @@ -1,5 +1,5 @@ """ - The version of the XENDIT API: 1.44.1 + The version of the XENDIT API: 1.45.1 """