komoju-sdk 1.0.0.beta.1 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +140 -0
- data/README.md +72 -44
- data/docs/BalanceTransactionList.md +1 -1
- data/docs/BarcodesApi.md +1 -6
- data/docs/CapturePaymentRequest.md +1 -1
- data/docs/ChargebackCustomer.md +20 -0
- data/docs/ChargebackDefense.md +26 -0
- data/docs/ChargebackDefenseDocument.md +26 -0
- data/docs/ChargebackDefenseRecipientInfo.md +22 -0
- data/docs/ChargebackDefenseShippingInfo.md +24 -0
- data/docs/ChargebackPayment.md +30 -0
- data/docs/ChargebackPaymentMethod.md +22 -0
- data/docs/ChargebackRequestDetail.md +38 -0
- data/docs/ChargebackRequestList.md +32 -0
- data/docs/ChargebackRequestListItem.md +36 -0
- data/docs/ChargebackStatus.md +15 -0
- data/docs/ChargebackTimelineEntry.md +20 -0
- data/docs/ChargebacksApi.md +307 -0
- data/docs/CreateSessionRequest.md +0 -31
- data/docs/CreateSessionRequestWithCustomerMode.md +2 -2
- data/docs/CreateSessionRequestWithCustomerPaymentMode.md +2 -2
- data/docs/CreateSessionRequestWithPaymentMode.md +3 -3
- data/docs/Customer.md +5 -3
- data/docs/DefendChargebackDocument.md +22 -0
- data/docs/DefendChargebackRecipientInfo.md +22 -0
- data/docs/DefendChargebackRequestBody.md +26 -0
- data/docs/DefendChargebackShippingInfo.md +24 -0
- data/docs/DeleteExternalCustomer200Response.md +18 -0
- data/docs/Event.md +1 -1
- data/docs/FieldFieldProperties.md +15 -3
- data/docs/OneClickApi.md +4 -4
- data/docs/PaymentMethodApplication.md +30 -0
- data/docs/PaymentMethodApplicationStatus.md +15 -0
- data/docs/PaymentMethodApplicationWithSubmittedFields.md +32 -0
- data/docs/PaymentMethodStatus.md +1 -1
- data/docs/PlatformModelApi.md +9 -9
- data/docs/SecureToken.md +3 -1
- data/docs/SecureTokenThreeDSecureAccount.md +20 -0
- data/docs/SerializedSubmerchant.md +4 -4
- data/docs/SessionsApi.md +1 -1
- data/docs/Settlement.md +3 -3
- data/docs/SettlementList.md +1 -1
- data/docs/SettlementShow.md +3 -3
- data/docs/SettlementsApi.md +157 -5
- data/docs/ShowBalance200Response.md +34 -0
- data/docs/Subscription.md +1 -1
- data/docs/SubscriptionCustomer.md +10 -2
- data/docs/ThreeDsAuthResult.md +11 -11
- data/docs/TokenPaymentDetails.md +7 -7
- data/komoju-sdk.gemspec +1 -2
- data/lib/komoju-sdk/api/barcodes_api.rb +4 -4
- data/lib/komoju-sdk/api/chargebacks_api.rb +327 -0
- data/lib/komoju-sdk/api/disbursements_api.rb +5 -5
- data/lib/komoju-sdk/api/events_api.rb +3 -3
- data/lib/komoju-sdk/api/one_click_api.rb +5 -13
- data/lib/komoju-sdk/api/payments_api.rb +16 -16
- data/lib/komoju-sdk/api/platform_model_api.rb +56 -56
- data/lib/komoju-sdk/api/secure_tokens_api.rb +3 -3
- data/lib/komoju-sdk/api/sessions_api.rb +4 -4
- data/lib/komoju-sdk/api/settlements_api.rb +157 -16
- data/lib/komoju-sdk/api/subscriptions_api.rb +11 -11
- data/lib/komoju-sdk/api/tokens_api.rb +1 -1
- data/lib/komoju-sdk/api_client.rb +7 -5
- data/lib/komoju-sdk/api_error.rb +1 -1
- data/lib/komoju-sdk/api_model_base.rb +88 -0
- data/lib/komoju-sdk/configuration.rb +1 -3
- data/lib/komoju-sdk/models/address.rb +11 -5
- data/lib/komoju-sdk/models/api_error.rb +21 -5
- data/lib/komoju-sdk/models/api_error_body.rb +51 -5
- data/lib/komoju-sdk/models/auto.rb +1 -1
- data/lib/komoju-sdk/models/available_payment_method.rb +61 -5
- data/lib/komoju-sdk/models/balance.rb +31 -5
- data/lib/komoju-sdk/models/balance_settings.rb +31 -5
- data/lib/komoju-sdk/models/balance_show.rb +91 -5
- data/lib/komoju-sdk/models/balance_transaction_list.rb +92 -6
- data/lib/komoju-sdk/models/balance_transfer_request.rb +21 -5
- data/lib/komoju-sdk/models/balance_transfer_service_record.rb +61 -5
- data/lib/komoju-sdk/models/barcode_pending_response.rb +21 -5
- data/lib/komoju-sdk/models/barcode_ready_response.rb +31 -5
- data/lib/komoju-sdk/models/cancel_disbursement_request.rb +21 -5
- data/lib/komoju-sdk/models/capture_payment_request.rb +12 -6
- data/lib/komoju-sdk/models/chargeback_customer.rb +243 -0
- data/lib/komoju-sdk/models/chargeback_defense.rb +338 -0
- data/lib/komoju-sdk/models/chargeback_defense_document.rb +352 -0
- data/lib/komoju-sdk/models/chargeback_defense_recipient_info.rb +257 -0
- data/lib/komoju-sdk/models/chargeback_defense_shipping_info.rb +270 -0
- data/lib/komoju-sdk/models/chargeback_payment.rb +425 -0
- data/lib/komoju-sdk/models/chargeback_payment_method.rb +271 -0
- data/lib/komoju-sdk/models/chargeback_request_detail.rb +552 -0
- data/lib/komoju-sdk/models/chargeback_request_list.rb +435 -0
- data/lib/komoju-sdk/models/chargeback_request_list_item.rb +551 -0
- data/lib/komoju-sdk/models/chargeback_status.rb +43 -0
- data/lib/komoju-sdk/models/chargeback_timeline_entry.rb +271 -0
- data/lib/komoju-sdk/models/country_code.rb +1 -1
- data/lib/komoju-sdk/models/create_customer_request.rb +11 -5
- data/lib/komoju-sdk/models/create_disbursement_request.rb +61 -5
- data/lib/komoju-sdk/models/create_file_request.rb +21 -5
- data/lib/komoju-sdk/models/create_merchant_balance_transfer_request.rb +33 -7
- data/lib/komoju-sdk/models/create_merchant_request.rb +31 -5
- data/lib/komoju-sdk/models/create_payment_request.rb +3 -4
- data/lib/komoju-sdk/models/create_payment_request_with_customer.rb +25 -9
- data/lib/komoju-sdk/models/create_payment_request_with_payment_details.rb +33 -7
- data/lib/komoju-sdk/models/create_payment_request_with_payment_details_tax.rb +3 -4
- data/lib/komoju-sdk/models/create_refund_request_request.rb +61 -5
- data/lib/komoju-sdk/models/create_secure_token_request.rb +3 -4
- data/lib/komoju-sdk/models/create_secure_token_request_with_customer.rb +33 -7
- data/lib/komoju-sdk/models/create_secure_token_request_with_payment_details.rb +41 -5
- data/lib/komoju-sdk/models/create_session_request.rb +68 -20
- data/lib/komoju-sdk/models/create_session_request_with_customer_mode.rb +34 -25
- data/lib/komoju-sdk/models/create_session_request_with_customer_payment_mode.rb +44 -18
- data/lib/komoju-sdk/models/create_session_request_with_payment_mode.rb +43 -24
- data/lib/komoju-sdk/models/create_subscription_request.rb +33 -7
- data/lib/komoju-sdk/models/create_token_request.rb +21 -5
- data/lib/komoju-sdk/models/currency.rb +1 -1
- data/lib/komoju-sdk/models/customer.rb +85 -23
- data/lib/komoju-sdk/models/customer_list.rb +91 -5
- data/lib/komoju-sdk/models/customer_source.rb +62 -5
- data/lib/komoju-sdk/models/defend_chargeback_document.rb +264 -0
- data/lib/komoju-sdk/models/defend_chargeback_recipient_info.rb +248 -0
- data/lib/komoju-sdk/models/defend_chargeback_request_body.rb +298 -0
- data/lib/komoju-sdk/models/defend_chargeback_shipping_info.rb +258 -0
- data/lib/komoju-sdk/models/delete_external_customer200_response.rb +243 -0
- data/lib/komoju-sdk/models/disbursement.rb +123 -7
- data/lib/komoju-sdk/models/disbursement_list.rb +91 -5
- data/lib/komoju-sdk/models/disbursement_status.rb +1 -1
- data/lib/komoju-sdk/models/edit_merchant_balance_settings_request.rb +33 -7
- data/lib/komoju-sdk/models/errored_field.rb +91 -5
- data/lib/komoju-sdk/models/event.rb +79 -13
- data/lib/komoju-sdk/models/event_list.rb +81 -5
- data/lib/komoju-sdk/models/field.rb +71 -5
- data/lib/komoju-sdk/models/field_field_properties.rb +75 -23
- data/lib/komoju-sdk/models/finalize_payment_request.rb +31 -5
- data/lib/komoju-sdk/models/fraud_details.rb +31 -5
- data/lib/komoju-sdk/models/industry_type.rb +1 -1
- data/lib/komoju-sdk/models/installments.rb +1 -1
- data/lib/komoju-sdk/models/intent.rb +1 -1
- data/lib/komoju-sdk/models/line_item.rb +11 -5
- data/lib/komoju-sdk/models/live_application.rb +73 -7
- data/lib/komoju-sdk/models/live_application_request.rb +11 -5
- data/lib/komoju-sdk/models/live_application_status.rb +1 -1
- data/lib/komoju-sdk/models/live_application_with_submitted_fields.rb +83 -7
- data/lib/komoju-sdk/models/locale.rb +1 -1
- data/lib/komoju-sdk/models/merchant_balance.rb +31 -5
- data/lib/komoju-sdk/models/merchant_data.rb +21 -5
- data/lib/komoju-sdk/models/merchant_file.rb +81 -5
- data/lib/komoju-sdk/models/merchant_role.rb +1 -1
- data/lib/komoju-sdk/models/merchant_submission_status.rb +31 -5
- data/lib/komoju-sdk/models/pay_session_request.rb +21 -5
- data/lib/komoju-sdk/models/pay_session_response.rb +21 -5
- data/lib/komoju-sdk/models/payment.rb +105 -9
- data/lib/komoju-sdk/models/payment_data.rb +11 -5
- data/lib/komoju-sdk/models/payment_data_request.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_alipay.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_alipay_hk.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_all.rb +1 -1
- data/lib/komoju-sdk/models/payment_details_au.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_aupay.rb +13 -7
- data/lib/komoju-sdk/models/payment_details_bancontact.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_bank_transfer.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_bit_cash.rb +13 -7
- data/lib/komoju-sdk/models/payment_details_blik.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_credit_card.rb +13 -7
- data/lib/komoju-sdk/models/payment_details_credit_card_brazil.rb +53 -7
- data/lib/komoju-sdk/models/payment_details_credit_card_korea.rb +15 -9
- data/lib/komoju-sdk/models/payment_details_credit_card_korea_social_id.rb +3 -4
- data/lib/komoju-sdk/models/payment_details_credit_card_terminal.rb +13 -7
- data/lib/komoju-sdk/models/payment_details_culture_voucher.rb +15 -9
- data/lib/komoju-sdk/models/payment_details_cvs.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_dana.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_docomo.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_doku_wallet.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_dospara.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_dragonpay.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_enets.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_epospay.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_eps.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_fpx.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_g_cash.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_giropay.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_happy_money.rb +15 -9
- data/lib/komoju-sdk/models/payment_details_ideal.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_kakaopay.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_konbini.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_merpay.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_mobile.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_mobile_japan.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_multibanco.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_mybank.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_narvesen.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_naverpay.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_net_cash.rb +13 -7
- data/lib/komoju-sdk/models/payment_details_only_credit_cards.rb +1 -1
- data/lib/komoju-sdk/models/payment_details_ovo.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_paidy.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_pay_easy.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_pay_pay.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_payco.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_paypost.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_paysafe_card.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_paysafe_cash.rb +21 -5
- data/lib/komoju-sdk/models/payment_details_paysera.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_payu.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_perlas.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_pix.rb +31 -5
- data/lib/komoju-sdk/models/payment_details_poli.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_przelewy24.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_rakutenpay.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_sepa_transfer.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_sofortbanking.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_softbank.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_tng.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_toss.rb +13 -7
- data/lib/komoju-sdk/models/payment_details_truemoney.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_unionpay.rb +11 -5
- data/lib/komoju-sdk/models/payment_details_web_money.rb +13 -7
- data/lib/komoju-sdk/models/payment_details_wechatpay.rb +11 -5
- data/lib/komoju-sdk/models/payment_list.rb +91 -5
- data/lib/komoju-sdk/models/payment_method.rb +21 -5
- data/lib/komoju-sdk/models/payment_method_application.rb +451 -0
- data/lib/komoju-sdk/models/payment_method_application_status.rb +40 -0
- data/lib/komoju-sdk/models/payment_method_application_with_submitted_fields.rb +486 -0
- data/lib/komoju-sdk/models/payment_method_brands.rb +3 -4
- data/lib/komoju-sdk/models/payment_method_installments_inner.rb +31 -5
- data/lib/komoju-sdk/models/payment_method_status.rb +32 -6
- data/lib/komoju-sdk/models/payment_methods_list.rb +31 -5
- data/lib/komoju-sdk/models/payment_status.rb +1 -1
- data/lib/komoju-sdk/models/payment_type.rb +1 -1
- data/lib/komoju-sdk/models/platform_details.rb +23 -7
- data/lib/komoju-sdk/models/platform_merchant_payment_list.rb +31 -5
- data/lib/komoju-sdk/models/platform_payment.rb +205 -9
- data/lib/komoju-sdk/models/prepaid_cards.rb +11 -5
- data/lib/komoju-sdk/models/processing_merchant.rb +13 -7
- data/lib/komoju-sdk/models/refund.rb +55 -9
- data/lib/komoju-sdk/models/refund_payment_request.rb +11 -5
- data/lib/komoju-sdk/models/refund_request.rb +71 -15
- data/lib/komoju-sdk/models/refund_request_status.rb +1 -1
- data/lib/komoju-sdk/models/response_payment_details_alipay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_alipay_hk.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_all.rb +1 -1
- data/lib/komoju-sdk/models/response_payment_details_au.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_aupay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_bancontact.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_bank_transfer.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_bit_cash.rb +11 -5
- data/lib/komoju-sdk/models/response_payment_details_blik.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_credit_card.rb +41 -5
- data/lib/komoju-sdk/models/response_payment_details_credit_card_brazil.rb +31 -5
- data/lib/komoju-sdk/models/response_payment_details_credit_card_korea.rb +31 -5
- data/lib/komoju-sdk/models/response_payment_details_credit_card_terminal.rb +11 -5
- data/lib/komoju-sdk/models/response_payment_details_culture_voucher.rb +31 -5
- data/lib/komoju-sdk/models/response_payment_details_cvs.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_dana.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_docomo.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_doku_wallet.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_dospara.rb +31 -5
- data/lib/komoju-sdk/models/response_payment_details_dragonpay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_enets.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_epospay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_eps.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_fpx.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_g_cash.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_giropay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_happy_money.rb +31 -5
- data/lib/komoju-sdk/models/response_payment_details_ideal.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_kakaopay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_konbini.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_merpay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_mobile.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_mobile_japan.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_multibanco.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_mybank.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_narvesen.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_naverpay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_net_cash.rb +11 -5
- data/lib/komoju-sdk/models/response_payment_details_ovo.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_paidy.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_pay_easy.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_pay_pay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_payco.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_paypost.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_paysafe_card.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_paysafe_cash.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_paysera.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_payu.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_perlas.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_pix.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_poli.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_przelewy24.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_rakutenpay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_sepa_transfer.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_sofortbanking.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_softbank.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_tng.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_toss.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_truemoney.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_unionpay.rb +21 -5
- data/lib/komoju-sdk/models/response_payment_details_web_money.rb +11 -5
- data/lib/komoju-sdk/models/response_payment_details_wechatpay.rb +21 -5
- data/lib/komoju-sdk/models/secure_token.rb +68 -16
- data/lib/komoju-sdk/models/secure_token_three_d_secure_account.rb +244 -0
- data/lib/komoju-sdk/models/serialized_submerchant.rb +145 -37
- data/lib/komoju-sdk/models/serialized_submerchant_active_payment_methods_inner.rb +41 -5
- data/lib/komoju-sdk/models/serialized_submerchant_expiry_settings_inner.rb +41 -5
- data/lib/komoju-sdk/models/session.rb +113 -7
- data/lib/komoju-sdk/models/session_mode.rb +1 -1
- data/lib/komoju-sdk/models/session_status.rb +1 -1
- data/lib/komoju-sdk/models/settlement.rb +208 -24
- data/lib/komoju-sdk/models/settlement_download.rb +11 -5
- data/lib/komoju-sdk/models/settlement_frequency.rb +1 -1
- data/lib/komoju-sdk/models/settlement_list.rb +92 -6
- data/lib/komoju-sdk/models/settlement_show.rb +268 -24
- data/lib/komoju-sdk/models/shared_details.rb +71 -5
- data/lib/komoju-sdk/models/shared_details_corrections.rb +21 -5
- data/lib/komoju-sdk/models/shared_details_disbursements.rb +41 -5
- data/lib/komoju-sdk/models/shared_details_misc.rb +61 -5
- data/lib/komoju-sdk/models/shared_details_payments.rb +41 -5
- data/lib/komoju-sdk/models/shared_details_platform_model.rb +11 -5
- data/lib/komoju-sdk/models/shared_details_refunds.rb +51 -5
- data/lib/komoju-sdk/models/show_balance200_response.rb +465 -0
- data/lib/komoju-sdk/models/show_barcode_response.rb +1 -1
- data/lib/komoju-sdk/models/simulate_live_application_payment_method_status_request.rb +11 -5
- data/lib/komoju-sdk/models/statement_descriptor.rb +11 -5
- data/lib/komoju-sdk/models/status.rb +1 -1
- data/lib/komoju-sdk/models/submerchant.rb +13 -7
- data/lib/komoju-sdk/models/submerchant_list_item.rb +101 -5
- data/lib/komoju-sdk/models/submerchants_list.rb +31 -5
- data/lib/komoju-sdk/models/submitted_field.rb +81 -5
- data/lib/komoju-sdk/models/submitted_field_all_of_value.rb +3 -4
- data/lib/komoju-sdk/models/subscription.rb +139 -19
- data/lib/komoju-sdk/models/subscription_customer.rb +134 -17
- data/lib/komoju-sdk/models/subscription_list.rb +91 -5
- data/lib/komoju-sdk/models/subscription_payment_details.rb +51 -5
- data/lib/komoju-sdk/models/subscription_period.rb +1 -1
- data/lib/komoju-sdk/models/terminal_error.rb +21 -5
- data/lib/komoju-sdk/models/terminal_error_body.rb +61 -5
- data/lib/komoju-sdk/models/three_ds_auth_result.rb +11 -82
- data/lib/komoju-sdk/models/token.rb +68 -8
- data/lib/komoju-sdk/models/token_payment_details.rb +21 -54
- data/lib/komoju-sdk/models/transaction.rb +33 -7
- data/lib/komoju-sdk/models/transfer.rb +61 -5
- data/lib/komoju-sdk/models/update_customer_request.rb +11 -5
- data/lib/komoju-sdk/models/update_merchant_request.rb +11 -5
- data/lib/komoju-sdk/models/update_merchant_request_expiry_settings_inner.rb +21 -5
- data/lib/komoju-sdk/models/update_payment_method_request.rb +11 -5
- data/lib/komoju-sdk/models/update_payment_request.rb +11 -5
- data/lib/komoju-sdk/version.rb +2 -2
- data/lib/komoju-sdk.rb +25 -4
- data/spec/api/barcodes_api_spec.rb +1 -1
- data/spec/api/chargebacks_api_spec.rb +91 -0
- data/spec/api/disbursements_api_spec.rb +1 -1
- data/spec/api/events_api_spec.rb +1 -1
- data/spec/api/one_click_api_spec.rb +2 -2
- data/spec/api/payments_api_spec.rb +1 -1
- data/spec/api/platform_model_api_spec.rb +3 -3
- data/spec/api/secure_tokens_api_spec.rb +1 -1
- data/spec/api/sessions_api_spec.rb +1 -1
- data/spec/api/settlements_api_spec.rb +32 -3
- data/spec/api/subscriptions_api_spec.rb +1 -1
- data/spec/api/tokens_api_spec.rb +1 -1
- data/spec/models/address_spec.rb +2 -2
- data/spec/models/api_error_body_spec.rb +2 -2
- data/spec/models/api_error_spec.rb +2 -2
- data/spec/models/auto_spec.rb +2 -2
- data/spec/models/available_payment_method_spec.rb +2 -2
- data/spec/models/balance_settings_spec.rb +2 -2
- data/spec/models/balance_show_spec.rb +2 -2
- data/spec/models/balance_spec.rb +2 -2
- data/spec/models/balance_transaction_list_spec.rb +2 -2
- data/spec/models/balance_transfer_request_spec.rb +2 -2
- data/spec/models/balance_transfer_service_record_spec.rb +2 -2
- data/spec/models/barcode_pending_response_spec.rb +2 -2
- data/spec/models/barcode_ready_response_spec.rb +2 -2
- data/spec/models/cancel_disbursement_request_spec.rb +2 -2
- data/spec/models/capture_payment_request_spec.rb +2 -2
- data/spec/models/chargeback_customer_spec.rb +42 -0
- data/spec/models/chargeback_defense_document_spec.rb +60 -0
- data/spec/models/chargeback_defense_recipient_info_spec.rb +48 -0
- data/spec/models/chargeback_defense_shipping_info_spec.rb +54 -0
- data/spec/models/chargeback_defense_spec.rb +60 -0
- data/spec/models/chargeback_payment_method_spec.rb +48 -0
- data/spec/models/chargeback_payment_spec.rb +72 -0
- data/spec/models/chargeback_request_detail_spec.rb +96 -0
- data/spec/models/chargeback_request_list_item_spec.rb +90 -0
- data/spec/models/chargeback_request_list_spec.rb +78 -0
- data/spec/models/chargeback_status_spec.rb +30 -0
- data/spec/models/chargeback_timeline_entry_spec.rb +42 -0
- data/spec/models/country_code_spec.rb +2 -2
- data/spec/models/create_customer_request_spec.rb +2 -2
- data/spec/models/create_disbursement_request_spec.rb +2 -2
- data/spec/models/create_file_request_spec.rb +2 -2
- data/spec/models/create_merchant_balance_transfer_request_spec.rb +2 -2
- data/spec/models/create_merchant_request_spec.rb +2 -2
- data/spec/models/create_payment_request_spec.rb +1 -1
- data/spec/models/create_payment_request_with_customer_spec.rb +2 -2
- data/spec/models/create_payment_request_with_payment_details_spec.rb +2 -2
- data/spec/models/create_payment_request_with_payment_details_tax_spec.rb +1 -1
- data/spec/models/create_refund_request_request_spec.rb +2 -2
- data/spec/models/create_secure_token_request_spec.rb +1 -1
- data/spec/models/create_secure_token_request_with_customer_spec.rb +2 -2
- data/spec/models/create_secure_token_request_with_payment_details_spec.rb +2 -2
- data/spec/models/create_session_request_spec.rb +1 -13
- data/spec/models/create_session_request_with_customer_mode_spec.rb +4 -4
- data/spec/models/create_session_request_with_customer_payment_mode_spec.rb +4 -4
- data/spec/models/create_session_request_with_payment_mode_spec.rb +4 -4
- data/spec/models/create_subscription_request_spec.rb +2 -2
- data/spec/models/create_token_request_spec.rb +2 -2
- data/spec/models/currency_spec.rb +2 -2
- data/spec/models/customer_list_spec.rb +2 -2
- data/spec/models/customer_source_spec.rb +2 -2
- data/spec/models/customer_spec.rb +12 -2
- data/spec/models/defend_chargeback_document_spec.rb +48 -0
- data/spec/models/defend_chargeback_recipient_info_spec.rb +48 -0
- data/spec/models/defend_chargeback_request_body_spec.rb +60 -0
- data/spec/models/defend_chargeback_shipping_info_spec.rb +54 -0
- data/spec/models/delete_external_customer200_response_spec.rb +36 -0
- data/spec/models/disbursement_list_spec.rb +2 -2
- data/spec/models/disbursement_spec.rb +2 -2
- data/spec/models/disbursement_status_spec.rb +2 -2
- data/spec/models/edit_merchant_balance_settings_request_spec.rb +2 -2
- data/spec/models/errored_field_spec.rb +2 -2
- data/spec/models/event_list_spec.rb +2 -2
- data/spec/models/event_spec.rb +6 -2
- data/spec/models/field_field_properties_spec.rb +38 -2
- data/spec/models/field_spec.rb +2 -2
- data/spec/models/finalize_payment_request_spec.rb +2 -2
- data/spec/models/fraud_details_spec.rb +2 -2
- data/spec/models/industry_type_spec.rb +2 -2
- data/spec/models/installments_spec.rb +2 -2
- data/spec/models/intent_spec.rb +2 -2
- data/spec/models/line_item_spec.rb +2 -2
- data/spec/models/live_application_request_spec.rb +2 -2
- data/spec/models/live_application_spec.rb +2 -2
- data/spec/models/live_application_status_spec.rb +2 -2
- data/spec/models/live_application_with_submitted_fields_spec.rb +2 -2
- data/spec/models/locale_spec.rb +2 -2
- data/spec/models/merchant_balance_spec.rb +2 -2
- data/spec/models/merchant_data_spec.rb +2 -2
- data/spec/models/merchant_file_spec.rb +2 -2
- data/spec/models/merchant_role_spec.rb +2 -2
- data/spec/models/merchant_submission_status_spec.rb +2 -2
- data/spec/models/pay_session_request_spec.rb +2 -2
- data/spec/models/pay_session_response_spec.rb +2 -2
- data/spec/models/payment_data_request_spec.rb +2 -2
- data/spec/models/payment_data_spec.rb +2 -2
- data/spec/models/payment_details_alipay_hk_spec.rb +2 -2
- data/spec/models/payment_details_alipay_spec.rb +2 -2
- data/spec/models/payment_details_all_spec.rb +1 -1
- data/spec/models/payment_details_au_spec.rb +2 -2
- data/spec/models/payment_details_aupay_spec.rb +2 -2
- data/spec/models/payment_details_bancontact_spec.rb +2 -2
- data/spec/models/payment_details_bank_transfer_spec.rb +2 -2
- data/spec/models/payment_details_bit_cash_spec.rb +2 -2
- data/spec/models/payment_details_blik_spec.rb +2 -2
- data/spec/models/payment_details_credit_card_brazil_spec.rb +2 -2
- data/spec/models/payment_details_credit_card_korea_social_id_spec.rb +1 -1
- data/spec/models/payment_details_credit_card_korea_spec.rb +2 -2
- data/spec/models/payment_details_credit_card_spec.rb +2 -2
- data/spec/models/payment_details_credit_card_terminal_spec.rb +2 -2
- data/spec/models/payment_details_culture_voucher_spec.rb +2 -2
- data/spec/models/payment_details_cvs_spec.rb +2 -2
- data/spec/models/payment_details_dana_spec.rb +2 -2
- data/spec/models/payment_details_docomo_spec.rb +2 -2
- data/spec/models/payment_details_doku_wallet_spec.rb +2 -2
- data/spec/models/payment_details_dospara_spec.rb +2 -2
- data/spec/models/payment_details_dragonpay_spec.rb +2 -2
- data/spec/models/payment_details_enets_spec.rb +2 -2
- data/spec/models/payment_details_epospay_spec.rb +2 -2
- data/spec/models/payment_details_eps_spec.rb +2 -2
- data/spec/models/payment_details_fpx_spec.rb +2 -2
- data/spec/models/payment_details_g_cash_spec.rb +2 -2
- data/spec/models/payment_details_giropay_spec.rb +2 -2
- data/spec/models/payment_details_happy_money_spec.rb +2 -2
- data/spec/models/payment_details_ideal_spec.rb +2 -2
- data/spec/models/payment_details_kakaopay_spec.rb +2 -2
- data/spec/models/payment_details_konbini_spec.rb +2 -2
- data/spec/models/payment_details_merpay_spec.rb +2 -2
- data/spec/models/payment_details_mobile_japan_spec.rb +2 -2
- data/spec/models/payment_details_mobile_spec.rb +2 -2
- data/spec/models/payment_details_multibanco_spec.rb +2 -2
- data/spec/models/payment_details_mybank_spec.rb +2 -2
- data/spec/models/payment_details_narvesen_spec.rb +2 -2
- data/spec/models/payment_details_naverpay_spec.rb +2 -2
- data/spec/models/payment_details_net_cash_spec.rb +2 -2
- data/spec/models/payment_details_only_credit_cards_spec.rb +1 -1
- data/spec/models/payment_details_ovo_spec.rb +2 -2
- data/spec/models/payment_details_paidy_spec.rb +2 -2
- data/spec/models/payment_details_pay_easy_spec.rb +2 -2
- data/spec/models/payment_details_pay_pay_spec.rb +2 -2
- data/spec/models/payment_details_payco_spec.rb +2 -2
- data/spec/models/payment_details_paypost_spec.rb +2 -2
- data/spec/models/payment_details_paysafe_card_spec.rb +2 -2
- data/spec/models/payment_details_paysafe_cash_spec.rb +2 -2
- data/spec/models/payment_details_paysera_spec.rb +2 -2
- data/spec/models/payment_details_payu_spec.rb +2 -2
- data/spec/models/payment_details_perlas_spec.rb +2 -2
- data/spec/models/payment_details_pix_spec.rb +2 -2
- data/spec/models/payment_details_poli_spec.rb +2 -2
- data/spec/models/payment_details_przelewy24_spec.rb +2 -2
- data/spec/models/payment_details_rakutenpay_spec.rb +2 -2
- data/spec/models/payment_details_sepa_transfer_spec.rb +2 -2
- data/spec/models/payment_details_sofortbanking_spec.rb +2 -2
- data/spec/models/payment_details_softbank_spec.rb +2 -2
- data/spec/models/payment_details_tng_spec.rb +2 -2
- data/spec/models/payment_details_toss_spec.rb +2 -2
- data/spec/models/payment_details_truemoney_spec.rb +2 -2
- data/spec/models/payment_details_unionpay_spec.rb +2 -2
- data/spec/models/payment_details_web_money_spec.rb +2 -2
- data/spec/models/payment_details_wechatpay_spec.rb +2 -2
- data/spec/models/payment_list_spec.rb +2 -2
- data/spec/models/payment_method_application_spec.rb +72 -0
- data/spec/models/payment_method_application_status_spec.rb +30 -0
- data/spec/models/payment_method_application_with_submitted_fields_spec.rb +78 -0
- data/spec/models/payment_method_brands_spec.rb +1 -1
- data/spec/models/payment_method_installments_inner_spec.rb +2 -2
- data/spec/models/payment_method_spec.rb +2 -2
- data/spec/models/payment_method_status_spec.rb +2 -2
- data/spec/models/payment_methods_list_spec.rb +2 -2
- data/spec/models/payment_spec.rb +2 -2
- data/spec/models/payment_status_spec.rb +2 -2
- data/spec/models/payment_type_spec.rb +2 -2
- data/spec/models/platform_details_spec.rb +2 -2
- data/spec/models/platform_merchant_payment_list_spec.rb +2 -2
- data/spec/models/platform_payment_spec.rb +2 -2
- data/spec/models/prepaid_cards_spec.rb +2 -2
- data/spec/models/processing_merchant_spec.rb +2 -2
- data/spec/models/refund_payment_request_spec.rb +2 -2
- data/spec/models/refund_request_spec.rb +2 -2
- data/spec/models/refund_request_status_spec.rb +2 -2
- data/spec/models/refund_spec.rb +2 -2
- data/spec/models/response_payment_details_alipay_hk_spec.rb +2 -2
- data/spec/models/response_payment_details_alipay_spec.rb +2 -2
- data/spec/models/response_payment_details_all_spec.rb +1 -1
- data/spec/models/response_payment_details_au_spec.rb +2 -2
- data/spec/models/response_payment_details_aupay_spec.rb +2 -2
- data/spec/models/response_payment_details_bancontact_spec.rb +2 -2
- data/spec/models/response_payment_details_bank_transfer_spec.rb +2 -2
- data/spec/models/response_payment_details_bit_cash_spec.rb +2 -2
- data/spec/models/response_payment_details_blik_spec.rb +2 -2
- data/spec/models/response_payment_details_credit_card_brazil_spec.rb +2 -2
- data/spec/models/response_payment_details_credit_card_korea_spec.rb +2 -2
- data/spec/models/response_payment_details_credit_card_spec.rb +2 -2
- data/spec/models/response_payment_details_credit_card_terminal_spec.rb +2 -2
- data/spec/models/response_payment_details_culture_voucher_spec.rb +2 -2
- data/spec/models/response_payment_details_cvs_spec.rb +2 -2
- data/spec/models/response_payment_details_dana_spec.rb +2 -2
- data/spec/models/response_payment_details_docomo_spec.rb +2 -2
- data/spec/models/response_payment_details_doku_wallet_spec.rb +2 -2
- data/spec/models/response_payment_details_dospara_spec.rb +2 -2
- data/spec/models/response_payment_details_dragonpay_spec.rb +2 -2
- data/spec/models/response_payment_details_enets_spec.rb +2 -2
- data/spec/models/response_payment_details_epospay_spec.rb +2 -2
- data/spec/models/response_payment_details_eps_spec.rb +2 -2
- data/spec/models/response_payment_details_fpx_spec.rb +2 -2
- data/spec/models/response_payment_details_g_cash_spec.rb +2 -2
- data/spec/models/response_payment_details_giropay_spec.rb +2 -2
- data/spec/models/response_payment_details_happy_money_spec.rb +2 -2
- data/spec/models/response_payment_details_ideal_spec.rb +2 -2
- data/spec/models/response_payment_details_kakaopay_spec.rb +2 -2
- data/spec/models/response_payment_details_konbini_spec.rb +2 -2
- data/spec/models/response_payment_details_merpay_spec.rb +2 -2
- data/spec/models/response_payment_details_mobile_japan_spec.rb +2 -2
- data/spec/models/response_payment_details_mobile_spec.rb +2 -2
- data/spec/models/response_payment_details_multibanco_spec.rb +2 -2
- data/spec/models/response_payment_details_mybank_spec.rb +2 -2
- data/spec/models/response_payment_details_narvesen_spec.rb +2 -2
- data/spec/models/response_payment_details_naverpay_spec.rb +2 -2
- data/spec/models/response_payment_details_net_cash_spec.rb +2 -2
- data/spec/models/response_payment_details_ovo_spec.rb +2 -2
- data/spec/models/response_payment_details_paidy_spec.rb +2 -2
- data/spec/models/response_payment_details_pay_easy_spec.rb +2 -2
- data/spec/models/response_payment_details_pay_pay_spec.rb +2 -2
- data/spec/models/response_payment_details_payco_spec.rb +2 -2
- data/spec/models/response_payment_details_paypost_spec.rb +2 -2
- data/spec/models/response_payment_details_paysafe_card_spec.rb +2 -2
- data/spec/models/response_payment_details_paysafe_cash_spec.rb +2 -2
- data/spec/models/response_payment_details_paysera_spec.rb +2 -2
- data/spec/models/response_payment_details_payu_spec.rb +2 -2
- data/spec/models/response_payment_details_perlas_spec.rb +2 -2
- data/spec/models/response_payment_details_pix_spec.rb +2 -2
- data/spec/models/response_payment_details_poli_spec.rb +2 -2
- data/spec/models/response_payment_details_przelewy24_spec.rb +2 -2
- data/spec/models/response_payment_details_rakutenpay_spec.rb +2 -2
- data/spec/models/response_payment_details_sepa_transfer_spec.rb +2 -2
- data/spec/models/response_payment_details_sofortbanking_spec.rb +2 -2
- data/spec/models/response_payment_details_softbank_spec.rb +2 -2
- data/spec/models/response_payment_details_tng_spec.rb +2 -2
- data/spec/models/response_payment_details_toss_spec.rb +2 -2
- data/spec/models/response_payment_details_truemoney_spec.rb +2 -2
- data/spec/models/response_payment_details_unionpay_spec.rb +2 -2
- data/spec/models/response_payment_details_web_money_spec.rb +2 -2
- data/spec/models/response_payment_details_wechatpay_spec.rb +2 -2
- data/spec/models/secure_token_spec.rb +12 -2
- data/spec/models/secure_token_three_d_secure_account_spec.rb +42 -0
- data/spec/models/serialized_submerchant_active_payment_methods_inner_spec.rb +2 -2
- data/spec/models/serialized_submerchant_expiry_settings_inner_spec.rb +2 -2
- data/spec/models/serialized_submerchant_spec.rb +2 -2
- data/spec/models/session_mode_spec.rb +2 -2
- data/spec/models/session_spec.rb +2 -2
- data/spec/models/session_status_spec.rb +2 -2
- data/spec/models/settlement_download_spec.rb +2 -2
- data/spec/models/settlement_frequency_spec.rb +2 -2
- data/spec/models/settlement_list_spec.rb +2 -2
- data/spec/models/settlement_show_spec.rb +7 -3
- data/spec/models/settlement_spec.rb +7 -3
- data/spec/models/shared_details_corrections_spec.rb +2 -2
- data/spec/models/shared_details_disbursements_spec.rb +2 -2
- data/spec/models/shared_details_misc_spec.rb +2 -2
- data/spec/models/shared_details_payments_spec.rb +2 -2
- data/spec/models/shared_details_platform_model_spec.rb +2 -2
- data/spec/models/shared_details_refunds_spec.rb +2 -2
- data/spec/models/shared_details_spec.rb +2 -2
- data/spec/models/show_balance200_response_spec.rb +84 -0
- data/spec/models/show_barcode_response_spec.rb +1 -1
- data/spec/models/simulate_live_application_payment_method_status_request_spec.rb +2 -2
- data/spec/models/statement_descriptor_spec.rb +2 -2
- data/spec/models/status_spec.rb +2 -2
- data/spec/models/submerchant_list_item_spec.rb +2 -2
- data/spec/models/submerchant_spec.rb +2 -2
- data/spec/models/submerchants_list_spec.rb +2 -2
- data/spec/models/submitted_field_all_of_value_spec.rb +1 -1
- data/spec/models/submitted_field_spec.rb +2 -2
- data/spec/models/subscription_customer_spec.rb +26 -2
- data/spec/models/subscription_list_spec.rb +2 -2
- data/spec/models/subscription_payment_details_spec.rb +2 -2
- data/spec/models/subscription_period_spec.rb +2 -2
- data/spec/models/subscription_spec.rb +6 -2
- data/spec/models/terminal_error_body_spec.rb +2 -2
- data/spec/models/terminal_error_spec.rb +2 -2
- data/spec/models/three_ds_auth_result_spec.rb +2 -2
- data/spec/models/token_payment_details_spec.rb +2 -2
- data/spec/models/token_spec.rb +6 -2
- data/spec/models/transaction_spec.rb +2 -2
- data/spec/models/transfer_spec.rb +2 -2
- data/spec/models/update_customer_request_spec.rb +2 -2
- data/spec/models/update_merchant_request_expiry_settings_inner_spec.rb +2 -2
- data/spec/models/update_merchant_request_spec.rb +2 -2
- data/spec/models/update_payment_method_request_spec.rb +2 -2
- data/spec/models/update_payment_request_spec.rb +2 -2
- data/spec/spec_helper.rb +1 -1
- metadata +333 -240
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cd73b163d2d1057a44eb39204ada1a03fa7492dcc654d3f4487fea041766ae83
|
|
4
|
+
data.tar.gz: be7878cec97d973f2196384a2c6830e919bf66fe37ded010fe6195367710cffb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2cde3f3a46a2ac46192a6a6771242da338fb3bd56e9ee8b2e6f1be48e20d787755c99a253cda684cc7ee81fdae945c19f432d994455bb325d9845d59d73d1971
|
|
7
|
+
data.tar.gz: d0375e5fc6ca094f8b7a1061d6af07057d6f4fda979da47e8afdcb0e2632cec8cc39778b5bd28a5b39ed8602e41b77176a963a2b6344a9fe882f8a4a19e46c8f
|
data/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,146 @@
|
|
|
2
2
|
|
|
3
3
|
## [Unreleased]
|
|
4
4
|
|
|
5
|
+
## [1.0.0] - 2026-06-29
|
|
6
|
+
|
|
7
|
+
Targets KOMOJU API version `2025-01-28`.
|
|
8
|
+
|
|
9
|
+
### Changed
|
|
10
|
+
|
|
11
|
+
- [`GET payments` endpoint] The response object for partially captured payments has been updated.
|
|
12
|
+
|
|
13
|
+
- **Return value changes**:
|
|
14
|
+
- `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
|
|
15
|
+
- `refunds`: partially captured payments no longer show a refund for the difference between the authorized amount and captured amount.
|
|
16
|
+
|
|
17
|
+
- [`POST payments` endpoint] The response object for partially captured payments has been updated.
|
|
18
|
+
|
|
19
|
+
- **Return value changes**:
|
|
20
|
+
- `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
|
|
21
|
+
- `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment.
|
|
22
|
+
|
|
23
|
+
- [`GET payments/:id` endpoint] The response object for a partially captured payment has been updated.
|
|
24
|
+
|
|
25
|
+
- **Return value changes**:
|
|
26
|
+
- `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
|
|
27
|
+
- `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment.
|
|
28
|
+
|
|
29
|
+
- [`PATCH payments/:id` endpoint] The response object for a partially captured payment has been updated.
|
|
30
|
+
|
|
31
|
+
- **Return value changes**:
|
|
32
|
+
- `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
|
|
33
|
+
- `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment.
|
|
34
|
+
|
|
35
|
+
- [`POST payments/:id/capture` endpoint] The response object for a partially captured payment has been updated.
|
|
36
|
+
|
|
37
|
+
- **Return value changes**:
|
|
38
|
+
- `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
|
|
39
|
+
- `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment.
|
|
40
|
+
|
|
41
|
+
- [`POST payments/:id/refund` endpoint] The response object for a partially captured payment has been updated.
|
|
42
|
+
|
|
43
|
+
- **Return value changes**:
|
|
44
|
+
- `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
|
|
45
|
+
- `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment.
|
|
46
|
+
|
|
47
|
+
- [`POST payments/:id/cancel` endpoint] The response object for a partially captured payment has been updated.
|
|
48
|
+
|
|
49
|
+
- **Return value changes**:
|
|
50
|
+
- `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
|
|
51
|
+
- `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment.
|
|
52
|
+
|
|
53
|
+
- [`POST payments/:id/finalize` endpoint] The response object for a partially captured payment has been updated.
|
|
54
|
+
|
|
55
|
+
- `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
|
|
56
|
+
- `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment.
|
|
57
|
+
|
|
58
|
+
- [`GET merchants/{merchant_id}/payments` endpoint] The response object for a partially captured payment has been updated.
|
|
59
|
+
|
|
60
|
+
- **Return value changes**:
|
|
61
|
+
- `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
|
|
62
|
+
- `refunds`: partially captured payments no longer show a refund for the difference between the authorized amount and captured amount.
|
|
63
|
+
|
|
64
|
+
- [`GET balances/:id` endpoint] Transformed the response to a nested (2D) structure to match the Merchant dashboard's Payout Balance page.
|
|
65
|
+
|
|
66
|
+
- **Renamed keys**: `balance_total` is now `total_balance_cents`.
|
|
67
|
+
- **Removed keys**: `payment_fee_total`, `tax_total`.
|
|
68
|
+
- **Structural changes**: Added new `payments`, `refunds`, `platform_model`, `corrections`, `komoju_card_charges` and `misc` sections.
|
|
69
|
+
- `payments`:
|
|
70
|
+
- Moved here: `payment_total` now called `captured_amount_total_cents`
|
|
71
|
+
- New keys: `processing_fees_cents`
|
|
72
|
+
- `refunds`:
|
|
73
|
+
- Moved here:
|
|
74
|
+
- `refund_total` now called `refunded_amount_total_cents`
|
|
75
|
+
- `refund_fee_total` now called `refund_processing_fees_cents` and includes tax
|
|
76
|
+
- `refunded_customer_fee_total` now called `refunded_customer_fees_cents` and includes tax
|
|
77
|
+
- `platform_model` (only available for Platform merchants):
|
|
78
|
+
- Moved here: `fund_transfer_total_cents`
|
|
79
|
+
- New keys: `payment_share_total_cents`, `payment_share_refund_total_cents`, `platform_fee_total_cents`, `platform_fee_refund_total_cents`, `submerchant_management_fees_cents`.
|
|
80
|
+
- `disbursements`:
|
|
81
|
+
- New keys: `disbursement_amount_total_cents`, `disbursement_fee_total_cents`
|
|
82
|
+
- `misc`:
|
|
83
|
+
- New keys: `clearing_total_cents`, `komoju_card_discount_total_cents`, `chargeback_fixed_fee_total_cents`, `other_fee_adjustments_total_cents` (this is the sum of all fee adjustments, any misc. record types that don't belong in other sections, and/or any new types of records that impact a merchant's balance. Refer to the API reference for the exhaustive list).
|
|
84
|
+
- For each section, added a `total_cents` of each of its amounts.
|
|
85
|
+
|
|
86
|
+
- [`GET settlements` endpoint] Renamed one key name, added a number of new keys, and made changes to several returned values.
|
|
87
|
+
|
|
88
|
+
- **Renamed keys**:
|
|
89
|
+
- `amount` is now `settlement_amount_cents` in order to make the key more clear and less generic.
|
|
90
|
+
|
|
91
|
+
- **Added keys**:
|
|
92
|
+
- NOTE: values for keys ending in `_cents` are returned as integers (not strings); any integers related to fees can be negative integers.
|
|
93
|
+
- `transaction_amount_cents`
|
|
94
|
+
- `fee_amount_cents`
|
|
95
|
+
- `fee_tax_amount_cents`
|
|
96
|
+
- `fx_currency`
|
|
97
|
+
- `fx_conversion_rate`
|
|
98
|
+
- `fx_conversion_amount_cents`
|
|
99
|
+
- `bank_transfer_fee_amount_cents`
|
|
100
|
+
- `remittance_amount_cents`
|
|
101
|
+
|
|
102
|
+
- **Return value changes**:
|
|
103
|
+
- `status`: "automatic_pending" is now returned as "pending".
|
|
104
|
+
- `settlement_amount_cents` (formerly `amount`): the value of `settlement_amount_cents` is now returned as an integer rather than a string.
|
|
105
|
+
- `download`: all keys in this section (such as `csv` or `xls`) will show "null" instead of a link if the settlement is cancelled. If the settlement is not cancelled, all links will point to an updated version of the report.
|
|
106
|
+
|
|
107
|
+
- [`GET settlements/:id` endpoint] Renamed two key names, added a number of new keys, made changes to several returned values, and transformed the response to a nested (2D) structure to include details for various kinds of payments and fees.
|
|
108
|
+
|
|
109
|
+
- **Renamed keys**:
|
|
110
|
+
- `amount` is now `settlement_amount_cents` in order to make the key more clear and less generic.
|
|
111
|
+
|
|
112
|
+
- **Removed keys**:
|
|
113
|
+
- `payment_total`
|
|
114
|
+
- `payment_fee_total`
|
|
115
|
+
- `refund_total`
|
|
116
|
+
- `refund_fee_total`
|
|
117
|
+
- `refunded_customer_fee_total`
|
|
118
|
+
- `correction_total`
|
|
119
|
+
- `tax_total`
|
|
120
|
+
- `balance_amount`
|
|
121
|
+
|
|
122
|
+
- **Added keys**:
|
|
123
|
+
- NOTE: values for keys ending in `_cents` are returned as integers (not strings); any integers related to fees can be negative integers.
|
|
124
|
+
- `transaction_amount_cents`
|
|
125
|
+
- `fee_amount_cents`
|
|
126
|
+
- `fee_tax_amount_cents`
|
|
127
|
+
- `fx_currency`
|
|
128
|
+
- `fx_conversion_rate`
|
|
129
|
+
- `fx_conversion_amount_cents`
|
|
130
|
+
- `bank_transfer_fee_amount_cents`
|
|
131
|
+
- `remittance_amount_cents`
|
|
132
|
+
- `payments`, `refunds`, `platform_model`, `corrections`, `komoju_card_charges`, `disbursements`, `misc` sections (see `GET balances/:id` above for structure)
|
|
133
|
+
|
|
134
|
+
- **Return value changes**:
|
|
135
|
+
- `download`: all keys in this section (such as `csv` or `xls`) will show "null" instead of a link if the settlement is cancelled. If the settlement is not cancelled, all links will point to an updated version of the report. Additionally, URLs for downloading settlement CSV and XLS files will point to a new version of the report.
|
|
136
|
+
|
|
137
|
+
- [`GET settlements/:id/csv` endpoint] Updated format of the report.
|
|
138
|
+
|
|
139
|
+
- [`GET settlements/:id/xls` endpoint] Updated format of the report.
|
|
140
|
+
|
|
141
|
+
## [1.0.0.beta.2] - 2026-06-11
|
|
142
|
+
|
|
143
|
+
No changes. Release to verify CI runner configuration.
|
|
144
|
+
|
|
5
145
|
## [1.0.0.beta.1] - 2026-05-25
|
|
6
146
|
|
|
7
147
|
Targets KOMOJU API version `2025-01-28`.
|
data/README.md
CHANGED
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
# komoju-sdk
|
|
2
2
|
|
|
3
|
-
Ruby gem for the KOMOJU API
|
|
3
|
+
The KOMOJU Ruby SDK is a full-featured gem for the KOMOJU Payments API. It works with any Ruby application or framework, including Rails.
|
|
4
|
+
|
|
5
|
+
For a full reference of all available endpoints and models, see the [KOMOJU API Reference](https://doc.komoju.com/reference/getting-started).
|
|
4
6
|
|
|
5
7
|
## Installation
|
|
6
8
|
|
|
7
9
|
Add to your Gemfile:
|
|
8
10
|
|
|
9
11
|
```ruby
|
|
10
|
-
gem 'komoju-sdk', '~> 1.0.0
|
|
12
|
+
gem 'komoju-sdk', '~> 1.0.0'
|
|
11
13
|
```
|
|
12
14
|
|
|
13
15
|
Then run `bundle install`.
|
|
@@ -25,60 +27,61 @@ end
|
|
|
25
27
|
|
|
26
28
|
Get your API keys from the [KOMOJU Merchant Settings](https://komoju.com/merchant/settings).
|
|
27
29
|
|
|
28
|
-
|
|
30
|
+
## Example: Hosted Page Payment
|
|
31
|
+
|
|
32
|
+
The following example walks through a basic hosted page payment flow. For a full guide, see the [Hosted Page Integration Guide](https://doc.komoju.com/docs/hosted-page-integration-guide).
|
|
33
|
+
|
|
34
|
+
### 1. Creating a Session
|
|
29
35
|
|
|
30
|
-
|
|
36
|
+
When your customer is ready to pay, create a session and redirect them to the returned `session_url`.
|
|
31
37
|
|
|
32
38
|
```ruby
|
|
33
|
-
|
|
39
|
+
sessions_api = Komoju::SessionsApi.new
|
|
34
40
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
type: 'credit_card',
|
|
42
|
-
number: '4111111111111111',
|
|
43
|
-
month: 12,
|
|
44
|
-
year: 2025,
|
|
45
|
-
verification_value: '123'
|
|
46
|
-
}
|
|
47
|
-
)
|
|
41
|
+
session = sessions_api.create_session(
|
|
42
|
+
Komoju::CreateSessionRequestWithPaymentMode.new(
|
|
43
|
+
mode: 'payment',
|
|
44
|
+
amount: 1000,
|
|
45
|
+
currency: 'JPY',
|
|
46
|
+
return_url: 'https://your-site.com/orders/return'
|
|
48
47
|
)
|
|
49
|
-
|
|
48
|
+
)
|
|
50
49
|
|
|
51
|
-
|
|
52
|
-
captured = payments_api.capture_payment(payment.id, Komoju::CapturePaymentRequest.new)
|
|
53
|
-
puts "Payment captured: #{captured.captured_at}"
|
|
54
|
-
rescue Komoju::ApiError => e
|
|
55
|
-
puts "Error #{e.code}: #{e.message}"
|
|
56
|
-
end
|
|
50
|
+
redirect_to session.session_url, allow_other_host: true
|
|
57
51
|
```
|
|
58
52
|
|
|
59
|
-
###
|
|
53
|
+
### 2. Handling the Return URL
|
|
54
|
+
|
|
55
|
+
After the customer pays, KOMOJU redirects them back to your `return_url` with a `session_id` query param appended:
|
|
60
56
|
|
|
61
|
-
|
|
57
|
+
```
|
|
58
|
+
https://your-site.com/orders/return?session_id=xxxxx
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Fetch the session to check the outcome:
|
|
62
62
|
|
|
63
63
|
```ruby
|
|
64
64
|
sessions_api = Komoju::SessionsApi.new
|
|
65
|
+
komoju_session = sessions_api.show_session(params[:session_id])
|
|
65
66
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
currency: 'JPY',
|
|
72
|
-
return_url: 'https://example.com/thank-you',
|
|
73
|
-
default_locale: 'ja'
|
|
74
|
-
)
|
|
75
|
-
)
|
|
76
|
-
puts "Redirect customer to: #{session.session_url}"
|
|
77
|
-
rescue Komoju::ApiError => e
|
|
78
|
-
puts "Error #{e.code}: #{e.message}"
|
|
67
|
+
if komoju_session.status == Komoju::SessionStatus::COMPLETED
|
|
68
|
+
# payment.status will be "captured", "authorized", or "pending"
|
|
69
|
+
puts "Payment #{komoju_session.payment.status}"
|
|
70
|
+
else
|
|
71
|
+
puts "Payment was cancelled or failed"
|
|
79
72
|
end
|
|
80
73
|
```
|
|
81
74
|
|
|
75
|
+
### 3. Set Up Webhooks (Recommended)
|
|
76
|
+
|
|
77
|
+
It is possible that the redirect in step 2 fails, possibly due to the user closing their browser, network issues, etc. Or, that the capture will only take place later on, such as with Convenience Store payments. To account for this, we recommend setting up a [Webhook](https://doc.komoju.com/docs/webhooks) to listen for payment events such as `payment.captured`, `payment.authorized`, and `payment.cancelled`. Configure your webhook URL in the [KOMOJU Merchant Dashboard](https://komoju.com/merchant/settings).
|
|
78
|
+
|
|
79
|
+
#### Verifying Webhook Signatures
|
|
80
|
+
|
|
81
|
+
To ensure a webhook request genuinely came from KOMOJU, set a **secret token** when creating or updating the webhook. KOMOJU then signs every delivery with a SHA-256 HMAC of the raw request body in the `X-Komoju-Signature` header, which you can recompute and verify.
|
|
82
|
+
|
|
83
|
+
See [Webhooks → Secret Token](https://doc.komoju.com/docs/webhooks#secret-token) for the full explanation and code examples.
|
|
84
|
+
|
|
82
85
|
## Error Handling
|
|
83
86
|
|
|
84
87
|
All API errors raise `Komoju::ApiError`:
|
|
@@ -101,6 +104,10 @@ All URIs are relative to *https://komoju.com/api/v1*
|
|
|
101
104
|
Class | Method | HTTP request | Description
|
|
102
105
|
------------ | ------------- | ------------- | -------------
|
|
103
106
|
*Komoju::BarcodesApi* | [**show_barcode**](docs/BarcodesApi.md#show_barcode) | **GET** /barcodes/{payment_id} | Barcode: Show
|
|
107
|
+
*Komoju::ChargebacksApi* | [**accept_chargeback_request**](docs/ChargebacksApi.md#accept_chargeback_request) | **POST** /chargeback_requests/{id}/accept | Chargeback: Accept
|
|
108
|
+
*Komoju::ChargebacksApi* | [**defend_chargeback_request**](docs/ChargebacksApi.md#defend_chargeback_request) | **POST** /chargeback_requests/{id}/defend | Chargeback: Defend
|
|
109
|
+
*Komoju::ChargebacksApi* | [**list_chargeback_requests**](docs/ChargebacksApi.md#list_chargeback_requests) | **GET** /chargeback_requests | Chargeback: List
|
|
110
|
+
*Komoju::ChargebacksApi* | [**show_chargeback_request**](docs/ChargebacksApi.md#show_chargeback_request) | **GET** /chargeback_requests/{id} | Chargeback: Show
|
|
104
111
|
*Komoju::DisbursementsApi* | [**cancel_disbursement**](docs/DisbursementsApi.md#cancel_disbursement) | **POST** /disbursements/{id}/cancel | Disbursement: Cancel
|
|
105
112
|
*Komoju::DisbursementsApi* | [**create_disbursement**](docs/DisbursementsApi.md#create_disbursement) | **POST** /disbursements | Disbursement: Create
|
|
106
113
|
*Komoju::DisbursementsApi* | [**disbursement_report**](docs/DisbursementsApi.md#disbursement_report) | **GET** /disbursements/report | Disbursement: Report
|
|
@@ -123,7 +130,7 @@ Class | Method | HTTP request | Description
|
|
|
123
130
|
*Komoju::PlatformModelApi* | [**create_file**](docs/PlatformModelApi.md#create_file) | **POST** /merchants/{merchant_id}/files | File: Create
|
|
124
131
|
*Komoju::PlatformModelApi* | [**create_merchant**](docs/PlatformModelApi.md#create_merchant) | **POST** /merchants | Merchant: Create
|
|
125
132
|
*Komoju::PlatformModelApi* | [**create_merchant_balance_transfer**](docs/PlatformModelApi.md#create_merchant_balance_transfer) | **POST** /merchants/{merchant_id}/balances/{currency}/transfer | Balance: Transfer
|
|
126
|
-
*Komoju::PlatformModelApi* | [**edit_merchant_balance_settings**](docs/PlatformModelApi.md#edit_merchant_balance_settings) | **
|
|
133
|
+
*Komoju::PlatformModelApi* | [**edit_merchant_balance_settings**](docs/PlatformModelApi.md#edit_merchant_balance_settings) | **PUT** /merchants/{merchant_id}/balances/{currency}/settings | Balances: Edit Settings
|
|
127
134
|
*Komoju::PlatformModelApi* | [**list_live_application_payment_methods**](docs/PlatformModelApi.md#list_live_application_payment_methods) | **GET** /live_application/{merchant_id}/payment_methods | Live Application: Payment Methods
|
|
128
135
|
*Komoju::PlatformModelApi* | [**list_merchants**](docs/PlatformModelApi.md#list_merchants) | **GET** /merchants | Merchant: List
|
|
129
136
|
*Komoju::PlatformModelApi* | [**list_submerchant_payments**](docs/PlatformModelApi.md#list_submerchant_payments) | **GET** /merchants/{merchant_id}/payments | Payment: List for Merchant
|
|
@@ -151,7 +158,9 @@ Class | Method | HTTP request | Description
|
|
|
151
158
|
*Komoju::SessionsApi* | [**create_session**](docs/SessionsApi.md#create_session) | **POST** /sessions | Session: Create
|
|
152
159
|
*Komoju::SessionsApi* | [**pay_session**](docs/SessionsApi.md#pay_session) | **POST** /sessions/{id}/pay | Session: Pay
|
|
153
160
|
*Komoju::SessionsApi* | [**show_session**](docs/SessionsApi.md#show_session) | **GET** /sessions/{id} | Session: Show
|
|
161
|
+
*Komoju::SettlementsApi* | [**balance_transactions**](docs/SettlementsApi.md#balance_transactions) | **GET** /balances/{currency}/transactions | Balance: Transactions
|
|
154
162
|
*Komoju::SettlementsApi* | [**list_settlements**](docs/SettlementsApi.md#list_settlements) | **GET** /settlements | Settlement: Index
|
|
163
|
+
*Komoju::SettlementsApi* | [**show_balance**](docs/SettlementsApi.md#show_balance) | **GET** /balances/{currency} | Balance: Show
|
|
155
164
|
*Komoju::SettlementsApi* | [**show_settlement**](docs/SettlementsApi.md#show_settlement) | **GET** /settlements/{id} | Settlement: Show
|
|
156
165
|
*Komoju::SettlementsApi* | [**show_settlement_csv**](docs/SettlementsApi.md#show_settlement_csv) | **GET** /settlements/{id}/csv | Settlement: CSV
|
|
157
166
|
*Komoju::SettlementsApi* | [**show_settlement_pdf**](docs/SettlementsApi.md#show_settlement_pdf) | **GET** /settlements/{id}/pdf | Settlement: PDF
|
|
@@ -186,7 +195,18 @@ Class | Method | HTTP request | Description
|
|
|
186
195
|
- [Komoju::BarcodeReadyResponse](docs/BarcodeReadyResponse.md)
|
|
187
196
|
- [Komoju::CancelDisbursementRequest](docs/CancelDisbursementRequest.md)
|
|
188
197
|
- [Komoju::CapturePaymentRequest](docs/CapturePaymentRequest.md)
|
|
189
|
-
- [Komoju::
|
|
198
|
+
- [Komoju::ChargebackCustomer](docs/ChargebackCustomer.md)
|
|
199
|
+
- [Komoju::ChargebackDefense](docs/ChargebackDefense.md)
|
|
200
|
+
- [Komoju::ChargebackDefenseDocument](docs/ChargebackDefenseDocument.md)
|
|
201
|
+
- [Komoju::ChargebackDefenseRecipientInfo](docs/ChargebackDefenseRecipientInfo.md)
|
|
202
|
+
- [Komoju::ChargebackDefenseShippingInfo](docs/ChargebackDefenseShippingInfo.md)
|
|
203
|
+
- [Komoju::ChargebackPayment](docs/ChargebackPayment.md)
|
|
204
|
+
- [Komoju::ChargebackPaymentMethod](docs/ChargebackPaymentMethod.md)
|
|
205
|
+
- [Komoju::ChargebackRequestDetail](docs/ChargebackRequestDetail.md)
|
|
206
|
+
- [Komoju::ChargebackRequestList](docs/ChargebackRequestList.md)
|
|
207
|
+
- [Komoju::ChargebackRequestListItem](docs/ChargebackRequestListItem.md)
|
|
208
|
+
- [Komoju::ChargebackStatus](docs/ChargebackStatus.md)
|
|
209
|
+
- [Komoju::ChargebackTimelineEntry](docs/ChargebackTimelineEntry.md)
|
|
190
210
|
- [Komoju::CountryCode](docs/CountryCode.md)
|
|
191
211
|
- [Komoju::CreateCustomerRequest](docs/CreateCustomerRequest.md)
|
|
192
212
|
- [Komoju::CreateDisbursementRequest](docs/CreateDisbursementRequest.md)
|
|
@@ -210,9 +230,12 @@ Class | Method | HTTP request | Description
|
|
|
210
230
|
- [Komoju::Currency](docs/Currency.md)
|
|
211
231
|
- [Komoju::Customer](docs/Customer.md)
|
|
212
232
|
- [Komoju::CustomerList](docs/CustomerList.md)
|
|
213
|
-
- [Komoju::CustomerMetadata](docs/CustomerMetadata.md)
|
|
214
233
|
- [Komoju::CustomerSource](docs/CustomerSource.md)
|
|
215
|
-
- [Komoju::
|
|
234
|
+
- [Komoju::DefendChargebackDocument](docs/DefendChargebackDocument.md)
|
|
235
|
+
- [Komoju::DefendChargebackRecipientInfo](docs/DefendChargebackRecipientInfo.md)
|
|
236
|
+
- [Komoju::DefendChargebackRequestBody](docs/DefendChargebackRequestBody.md)
|
|
237
|
+
- [Komoju::DefendChargebackShippingInfo](docs/DefendChargebackShippingInfo.md)
|
|
238
|
+
- [Komoju::DeleteExternalCustomer200Response](docs/DeleteExternalCustomer200Response.md)
|
|
216
239
|
- [Komoju::Disbursement](docs/Disbursement.md)
|
|
217
240
|
- [Komoju::DisbursementList](docs/DisbursementList.md)
|
|
218
241
|
- [Komoju::DisbursementStatus](docs/DisbursementStatus.md)
|
|
@@ -309,6 +332,9 @@ Class | Method | HTTP request | Description
|
|
|
309
332
|
- [Komoju::PaymentDetailsWechatpay](docs/PaymentDetailsWechatpay.md)
|
|
310
333
|
- [Komoju::PaymentList](docs/PaymentList.md)
|
|
311
334
|
- [Komoju::PaymentMethod](docs/PaymentMethod.md)
|
|
335
|
+
- [Komoju::PaymentMethodApplication](docs/PaymentMethodApplication.md)
|
|
336
|
+
- [Komoju::PaymentMethodApplicationStatus](docs/PaymentMethodApplicationStatus.md)
|
|
337
|
+
- [Komoju::PaymentMethodApplicationWithSubmittedFields](docs/PaymentMethodApplicationWithSubmittedFields.md)
|
|
312
338
|
- [Komoju::PaymentMethodBrands](docs/PaymentMethodBrands.md)
|
|
313
339
|
- [Komoju::PaymentMethodInstallmentsInner](docs/PaymentMethodInstallmentsInner.md)
|
|
314
340
|
- [Komoju::PaymentMethodStatus](docs/PaymentMethodStatus.md)
|
|
@@ -387,6 +413,7 @@ Class | Method | HTTP request | Description
|
|
|
387
413
|
- [Komoju::ResponsePaymentDetailsWebMoney](docs/ResponsePaymentDetailsWebMoney.md)
|
|
388
414
|
- [Komoju::ResponsePaymentDetailsWechatpay](docs/ResponsePaymentDetailsWechatpay.md)
|
|
389
415
|
- [Komoju::SecureToken](docs/SecureToken.md)
|
|
416
|
+
- [Komoju::SecureTokenThreeDSecureAccount](docs/SecureTokenThreeDSecureAccount.md)
|
|
390
417
|
- [Komoju::SerializedSubmerchant](docs/SerializedSubmerchant.md)
|
|
391
418
|
- [Komoju::SerializedSubmerchantActivePaymentMethodsInner](docs/SerializedSubmerchantActivePaymentMethodsInner.md)
|
|
392
419
|
- [Komoju::SerializedSubmerchantExpirySettingsInner](docs/SerializedSubmerchantExpirySettingsInner.md)
|
|
@@ -405,6 +432,7 @@ Class | Method | HTTP request | Description
|
|
|
405
432
|
- [Komoju::SharedDetailsPayments](docs/SharedDetailsPayments.md)
|
|
406
433
|
- [Komoju::SharedDetailsPlatformModel](docs/SharedDetailsPlatformModel.md)
|
|
407
434
|
- [Komoju::SharedDetailsRefunds](docs/SharedDetailsRefunds.md)
|
|
435
|
+
- [Komoju::ShowBalance200Response](docs/ShowBalance200Response.md)
|
|
408
436
|
- [Komoju::ShowBarcodeResponse](docs/ShowBarcodeResponse.md)
|
|
409
437
|
- [Komoju::SimulateLiveApplicationPaymentMethodStatusRequest](docs/SimulateLiveApplicationPaymentMethodStatusRequest.md)
|
|
410
438
|
- [Komoju::StatementDescriptor](docs/StatementDescriptor.md)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **resource** | **String** | Resource type name for this list, always \"
|
|
7
|
+
| **resource** | **String** | Resource type name for this list, always \"list\". | |
|
|
8
8
|
| **data** | [**Array<Transaction>**](Transaction.md) | Array of ledger transaction objects. | |
|
|
9
9
|
| **start_time** | **Time** | Start of the time range for records in this response. | |
|
|
10
10
|
| **end_time** | **Time** | End of the time range for records in this response. | |
|
data/docs/BarcodesApi.md
CHANGED
|
@@ -23,11 +23,6 @@ Fetches the latest barcode for a konbini payment. Barcodes can be displayed in
|
|
|
23
23
|
```ruby
|
|
24
24
|
require 'time'
|
|
25
25
|
require 'komoju-sdk'
|
|
26
|
-
# setup authorization
|
|
27
|
-
Komoju.configure do |config|
|
|
28
|
-
# Configure your KOMOJU API key
|
|
29
|
-
config.api_key = 'YOUR_API_KEY'
|
|
30
|
-
end
|
|
31
26
|
|
|
32
27
|
api_instance = Komoju::BarcodesApi.new
|
|
33
28
|
payment_id = 'payment_id_example' # String | Payment unique identifier
|
|
@@ -71,7 +66,7 @@ end
|
|
|
71
66
|
|
|
72
67
|
### Authorization
|
|
73
68
|
|
|
74
|
-
|
|
69
|
+
No authorization required
|
|
75
70
|
|
|
76
71
|
### HTTP request headers
|
|
77
72
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **amount** | **Integer** | The payment amount before tax, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). | [optional] |
|
|
8
|
-
| **tax** | [**
|
|
8
|
+
| **tax** | [**CreatePaymentRequestWithPaymentDetailsTax**](CreatePaymentRequestWithPaymentDetailsTax.md) | | [optional] |
|
|
9
9
|
| **platform_details** | [**PlatformDetails**](PlatformDetails.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Komoju::ChargebackCustomer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Customer's name, or null if not provided. | |
|
|
8
|
+
| **email** | **String** | Customer's email address, or null if not provided. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'komoju-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Komoju::ChargebackCustomer.new(
|
|
16
|
+
name: null,
|
|
17
|
+
email: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Komoju::ChargebackDefense
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **product_name** | **String** | Name of the product or service, or null if not provided. | |
|
|
8
|
+
| **reason** | **String** | The merchant's defense reason. | |
|
|
9
|
+
| **shipping_info** | [**ChargebackDefenseShippingInfo**](ChargebackDefenseShippingInfo.md) | | |
|
|
10
|
+
| **recipient_info** | [**ChargebackDefenseRecipientInfo**](ChargebackDefenseRecipientInfo.md) | | |
|
|
11
|
+
| **documents** | [**Array<ChargebackDefenseDocument>**](ChargebackDefenseDocument.md) | Supporting documents submitted with the defense. | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'komoju-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Komoju::ChargebackDefense.new(
|
|
19
|
+
product_name: null,
|
|
20
|
+
reason: null,
|
|
21
|
+
shipping_info: null,
|
|
22
|
+
recipient_info: null,
|
|
23
|
+
documents: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Komoju::ChargebackDefenseDocument
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **file_name** | **String** | Stored file name. | |
|
|
8
|
+
| **content_type** | **String** | MIME type of the document. | |
|
|
9
|
+
| **file_size** | **Integer** | File size in bytes. | |
|
|
10
|
+
| **uploaded_at** | **Time** | When the document was uploaded. | |
|
|
11
|
+
| **url** | **String** | Temporary signed URL to download the document. | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'komoju-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Komoju::ChargebackDefenseDocument.new(
|
|
19
|
+
file_name: null,
|
|
20
|
+
content_type: null,
|
|
21
|
+
file_size: null,
|
|
22
|
+
uploaded_at: null,
|
|
23
|
+
url: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Komoju::ChargebackDefenseRecipientInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Recipient's name, or null. | |
|
|
8
|
+
| **phone** | **String** | Recipient's phone number, or null. | |
|
|
9
|
+
| **email** | **String** | Recipient's email address, or null. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'komoju-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Komoju::ChargebackDefenseRecipientInfo.new(
|
|
17
|
+
name: null,
|
|
18
|
+
phone: null,
|
|
19
|
+
email: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Komoju::ChargebackDefenseShippingInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_name** | **String** | Shipping carrier company name, or null. | |
|
|
8
|
+
| **shipping_date** | **String** | Date the item was shipped (e.g. 2026-05-20), or null. | |
|
|
9
|
+
| **tracking_number** | **String** | Carrier tracking number, or null. | |
|
|
10
|
+
| **shipping_address** | **String** | Destination shipping address, or null. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'komoju-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Komoju::ChargebackDefenseShippingInfo.new(
|
|
18
|
+
company_name: null,
|
|
19
|
+
shipping_date: null,
|
|
20
|
+
tracking_number: null,
|
|
21
|
+
shipping_address: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Komoju::ChargebackPayment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | A unique 25-character alphanumeric resource identifier. | |
|
|
8
|
+
| **amount** | **Integer** | Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). | |
|
|
9
|
+
| **currency** | [**Currency**](Currency.md) | | |
|
|
10
|
+
| **created_at** | **Time** | Timestamp when the payment was created. | |
|
|
11
|
+
| **captured_at** | **Time** | Timestamp when the payment was captured, or null. | |
|
|
12
|
+
| **payment_method** | [**ChargebackPaymentMethod**](ChargebackPaymentMethod.md) | | |
|
|
13
|
+
| **masked_card_number** | **String** | Masked card number, or null if not applicable. | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'komoju-sdk'
|
|
19
|
+
|
|
20
|
+
instance = Komoju::ChargebackPayment.new(
|
|
21
|
+
id: null,
|
|
22
|
+
amount: null,
|
|
23
|
+
currency: null,
|
|
24
|
+
created_at: null,
|
|
25
|
+
captured_at: null,
|
|
26
|
+
payment_method: null,
|
|
27
|
+
masked_card_number: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Komoju::ChargebackPaymentMethod
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Payment method type slug (e.g. \"credit_card\"). | |
|
|
8
|
+
| **brand** | **String** | Card brand, or null if not applicable. | |
|
|
9
|
+
| **last_four_digits** | **String** | Last four digits of the card, or null if not applicable. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'komoju-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Komoju::ChargebackPaymentMethod.new(
|
|
17
|
+
type: null,
|
|
18
|
+
brand: null,
|
|
19
|
+
last_four_digits: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Komoju::ChargebackRequestDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | A unique 25-character alphanumeric resource identifier. | |
|
|
8
|
+
| **status** | [**ChargebackStatus**](ChargebackStatus.md) | | |
|
|
9
|
+
| **reason_code** | **String** | Machine-readable reason code. Internal codes (e.g. \"CB_Fraud\") are used by default; for Worldpay Visa/Mastercard payments the network's own reason codes are used instead (e.g. \"10.4\" or \"4837\"). | |
|
|
10
|
+
| **reason** | **String** | Human-readable chargeback reason corresponding to the reason code. | |
|
|
11
|
+
| **created_at** | **Time** | Timestamp when the chargeback was created. | |
|
|
12
|
+
| **due_date** | **Time** | Deadline by which the merchant must respond. | |
|
|
13
|
+
| **last_updated_at** | **Time** | Timestamp when the chargeback was last updated. | |
|
|
14
|
+
| **timeline** | [**Array<ChargebackTimelineEntry>**](ChargebackTimelineEntry.md) | Chronological list of chargeback events. | |
|
|
15
|
+
| **payment** | [**ChargebackPayment**](ChargebackPayment.md) | | |
|
|
16
|
+
| **customer** | [**ChargebackCustomer**](ChargebackCustomer.md) | | |
|
|
17
|
+
| **defense** | [**ChargebackDefense**](ChargebackDefense.md) | | |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'komoju-sdk'
|
|
23
|
+
|
|
24
|
+
instance = Komoju::ChargebackRequestDetail.new(
|
|
25
|
+
id: null,
|
|
26
|
+
status: null,
|
|
27
|
+
reason_code: CB_Fraud,
|
|
28
|
+
reason: null,
|
|
29
|
+
created_at: null,
|
|
30
|
+
due_date: null,
|
|
31
|
+
last_updated_at: null,
|
|
32
|
+
timeline: null,
|
|
33
|
+
payment: null,
|
|
34
|
+
customer: null,
|
|
35
|
+
defense: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Komoju::ChargebackRequestList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **resource** | **String** | Resource type name, always \"list\". | |
|
|
8
|
+
| **data** | [**Array<ChargebackRequestListItem>**](ChargebackRequestListItem.md) | Array of chargeback request objects for this page. | |
|
|
9
|
+
| **start_time** | **Time** | Start of the time range for records in this response. | |
|
|
10
|
+
| **end_time** | **Time** | End of the time range for records in this response. | |
|
|
11
|
+
| **total** | **Integer** | Total number of records matching the query. | |
|
|
12
|
+
| **page** | **Integer** | Current page number. | |
|
|
13
|
+
| **per_page** | **Integer** | Number of results per page. | |
|
|
14
|
+
| **last_page** | **Integer** | Last available page number. | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'komoju-sdk'
|
|
20
|
+
|
|
21
|
+
instance = Komoju::ChargebackRequestList.new(
|
|
22
|
+
resource: null,
|
|
23
|
+
data: null,
|
|
24
|
+
start_time: null,
|
|
25
|
+
end_time: null,
|
|
26
|
+
total: null,
|
|
27
|
+
page: null,
|
|
28
|
+
per_page: null,
|
|
29
|
+
last_page: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|