├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.md ├── doc ├── api-helper.md ├── auth │ └── basic-authentication.md ├── client.md ├── controllers │ ├── balance-operations.md │ ├── charges.md │ ├── customers.md │ ├── invoices.md │ ├── orders.md │ ├── payables.md │ ├── plans.md │ ├── recipients.md │ ├── subscriptions.md │ ├── tokens.md │ ├── transactions.md │ └── transfers.md ├── http-date-time.md ├── http-request.md ├── http-response.md ├── models │ ├── create-access-token-request.md │ ├── create-address-request.md │ ├── create-anticipation-request.md │ ├── create-antifraud-request.md │ ├── create-apple-pay-header-request.md │ ├── create-apple-pay-request.md │ ├── create-automatic-anticipation-settings-request.md │ ├── create-bank-account-refunding-dto.md │ ├── create-bank-account-request.md │ ├── create-bank-transfer-payment-request.md │ ├── create-boleto-payment-request.md │ ├── create-cancel-charge-request.md │ ├── create-cancel-charge-split-rules-request.md │ ├── create-cancel-subscription-request.md │ ├── create-capture-charge-request.md │ ├── create-card-options-request.md │ ├── create-card-payload-request.md │ ├── create-card-payment-contactless-poi-request.md │ ├── create-card-payment-contactless-request.md │ ├── create-card-request.md │ ├── create-card-token-request.md │ ├── create-cash-payment-request.md │ ├── create-charge-request.md │ ├── create-checkout-bank-transfer-request.md │ ├── create-checkout-boleto-payment-request.md │ ├── create-checkout-card-installment-option-request.md │ ├── create-checkout-credit-card-payment-request.md │ ├── create-checkout-debit-card-payment-request.md │ ├── create-checkout-payment-request.md │ ├── create-checkout-pix-payment-request.md │ ├── create-clear-sale-request.md │ ├── create-confirm-payment-request.md │ ├── create-credit-card-payment-request.md │ ├── create-customer-request.md │ ├── create-debit-card-payment-request.md │ ├── create-device-request.md │ ├── create-discount-request.md │ ├── create-emv-data-decrypt-request.md │ ├── create-emv-data-dukpt-decrypt-request.md │ ├── create-emv-data-tlv-decrypt-request.md │ ├── create-emv-decrypt-request.md │ ├── create-fine-request.md │ ├── create-google-pay-header-request.md │ ├── create-google-pay-intermediate-signing-key-request.md │ ├── create-google-pay-request.md │ ├── create-increment-request.md │ ├── create-interest-request.md │ ├── create-invoice-request.md │ ├── create-kyc-link-response.md │ ├── create-location-request.md │ ├── create-managing-partner-request.md │ ├── create-order-item-request.md │ ├── create-order-request.md │ ├── create-payment-authentication-request.md │ ├── create-payment-origin-request.md │ ├── create-payment-request.md │ ├── create-period-request.md │ ├── create-phone-request.md │ ├── create-phones-request.md │ ├── create-pix-payment-request.md │ ├── create-plan-item-request.md │ ├── create-plan-request.md │ ├── create-price-bracket-request.md │ ├── create-pricing-scheme-request.md │ ├── create-private-label-payment-request.md │ ├── create-recipient-request.md │ ├── create-register-information-address-request.md │ ├── create-register-information-base-request.md │ ├── create-register-information-corporation-request.md │ ├── create-register-information-individual-request.md │ ├── create-register-information-phone-request.md │ ├── create-setup-request.md │ ├── create-shipping-request.md │ ├── create-split-options-request.md │ ├── create-split-request.md │ ├── create-sub-merchant-request.md │ ├── create-subscription-boleto-request.md │ ├── create-subscription-item-request.md │ ├── create-subscription-request.md │ ├── create-subscription-split-request.md │ ├── create-three-d-secure-request.md │ ├── create-token-request.md │ ├── create-transaction-report-file-request.md │ ├── create-transfer-request.md │ ├── create-transfer-settings-request.md │ ├── create-transfer.md │ ├── create-usage-request.md │ ├── create-voucher-payment-request.md │ ├── create-withdraw-request.md │ ├── error-exception.md │ ├── get-access-token-response.md │ ├── get-address-response.md │ ├── get-anticipation-limit-response.md │ ├── get-anticipation-limits-response.md │ ├── get-anticipation-response.md │ ├── get-antifraud-response.md │ ├── get-automatic-anticipation-response.md │ ├── get-balance-operation-response.md │ ├── get-balance-response.md │ ├── get-bank-account-response.md │ ├── get-bank-transfer-transaction-response.md │ ├── get-billing-address-response.md │ ├── get-boleto-transaction-response.md │ ├── get-card-response.md │ ├── get-card-token-response.md │ ├── get-cash-transaction-response.md │ ├── get-charge-response.md │ ├── get-charges-summary-response.md │ ├── get-checkout-bank-transfer-payment-response.md │ ├── get-checkout-boleto-payment-response.md │ ├── get-checkout-card-installment-options-response.md │ ├── get-checkout-credit-card-payment-response.md │ ├── get-checkout-debit-card-payment-response.md │ ├── get-checkout-payment-response.md │ ├── get-checkout-payment-settings-response.md │ ├── get-checkout-pix-payment-response.md │ ├── get-credit-card-transaction-response.md │ ├── get-customer-response.md │ ├── get-debit-card-transaction-response.md │ ├── get-device-response.md │ ├── get-discount-response.md │ ├── get-fine-response.md │ ├── get-gateway-error-response.md │ ├── get-gateway-recipient-response.md │ ├── get-gateway-response-response.md │ ├── get-increment-response.md │ ├── get-integration-response.md │ ├── get-interest-response.md │ ├── get-invoice-item-response.md │ ├── get-invoice-response.md │ ├── get-location-response.md │ ├── get-managing-partner-response.md │ ├── get-movement-object-base-response.md │ ├── get-movement-object-fee-collection-response.md │ ├── get-movement-object-payable-response.md │ ├── get-movement-object-refund-response.md │ ├── get-movement-object-settlement-response.md │ ├── get-movement-object-transfer-response.md │ ├── get-order-item-response.md │ ├── get-order-response.md │ ├── get-payable-response.md │ ├── get-payment-authentication-response.md │ ├── get-payment-origin-response.md │ ├── get-period-response.md │ ├── get-phone-number-response.md │ ├── get-phone-response.md │ ├── get-phones-response.md │ ├── get-pix-bank-account-response.md │ ├── get-pix-payer-response.md │ ├── get-pix-transaction-response.md │ ├── get-plan-item-response.md │ ├── get-plan-response.md │ ├── get-price-bracket-response.md │ ├── get-pricing-scheme-response.md │ ├── get-private-label-transaction-response.md │ ├── get-recipient-response.md │ ├── get-register-information-address-response.md │ ├── get-register-information-response.md │ ├── get-retry-transaction-information-response.md │ ├── get-safety-pay-transaction-response.md │ ├── get-setup-response.md │ ├── get-shipping-response.md │ ├── get-split-options-response.md │ ├── get-split-response.md │ ├── get-subscription-boleto-response.md │ ├── get-subscription-item-response.md │ ├── get-subscription-response.md │ ├── get-subscription-split-response.md │ ├── get-three-d-secure-response.md │ ├── get-token-response.md │ ├── get-transaction-report-file-response.md │ ├── get-transaction-response.md │ ├── get-transfer-response.md │ ├── get-transfer-settings-response.md │ ├── get-transfer-source-response.md │ ├── get-transfer-target-response.md │ ├── get-transfer.md │ ├── get-usage-report-response.md │ ├── get-usage-response.md │ ├── get-voucher-transaction-response.md │ ├── get-withdraw-response.md │ ├── get-withdraw-source-response.md │ ├── get-withdraw-target-response.md │ ├── list-access-tokens-response.md │ ├── list-addresses-response.md │ ├── list-anticipation-response.md │ ├── list-balance-operation-response.md │ ├── list-cards-response.md │ ├── list-charge-transactions-response.md │ ├── list-charges-response.md │ ├── list-customers-response.md │ ├── list-cycles-response.md │ ├── list-discounts-response.md │ ├── list-increments-response.md │ ├── list-invoices-response.md │ ├── list-order-response.md │ ├── list-payables-response.md │ ├── list-plans-response.md │ ├── list-recipient-response.md │ ├── list-subscription-items-response.md │ ├── list-subscriptions-response.md │ ├── list-transactions-files-response.md │ ├── list-transactions-response.md │ ├── list-transfer-response.md │ ├── list-transfers.md │ ├── list-usages-response.md │ ├── list-withdrawals.md │ ├── paging-response.md │ ├── pix-additional-information.md │ ├── update-address-request.md │ ├── update-automatic-anticipation-settings-request.md │ ├── update-card-request.md │ ├── update-charge-card-request.md │ ├── update-charge-due-date-request.md │ ├── update-charge-payment-method-request.md │ ├── update-current-cycle-end-date-request.md │ ├── update-current-cycle-status-request.md │ ├── update-customer-request.md │ ├── update-invoice-status-request.md │ ├── update-metadata-request.md │ ├── update-order-item-request.md │ ├── update-order-status-request.md │ ├── update-plan-item-request.md │ ├── update-plan-request.md │ ├── update-price-bracket-request.md │ ├── update-pricing-scheme-request.md │ ├── update-recipient-bank-account-request.md │ ├── update-recipient-code-request.md │ ├── update-recipient-request.md │ ├── update-subscription-affiliation-id-request.md │ ├── update-subscription-billing-date-request.md │ ├── update-subscription-card-request.md │ ├── update-subscription-due-days-request.md │ ├── update-subscription-item-request.md │ ├── update-subscription-minimum-price-request.md │ ├── update-subscription-payment-method-request.md │ ├── update-subscription-split-request.md │ ├── update-subscription-start-at-request.md │ └── update-transfer-settings-request.md ├── rfc3339-date-time.md └── unix-date-time.md ├── pagarmeapisdk ├── __init__.py ├── api_helper.py ├── configuration.py ├── controllers │ ├── __init__.py │ ├── balance_operations_controller.py │ ├── base_controller.py │ ├── charges_controller.py │ ├── customers_controller.py │ ├── invoices_controller.py │ ├── orders_controller.py │ ├── payables_controller.py │ ├── plans_controller.py │ ├── recipients_controller.py │ ├── subscriptions_controller.py │ ├── tokens_controller.py │ ├── transactions_controller.py │ └── transfers_controller.py ├── exceptions │ ├── __init__.py │ ├── api_exception.py │ └── error_exception.py ├── http │ ├── __init__.py │ ├── auth │ │ ├── __init__.py │ │ └── basic_auth.py │ ├── http_call_back.py │ ├── http_method_enum.py │ ├── http_request.py │ └── http_response.py ├── models │ ├── __init__.py │ ├── create_access_token_request.py │ ├── create_address_request.py │ ├── create_anticipation_request.py │ ├── create_antifraud_request.py │ ├── create_apple_pay_header_request.py │ ├── create_apple_pay_request.py │ ├── create_automatic_anticipation_settings_request.py │ ├── create_bank_account_refunding_dto.py │ ├── create_bank_account_request.py │ ├── create_bank_transfer_payment_request.py │ ├── create_boleto_payment_request.py │ ├── create_cancel_charge_request.py │ ├── create_cancel_charge_split_rules_request.py │ ├── create_cancel_subscription_request.py │ ├── create_capture_charge_request.py │ ├── create_card_options_request.py │ ├── create_card_payload_request.py │ ├── create_card_payment_contactless_poi_request.py │ ├── create_card_payment_contactless_request.py │ ├── create_card_request.py │ ├── create_card_token_request.py │ ├── create_cash_payment_request.py │ ├── create_charge_request.py │ ├── create_checkout_bank_transfer_request.py │ ├── create_checkout_boleto_payment_request.py │ ├── create_checkout_card_installment_option_request.py │ ├── create_checkout_credit_card_payment_request.py │ ├── create_checkout_debit_card_payment_request.py │ ├── create_checkout_payment_request.py │ ├── create_checkout_pix_payment_request.py │ ├── create_clear_sale_request.py │ ├── create_confirm_payment_request.py │ ├── create_credit_card_payment_request.py │ ├── create_customer_request.py │ ├── create_debit_card_payment_request.py │ ├── create_device_request.py │ ├── create_discount_request.py │ ├── create_emv_data_decrypt_request.py │ ├── create_emv_data_dukpt_decrypt_request.py │ ├── create_emv_data_tlv_decrypt_request.py │ ├── create_emv_decrypt_request.py │ ├── create_fine_request.py │ ├── create_google_pay_header_request.py │ ├── create_google_pay_intermediate_signing_key_request.py │ ├── create_google_pay_request.py │ ├── create_increment_request.py │ ├── create_interest_request.py │ ├── create_invoice_request.py │ ├── create_kyc_link_response.py │ ├── create_location_request.py │ ├── create_managing_partner_request.py │ ├── create_order_item_request.py │ ├── create_order_request.py │ ├── create_payment_authentication_request.py │ ├── create_payment_origin_request.py │ ├── create_payment_request.py │ ├── create_period_request.py │ ├── create_phone_request.py │ ├── create_phones_request.py │ ├── create_pix_payment_request.py │ ├── create_plan_item_request.py │ ├── create_plan_request.py │ ├── create_price_bracket_request.py │ ├── create_pricing_scheme_request.py │ ├── create_private_label_payment_request.py │ ├── create_recipient_request.py │ ├── create_register_information_address_request.py │ ├── create_register_information_base_request.py │ ├── create_register_information_phone_request.py │ ├── create_setup_request.py │ ├── create_shipping_request.py │ ├── create_split_options_request.py │ ├── create_split_request.py │ ├── create_sub_merchant_request.py │ ├── create_subscription_boleto_request.py │ ├── create_subscription_item_request.py │ ├── create_subscription_request.py │ ├── create_subscription_split_request.py │ ├── create_three_d_secure_request.py │ ├── create_token_request.py │ ├── create_transaction_report_file_request.py │ ├── create_transfer.py │ ├── create_transfer_request.py │ ├── create_transfer_settings_request.py │ ├── create_usage_request.py │ ├── create_voucher_payment_request.py │ ├── create_withdraw_request.py │ ├── get_access_token_response.py │ ├── get_address_response.py │ ├── get_anticipation_limit_response.py │ ├── get_anticipation_limits_response.py │ ├── get_anticipation_response.py │ ├── get_antifraud_response.py │ ├── get_automatic_anticipation_response.py │ ├── get_balance_operation_response.py │ ├── get_balance_response.py │ ├── get_bank_account_response.py │ ├── get_billing_address_response.py │ ├── get_card_response.py │ ├── get_card_token_response.py │ ├── get_charge_response.py │ ├── get_charges_summary_response.py │ ├── get_checkout_bank_transfer_payment_response.py │ ├── get_checkout_boleto_payment_response.py │ ├── get_checkout_card_installment_options_response.py │ ├── get_checkout_credit_card_payment_response.py │ ├── get_checkout_debit_card_payment_response.py │ ├── get_checkout_payment_response.py │ ├── get_checkout_payment_settings_response.py │ ├── get_checkout_pix_payment_response.py │ ├── get_customer_response.py │ ├── get_device_response.py │ ├── get_discount_response.py │ ├── get_fine_response.py │ ├── get_gateway_error_response.py │ ├── get_gateway_recipient_response.py │ ├── get_gateway_response_response.py │ ├── get_increment_response.py │ ├── get_integration_response.py │ ├── get_interest_response.py │ ├── get_invoice_item_response.py │ ├── get_invoice_response.py │ ├── get_location_response.py │ ├── get_managing_partner_response.py │ ├── get_movement_object_base_response.py │ ├── get_order_item_response.py │ ├── get_order_response.py │ ├── get_payable_response.py │ ├── get_payment_authentication_response.py │ ├── get_payment_origin_response.py │ ├── get_period_response.py │ ├── get_phone_number_response.py │ ├── get_phone_response.py │ ├── get_phones_response.py │ ├── get_pix_bank_account_response.py │ ├── get_pix_payer_response.py │ ├── get_plan_item_response.py │ ├── get_plan_response.py │ ├── get_price_bracket_response.py │ ├── get_pricing_scheme_response.py │ ├── get_recipient_response.py │ ├── get_register_information_address_response.py │ ├── get_register_information_response.py │ ├── get_retry_transaction_information_response.py │ ├── get_setup_response.py │ ├── get_shipping_response.py │ ├── get_split_options_response.py │ ├── get_split_response.py │ ├── get_subscription_boleto_response.py │ ├── get_subscription_item_response.py │ ├── get_subscription_response.py │ ├── get_subscription_split_response.py │ ├── get_three_d_secure_response.py │ ├── get_token_response.py │ ├── get_transaction_report_file_response.py │ ├── get_transaction_response.py │ ├── get_transfer.py │ ├── get_transfer_response.py │ ├── get_transfer_settings_response.py │ ├── get_transfer_source_response.py │ ├── get_transfer_target_response.py │ ├── get_usage_report_response.py │ ├── get_usage_response.py │ ├── get_withdraw_response.py │ ├── get_withdraw_source_response.py │ ├── get_withdraw_target_response.py │ ├── list_access_tokens_response.py │ ├── list_addresses_response.py │ ├── list_anticipation_response.py │ ├── list_balance_operation_response.py │ ├── list_cards_response.py │ ├── list_charge_transactions_response.py │ ├── list_charges_response.py │ ├── list_customers_response.py │ ├── list_cycles_response.py │ ├── list_discounts_response.py │ ├── list_increments_response.py │ ├── list_invoices_response.py │ ├── list_order_response.py │ ├── list_payables_response.py │ ├── list_plans_response.py │ ├── list_recipient_response.py │ ├── list_subscription_items_response.py │ ├── list_subscriptions_response.py │ ├── list_transactions_files_response.py │ ├── list_transactions_response.py │ ├── list_transfer_response.py │ ├── list_transfers.py │ ├── list_usages_response.py │ ├── list_withdrawals.py │ ├── paging_response.py │ ├── pix_additional_information.py │ ├── update_address_request.py │ ├── update_automatic_anticipation_settings_request.py │ ├── update_card_request.py │ ├── update_charge_card_request.py │ ├── update_charge_due_date_request.py │ ├── update_charge_payment_method_request.py │ ├── update_current_cycle_end_date_request.py │ ├── update_current_cycle_status_request.py │ ├── update_customer_request.py │ ├── update_invoice_status_request.py │ ├── update_metadata_request.py │ ├── update_order_item_request.py │ ├── update_order_status_request.py │ ├── update_plan_item_request.py │ ├── update_plan_request.py │ ├── update_price_bracket_request.py │ ├── update_pricing_scheme_request.py │ ├── update_recipient_bank_account_request.py │ ├── update_recipient_code_request.py │ ├── update_recipient_request.py │ ├── update_subscription_affiliation_id_request.py │ ├── update_subscription_billing_date_request.py │ ├── update_subscription_card_request.py │ ├── update_subscription_due_days_request.py │ ├── update_subscription_item_request.py │ ├── update_subscription_minimum_price_request.py │ ├── update_subscription_payment_method_request.py │ ├── update_subscription_split_request.py │ ├── update_subscription_start_at_request.py │ └── update_transfer_settings_request.py ├── pagarmeapisdk_client.py └── utilities │ ├── __init__.py │ └── file_wrapper.py ├── pyproject.toml ├── requirements.txt ├── setup.cfg ├── test-requirements.txt └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | License: 2 | ======== 3 | The MIT License (MIT) 4 | http://opensource.org/licenses/MIT 5 | 6 | Copyright (c) 2014 - 2025 APIMATIC Limited 7 | 8 | Permission is hereby granted, free of charge, to any person obtaining a copy 9 | of this software and associated documentation files (the "Software"), to deal 10 | in the Software without restriction, including without limitation the rights 11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 12 | copies of the Software, and to permit persons to whom the Software is 13 | furnished to do so, subject to the following conditions: 14 | 15 | The above copyright notice and this permission notice shall be included in 16 | all copies or substantial portions of the Software. 17 | 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 24 | THE SOFTWARE. 25 | 26 | Trade Mark: 27 | ========== 28 | APIMATIC is a trade mark for APIMATIC Limited -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include README.md 3 | -------------------------------------------------------------------------------- /doc/api-helper.md: -------------------------------------------------------------------------------- 1 | 2 | # ApiHelper 3 | 4 | A utility class for processing API Calls. Also contains classes for supporting standard datetime formats. 5 | 6 | ## Methods 7 | 8 | | Name | Description | 9 | | --- | --- | 10 | | json_deserialize | Deserializes a JSON string to a Python dictionary. | 11 | 12 | -------------------------------------------------------------------------------- /doc/auth/basic-authentication.md: -------------------------------------------------------------------------------- 1 | 2 | # Basic Authentication 3 | 4 | 5 | 6 | Documentation for accessing and setting credentials for httpBasic. 7 | 8 | ## Auth Credentials 9 | 10 | | Name | Type | Description | Getter | 11 | | --- | --- | --- | --- | 12 | | BasicAuthUserName | `str` | The username to use with basic authentication | `username` | 13 | | BasicAuthPassword | `str` | The password to use with basic authentication | `password` | 14 | 15 | 16 | 17 | **Note:** Auth credentials can be set using `BasicAuthCredentials` object, passed in as named parameter `basic_auth_credentials` in the client initialization. 18 | 19 | ## Usage Example 20 | 21 | ### Client Initialization 22 | 23 | You must provide credentials in the client as shown in the following code snippet. 24 | 25 | ```python 26 | client = PagarmeapisdkClient( 27 | basic_auth_credentials=BasicAuthCredentials( 28 | username='BasicAuthUserName', 29 | password='BasicAuthPassword' 30 | ) 31 | ) 32 | ``` 33 | 34 | 35 | -------------------------------------------------------------------------------- /doc/controllers/transactions.md: -------------------------------------------------------------------------------- 1 | # Transactions 2 | 3 | ```python 4 | transactions_controller = client.transactions 5 | ``` 6 | 7 | ## Class Name 8 | 9 | `TransactionsController` 10 | 11 | 12 | # Get Transaction 13 | 14 | ```python 15 | def get_transaction(self, 16 | transaction_id) 17 | ``` 18 | 19 | ## Parameters 20 | 21 | | Parameter | Type | Tags | Description | 22 | | --- | --- | --- | --- | 23 | | `transaction_id` | `str` | Template, Required | - | 24 | 25 | ## Response Type 26 | 27 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 28 | 29 | ## Example Usage 30 | 31 | ```python 32 | transaction_id = 'transaction_id8' 33 | 34 | result = transactions_controller.get_transaction(transaction_id) 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /doc/http-date-time.md: -------------------------------------------------------------------------------- 1 | 2 | # HttpDateTime 3 | 4 | A utility class for wrapping datetime to support HTTP date format. 5 | 6 | ## Methods 7 | 8 | | Name | Description | 9 | | --- | --- | 10 | | from_datetime | Converts a datetime object to an HTTP-compliant date string. | 11 | | from_value | Parses an HTTP date string into a datetime object. | 12 | 13 | -------------------------------------------------------------------------------- /doc/http-request.md: -------------------------------------------------------------------------------- 1 | 2 | # HttpRequest 3 | 4 | Represents a single Http Request. 5 | 6 | ## Parameters 7 | 8 | | Name | Type | Tag | Description | 9 | | --- | --- | --- | --- | 10 | | http_method | `HttpMethodEnum` | | The HTTP method of the request. | 11 | | query_url | `str` | | The endpoint URL for the API request. | 12 | | headers | `dict` | optional | Request headers. | 13 | | query_parameters | `dict` | optional | Query parameters to add in the URL. | 14 | | parameters | `dict` | optional | Request body, either as a serialized string or else a list of parameters to form encode. | 15 | | files | `dict` | optional | Files to be sent with the request. | 16 | 17 | -------------------------------------------------------------------------------- /doc/http-response.md: -------------------------------------------------------------------------------- 1 | 2 | # HttpResponse 3 | 4 | Http response received. 5 | 6 | ## Parameters 7 | 8 | | Name | Type | Description | 9 | | --- | --- | --- | 10 | | status_code | `int` | The status code returned by the server. | 11 | | reason_phrase | `str` | The reason phrase returned by the server. | 12 | | headers | `dict` | Response headers. | 13 | | text | `str` | Response body. | 14 | | request | [`HttpRequest`](../doc/http-request.md) | The request that resulted in this response. | 15 | 16 | -------------------------------------------------------------------------------- /doc/models/create-access-token-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Access Token Request 3 | 4 | Request for creating a new Access Token 5 | 6 | ## Structure 7 | 8 | `CreateAccessTokenRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `expires_in` | `int` | Optional | Minutes to expire the token | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "expires_in": 86 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/create-address-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Address Request 3 | 4 | Request for creating a new Address 5 | 6 | ## Structure 7 | 8 | `CreateAddressRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `street` | `str` | Required | Street | 15 | | `number` | `str` | Required | Number | 16 | | `zip_code` | `str` | Required | The zip code containing only numbers. No special characters or spaces. | 17 | | `neighborhood` | `str` | Required | Neighborhood | 18 | | `city` | `str` | Required | City | 19 | | `state` | `str` | Required | State | 20 | | `country` | `str` | Required | Country. Must be entered using ISO 3166-1 alpha-2 format. See https://pt.wikipedia.org/wiki/ISO_3166-1_alfa-2 | 21 | | `complement` | `str` | Required | Complement | 22 | | `metadata` | `Dict[str, str]` | Optional | Metadata | 23 | | `line_1` | `str` | Required | Line 1 for address | 24 | | `line_2` | `str` | Required | Line 2 for address | 25 | 26 | ## Example (as JSON) 27 | 28 | ```json 29 | { 30 | "street": "street6", 31 | "number": "number6", 32 | "zip_code": "zip_code0", 33 | "neighborhood": "neighborhood2", 34 | "city": "city6", 35 | "state": "state8", 36 | "country": "country0", 37 | "complement": "complement8", 38 | "metadata": { 39 | "key0": "metadata7" 40 | }, 41 | "line_1": "line_10", 42 | "line_2": "line_24" 43 | } 44 | ``` 45 | 46 | -------------------------------------------------------------------------------- /doc/models/create-anticipation-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Anticipation Request 3 | 4 | Request for creating an anticipation 5 | 6 | ## Structure 7 | 8 | `CreateAnticipationRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `amount` | `int` | Required | Amount requested for the anticipation | 15 | | `timeframe` | `str` | Required | Timeframe | 16 | | `payment_date` | `datetime` | Required | Payment date | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "amount": 68, 23 | "timeframe": "timeframe2", 24 | "payment_date": "2016-03-13T12:52:32.123Z" 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-antifraud-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Antifraud Request 3 | 4 | ## Structure 5 | 6 | `CreateAntifraudRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `mtype` | `str` | Required | - | 13 | | `clearsale` | [`CreateClearSaleRequest`](../../doc/models/create-clear-sale-request.md) | Required | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "type": "type0", 20 | "clearsale": { 21 | "custom_sla": 178 22 | } 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-apple-pay-header-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Apple Pay Header Request 3 | 4 | The ApplePay header request 5 | 6 | ## Structure 7 | 8 | `CreateApplePayHeaderRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `public_key_hash` | `str` | Optional | SHA–256 hash, Base64 string codified | 15 | | `ephemeral_public_key` | `str` | Required | X.509 encoded key bytes, Base64 encoded as a string | 16 | | `transaction_id` | `str` | Optional | Transaction identifier, generated on Device | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "public_key_hash": "public_key_hash8", 23 | "ephemeral_public_key": "ephemeral_public_key0", 24 | "transaction_id": "transaction_id8" 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-apple-pay-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Apple Pay Request 3 | 4 | The ApplePay Token Payment Request 5 | 6 | ## Structure 7 | 8 | `CreateApplePayRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `version` | `str` | Required | The token version | 15 | | `data` | `str` | Required | The cryptography data | 16 | | `header` | [`CreateApplePayHeaderRequest`](../../doc/models/create-apple-pay-header-request.md) | Required | The ApplePay header request | 17 | | `signature` | `str` | Required | Detached PKCS #7 signature, Base64 encoded as string | 18 | | `merchant_identifier` | `str` | Required | ApplePay Merchant identifier | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "version": "version6", 25 | "data": "data0", 26 | "header": { 27 | "public_key_hash": "public_key_hash4", 28 | "ephemeral_public_key": "ephemeral_public_key6", 29 | "transaction_id": "transaction_id4" 30 | }, 31 | "signature": "signature8", 32 | "merchant_identifier": "merchant_identifier4" 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/create-automatic-anticipation-settings-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Automatic Anticipation Settings Request 3 | 4 | ## Structure 5 | 6 | `CreateAutomaticAnticipationSettingsRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `enabled` | `bool` | Required | - | 13 | | `mtype` | `str` | Required | - | 14 | | `volume_percentage` | `int` | Required | - | 15 | | `delay` | `int` | Required | - | 16 | | `days` | `List[int]` | Required | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "enabled": false, 23 | "type": "type8", 24 | "volume_percentage": 208, 25 | "delay": 82, 26 | "days": [ 27 | 58, 28 | 59 29 | ] 30 | } 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /doc/models/create-bank-account-refunding-dto.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Bank Account Refunding DTO 3 | 4 | Bank Account 5 | 6 | ## Structure 7 | 8 | `CreateBankAccountRefundingDTO` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `holder_name` | `str` | Required | Nome/razão social do favorecido | 15 | | `holder_type` | `str` | Required | Tipo de titular (pessoa física ou jurídica) | 16 | | `holder_document` | `str` | Required | CPF ou CNPJ do favorecido | 17 | | `bank` | `str` | Required | Dígitos que identificam cada banco. | 18 | | `branch_number` | `str` | Required | Número da agência bancária | 19 | | `branch_check_digit` | `str` | Required | Dígito da agência bancária | 20 | | `account_number` | `str` | Required | Número da conta | 21 | | `account_check_digit` | `str` | Required | Dígito verificador da conta | 22 | | `mtype` | `str` | Required | Tipo de conta | 23 | 24 | ## Example (as JSON) 25 | 26 | ```json 27 | { 28 | "holder_name": "holder_name2", 29 | "holder_type": "holder_type8", 30 | "holder_document": "holder_document0", 31 | "bank": "bank4", 32 | "branch_number": "branch_number2", 33 | "branch_check_digit": "branch_check_digit2", 34 | "account_number": "account_number6", 35 | "account_check_digit": "account_check_digit2", 36 | "type": "type4" 37 | } 38 | ``` 39 | 40 | -------------------------------------------------------------------------------- /doc/models/create-bank-account-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Bank Account Request 3 | 4 | Request for creating a bank account 5 | 6 | ## Structure 7 | 8 | `CreateBankAccountRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `holder_name` | `str` | Required | Bank account holder name | 15 | | `holder_type` | `str` | Required | Bank account holder type | 16 | | `holder_document` | `str` | Required | Bank account holder document | 17 | | `bank` | `str` | Required | Bank | 18 | | `branch_number` | `str` | Required | Branch number | 19 | | `branch_check_digit` | `str` | Optional | Branch check digit | 20 | | `account_number` | `str` | Required | Account number | 21 | | `account_check_digit` | `str` | Required | Account check digit | 22 | | `mtype` | `str` | Required | Bank account type | 23 | | `metadata` | `Dict[str, str]` | Required | Metadata | 24 | | `pix_key` | `str` | Optional | Pix key | 25 | 26 | ## Example (as JSON) 27 | 28 | ```json 29 | { 30 | "holder_name": "holder_name4", 31 | "holder_type": "holder_type0", 32 | "holder_document": "holder_document8", 33 | "bank": "bank6", 34 | "branch_number": "branch_number4", 35 | "branch_check_digit": "branch_check_digit4", 36 | "account_number": "account_number8", 37 | "account_check_digit": "account_check_digit4", 38 | "type": "type2", 39 | "metadata": { 40 | "key0": "metadata5", 41 | "key1": "metadata6", 42 | "key2": "metadata7" 43 | }, 44 | "pix_key": "pix_key8" 45 | } 46 | ``` 47 | 48 | -------------------------------------------------------------------------------- /doc/models/create-bank-transfer-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Bank Transfer Payment Request 3 | 4 | Request for creating a bank transfer payment 5 | 6 | ## Structure 7 | 8 | `CreateBankTransferPaymentRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `bank` | `str` | Required | Bank | 15 | | `retries` | `int` | Required | Number of retries | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "bank": "bank4", 22 | "retries": 188 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-cancel-charge-split-rules-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Cancel Charge Split Rules Request 3 | 4 | Creates a refund with split rules 5 | 6 | ## Structure 7 | 8 | `CreateCancelChargeSplitRulesRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Required | The split rule gateway id | 15 | | `amount` | `int` | Required | The split rule amount | 16 | | `mtype` | `str` | Required | The amount type (flat ou percentage) | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "id": "id6", 23 | "Amount": 222, 24 | "type": "type6" 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-cancel-subscription-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Cancel Subscription Request 3 | 4 | Request for canceling a subscription 5 | 6 | ## Structure 7 | 8 | `CreateCancelSubscriptionRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `cancel_pending_invoices` | `bool` | Required | Indicates if the pending invoices must also be canceled.

**Default**: `True` | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "cancel_pending_invoices": true 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/create-capture-charge-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Capture Charge Request 3 | 4 | Request for capturing a charge 5 | 6 | ## Structure 7 | 8 | `CreateCaptureChargeRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `code` | `str` | Required | Code for the charge. Sending this field will update the code send on the charge and order creation. | 15 | | `amount` | `int` | Optional | The amount that will be captured | 16 | | `split` | [`List[CreateSplitRequest]`](../../doc/models/create-split-request.md) | Optional | Splits | 17 | | `operation_reference` | `str` | Required | - | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "code": "code8", 24 | "amount": 96, 25 | "split": [ 26 | { 27 | "type": "type2", 28 | "amount": 10, 29 | "recipient_id": "recipient_id2", 30 | "options": { 31 | "liable": false, 32 | "charge_processing_fee": false, 33 | "charge_remainder_fee": false 34 | }, 35 | "split_rule_id": "split_rule_id0" 36 | }, 37 | { 38 | "type": "type2", 39 | "amount": 10, 40 | "recipient_id": "recipient_id2", 41 | "options": { 42 | "liable": false, 43 | "charge_processing_fee": false, 44 | "charge_remainder_fee": false 45 | }, 46 | "split_rule_id": "split_rule_id0" 47 | } 48 | ], 49 | "operation_reference": "operation_reference0" 50 | } 51 | ``` 52 | 53 | -------------------------------------------------------------------------------- /doc/models/create-card-options-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Card Options Request 3 | 4 | Options for creating the card 5 | 6 | ## Structure 7 | 8 | `CreateCardOptionsRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `verify_card` | `bool` | Required | Indicates if the card should be verified before creation. If true, executes an authorization before saving the card. | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "verify_card": false 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/create-card-payload-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Card Payload Request 3 | 4 | ## Structure 5 | 6 | `CreateCardPayloadRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `mtype` | `str` | Optional | - | 13 | | `google_pay` | [`CreateGooglePayRequest`](../../doc/models/create-google-pay-request.md) | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "type": "type6", 20 | "google_pay": { 21 | "version": "version4", 22 | "data": "data8", 23 | "intermediate_signing_key": { 24 | "signed_key": "signed_key0", 25 | "signatures": [ 26 | "signatures2", 27 | "signatures3", 28 | "signatures4" 29 | ] 30 | }, 31 | "signature": "signature6", 32 | "signed_message": "signed_message4" 33 | } 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /doc/models/create-card-payment-contactless-poi-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Card Payment Contactless POI Request 3 | 4 | ## Structure 5 | 6 | `CreateCardPaymentContactlessPOIRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `system_name` | `str` | Required | system name | 13 | | `model` | `str` | Required | model | 14 | | `provider` | `str` | Required | provider | 15 | | `serial_number` | `str` | Required | serial number | 16 | | `version_number` | `str` | Required | version number | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "system_name": "system_name0", 23 | "model": "model8", 24 | "provider": "provider2", 25 | "serial_number": "serial_number4", 26 | "version_number": "version_number0" 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/create-card-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Card Request 3 | 4 | Card data 5 | 6 | ## Structure 7 | 8 | `CreateCardRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `number` | `str` | Optional | Credit card number | 15 | | `holder_name` | `str` | Optional | Holder name, as written on the card | 16 | | `exp_month` | `int` | Optional | The expiration month | 17 | | `exp_year` | `int` | Optional | The expiration year, that can be informed with 2 or 4 digits | 18 | | `cvv` | `str` | Optional | The card's security code | 19 | | `billing_address` | [`CreateAddressRequest`](../../doc/models/create-address-request.md) | Optional | Card's billing address | 20 | | `brand` | `str` | Optional | Card brand | 21 | | `billing_address_id` | `str` | Optional | The address id for the billing address | 22 | | `metadata` | `Dict[str, str]` | Optional | Metadata | 23 | | `mtype` | `str` | Optional | Card type

**Default**: `'credit'` | 24 | | `options` | [`CreateCardOptionsRequest`](../../doc/models/create-card-options-request.md) | Optional | Options for creating the card | 25 | | `holder_document` | `str` | Optional | Document number for the card's holder | 26 | | `private_label` | `bool` | Optional | Indicates whether it is a private label card | 27 | | `label` | `str` | Optional | - | 28 | | `id` | `str` | Optional | Identifier | 29 | | `token` | `str` | Optional | token identifier | 30 | 31 | ## Example (as JSON) 32 | 33 | ```json 34 | { 35 | "type": "credit", 36 | "number": "number0", 37 | "holder_name": "holder_name8", 38 | "exp_month": 92, 39 | "exp_year": 204, 40 | "cvv": "cvv0" 41 | } 42 | ``` 43 | 44 | -------------------------------------------------------------------------------- /doc/models/create-card-token-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Card Token Request 3 | 4 | Card token data 5 | 6 | ## Structure 7 | 8 | `CreateCardTokenRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `number` | `str` | Required | Credit card number | 15 | | `holder_name` | `str` | Required | Holder name, as written on the card | 16 | | `exp_month` | `int` | Required | The expiration month | 17 | | `exp_year` | `int` | Required | The expiration year, that can be informed with 2 or 4 digits | 18 | | `cvv` | `str` | Required | The card's security code | 19 | | `brand` | `str` | Required | Card brand | 20 | | `label` | `str` | Required | - | 21 | 22 | ## Example (as JSON) 23 | 24 | ```json 25 | { 26 | "number": "number8", 27 | "holder_name": "holder_name6", 28 | "exp_month": 168, 29 | "exp_year": 208, 30 | "cvv": "cvv8", 31 | "brand": "brand4", 32 | "label": "label0" 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/create-cash-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Cash Payment Request 3 | 4 | ## Structure 5 | 6 | `CreateCashPaymentRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `description` | `str` | Required | Description | 13 | | `confirm` | `bool` | Required | Indicates whether cash collection will be confirmed in the act of creation | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "description": "description8", 20 | "confirm": false 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/create-checkout-bank-transfer-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Checkout Bank Transfer Request 3 | 4 | Checkout bank transfer payment request 5 | 6 | ## Structure 7 | 8 | `CreateCheckoutBankTransferRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `bank` | `List[str]` | Required | Bank | 15 | | `retries` | `int` | Required | Number of retries for processing | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "bank": [ 22 | "bank7", 23 | "bank8", 24 | "bank9" 25 | ], 26 | "retries": 56 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/create-checkout-boleto-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Checkout Boleto Payment Request 3 | 4 | ## Structure 5 | 6 | `CreateCheckoutBoletoPaymentRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `bank` | `str` | Required | Bank identifier | 13 | | `instructions` | `str` | Required | Instructions | 14 | | `due_at` | `datetime` | Required | Due date | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "bank": "bank4", 21 | "instructions": "instructions4", 22 | "due_at": "2016-03-13T12:52:32.123Z" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-checkout-card-installment-option-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Checkout Card Installment Option Request 3 | 4 | Options for card installment 5 | 6 | ## Structure 7 | 8 | `CreateCheckoutCardInstallmentOptionRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `number` | `int` | Required | Installment quantity | 15 | | `total` | `int` | Required | Total amount | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "number": 154, 22 | "total": 46 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-checkout-credit-card-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Checkout Credit Card Payment Request 3 | 4 | Checkout card payment request 5 | 6 | ## Structure 7 | 8 | `CreateCheckoutCreditCardPaymentRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `statement_descriptor` | `str` | Optional | Card invoice text descriptor | 15 | | `installments` | [`List[CreateCheckoutCardInstallmentOptionRequest]`](../../doc/models/create-checkout-card-installment-option-request.md) | Optional | Payment installment options | 16 | | `authentication` | [`CreatePaymentAuthenticationRequest`](../../doc/models/create-payment-authentication-request.md) | Optional | Creates payment authentication | 17 | | `capture` | `bool` | Optional | Authorize and capture? | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "statement_descriptor": "statement_descriptor0", 24 | "installments": [ 25 | { 26 | "number": 164, 27 | "total": 16 28 | } 29 | ], 30 | "authentication": { 31 | "type": "type2", 32 | "threed_secure": { 33 | "mpi": "mpi0", 34 | "cavv": "cavv8", 35 | "eci": "eci2", 36 | "transaction_id": "transaction_id0", 37 | "success_url": "success_url4", 38 | "ds_transaction_id": "ds_transaction_id0" 39 | } 40 | }, 41 | "capture": false 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/create-checkout-debit-card-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Checkout Debit Card Payment Request 3 | 4 | Checkout credit card payment request 5 | 6 | ## Structure 7 | 8 | `CreateCheckoutDebitCardPaymentRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `statement_descriptor` | `str` | Optional | Card invoice text descriptor | 15 | | `authentication` | [`CreatePaymentAuthenticationRequest`](../../doc/models/create-payment-authentication-request.md) | Required | Creates payment authentication | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "statement_descriptor": "statement_descriptor4", 22 | "authentication": { 23 | "type": "type2", 24 | "threed_secure": { 25 | "mpi": "mpi0", 26 | "cavv": "cavv8", 27 | "eci": "eci2", 28 | "transaction_id": "transaction_id0", 29 | "success_url": "success_url4", 30 | "ds_transaction_id": "ds_transaction_id0" 31 | } 32 | } 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/create-checkout-pix-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Checkout Pix Payment Request 3 | 4 | Checkout pix payment request 5 | 6 | ## Structure 7 | 8 | `CreateCheckoutPixPaymentRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `expires_at` | `datetime` | Optional | Expires at | 15 | | `expires_in` | `int` | Optional | Expires in | 16 | | `additional_information` | [`List[PixAdditionalInformation]`](../../doc/models/pix-additional-information.md) | Optional | Additional information | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "expires_at": "2016-03-13T12:52:32.123Z", 23 | "expires_in": 4, 24 | "additional_information": [ 25 | { 26 | "Name": "Name0", 27 | "Value": "Value2" 28 | } 29 | ] 30 | } 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /doc/models/create-clear-sale-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Clear Sale Request 3 | 4 | ## Structure 5 | 6 | `CreateClearSaleRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `custom_sla` | `int` | Required | - | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "custom_sla": 150 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /doc/models/create-confirm-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Confirm Payment Request 3 | 4 | ## Structure 5 | 6 | `CreateConfirmPaymentRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `description` | `str` | Required | Description | 13 | | `amount` | `int` | Optional | Amount | 14 | | `code` | `str` | Required | Code reference | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "description": "description0", 21 | "Amount": 178, 22 | "Code": "Code0" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-debit-card-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Debit Card Payment Request 3 | 4 | The settings for creating a debit card payment 5 | 6 | ## Structure 7 | 8 | `CreateDebitCardPaymentRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `statement_descriptor` | `str` | Optional | The text that will be shown on the debit card's statement | 15 | | `card` | [`CreateCardRequest`](../../doc/models/create-card-request.md) | Optional | Debit card data | 16 | | `card_id` | `str` | Optional | The debit card id | 17 | | `card_token` | `str` | Optional | The debit card token | 18 | | `recurrence` | `bool` | Optional | Indicates a recurrence | 19 | | `authentication` | [`CreatePaymentAuthenticationRequest`](../../doc/models/create-payment-authentication-request.md) | Optional | The payment authentication request | 20 | | `token` | [`CreateCardPaymentContactlessRequest`](../../doc/models/create-card-payment-contactless-request.md) | Optional | The Debit card payment token request | 21 | | `initiated_type` | `str` | Optional | - | 22 | | `recurrence_model` | `str` | Optional | - | 23 | | `payment_origin` | [`CreatePaymentOriginRequest`](../../doc/models/create-payment-origin-request.md) | Optional | - | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "statement_descriptor": "statement_descriptor8", 30 | "card": { 31 | "number": "number6", 32 | "holder_name": "holder_name2", 33 | "exp_month": 228, 34 | "exp_year": 68, 35 | "cvv": "cvv4" 36 | }, 37 | "card_id": "card_id4", 38 | "card_token": "card_token2", 39 | "recurrence": false 40 | } 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /doc/models/create-device-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Device Request 3 | 4 | Request for creating a device 5 | 6 | ## Structure 7 | 8 | `CreateDeviceRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `platform` | `str` | Optional | Device's platform | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "platform": "platform8" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/create-discount-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Discount Request 3 | 4 | Request for creating a new discount 5 | 6 | ## Structure 7 | 8 | `CreateDiscountRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `value` | `float` | Required | The discount value | 15 | | `discount_type` | `str` | Required | Discount type. Can be either flat or percentage. | 16 | | `item_id` | `str` | Required | The item where the discount will be applied | 17 | | `cycles` | `int` | Optional | Number of cycles that the discount will be applied | 18 | | `description` | `str` | Optional | Description | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "value": 146.6, 25 | "discount_type": "discount_type6", 26 | "item_id": "item_id2", 27 | "cycles": 164, 28 | "description": "description2" 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /doc/models/create-emv-data-decrypt-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Emv Data Decrypt Request 3 | 4 | ## Structure 5 | 6 | `CreateEmvDataDecryptRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `cipher` | `str` | Required | Emv Decrypt cipher type | 13 | | `dukpt` | [`CreateEmvDataDukptDecryptRequest`](../../doc/models/create-emv-data-dukpt-decrypt-request.md) | Optional | Dukpt data request | 14 | | `tags` | [`List[CreateEmvDataTlvDecryptRequest]`](../../doc/models/create-emv-data-tlv-decrypt-request.md) | Required | Encrypted tags list | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "cipher": "cipher2", 21 | "tags": [ 22 | { 23 | "tag": "tag4", 24 | "lenght": "lenght2", 25 | "value": "value2" 26 | } 27 | ], 28 | "dukpt": { 29 | "ksn": "ksn0" 30 | } 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /doc/models/create-emv-data-dukpt-decrypt-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Emv Data Dukpt Decrypt Request 3 | 4 | ## Structure 5 | 6 | `CreateEmvDataDukptDecryptRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `ksn` | `str` | Required | Key serial number | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "ksn": "ksn8" 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /doc/models/create-emv-data-tlv-decrypt-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Emv Data Tlv Decrypt Request 3 | 4 | ## Structure 5 | 6 | `CreateEmvDataTlvDecryptRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `tag` | `str` | Required | Emv tag | 13 | | `lenght` | `str` | Required | Emv lenght | 14 | | `value` | `str` | Required | Emv value | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "tag": "tag6", 21 | "lenght": "lenght6", 22 | "value": "value4" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-emv-decrypt-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Emv Decrypt Request 3 | 4 | ## Structure 5 | 6 | `CreateEmvDecryptRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `icc_data` | `str` | Required | - | 13 | | `card_sequence_number` | `str` | Required | - | 14 | | `data` | [`CreateEmvDataDecryptRequest`](../../doc/models/create-emv-data-decrypt-request.md) | Required | - | 15 | | `poi` | [`CreateCardPaymentContactlessPOIRequest`](../../doc/models/create-card-payment-contactless-poi-request.md) | Optional | - | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "icc_data": "icc_data4", 22 | "card_sequence_number": "card_sequence_number2", 23 | "data": { 24 | "cipher": "cipher4", 25 | "tags": [ 26 | { 27 | "tag": "tag4", 28 | "lenght": "lenght2", 29 | "value": "value2" 30 | } 31 | ], 32 | "dukpt": { 33 | "ksn": "ksn0" 34 | } 35 | }, 36 | "poi": { 37 | "system_name": "system_name4", 38 | "model": "model2", 39 | "provider": "provider4", 40 | "serial_number": "serial_number2", 41 | "version_number": "version_number6" 42 | } 43 | } 44 | ``` 45 | 46 | -------------------------------------------------------------------------------- /doc/models/create-fine-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Fine Request 3 | 4 | Fine Request 5 | 6 | ## Structure 7 | 8 | `CreateFineRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `days` | `int` | Required | Days | 15 | | `mtype` | `str` | Required | Type | 16 | | `amount` | `int` | Required | Amount | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "days": 218, 23 | "type": "\"percentage\" or \"flat\"", 24 | "amount": 220 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-google-pay-header-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Google Pay Header Request 3 | 4 | The GooglePay header request 5 | 6 | ## Structure 7 | 8 | `CreateGooglePayHeaderRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `ephemeral_public_key` | `str` | Required | X.509 encoded key bytes, Base64 encoded as a string | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "ephemeral_public_key": "ephemeral_public_key2" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/create-google-pay-intermediate-signing-key-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Google Pay Intermediate Signing Key Request 3 | 4 | The GooglePay Intermediate Signing Key Request 5 | 6 | ## Structure 7 | 8 | `CreateGooglePayIntermediateSigningKeyRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `signed_key` | `str` | Optional | Uma mensagem codificada em Base64 com a descrição de pagamento da chave. | 15 | | `signatures` | `List[str]` | Optional | Verifica se a origem da chave de assinatura intermediária é o Google. É codificada em Base64 e criada usando o ECDSA. | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "signed_key": "signed_key2", 22 | "signatures": [ 23 | "signatures0", 24 | "signatures1", 25 | "signatures2" 26 | ] 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/create-google-pay-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Google Pay Request 3 | 4 | The GooglePay Token Payment Request 5 | 6 | ## Structure 7 | 8 | `CreateGooglePayRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `version` | `str` | Optional | Informação sobre a versão do token. Único valor aceito é EC_v2 | 15 | | `data` | `str` | Optional | Dados de pagamento criptografados. Corresponde ao encryptedMessage do token Google. | 16 | | `intermediate_signing_key` | [`CreateGooglePayIntermediateSigningKeyRequest`](../../doc/models/create-google-pay-intermediate-signing-key-request.md) | Optional | The GooglePay intermediate signing key request | 17 | | `signature` | `str` | Optional | Assinatura dos dados de pagamento. Verifica se a origem da mensagem é o Google. Corresponde ao signature do token Google. | 18 | | `signed_message` | `str` | Optional | - | 19 | | `merchant_identifier` | `str` | Optional | - | 20 | 21 | ## Example (as JSON) 22 | 23 | ```json 24 | { 25 | "version": "version6", 26 | "data": "data0", 27 | "intermediate_signing_key": { 28 | "signed_key": "signed_key0", 29 | "signatures": [ 30 | "signatures2", 31 | "signatures3", 32 | "signatures4" 33 | ] 34 | }, 35 | "signature": "signature8", 36 | "signed_message": "signed_message6" 37 | } 38 | ``` 39 | 40 | -------------------------------------------------------------------------------- /doc/models/create-increment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Increment Request 3 | 4 | Request for creating a new increment 5 | 6 | ## Structure 7 | 8 | `CreateIncrementRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `value` | `float` | Required | The increment value | 15 | | `increment_type` | `str` | Required | Increment type. Can be either flat or percentage. | 16 | | `item_id` | `str` | Required | The item where the increment will be applied | 17 | | `cycles` | `int` | Optional | Number of cycles that the increment will be applied | 18 | | `description` | `str` | Optional | Description | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "value": 72.04, 25 | "increment_type": "increment_type4", 26 | "item_id": "item_id8", 27 | "cycles": 196, 28 | "description": "description8" 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /doc/models/create-interest-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Interest Request 3 | 4 | Interest Request 5 | 6 | ## Structure 7 | 8 | `CreateInterestRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `days` | `int` | Required | Days | 15 | | `mtype` | `str` | Required | Type | 16 | | `amount` | `int` | Required | Amount | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "days": 4, 23 | "type": "\"percentage\" or \"flat\"", 24 | "amount": 78 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-invoice-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Invoice Request 3 | 4 | Request for creating a new Invoice 5 | 6 | ## Structure 7 | 8 | `CreateInvoiceRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `metadata` | `Dict[str, str]` | Required | Metadata | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "metadata": { 21 | "key0": "metadata9" 22 | } 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-kyc-link-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Create KYC Link Response 3 | 4 | KYC Link 5 | 6 | ## Structure 7 | 8 | `CreateKYCLinkResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `base_64` | `str` | Optional | Base64 | 15 | | `url` | `str` | Optional | URL | 16 | | `expiration_date` | `str` | Optional | Expiration Date | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "base64": "base644", 23 | "url": "url0", 24 | "expiration_date": "expiration_date0" 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-location-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Location Request 3 | 4 | Request for creating a location 5 | 6 | ## Structure 7 | 8 | `CreateLocationRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `latitude` | `str` | Required | Latitude | 15 | | `longitude` | `str` | Required | Longitude | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "latitude": "latitude0", 22 | "longitude": "longitude0" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-order-item-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Order Item Request 3 | 4 | Request for creating an order item 5 | 6 | ## Structure 7 | 8 | `CreateOrderItemRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `amount` | `int` | Required | Amount | 15 | | `description` | `str` | Required | Description | 16 | | `quantity` | `int` | Required | Quantity | 17 | | `category` | `str` | Required | Category | 18 | | `code` | `str` | Optional | The item code passed by the client | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "amount": 102, 25 | "description": "description4", 26 | "quantity": 216, 27 | "category": "category4", 28 | "code": "code4" 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /doc/models/create-payment-authentication-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Payment Authentication Request 3 | 4 | The payment authentication request 5 | 6 | ## Structure 7 | 8 | `CreatePaymentAuthenticationRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `mtype` | `str` | Required | The Authentication type | 15 | | `threed_secure` | [`CreateThreeDSecureRequest`](../../doc/models/create-three-d-secure-request.md) | Required | The 3D-S authentication object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "type": "type8", 22 | "threed_secure": { 23 | "mpi": "mpi0", 24 | "cavv": "cavv8", 25 | "eci": "eci2", 26 | "transaction_id": "transaction_id0", 27 | "success_url": "success_url4", 28 | "ds_transaction_id": "ds_transaction_id0" 29 | } 30 | } 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /doc/models/create-payment-origin-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Payment Origin Request 3 | 4 | Request object for PaymentOrigin 5 | 6 | ## Structure 7 | 8 | `CreatePaymentOriginRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `brand_id` | `str` | Optional | - | 15 | | `charge_id` | `str` | Optional | - | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "brand_id": "brand_id0", 22 | "charge_id": "charge_id4" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-period-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Period Request 3 | 4 | ## Structure 5 | 6 | `CreatePeriodRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `end_at` | `datetime` | Optional | - | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "end_at": "2016-03-13T12:52:32.123Z" 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /doc/models/create-phone-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Phone Request 3 | 4 | ## Structure 5 | 6 | `CreatePhoneRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `country_code` | `str` | Optional | - | 13 | | `number` | `str` | Optional | - | 14 | | `area_code` | `str` | Optional | - | 15 | | `mtype` | `str` | Optional | - | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "country_code": "country_code0", 22 | "number": "number2", 23 | "area_code": "area_code0", 24 | "Type": "Type0" 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-phones-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Phones Request 3 | 4 | ## Structure 5 | 6 | `CreatePhonesRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `home_phone` | [`CreatePhoneRequest`](../../doc/models/create-phone-request.md) | Optional | - | 13 | | `mobile_phone` | [`CreatePhoneRequest`](../../doc/models/create-phone-request.md) | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "home_phone": { 20 | "country_code": "country_code0", 21 | "number": "number2", 22 | "area_code": "area_code0", 23 | "Type": "Type0" 24 | }, 25 | "mobile_phone": { 26 | "country_code": "country_code0", 27 | "number": "number8", 28 | "area_code": "area_code0", 29 | "Type": "Type0" 30 | } 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /doc/models/create-pix-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Pix Payment Request 3 | 4 | Contains information to create a pix payment 5 | 6 | ## Structure 7 | 8 | `CreatePixPaymentRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `expires_at` | `datetime` | Optional | Datetime when pix payment will expire | 15 | | `expires_in` | `int` | Optional | Seconds until pix payment expires | 16 | | `additional_information` | [`List[PixAdditionalInformation]`](../../doc/models/pix-additional-information.md) | Optional | Pix additional information | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "expires_at": "2016-03-13T12:52:32.123Z", 23 | "expires_in": 216, 24 | "additional_information": [ 25 | { 26 | "Name": "Name0", 27 | "Value": "Value2" 28 | }, 29 | { 30 | "Name": "Name0", 31 | "Value": "Value2" 32 | } 33 | ] 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /doc/models/create-plan-item-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Plan Item Request 3 | 4 | Request for creating a plan item 5 | 6 | ## Structure 7 | 8 | `CreatePlanItemRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `name` | `str` | Required | Item name | 15 | | `pricing_scheme` | [`CreatePricingSchemeRequest`](../../doc/models/create-pricing-scheme-request.md) | Required | Item's pricing scheme | 16 | | `id` | `str` | Required | Item's id | 17 | | `description` | `str` | Required | Item's description | 18 | | `cycles` | `int` | Optional | Number of cycles where the item will be charged | 19 | | `quantity` | `int` | Optional | Quantity | 20 | 21 | ## Example (as JSON) 22 | 23 | ```json 24 | { 25 | "name": "name0", 26 | "pricing_scheme": { 27 | "scheme_type": "scheme_type8", 28 | "price_brackets": [ 29 | { 30 | "start_quantity": 144, 31 | "price": 174, 32 | "end_quantity": 152, 33 | "overage_price": 166 34 | }, 35 | { 36 | "start_quantity": 144, 37 | "price": 174, 38 | "end_quantity": 152, 39 | "overage_price": 166 40 | }, 41 | { 42 | "start_quantity": 144, 43 | "price": 174, 44 | "end_quantity": 152, 45 | "overage_price": 166 46 | } 47 | ], 48 | "price": 166, 49 | "minimum_price": 6, 50 | "percentage": 251.76 51 | }, 52 | "id": "id0", 53 | "description": "description0", 54 | "cycles": 52, 55 | "quantity": 184 56 | } 57 | ``` 58 | 59 | -------------------------------------------------------------------------------- /doc/models/create-price-bracket-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Price Bracket Request 3 | 4 | Request for creating a price bracket 5 | 6 | ## Structure 7 | 8 | `CreatePriceBracketRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `start_quantity` | `int` | Required | Start quantity | 15 | | `price` | `int` | Required | Price | 16 | | `end_quantity` | `int` | Optional | End quantity | 17 | | `overage_price` | `int` | Optional | Overage price | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "start_quantity": 154, 24 | "price": 164, 25 | "end_quantity": 162, 26 | "overage_price": 176 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/create-pricing-scheme-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Pricing Scheme Request 3 | 4 | Request for creating a pricing scheme 5 | 6 | ## Structure 7 | 8 | `CreatePricingSchemeRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `scheme_type` | `str` | Required | Scheme type | 15 | | `price_brackets` | [`List[CreatePriceBracketRequest]`](../../doc/models/create-price-bracket-request.md) | Optional | Price brackets | 16 | | `price` | `int` | Optional | Price | 17 | | `minimum_price` | `int` | Optional | Minimum price | 18 | | `percentage` | `float` | Optional | percentual value used in pricing_scheme Percent | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "scheme_type": "scheme_type2", 25 | "price_brackets": [ 26 | { 27 | "start_quantity": 144, 28 | "price": 174, 29 | "end_quantity": 152, 30 | "overage_price": 166 31 | }, 32 | { 33 | "start_quantity": 144, 34 | "price": 174, 35 | "end_quantity": 152, 36 | "overage_price": 166 37 | } 38 | ], 39 | "price": 84, 40 | "minimum_price": 12, 41 | "percentage": 157.1 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/create-private-label-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Private Label Payment Request 3 | 4 | The settings for creating a private label payment 5 | 6 | ## Structure 7 | 8 | `CreatePrivateLabelPaymentRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `installments` | `int` | Optional | Number of installments

**Default**: `1` | 15 | | `statement_descriptor` | `str` | Optional | The text that will be shown on the private label's statement | 16 | | `card` | [`CreateCardRequest`](../../doc/models/create-card-request.md) | Optional | Card data | 17 | | `card_id` | `str` | Optional | The Card id | 18 | | `card_token` | `str` | Optional | - | 19 | | `recurrence` | `bool` | Optional | Indicates a recurrence | 20 | | `capture` | `bool` | Optional | Indicates if the operation should be only authorization or auth and capture.

**Default**: `True` | 21 | | `extended_limit_enabled` | `bool` | Optional | Indicates whether the extended label (private label) is enabled | 22 | | `extended_limit_code` | `str` | Optional | Extended Limit Code | 23 | | `recurrency_cycle` | `str` | Optional | Defines whether the card has been used one or more times. | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "installments": 1, 30 | "capture": true, 31 | "recurrency_cycle": "\"first\" or \"subsequent\"", 32 | "statement_descriptor": "statement_descriptor8", 33 | "card": { 34 | "number": "number6", 35 | "holder_name": "holder_name2", 36 | "exp_month": 228, 37 | "exp_year": 68, 38 | "cvv": "cvv4" 39 | }, 40 | "card_id": "card_id4", 41 | "card_token": "card_token2" 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/create-register-information-address-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Register Information Address Request 3 | 4 | Register Information Address 5 | 6 | ## Structure 7 | 8 | `CreateRegisterInformationAddressRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `street` | `str` | Required | - | 15 | | `complementary` | `str` | Required | - | 16 | | `street_number` | `str` | Required | - | 17 | | `neighborhood` | `str` | Required | - | 18 | | `city` | `str` | Required | - | 19 | | `state` | `str` | Required | - | 20 | | `zip_code` | `str` | Required | - | 21 | | `reference_point` | `str` | Required | - | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "street": "street8", 28 | "complementary": "complementary0", 29 | "street_number": "street_number8", 30 | "neighborhood": "neighborhood4", 31 | "city": "city8", 32 | "state": "state4", 33 | "zip_code": "zip_code2", 34 | "reference_point": "reference_point2" 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/create-register-information-base-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Register Information Base Request 3 | 4 | Request object for RegisterInformation. 5 | 6 | ## Structure 7 | 8 | `CreateRegisterInformationBaseRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `email` | `str` | Required | - | 15 | | `document` | `str` | Required | - | 16 | | `mtype` | `str` | Required | "individual" ou "corporation" | 17 | | `site_url` | `str` | Optional | - | 18 | | `phone_numbers` | [`List[CreateRegisterInformationPhoneRequest]`](../../doc/models/create-register-information-phone-request.md) | Required | - | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "email": "email4", 25 | "document": "document6", 26 | "type": "type8", 27 | "phone_numbers": [ 28 | { 29 | "ddd": "ddd4", 30 | "number": "number2", 31 | "type": "type0" 32 | } 33 | ], 34 | "site_url": "site_url4" 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/create-register-information-individual-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Register Information Individual Request 3 | 4 | ## Structure 5 | 6 | `CreateRegisterInformationIndividualRequest` 7 | 8 | ## Inherits From 9 | 10 | [`CreateRegisterInformationBaseRequest`](../../doc/models/create-register-information-base-request.md) 11 | 12 | ## Fields 13 | 14 | | Name | Type | Tags | Description | 15 | | --- | --- | --- | --- | 16 | | `name` | `str` | Required | - | 17 | | `mother_name` | `str` | Optional | - | 18 | | `birthdate` | `str` | Required | - | 19 | | `monthly_income` | `int` | Required | - | 20 | | `professional_occupation` | `str` | Required | - | 21 | | `address` | [`CreateRegisterInformationAddressRequest`](../../doc/models/create-register-information-address-request.md) | Required | - | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "email": "email4", 28 | "document": "document6", 29 | "type": "type8", 30 | "site_url": "site_url4", 31 | "phone_numbers": [ 32 | { 33 | "ddd": "ddd4", 34 | "number": "number2", 35 | "type": "type0" 36 | }, 37 | { 38 | "ddd": "ddd4", 39 | "number": "number2", 40 | "type": "type0" 41 | } 42 | ], 43 | "name": "name6", 44 | "mother_name": "mother_name2", 45 | "birthdate": "birthdate0", 46 | "monthly_income": 206, 47 | "professional_occupation": "professional_occupation0", 48 | "address": { 49 | "street": "street6", 50 | "complementary": "complementary8", 51 | "street_number": "street_number6", 52 | "neighborhood": "neighborhood2", 53 | "city": "city6", 54 | "state": "state2", 55 | "zip_code": "zip_code0", 56 | "reference_point": "reference_point0" 57 | } 58 | } 59 | ``` 60 | 61 | -------------------------------------------------------------------------------- /doc/models/create-register-information-phone-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Register Information Phone Request 3 | 4 | Register Information Phone 5 | 6 | ## Structure 7 | 8 | `CreateRegisterInformationPhoneRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `ddd` | `str` | Required | - | 15 | | `number` | `str` | Required | - | 16 | | `mtype` | `str` | Required | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "ddd": "ddd4", 23 | "number": "number6", 24 | "type": "type8" 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-split-options-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Split Options Request 3 | 4 | The Split Options Request 5 | 6 | ## Structure 7 | 8 | `CreateSplitOptionsRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `liable` | `bool` | Optional | Liable options | 15 | | `charge_processing_fee` | `bool` | Optional | Charge processing fee | 16 | | `charge_remainder_fee` | `bool` | Optional | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "liable": false, 23 | "charge_processing_fee": false, 24 | "charge_remainder_fee": false 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-split-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Split Request 3 | 4 | Split 5 | 6 | ## Structure 7 | 8 | `CreateSplitRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `mtype` | `str` | Required | Split type | 15 | | `amount` | `int` | Required | Amount | 16 | | `recipient_id` | `str` | Required | Recipient id | 17 | | `options` | [`CreateSplitOptionsRequest`](../../doc/models/create-split-options-request.md) | Optional | The split options request | 18 | | `split_rule_id` | `str` | Optional | Rule code used in cancellation. | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "type": "type6", 25 | "amount": 100, 26 | "recipient_id": "recipient_id6", 27 | "options": { 28 | "liable": false, 29 | "charge_processing_fee": false, 30 | "charge_remainder_fee": false 31 | }, 32 | "split_rule_id": "split_rule_id8" 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/create-subscription-boleto-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Subscription Boleto Request 3 | 4 | Information about fines and interest on the "boleto" used from payment 5 | 6 | ## Structure 7 | 8 | `CreateSubscriptionBoletoRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `interest` | [`CreateInterestRequest`](../../doc/models/create-interest-request.md) | Optional | - | 15 | | `fine` | [`CreateFineRequest`](../../doc/models/create-fine-request.md) | Optional | - | 16 | | `max_days_to_pay_past_due` | `int` | Optional | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "interest": { 23 | "days": 156, 24 | "type": "type0", 25 | "amount": 230 26 | }, 27 | "fine": { 28 | "days": 138, 29 | "type": "type2", 30 | "amount": 212 31 | }, 32 | "max_days_to_pay_past_due": 22 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/create-subscription-split-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Subscription Split Request 3 | 4 | ## Structure 5 | 6 | `CreateSubscriptionSplitRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `enabled` | `bool` | Required | Defines if the split is enabled | 13 | | `rules` | [`List[CreateSplitRequest]`](../../doc/models/create-split-request.md) | Required | Split | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "enabled": false, 20 | "rules": [ 21 | { 22 | "type": "type2", 23 | "amount": 118, 24 | "recipient_id": "recipient_id2", 25 | "options": { 26 | "liable": false, 27 | "charge_processing_fee": false, 28 | "charge_remainder_fee": false 29 | }, 30 | "split_rule_id": "split_rule_id0" 31 | } 32 | ] 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/create-three-d-secure-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Three D Secure Request 3 | 4 | Creates a 3D-S authentication payment 5 | 6 | ## Structure 7 | 8 | `CreateThreeDSecureRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `mpi` | `str` | Required | The MPI Vendor (MerchantPlugin) | 15 | | `cavv` | `str` | Optional | The Cardholder Authentication Verification value | 16 | | `eci` | `str` | Optional | The Electronic Commerce Indicator value | 17 | | `transaction_id` | `str` | Optional | The TransactionId value (XID) | 18 | | `success_url` | `str` | Optional | The success URL after the authentication | 19 | | `ds_transaction_id` | `str` | Optional | Directory Service Transaction Identifier | 20 | | `version` | `str` | Optional | ThreeDSecure Version | 21 | 22 | ## Example (as JSON) 23 | 24 | ```json 25 | { 26 | "mpi": "mpi4", 27 | "cavv": "cavv2", 28 | "eci": "eci6", 29 | "transaction_id": "transaction_id4", 30 | "success_url": "success_url8", 31 | "ds_transaction_id": "ds_transaction_id4" 32 | } 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /doc/models/create-token-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Token Request 3 | 4 | Token data 5 | 6 | ## Structure 7 | 8 | `CreateTokenRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `mtype` | `str` | Required | Token type

**Default**: `'card'` | 15 | | `card` | [`CreateCardTokenRequest`](../../doc/models/create-card-token-request.md) | Required | Card data | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "type": "card", 22 | "card": { 23 | "number": "number6", 24 | "holder_name": "holder_name2", 25 | "exp_month": 228, 26 | "exp_year": 68, 27 | "cvv": "cvv4", 28 | "brand": "brand0", 29 | "label": "label6" 30 | } 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /doc/models/create-transaction-report-file-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Transaction Report File Request 3 | 4 | ## Structure 5 | 6 | `CreateTransactionReportFileRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `name` | `str` | Required | - | 13 | | `start_at` | `datetime` | Optional | - | 14 | | `end_at` | `str` | Optional | - | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "name": "name6", 21 | "start_at": "2016-03-13T12:52:32.123Z", 22 | "end_at": "end_at6" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/create-transfer-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Transfer Request 3 | 4 | Request for creating a transfer 5 | 6 | ## Structure 7 | 8 | `CreateTransferRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `amount` | `int` | Required | Transfer amount | 15 | | `metadata` | `Dict[str, str]` | Required | Metadata | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "amount": 148, 22 | "metadata": { 23 | "key0": "metadata7", 24 | "key1": "metadata8", 25 | "key2": "metadata9" 26 | } 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/create-transfer-settings-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Transfer Settings Request 3 | 4 | Informações de transferência do recebedor 5 | 6 | ## Structure 7 | 8 | `CreateTransferSettingsRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `transfer_enabled` | `bool` | Required | - | 15 | | `transfer_interval` | `str` | Required | - | 16 | | `transfer_day` | `int` | Required | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "transfer_enabled": false, 23 | "transfer_interval": "transfer_interval4", 24 | "transfer_day": 82 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/create-transfer.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Transfer 3 | 4 | ## Structure 5 | 6 | `CreateTransfer` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `amount` | `int` | Required | - | 13 | | `source_id` | `str` | Required | - | 14 | | `target_id` | `str` | Required | - | 15 | | `metadata` | `List[str]` | Optional | - | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "amount": 252, 22 | "source_id": "source_id6", 23 | "target_id": "target_id8", 24 | "metadata": [ 25 | "metadata1", 26 | "metadata2" 27 | ] 28 | } 29 | ``` 30 | 31 | -------------------------------------------------------------------------------- /doc/models/create-usage-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Usage Request 3 | 4 | Request for creating a usage 5 | 6 | ## Structure 7 | 8 | `CreateUsageRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `quantity` | `int` | Required | - | 15 | | `description` | `str` | Required | - | 16 | | `used_at` | `datetime` | Required | - | 17 | | `code` | `str` | Optional | Identification code in the client system | 18 | | `group` | `str` | Optional | identification group in the client system | 19 | | `amount` | `int` | Optional | Field used in item scheme type 'Percent' | 20 | 21 | ## Example (as JSON) 22 | 23 | ```json 24 | { 25 | "quantity": 224, 26 | "description": "description8", 27 | "used_at": "2016-03-13T12:52:32.123Z", 28 | "code": "code0", 29 | "group": "group0", 30 | "amount": 110 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /doc/models/create-voucher-payment-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Voucher Payment Request 3 | 4 | The settings for creating a voucher payment 5 | 6 | ## Structure 7 | 8 | `CreateVoucherPaymentRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `statement_descriptor` | `str` | Optional | The text that will be shown on the voucher's statement | 15 | | `card_id` | `str` | Optional | Card id | 16 | | `card_token` | `str` | Optional | Card token | 17 | | `card` | [`CreateCardRequest`](../../doc/models/create-card-request.md) | Optional | Card info | 18 | | `recurrency_cycle` | `str` | Optional | Defines whether the card has been used one or more times. | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "recurrency_cycle": "\"first\" or \"subsequent\"", 25 | "statement_descriptor": "statement_descriptor0", 26 | "card_id": "card_id6", 27 | "card_token": "card_token0", 28 | "Card": { 29 | "number": "number8", 30 | "holder_name": "holder_name6", 31 | "exp_month": 240, 32 | "exp_year": 56, 33 | "cvv": "cvv8" 34 | } 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/create-withdraw-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Withdraw Request 3 | 4 | ## Structure 5 | 6 | `CreateWithdrawRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `amount` | `int` | Required | - | 13 | | `metadata` | `Dict[str, str]` | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "amount": 204, 20 | "metadata": { 21 | "key0": "metadata7", 22 | "key1": "metadata6" 23 | } 24 | } 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /doc/models/error-exception.md: -------------------------------------------------------------------------------- 1 | 2 | # Error Exception 3 | 4 | Api Error Exception 5 | 6 | ## Structure 7 | 8 | `ErrorException` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `message` | `str` | Required | - | 15 | | `errors` | `Any` | Required | - | 16 | | `request` | `Any` | Required | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "message": "message4", 23 | "errors": { 24 | "key1": "val1", 25 | "key2": "val2" 26 | }, 27 | "request": { 28 | "key1": "val1", 29 | "key2": "val2" 30 | } 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /doc/models/get-access-token-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Access Token Response 3 | 4 | Response object for getting a access token 5 | 6 | ## Structure 7 | 8 | `GetAccessTokenResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `code` | `str` | Optional | - | 16 | | `status` | `str` | Optional | - | 17 | | `created_at` | `datetime` | Optional | - | 18 | | `customer` | [`GetCustomerResponse`](../../doc/models/get-customer-response.md) | Optional | - | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "id": "id0", 25 | "code": "code8", 26 | "status": "status2", 27 | "created_at": "2016-03-13T12:52:32.123Z", 28 | "customer": { 29 | "id": "id0", 30 | "name": "name0", 31 | "email": "email6", 32 | "delinquent": false, 33 | "created_at": "2016-03-13T12:52:32.123Z" 34 | } 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/get-address-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Address Response 3 | 4 | Response object for getting an Address 5 | 6 | ## Structure 7 | 8 | `GetAddressResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `street` | `str` | Optional | - | 16 | | `number` | `str` | Optional | - | 17 | | `complement` | `str` | Optional | - | 18 | | `zip_code` | `str` | Optional | - | 19 | | `neighborhood` | `str` | Optional | - | 20 | | `city` | `str` | Optional | - | 21 | | `state` | `str` | Optional | - | 22 | | `country` | `str` | Optional | - | 23 | | `status` | `str` | Optional | - | 24 | | `created_at` | `datetime` | Optional | - | 25 | | `updated_at` | `datetime` | Optional | - | 26 | | `customer` | [`GetCustomerResponse`](../../doc/models/get-customer-response.md) | Optional | - | 27 | | `metadata` | `Dict[str, str]` | Optional | - | 28 | | `line_1` | `str` | Optional | Line 1 for address | 29 | | `line_2` | `str` | Optional | Line 2 for address | 30 | | `deleted_at` | `datetime` | Optional | - | 31 | 32 | ## Example (as JSON) 33 | 34 | ```json 35 | { 36 | "id": "id2", 37 | "street": "street2", 38 | "number": "number0", 39 | "complement": "complement8", 40 | "zip_code": "zip_code6" 41 | } 42 | ``` 43 | 44 | -------------------------------------------------------------------------------- /doc/models/get-anticipation-limit-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Anticipation Limit Response 3 | 4 | Anticipation limit 5 | 6 | ## Structure 7 | 8 | `GetAnticipationLimitResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `amount` | `int` | Optional | Amount | 15 | | `anticipation_fee` | `int` | Optional | Anticipation fee | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "amount": 6, 22 | "anticipation_fee": 88 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/get-anticipation-limits-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Anticipation Limits Response 3 | 4 | Anticipation limits 5 | 6 | ## Structure 7 | 8 | `GetAnticipationLimitsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `max` | [`GetAnticipationLimitResponse`](../../doc/models/get-anticipation-limit-response.md) | Optional | Max limit | 15 | | `min` | [`GetAnticipationLimitResponse`](../../doc/models/get-anticipation-limit-response.md) | Optional | Min limit | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "max": { 22 | "amount": 140, 23 | "anticipation_fee": 234 24 | }, 25 | "min": { 26 | "amount": 34, 27 | "anticipation_fee": 60 28 | } 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /doc/models/get-anticipation-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Anticipation Response 3 | 4 | Anticipation 5 | 6 | ## Structure 7 | 8 | `GetAnticipationResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | Id | 15 | | `requested_amount` | `int` | Optional | Requested amount | 16 | | `approved_amount` | `int` | Optional | Approved amount | 17 | | `recipient` | [`GetRecipientResponse`](../../doc/models/get-recipient-response.md) | Optional | Recipient | 18 | | `pgid` | `str` | Optional | Anticipation id on the gateway | 19 | | `created_at` | `datetime` | Optional | Creation date | 20 | | `updated_at` | `datetime` | Optional | Last update date | 21 | | `payment_date` | `datetime` | Optional | Payment date | 22 | | `status` | `str` | Optional | Status | 23 | | `timeframe` | `str` | Optional | Timeframe | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "id": "id8", 30 | "requested_amount": 130, 31 | "approved_amount": 184, 32 | "recipient": { 33 | "id": "id8", 34 | "name": "name8", 35 | "email": "email8", 36 | "document": "document8", 37 | "description": "description2" 38 | }, 39 | "pgid": "pgid4" 40 | } 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /doc/models/get-antifraud-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Antifraud Response 3 | 4 | ## Structure 5 | 6 | `GetAntifraudResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `status` | `str` | Optional | - | 13 | | `return_code` | `str` | Optional | - | 14 | | `return_message` | `str` | Optional | - | 15 | | `provider_name` | `str` | Optional | - | 16 | | `score` | `str` | Optional | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "status": "status0", 23 | "return_code": "return_code8", 24 | "return_message": "return_message6", 25 | "provider_name": "provider_name6", 26 | "score": "score8" 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/get-automatic-anticipation-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Automatic Anticipation Response 3 | 4 | ## Structure 5 | 6 | `GetAutomaticAnticipationResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `enabled` | `bool` | Optional | - | 13 | | `mtype` | `str` | Optional | - | 14 | | `volume_percentage` | `int` | Optional | - | 15 | | `delay` | `int` | Optional | - | 16 | | `days` | `List[int]` | Optional | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "enabled": false, 23 | "type": "type8", 24 | "volume_percentage": 178, 25 | "delay": 112, 26 | "days": [ 27 | 88 28 | ] 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /doc/models/get-balance-operation-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Balance Operation Response 3 | 4 | Generic response object for getting a BalanceOperation. 5 | 6 | ## Structure 7 | 8 | `GetBalanceOperationResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `status` | `str` | Optional | - | 16 | | `balance_amount` | `str` | Optional | - | 17 | | `balance_old_amount` | `str` | Optional | - | 18 | | `mtype` | `str` | Optional | - | 19 | | `amount` | `int` | Optional | - | 20 | | `fee` | `str` | Optional | - | 21 | | `created_at` | `str` | Optional | - | 22 | | `movement_object` | [`GetMovementObjectBaseResponse`](../../doc/models/get-movement-object-base-response.md) | Optional | - | 23 | 24 | ## Example (as JSON) 25 | 26 | ```json 27 | { 28 | "id": "id0", 29 | "status": "status2", 30 | "balance_amount": "balance_amount0", 31 | "balance_old_amount": "balance_old_amount8", 32 | "type": "type0" 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/get-balance-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Balance Response 3 | 4 | Balance 5 | 6 | ## Structure 7 | 8 | `GetBalanceResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `currency` | `str` | Optional | Currency | 15 | | `available_amount` | `int` | Optional | Amount available for transferring | 16 | | `recipient` | [`GetRecipientResponse`](../../doc/models/get-recipient-response.md) | Optional | Recipient | 17 | | `transferred_amount` | `int` | Optional | - | 18 | | `waiting_funds_amount` | `int` | Optional | - | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "currency": "currency2", 25 | "available_amount": 96, 26 | "recipient": { 27 | "id": "id8", 28 | "name": "name8", 29 | "email": "email8", 30 | "document": "document8", 31 | "description": "description2" 32 | }, 33 | "transferred_amount": 142, 34 | "waiting_funds_amount": 174 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/get-bank-account-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Bank Account Response 3 | 4 | ## Structure 5 | 6 | `GetBankAccountResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `id` | `str` | Optional | Id | 13 | | `holder_name` | `str` | Optional | Holder name | 14 | | `holder_type` | `str` | Optional | Holder type | 15 | | `bank` | `str` | Optional | Bank | 16 | | `branch_number` | `str` | Optional | Branch number | 17 | | `branch_check_digit` | `str` | Optional | Branch check digit | 18 | | `account_number` | `str` | Optional | Account number | 19 | | `account_check_digit` | `str` | Optional | Account check digit | 20 | | `mtype` | `str` | Optional | Bank account type | 21 | | `status` | `str` | Optional | Bank account status | 22 | | `created_at` | `datetime` | Optional | Creation date | 23 | | `updated_at` | `datetime` | Optional | Last update date | 24 | | `deleted_at` | `datetime` | Optional | Deletion date | 25 | | `recipient` | [`GetRecipientResponse`](../../doc/models/get-recipient-response.md) | Optional | Recipient | 26 | | `metadata` | `Dict[str, str]` | Optional | Metadata | 27 | | `pix_key` | `str` | Optional | Pix Key | 28 | 29 | ## Example (as JSON) 30 | 31 | ```json 32 | { 33 | "id": "id6", 34 | "holder_name": "holder_name2", 35 | "holder_type": "holder_type8", 36 | "bank": "bank4", 37 | "branch_number": "branch_number2" 38 | } 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /doc/models/get-bank-transfer-transaction-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Bank Transfer Transaction Response 3 | 4 | Response object for getting a bank transfer transaction 5 | 6 | ## Structure 7 | 8 | `GetBankTransferTransactionResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `url` | `str` | Optional | Payment url | 19 | | `bank_tid` | `str` | Optional | Transaction identifier for the bank | 20 | | `bank` | `str` | Optional | Bank | 21 | | `paid_at` | `datetime` | Optional | Payment date | 22 | | `paid_amount` | `int` | Optional | Paid amount | 23 | 24 | ## Example (as JSON) 25 | 26 | ```json 27 | { 28 | "gateway_id": "gateway_id8", 29 | "amount": 40, 30 | "status": "status6", 31 | "success": false, 32 | "created_at": "2016-03-13T12:52:32.123Z", 33 | "url": "url2", 34 | "bank_tid": "bank_tid2", 35 | "bank": "bank6", 36 | "paid_at": "2016-03-13T12:52:32.123Z", 37 | "paid_amount": 176 38 | } 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /doc/models/get-billing-address-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Billing Address Response 3 | 4 | Response object for getting a billing address 5 | 6 | ## Structure 7 | 8 | `GetBillingAddressResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `street` | `str` | Optional | - | 15 | | `number` | `str` | Optional | - | 16 | | `zip_code` | `str` | Optional | - | 17 | | `neighborhood` | `str` | Optional | - | 18 | | `city` | `str` | Optional | - | 19 | | `state` | `str` | Optional | - | 20 | | `country` | `str` | Optional | - | 21 | | `complement` | `str` | Optional | - | 22 | | `line_1` | `str` | Optional | Line 1 for address | 23 | | `line_2` | `str` | Optional | Line 2 for address | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "street": "street4", 30 | "number": "number2", 31 | "zip_code": "zip_code8", 32 | "neighborhood": "neighborhood0", 33 | "city": "city4" 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /doc/models/get-boleto-transaction-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Boleto Transaction Response 3 | 4 | Response object for getting a boleto transaction 5 | 6 | ## Structure 7 | 8 | `GetBoletoTransactionResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `url` | `str` | Optional | - | 19 | | `barcode` | `str` | Optional | - | 20 | | `nosso_numero` | `str` | Optional | - | 21 | | `bank` | `str` | Optional | - | 22 | | `document_number` | `str` | Optional | - | 23 | | `instructions` | `str` | Optional | - | 24 | | `billing_address` | [`GetBillingAddressResponse`](../../doc/models/get-billing-address-response.md) | Optional | - | 25 | | `due_at` | `datetime` | Optional | - | 26 | | `qr_code` | `str` | Optional | - | 27 | | `line` | `str` | Optional | - | 28 | | `pdf_password` | `str` | Optional | - | 29 | | `pdf` | `str` | Optional | - | 30 | | `paid_at` | `datetime` | Optional | - | 31 | | `paid_amount` | `str` | Optional | - | 32 | | `mtype` | `str` | Optional | - | 33 | | `credit_at` | `datetime` | Optional | - | 34 | | `statement_descriptor` | `str` | Optional | Soft Descriptor | 35 | 36 | ## Example (as JSON) 37 | 38 | ```json 39 | { 40 | "gateway_id": "gateway_id8", 41 | "amount": 40, 42 | "status": "status6", 43 | "success": false, 44 | "created_at": "2016-03-13T12:52:32.123Z", 45 | "url": "url0", 46 | "barcode": "barcode4", 47 | "nosso_numero": "nosso_numero6", 48 | "bank": "bank4", 49 | "document_number": "document_number0" 50 | } 51 | ``` 52 | 53 | -------------------------------------------------------------------------------- /doc/models/get-card-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Card Response 3 | 4 | Response object for getting a credit card 5 | 6 | ## Structure 7 | 8 | `GetCardResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `last_four_digits` | `str` | Optional | - | 16 | | `brand` | `str` | Optional | - | 17 | | `holder_name` | `str` | Optional | - | 18 | | `exp_month` | `int` | Optional | - | 19 | | `exp_year` | `int` | Optional | - | 20 | | `status` | `str` | Optional | - | 21 | | `created_at` | `datetime` | Optional | - | 22 | | `updated_at` | `datetime` | Optional | - | 23 | | `billing_address` | [`GetBillingAddressResponse`](../../doc/models/get-billing-address-response.md) | Optional | - | 24 | | `customer` | [`GetCustomerResponse`](../../doc/models/get-customer-response.md) | Optional | - | 25 | | `metadata` | `Dict[str, str]` | Optional | - | 26 | | `mtype` | `str` | Optional | Card type | 27 | | `holder_document` | `str` | Optional | Document number for the card's holder | 28 | | `deleted_at` | `datetime` | Optional | - | 29 | | `first_six_digits` | `str` | Optional | First six digits | 30 | | `label` | `str` | Optional | - | 31 | 32 | ## Example (as JSON) 33 | 34 | ```json 35 | { 36 | "id": "id4", 37 | "last_four_digits": "last_four_digits0", 38 | "brand": "brand8", 39 | "holder_name": "holder_name0", 40 | "exp_month": 52 41 | } 42 | ``` 43 | 44 | -------------------------------------------------------------------------------- /doc/models/get-card-token-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Card Token Response 3 | 4 | Card token data 5 | 6 | ## Structure 7 | 8 | `GetCardTokenResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `last_four_digits` | `str` | Optional | - | 15 | | `holder_name` | `str` | Optional | - | 16 | | `holder_document` | `str` | Optional | - | 17 | | `exp_month` | `int` | Optional | - | 18 | | `exp_year` | `int` | Optional | - | 19 | | `brand` | `str` | Optional | - | 20 | | `mtype` | `str` | Optional | - | 21 | | `label` | `str` | Optional | - | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "last_four_digits": "last_four_digits8", 28 | "holder_name": "holder_name8", 29 | "holder_document": "holder_document6", 30 | "exp_month": 168, 31 | "exp_year": 128 32 | } 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /doc/models/get-cash-transaction-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Cash Transaction Response 3 | 4 | Response object for getting a cash transaction 5 | 6 | ## Structure 7 | 8 | `GetCashTransactionResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `description` | `str` | Optional | Description | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "gateway_id": "gateway_id8", 25 | "amount": 40, 26 | "status": "status6", 27 | "success": false, 28 | "created_at": "2016-03-13T12:52:32.123Z", 29 | "description": "description0" 30 | } 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /doc/models/get-charges-summary-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Charges Summary Response 3 | 4 | ## Structure 5 | 6 | `GetChargesSummaryResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `total` | `int` | Optional | - | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "total": 150 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /doc/models/get-checkout-bank-transfer-payment-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Checkout Bank Transfer Payment Response 3 | 4 | Bank transfer checkout response 5 | 6 | ## Structure 7 | 8 | `GetCheckoutBankTransferPaymentResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `bank` | `List[str]` | Optional | bank list response | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "bank": [ 21 | "bank3", 22 | "bank4" 23 | ] 24 | } 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /doc/models/get-checkout-boleto-payment-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Checkout Boleto Payment Response 3 | 4 | ## Structure 5 | 6 | `GetCheckoutBoletoPaymentResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `due_at` | `datetime` | Optional | Data de vencimento do boleto | 13 | | `instructions` | `str` | Optional | Instruções do boleto | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "due_at": "2016-03-13T12:52:32.123Z", 20 | "instructions": "instructions8" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-checkout-card-installment-options-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Checkout Card Installment Options Response 3 | 4 | ## Structure 5 | 6 | `GetCheckoutCardInstallmentOptionsResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `number` | `int` | Required | Número de parcelas | 13 | | `total` | `int` | Required | Valor total da compra | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "number": 40, 20 | "total": 188 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-checkout-credit-card-payment-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Checkout Credit Card Payment Response 3 | 4 | ## Structure 5 | 6 | `GetCheckoutCreditCardPaymentResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `statement_descriptor` | `str` | Optional | Descrição na fatura | 13 | | `installments` | [`List[GetCheckoutCardInstallmentOptionsResponse]`](../../doc/models/get-checkout-card-installment-options-response.md) | Optional | Parcelas | 14 | | `authentication` | [`GetPaymentAuthenticationResponse`](../../doc/models/get-payment-authentication-response.md) | Optional | Payment Authentication response | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "statementDescriptor": "statementDescriptor8", 21 | "installments": [ 22 | { 23 | "number": 164, 24 | "total": 16 25 | } 26 | ], 27 | "authentication": { 28 | "type": "type2", 29 | "threed_secure": { 30 | "mpi": "mpi0", 31 | "eci": "eci2", 32 | "cavv": "cavv8", 33 | "transaction_Id": "transaction_Id2", 34 | "success_url": "success_url4" 35 | } 36 | } 37 | } 38 | ``` 39 | 40 | -------------------------------------------------------------------------------- /doc/models/get-checkout-debit-card-payment-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Checkout Debit Card Payment Response 3 | 4 | ## Structure 5 | 6 | `GetCheckoutDebitCardPaymentResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `statement_descriptor` | `str` | Optional | Descrição na fatura | 13 | | `authentication` | [`GetPaymentAuthenticationResponse`](../../doc/models/get-payment-authentication-response.md) | Optional | Payment Authentication response object data | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "statement_descriptor": "statement_descriptor6", 20 | "authentication": { 21 | "type": "type2", 22 | "threed_secure": { 23 | "mpi": "mpi0", 24 | "eci": "eci2", 25 | "cavv": "cavv8", 26 | "transaction_Id": "transaction_Id2", 27 | "success_url": "success_url4" 28 | } 29 | } 30 | } 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /doc/models/get-checkout-payment-settings-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Checkout Payment Settings Response 3 | 4 | Checkout Payment Settings Response 5 | 6 | ## Structure 7 | 8 | `GetCheckoutPaymentSettingsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `success_url` | `str` | Optional | Success Url | 15 | | `payment_url` | `str` | Optional | Payment Url | 16 | | `accepted_payment_methods` | `List[str]` | Optional | Accepted Payment Methods | 17 | | `status` | `str` | Optional | Status | 18 | | `customer` | [`GetCustomerResponse`](../../doc/models/get-customer-response.md) | Optional | Customer | 19 | | `amount` | `int` | Optional | Payment amount | 20 | | `default_payment_method` | `str` | Optional | Default Payment Method | 21 | | `gateway_affiliation_id` | `str` | Optional | Gateway Affiliation Id | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "success_url": "success_url0", 28 | "payment_url": "payment_url8", 29 | "accepted_payment_methods": [ 30 | "accepted_payment_methods1", 31 | "accepted_payment_methods2" 32 | ], 33 | "status": "status0", 34 | "customer": { 35 | "id": "id0", 36 | "name": "name0", 37 | "email": "email6", 38 | "delinquent": false, 39 | "created_at": "2016-03-13T12:52:32.123Z" 40 | } 41 | } 42 | ``` 43 | 44 | -------------------------------------------------------------------------------- /doc/models/get-checkout-pix-payment-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Checkout Pix Payment Response 3 | 4 | Checkout pix payment response 5 | 6 | ## Structure 7 | 8 | `GetCheckoutPixPaymentResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `expires_at` | `datetime` | Optional | Expires at | 15 | | `additional_information` | [`List[PixAdditionalInformation]`](../../doc/models/pix-additional-information.md) | Optional | Additional information | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "expires_at": "2016-03-13T12:52:32.123Z", 22 | "additional_information": [ 23 | { 24 | "Name": "Name0", 25 | "Value": "Value2" 26 | }, 27 | { 28 | "Name": "Name0", 29 | "Value": "Value2" 30 | }, 31 | { 32 | "Name": "Name0", 33 | "Value": "Value2" 34 | } 35 | ] 36 | } 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /doc/models/get-customer-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Customer Response 3 | 4 | Response object for getting a customer 5 | 6 | ## Structure 7 | 8 | `GetCustomerResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `name` | `str` | Optional | - | 16 | | `email` | `str` | Optional | - | 17 | | `delinquent` | `bool` | Optional | - | 18 | | `created_at` | `datetime` | Optional | - | 19 | | `updated_at` | `datetime` | Optional | - | 20 | | `document` | `str` | Optional | - | 21 | | `mtype` | `str` | Optional | - | 22 | | `fb_access_token` | `str` | Optional | - | 23 | | `address` | [`GetAddressResponse`](../../doc/models/get-address-response.md) | Optional | - | 24 | | `metadata` | `Dict[str, str]` | Optional | - | 25 | | `phones` | [`GetPhonesResponse`](../../doc/models/get-phones-response.md) | Optional | - | 26 | | `fb_id` | `int` | Optional | - | 27 | | `code` | `str` | Optional | Código de referência do cliente no sistema da loja. Max: 52 caracteres | 28 | | `document_type` | `str` | Optional | - | 29 | 30 | ## Example (as JSON) 31 | 32 | ```json 33 | { 34 | "id": "id4", 35 | "name": "name4", 36 | "email": "email2", 37 | "delinquent": false, 38 | "created_at": "2016-03-13T12:52:32.123Z" 39 | } 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /doc/models/get-device-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Device Response 3 | 4 | Response object for geetting an order device 5 | 6 | ## Structure 7 | 8 | `GetDeviceResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `platform` | `str` | Optional | Device's platform name | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "platform": "platform8" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-discount-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Discount Response 3 | 4 | Response object for getting a discount 5 | 6 | ## Structure 7 | 8 | `GetDiscountResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `value` | `float` | Optional | - | 16 | | `discount_type` | `str` | Optional | - | 17 | | `status` | `str` | Optional | - | 18 | | `created_at` | `datetime` | Optional | - | 19 | | `cycles` | `int` | Optional | - | 20 | | `deleted_at` | `datetime` | Optional | - | 21 | | `description` | `str` | Optional | - | 22 | | `subscription` | [`GetSubscriptionResponse`](../../doc/models/get-subscription-response.md) | Optional | - | 23 | | `subscription_item` | [`GetSubscriptionItemResponse`](../../doc/models/get-subscription-item-response.md) | Optional | The subscription item | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "id": "id4", 30 | "value": 139.66, 31 | "discount_type": "discount_type2", 32 | "status": "status6", 33 | "created_at": "2016-03-13T12:52:32.123Z" 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /doc/models/get-fine-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Fine Response 3 | 4 | Fine Response 5 | 6 | ## Structure 7 | 8 | `GetFineResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `days` | `int` | Optional | Days | 15 | | `mtype` | `str` | Optional | Type | 16 | | `amount` | `int` | Optional | Amount | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "type": "\"percentage\" or \"flat\"", 23 | "days": 112, 24 | "amount": 186 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/get-gateway-error-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Gateway Error Response 3 | 4 | Gateway Response 5 | 6 | ## Structure 7 | 8 | `GetGatewayErrorResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `message` | `str` | Optional | The message error | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "message": "message4" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-gateway-recipient-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Gateway Recipient Response 3 | 4 | Information about the recipient on the gateway 5 | 6 | ## Structure 7 | 8 | `GetGatewayRecipientResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `gateway` | `str` | Optional | Gateway name | 15 | | `status` | `str` | Optional | Status of the recipient on the gateway | 16 | | `pgid` | `str` | Optional | Recipient id on the gateway | 17 | | `created_at` | `str` | Optional | Creation date | 18 | | `updated_at` | `str` | Optional | Last update date | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "gateway": "gateway2", 25 | "status": "status4", 26 | "pgid": "pgid8", 27 | "created_at": "created_at0", 28 | "updated_at": "updated_at8" 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /doc/models/get-gateway-response-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Gateway Response Response 3 | 4 | The Transaction Gateway Response 5 | 6 | ## Structure 7 | 8 | `GetGatewayResponseResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `code` | `str` | Optional | The error code | 15 | | `errors` | [`List[GetGatewayErrorResponse]`](../../doc/models/get-gateway-error-response.md) | Optional | The gateway response errors list | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "code": "code6", 22 | "errors": [ 23 | { 24 | "message": "message0" 25 | }, 26 | { 27 | "message": "message0" 28 | } 29 | ] 30 | } 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /doc/models/get-increment-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Increment Response 3 | 4 | Response object for getting a increment 5 | 6 | ## Structure 7 | 8 | `GetIncrementResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `value` | `float` | Optional | - | 16 | | `increment_type` | `str` | Optional | - | 17 | | `status` | `str` | Optional | - | 18 | | `created_at` | `datetime` | Optional | - | 19 | | `cycles` | `int` | Optional | - | 20 | | `deleted_at` | `datetime` | Optional | - | 21 | | `description` | `str` | Optional | - | 22 | | `subscription` | [`GetSubscriptionResponse`](../../doc/models/get-subscription-response.md) | Optional | - | 23 | | `subscription_item` | [`GetSubscriptionItemResponse`](../../doc/models/get-subscription-item-response.md) | Optional | The Subscription Item | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "id": "id0", 30 | "value": 167.72, 31 | "increment_type": "increment_type2", 32 | "status": "status2", 33 | "created_at": "2016-03-13T12:52:32.123Z" 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /doc/models/get-integration-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Integration Response 3 | 4 | ## Structure 5 | 6 | `GetIntegrationResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `code` | `str` | Optional | - | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "code": "code2" 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /doc/models/get-interest-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Interest Response 3 | 4 | Interest Response 5 | 6 | ## Structure 7 | 8 | `GetInterestResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `days` | `int` | Optional | Days | 15 | | `mtype` | `str` | Optional | Type | 16 | | `amount` | `int` | Optional | Amount | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "type": "\"percentage\" or \"flat\"", 23 | "days": 114, 24 | "amount": 188 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/get-location-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Location Response 3 | 4 | Response object for geetting an order location request 5 | 6 | ## Structure 7 | 8 | `GetLocationResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `latitude` | `str` | Optional | Latitude | 15 | | `longitude` | `str` | Optional | Longitude | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "latitude": "latitude6", 22 | "longitude": "longitude4" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/get-managing-partner-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Managing Partner Response 3 | 4 | Response object for getting an ManagingPartnerResponse 5 | 6 | ## Structure 7 | 8 | `GetManagingPartnerResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `name` | `str` | Optional | - | 15 | | `email` | `str` | Optional | - | 16 | | `document` | `str` | Optional | - | 17 | | `mtype` | `str` | Optional | - | 18 | | `mother_name` | `str` | Optional | - | 19 | | `birthdate` | `str` | Optional | - | 20 | | `monthly_income` | `str` | Optional | - | 21 | | `professional_occupation` | `str` | Optional | - | 22 | | `self_declared_representative` | `bool` | Optional | - | 23 | | `address` | [`GetRegisterInformationAddressResponse`](../../doc/models/get-register-information-address-response.md) | Optional | - | 24 | | `phone_numbers` | [`List[GetPhoneNumberResponse]`](../../doc/models/get-phone-number-response.md) | Optional | - | 25 | 26 | ## Example (as JSON) 27 | 28 | ```json 29 | { 30 | "name": "name0", 31 | "email": "email6", 32 | "document": "document6", 33 | "type": "type0", 34 | "mother_name": "mother_name6" 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/get-movement-object-base-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Movement Object Base Response 3 | 4 | Generic response object for getting a MovementObjectBase. 5 | 6 | ## Structure 7 | 8 | `GetMovementObjectBaseResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `object` | `str` | Optional | - | 15 | | `id` | `str` | Optional | - | 16 | | `status` | `str` | Optional | - | 17 | | `amount` | `str` | Optional | - | 18 | | `created_at` | `str` | Optional | - | 19 | | `mtype` | `str` | Optional | - | 20 | | `charge_id` | `str` | Optional | - | 21 | | `gateway_id` | `str` | Optional | - | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "id": "id2", 28 | "status": "status4", 29 | "amount": "amount4", 30 | "created_at": "created_at0", 31 | "product": "product2", 32 | "brand": "brand6", 33 | "payment_date": "payment_date4", 34 | "recipient_id": "recipient_id2", 35 | "document_type": "document_type0" 36 | } 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /doc/models/get-movement-object-fee-collection-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Movement Object Fee Collection Response 3 | 4 | Generic response object for getting a MovementObjectFeeCollection. 5 | 6 | ## Structure 7 | 8 | `GetMovementObjectFeeCollectionResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetMovementObjectBaseResponse`](../../doc/models/get-movement-object-base-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `description` | `str` | Optional | - | 19 | | `payment_date` | `str` | Optional | - | 20 | | `recipient_id` | `str` | Optional | - | 21 | 22 | ## Example (as JSON) 23 | 24 | ```json 25 | { 26 | "id": "id2", 27 | "status": "status4", 28 | "amount": "amount4", 29 | "created_at": "created_at0", 30 | "description": "description4", 31 | "payment_date": "payment_date4", 32 | "recipient_id": "recipient_id6" 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/get-movement-object-refund-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Movement Object Refund Response 3 | 4 | Generic response object for getting a MovementObjectRefund. 5 | 6 | ## Structure 7 | 8 | `GetMovementObjectRefundResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetMovementObjectBaseResponse`](../../doc/models/get-movement-object-base-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `fraud_coverage_fee` | `str` | Optional | - | 19 | | `charge_fee_recipient_id` | `str` | Optional | - | 20 | | `bank_account_id` | `str` | Optional | - | 21 | | `local_transaction_id` | `str` | Optional | - | 22 | | `updated_at` | `str` | Optional | - | 23 | 24 | ## Example (as JSON) 25 | 26 | ```json 27 | { 28 | "id": "id2", 29 | "status": "status4", 30 | "amount": "amount4", 31 | "created_at": "created_at0", 32 | "fraud_coverage_fee": "fraud_coverage_fee0", 33 | "charge_fee_recipient_id": "charge_fee_recipient_id2", 34 | "bank_account_id": "bank_account_id2", 35 | "local_transaction_id": "local_transaction_id8", 36 | "updated_at": "updated_at8" 37 | } 38 | ``` 39 | 40 | -------------------------------------------------------------------------------- /doc/models/get-movement-object-settlement-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Movement Object Settlement Response 3 | 4 | Generic response object for getting a MovementObjectSettlement. 5 | 6 | ## Structure 7 | 8 | `GetMovementObjectSettlementResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetMovementObjectBaseResponse`](../../doc/models/get-movement-object-base-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `product` | `str` | Optional | - | 19 | | `brand` | `str` | Optional | - | 20 | | `payment_date` | `str` | Optional | - | 21 | | `recipient_id` | `str` | Optional | - | 22 | | `document_type` | `str` | Optional | - | 23 | | `document` | `str` | Optional | - | 24 | | `contract_obligation_id` | `str` | Optional | - | 25 | | `liquidation_arrangement_id` | `str` | Optional | - | 26 | | `external_engine_payment_id` | `str` | Optional | - | 27 | 28 | ## Example (as JSON) 29 | 30 | ```json 31 | { 32 | "id": "id2", 33 | "status": "status4", 34 | "amount": "amount4", 35 | "created_at": "created_at0", 36 | "product": "product2", 37 | "brand": "brand6", 38 | "payment_date": "payment_date4", 39 | "recipient_id": "recipient_id2", 40 | "document_type": "document_type0" 41 | } 42 | ``` 43 | 44 | -------------------------------------------------------------------------------- /doc/models/get-movement-object-transfer-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Movement Object Transfer Response 3 | 4 | ## Structure 5 | 6 | `GetMovementObjectTransferResponse` 7 | 8 | ## Inherits From 9 | 10 | [`GetMovementObjectBaseResponse`](../../doc/models/get-movement-object-base-response.md) 11 | 12 | ## Fields 13 | 14 | | Name | Type | Tags | Description | 15 | | --- | --- | --- | --- | 16 | | `source_type` | `str` | Optional | - | 17 | | `source_id` | `str` | Optional | - | 18 | | `target_type` | `str` | Optional | - | 19 | | `target_id` | `str` | Optional | - | 20 | | `fee` | `str` | Optional | - | 21 | | `funding_date` | `str` | Optional | - | 22 | | `funding_estimated_date` | `str` | Optional | - | 23 | | `bank_account` | `str` | Optional | - | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "id": "id2", 30 | "status": "status4", 31 | "amount": "amount4", 32 | "created_at": "created_at0", 33 | "source_type": "source_type6", 34 | "source_id": "source_id0", 35 | "target_type": "target_type8", 36 | "target_id": "target_id4", 37 | "fee": "fee8" 38 | } 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /doc/models/get-order-item-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Order Item Response 3 | 4 | Response object for getting an order item 5 | 6 | ## Structure 7 | 8 | `GetOrderItemResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | Id | 15 | | `mtype` | `str` | Optional | - | 16 | | `description` | `str` | Optional | - | 17 | | `amount` | `int` | Optional | - | 18 | | `quantity` | `int` | Optional | - | 19 | | `category` | `str` | Optional | Category | 20 | | `code` | `str` | Optional | Code | 21 | | `status` | `str` | Optional | - | 22 | | `created_at` | `datetime` | Optional | - | 23 | | `updated_at` | `datetime` | Optional | - | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "id": "id8", 30 | "type": "type8", 31 | "description": "description8", 32 | "amount": 224, 33 | "quantity": 82 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /doc/models/get-payable-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Payable Response 3 | 4 | Response object for getting an payable 5 | 6 | ## Structure 7 | 8 | `GetPayableResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `int` | Optional | - | 15 | | `status` | `str` | Optional | - | 16 | | `amount` | `int` | Optional | - | 17 | | `fee` | `int` | Optional | - | 18 | | `anticipation_fee` | `int` | Optional | - | 19 | | `fraud_coverage_fee` | `int` | Optional | - | 20 | | `installment` | `int` | Optional | - | 21 | | `gateway_id` | `int` | Optional | - | 22 | | `charge_id` | `str` | Optional | - | 23 | | `split_id` | `str` | Optional | - | 24 | | `bulk_anticipation_id` | `str` | Optional | - | 25 | | `anticipation_id` | `str` | Optional | - | 26 | | `recipient_id` | `str` | Optional | - | 27 | | `originator_model` | `str` | Optional | - | 28 | | `originator_model_id` | `str` | Optional | - | 29 | | `payment_date` | `datetime` | Optional | - | 30 | | `original_payment_date` | `datetime` | Optional | - | 31 | | `mtype` | `str` | Optional | - | 32 | | `payment_method` | `str` | Optional | - | 33 | | `accrual_at` | `datetime` | Optional | - | 34 | | `created_at` | `datetime` | Optional | - | 35 | | `liquidation_arrangement_id` | `str` | Optional | - | 36 | 37 | ## Example (as JSON) 38 | 39 | ```json 40 | { 41 | "id": 134, 42 | "status": "status8", 43 | "amount": 24, 44 | "fee": 190, 45 | "anticipation_fee": 118 46 | } 47 | ``` 48 | 49 | -------------------------------------------------------------------------------- /doc/models/get-payment-authentication-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Payment Authentication Response 3 | 4 | Payment Authentication response 5 | 6 | ## Structure 7 | 8 | `GetPaymentAuthenticationResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `mtype` | `str` | Optional | - | 15 | | `threed_secure` | [`GetThreeDSecureResponse`](../../doc/models/get-three-d-secure-response.md) | Optional | 3D-S payment authentication response | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "type": "type2", 22 | "threed_secure": { 23 | "mpi": "mpi0", 24 | "eci": "eci2", 25 | "cavv": "cavv8", 26 | "transaction_Id": "transaction_Id2", 27 | "success_url": "success_url4" 28 | } 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /doc/models/get-payment-origin-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Payment Origin Response 3 | 4 | ## Structure 5 | 6 | `GetPaymentOriginResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `charge_id` | `str` | Optional | - | 13 | | `brand_id` | `str` | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "charge_id": "charge_id8", 20 | "brand_id": "brand_id4" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-period-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Period Response 3 | 4 | Response object for getting a period 5 | 6 | ## Structure 7 | 8 | `GetPeriodResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `start_at` | `datetime` | Optional | - | 15 | | `end_at` | `datetime` | Optional | - | 16 | | `id` | `str` | Optional | - | 17 | | `billing_at` | `datetime` | Optional | - | 18 | | `subscription` | [`GetSubscriptionResponse`](../../doc/models/get-subscription-response.md) | Optional | - | 19 | | `status` | `str` | Optional | - | 20 | | `duration` | `int` | Optional | - | 21 | | `created_at` | `str` | Optional | - | 22 | | `updated_at` | `str` | Optional | - | 23 | | `cycle` | `int` | Optional | - | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "start_at": "2016-03-13T12:52:32.123Z", 30 | "end_at": "2016-03-13T12:52:32.123Z", 31 | "id": "id0", 32 | "billing_at": "2016-03-13T12:52:32.123Z", 33 | "subscription": { 34 | "id": "id4", 35 | "code": "code2", 36 | "start_at": "2016-03-13T12:52:32.123Z", 37 | "interval": "interval2", 38 | "interval_count": 234 39 | } 40 | } 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /doc/models/get-phone-number-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Phone Number Response 3 | 4 | Response object for getting an PhoneNumberResponse 5 | 6 | ## Structure 7 | 8 | `GetPhoneNumberResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `ddd` | `str` | Optional | - | 15 | | `number` | `str` | Optional | - | 16 | | `mtype` | `str` | Optional | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "ddd": "ddd2", 23 | "number": "number0", 24 | "type": "type8" 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/get-phone-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Phone Response 3 | 4 | ## Structure 5 | 6 | `GetPhoneResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `country_code` | `str` | Optional | - | 13 | | `number` | `str` | Optional | - | 14 | | `area_code` | `str` | Optional | - | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "country_code": "country_code6", 21 | "number": "number4", 22 | "area_code": "area_code6" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/get-phones-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Phones Response 3 | 4 | ## Structure 5 | 6 | `GetPhonesResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `home_phone` | [`GetPhoneResponse`](../../doc/models/get-phone-response.md) | Optional | - | 13 | | `mobile_phone` | [`GetPhoneResponse`](../../doc/models/get-phone-response.md) | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "home_phone": { 20 | "country_code": "country_code0", 21 | "number": "number2", 22 | "area_code": "area_code0" 23 | }, 24 | "mobile_phone": { 25 | "country_code": "country_code0", 26 | "number": "number8", 27 | "area_code": "area_code0" 28 | } 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /doc/models/get-pix-bank-account-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Pix Bank Account Response 3 | 4 | Payer's bank details. 5 | 6 | ## Structure 7 | 8 | `GetPixBankAccountResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `bank_name` | `str` | Optional | - | 15 | | `ispb` | `str` | Optional | - | 16 | | `branch_code` | `str` | Optional | - | 17 | | `account_number` | `str` | Optional | - | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "bank_name": "bank_name0", 24 | "ispb": "ispb8", 25 | "branch_code": "branch_code2", 26 | "account_number": "account_number4" 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/get-pix-payer-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Pix Payer Response 3 | 4 | Pix payer data. 5 | 6 | ## Structure 7 | 8 | `GetPixPayerResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `name` | `str` | Optional | - | 15 | | `document` | `str` | Optional | - | 16 | | `document_type` | `str` | Optional | - | 17 | | `bank_account` | [`GetPixBankAccountResponse`](../../doc/models/get-pix-bank-account-response.md) | Optional | - | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "name": "name0", 24 | "document": "document4", 25 | "document_type": "document_type8", 26 | "bank_account": { 27 | "bank_name": "bank_name0", 28 | "ispb": "ispb8", 29 | "branch_code": "branch_code2", 30 | "account_number": "account_number4" 31 | } 32 | } 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /doc/models/get-pix-transaction-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Pix Transaction Response 3 | 4 | Response object when getting a pix transaction 5 | 6 | ## Structure 7 | 8 | `GetPixTransactionResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `qr_code` | `str` | Optional | - | 19 | | `qr_code_url` | `str` | Optional | - | 20 | | `expires_at` | `datetime` | Optional | - | 21 | | `additional_information` | [`List[PixAdditionalInformation]`](../../doc/models/pix-additional-information.md) | Optional | - | 22 | | `end_to_end_id` | `str` | Optional | - | 23 | | `payer` | [`GetPixPayerResponse`](../../doc/models/get-pix-payer-response.md) | Optional | - | 24 | | `pix_provider_tid` | `str` | Optional | Pix provider TID | 25 | 26 | ## Example (as JSON) 27 | 28 | ```json 29 | { 30 | "gateway_id": "gateway_id8", 31 | "amount": 40, 32 | "status": "status6", 33 | "success": false, 34 | "created_at": "2016-03-13T12:52:32.123Z", 35 | "qr_code": "qr_code0", 36 | "qr_code_url": "qr_code_url6", 37 | "expires_at": "2016-03-13T12:52:32.123Z", 38 | "additional_information": [ 39 | { 40 | "Name": "Name0", 41 | "Value": "Value2" 42 | }, 43 | { 44 | "Name": "Name0", 45 | "Value": "Value2" 46 | } 47 | ], 48 | "end_to_end_id": "end_to_end_id6" 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/get-plan-item-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Plan Item Response 3 | 4 | Response object for getting a plan item 5 | 6 | ## Structure 7 | 8 | `GetPlanItemResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `name` | `str` | Optional | - | 16 | | `status` | `str` | Optional | - | 17 | | `created_at` | `datetime` | Optional | - | 18 | | `updated_at` | `datetime` | Optional | - | 19 | | `pricing_scheme` | [`GetPricingSchemeResponse`](../../doc/models/get-pricing-scheme-response.md) | Optional | - | 20 | | `description` | `str` | Optional | - | 21 | | `plan` | [`GetPlanResponse`](../../doc/models/get-plan-response.md) | Optional | - | 22 | | `quantity` | `int` | Optional | - | 23 | | `cycles` | `int` | Optional | - | 24 | | `deleted_at` | `datetime` | Optional | - | 25 | 26 | ## Example (as JSON) 27 | 28 | ```json 29 | { 30 | "id": "id8", 31 | "name": "name8", 32 | "status": "status0", 33 | "created_at": "2016-03-13T12:52:32.123Z", 34 | "updated_at": "2016-03-13T12:52:32.123Z" 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/get-plan-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Plan Response 3 | 4 | Response object for getting a plan 5 | 6 | ## Structure 7 | 8 | `GetPlanResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `name` | `str` | Optional | - | 16 | | `description` | `str` | Optional | - | 17 | | `url` | `str` | Optional | - | 18 | | `statement_descriptor` | `str` | Optional | - | 19 | | `interval` | `str` | Optional | - | 20 | | `interval_count` | `int` | Optional | - | 21 | | `billing_type` | `str` | Optional | - | 22 | | `payment_methods` | `List[str]` | Optional | - | 23 | | `installments` | `List[int]` | Optional | - | 24 | | `status` | `str` | Optional | - | 25 | | `currency` | `str` | Optional | - | 26 | | `created_at` | `datetime` | Optional | - | 27 | | `updated_at` | `datetime` | Optional | - | 28 | | `items` | [`List[GetPlanItemResponse]`](../../doc/models/get-plan-item-response.md) | Optional | - | 29 | | `billing_days` | `List[int]` | Optional | - | 30 | | `shippable` | `bool` | Optional | - | 31 | | `metadata` | `Dict[str, str]` | Optional | - | 32 | | `trial_period_days` | `int` | Optional | - | 33 | | `minimum_price` | `int` | Optional | - | 34 | | `deleted_at` | `datetime` | Optional | - | 35 | 36 | ## Example (as JSON) 37 | 38 | ```json 39 | { 40 | "id": "id0", 41 | "name": "name0", 42 | "description": "description0", 43 | "url": "url4", 44 | "statement_descriptor": "statement_descriptor0" 45 | } 46 | ``` 47 | 48 | -------------------------------------------------------------------------------- /doc/models/get-price-bracket-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Price Bracket Response 3 | 4 | Response object for getting a price bracket 5 | 6 | ## Structure 7 | 8 | `GetPriceBracketResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `start_quantity` | `int` | Optional | - | 15 | | `price` | `int` | Optional | - | 16 | | `end_quantity` | `int` | Optional | - | 17 | | `overage_price` | `int` | Optional | - | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "start_quantity": 186, 24 | "price": 124, 25 | "end_quantity": 194, 26 | "overage_price": 208 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/get-pricing-scheme-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Pricing Scheme Response 3 | 4 | Response object for getting a pricing scheme 5 | 6 | ## Structure 7 | 8 | `GetPricingSchemeResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `price` | `int` | Optional | - | 15 | | `scheme_type` | `str` | Optional | - | 16 | | `price_brackets` | [`List[GetPriceBracketResponse]`](../../doc/models/get-price-bracket-response.md) | Optional | - | 17 | | `minimum_price` | `int` | Optional | - | 18 | | `percentage` | `float` | Optional | percentual value used in pricing_scheme Percent | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "price": 182, 25 | "scheme_type": "scheme_type8", 26 | "price_brackets": [ 27 | { 28 | "start_quantity": 144, 29 | "price": 174, 30 | "end_quantity": 152, 31 | "overage_price": 166 32 | } 33 | ], 34 | "minimum_price": 170, 35 | "percentage": 166.36 36 | } 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /doc/models/get-private-label-transaction-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Private Label Transaction Response 3 | 4 | Response object for getting a private label transaction 5 | 6 | ## Structure 7 | 8 | `GetPrivateLabelTransactionResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `statement_descriptor` | `str` | Optional | Text that will appear on the credit card's statement | 19 | | `acquirer_name` | `str` | Optional | Acquirer name | 20 | | `acquirer_affiliation_code` | `str` | Optional | Aquirer affiliation code | 21 | | `acquirer_tid` | `str` | Optional | Acquirer TID | 22 | | `acquirer_nsu` | `str` | Optional | Acquirer NSU | 23 | | `acquirer_auth_code` | `str` | Optional | Acquirer authorization code | 24 | | `operation_type` | `str` | Optional | Operation type | 25 | | `card` | [`GetCardResponse`](../../doc/models/get-card-response.md) | Optional | Card data | 26 | | `acquirer_message` | `str` | Optional | Acquirer message | 27 | | `acquirer_return_code` | `str` | Optional | Acquirer Return Code | 28 | | `installments` | `int` | Optional | Number of installments | 29 | 30 | ## Example (as JSON) 31 | 32 | ```json 33 | { 34 | "gateway_id": "gateway_id8", 35 | "amount": 40, 36 | "status": "status6", 37 | "success": false, 38 | "created_at": "2016-03-13T12:52:32.123Z", 39 | "statement_descriptor": "statement_descriptor4", 40 | "acquirer_name": "acquirer_name8", 41 | "acquirer_affiliation_code": "acquirer_affiliation_code6", 42 | "acquirer_tid": "acquirer_tid6", 43 | "acquirer_nsu": "acquirer_nsu6" 44 | } 45 | ``` 46 | 47 | -------------------------------------------------------------------------------- /doc/models/get-register-information-address-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Register Information Address Response 3 | 4 | Response object for getting an RegisterInformationAddress 5 | 6 | ## Structure 7 | 8 | `GetRegisterInformationAddressResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `street` | `str` | Optional | - | 15 | | `complementary` | `str` | Optional | - | 16 | | `street_number` | `str` | Optional | - | 17 | | `neighborhood` | `str` | Optional | - | 18 | | `city` | `str` | Optional | - | 19 | | `state` | `str` | Optional | - | 20 | | `zip_code` | `str` | Optional | - | 21 | | `reference_point` | `str` | Optional | - | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "street": "street2", 28 | "complementary": "complementary4", 29 | "street_number": "street_number2", 30 | "neighborhood": "neighborhood8", 31 | "city": "city2" 32 | } 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /doc/models/get-retry-transaction-information-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Retry Transaction Information Response 3 | 4 | Response object for getting an RetryTransactionInformation 5 | 6 | ## Structure 7 | 8 | `GetRetryTransactionInformationResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `brand_failure_return_code` | `str` | Required | - | 15 | | `transaction_limit` | `int` | Required | - | 16 | | `transaction_date_limit` | `datetime` | Required | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "brand_failure_return_code": "brand_failure_return_code2", 23 | "transaction_limit": 44, 24 | "transaction_date_limit": "2016-03-13T12:52:32.123Z" 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/get-safety-pay-transaction-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Safety Pay Transaction Response 3 | 4 | Response object for getting a safety pay transaction 5 | 6 | ## Structure 7 | 8 | `GetSafetyPayTransactionResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `url` | `str` | Optional | Payment url | 19 | | `bank_tid` | `str` | Optional | Transaction identifier on bank | 20 | | `paid_at` | `datetime` | Optional | Payment date | 21 | | `paid_amount` | `int` | Optional | Paid amount | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "gateway_id": "gateway_id8", 28 | "amount": 40, 29 | "status": "status6", 30 | "success": false, 31 | "created_at": "2016-03-13T12:52:32.123Z", 32 | "url": "url8", 33 | "bank_tid": "bank_tid8", 34 | "paid_at": "2016-03-13T12:52:32.123Z", 35 | "paid_amount": 154 36 | } 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /doc/models/get-setup-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Setup Response 3 | 4 | Response object for getting the setup from a subscription 5 | 6 | ## Structure 7 | 8 | `GetSetupResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `description` | `str` | Optional | - | 16 | | `amount` | `int` | Optional | - | 17 | | `status` | `str` | Optional | - | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "id": "id6", 24 | "description": "description4", 25 | "amount": 152, 26 | "status": "status2" 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/get-shipping-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Shipping Response 3 | 4 | Response object for getting the shipping data 5 | 6 | ## Structure 7 | 8 | `GetShippingResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `amount` | `int` | Optional | - | 15 | | `description` | `str` | Optional | - | 16 | | `recipient_name` | `str` | Optional | - | 17 | | `recipient_phone` | `str` | Optional | - | 18 | | `address` | [`GetAddressResponse`](../../doc/models/get-address-response.md) | Optional | - | 19 | | `max_delivery_date` | `datetime` | Optional | Data máxima de entrega | 20 | | `estimated_delivery_date` | `datetime` | Optional | Prazo estimado de entrega | 21 | | `mtype` | `str` | Optional | Shipping Type | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "amount": 214, 28 | "description": "description8", 29 | "recipient_name": "recipient_name6", 30 | "recipient_phone": "recipient_phone0", 31 | "address": { 32 | "id": "id6", 33 | "street": "street6", 34 | "number": "number4", 35 | "complement": "complement2", 36 | "zip_code": "zip_code0" 37 | } 38 | } 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /doc/models/get-split-options-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Split Options Response 3 | 4 | ## Structure 5 | 6 | `GetSplitOptionsResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `liable` | `bool` | Optional | - | 13 | | `charge_processing_fee` | `bool` | Optional | - | 14 | | `charge_remainder_fee` | `str` | Optional | - | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "liable": false, 21 | "charge_processing_fee": false, 22 | "charge_remainder_fee": "charge_remainder_fee6" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/get-split-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Split Response 3 | 4 | Split response 5 | 6 | ## Structure 7 | 8 | `GetSplitResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `mtype` | `str` | Optional | Type | 15 | | `amount` | `int` | Optional | Amount | 16 | | `recipient` | [`GetRecipientResponse`](../../doc/models/get-recipient-response.md) | Optional | Recipient | 17 | | `gateway_id` | `str` | Optional | The split rule gateway id | 18 | | `options` | [`GetSplitOptionsResponse`](../../doc/models/get-split-options-response.md) | Optional | - | 19 | | `id` | `str` | Optional | - | 20 | 21 | ## Example (as JSON) 22 | 23 | ```json 24 | { 25 | "type": "type0", 26 | "amount": 252, 27 | "recipient": { 28 | "id": "id8", 29 | "name": "name8", 30 | "email": "email8", 31 | "document": "document8", 32 | "description": "description2" 33 | }, 34 | "gateway_id": "gateway_id0", 35 | "options": { 36 | "liable": false, 37 | "charge_processing_fee": false, 38 | "charge_remainder_fee": "charge_remainder_fee0" 39 | } 40 | } 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /doc/models/get-subscription-boleto-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Subscription Boleto Response 3 | 4 | Response object for getting a boleto 5 | 6 | ## Structure 7 | 8 | `GetSubscriptionBoletoResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `interest` | [`GetInterestResponse`](../../doc/models/get-interest-response.md) | Optional | Interest | 15 | | `fine` | [`GetFineResponse`](../../doc/models/get-fine-response.md) | Optional | Fine | 16 | | `max_days_to_pay_past_due` | `int` | Optional | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "interest": { 23 | "days": 2, 24 | "type": "percentage", 25 | "amount": 20 26 | }, 27 | "fine": { 28 | "days": 2, 29 | "type": "flat", 30 | "amount": 10 31 | }, 32 | "max_days_to_pay_past_due": 2 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/get-subscription-item-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Subscription Item Response 3 | 4 | ## Structure 5 | 6 | `GetSubscriptionItemResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `id` | `str` | Optional | - | 13 | | `description` | `str` | Optional | - | 14 | | `status` | `str` | Optional | - | 15 | | `created_at` | `datetime` | Optional | - | 16 | | `updated_at` | `datetime` | Optional | - | 17 | | `pricing_scheme` | [`GetPricingSchemeResponse`](../../doc/models/get-pricing-scheme-response.md) | Optional | - | 18 | | `discounts` | [`List[GetDiscountResponse]`](../../doc/models/get-discount-response.md) | Optional | - | 19 | | `increments` | [`List[GetIncrementResponse]`](../../doc/models/get-increment-response.md) | Optional | - | 20 | | `subscription` | [`GetSubscriptionResponse`](../../doc/models/get-subscription-response.md) | Optional | - | 21 | | `name` | `str` | Optional | Item name | 22 | | `quantity` | `int` | Optional | - | 23 | | `cycles` | `int` | Optional | - | 24 | | `deleted_at` | `datetime` | Optional | - | 25 | 26 | ## Example (as JSON) 27 | 28 | ```json 29 | { 30 | "id": "id2", 31 | "description": "description8", 32 | "status": "status6", 33 | "created_at": "2016-03-13T12:52:32.123Z", 34 | "updated_at": "2016-03-13T12:52:32.123Z" 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/get-three-d-secure-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Three D Secure Response 3 | 4 | 3D-S payment authentication response 5 | 6 | ## Structure 7 | 8 | `GetThreeDSecureResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `mpi` | `str` | Optional | MPI Vendor | 15 | | `eci` | `str` | Optional | Electronic Commerce Indicator (ECI) (Opcional) | 16 | | `cavv` | `str` | Optional | Online payment cryptogram, definido pelo 3-D Secure. | 17 | | `transaction_id` | `str` | Optional | Identificador da transação (XID) | 18 | | `success_url` | `str` | Optional | Url de redirecionamento de sucessso | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "mpi": "mpi2", 25 | "eci": "eci4", 26 | "cavv": "cavv0", 27 | "transaction_Id": "transaction_Id0", 28 | "success_url": "success_url6" 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /doc/models/get-token-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Token Response 3 | 4 | Token data 5 | 6 | ## Structure 7 | 8 | `GetTokenResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | - | 15 | | `mtype` | `str` | Optional | - | 16 | | `created_at` | `datetime` | Optional | - | 17 | | `expires_at` | `str` | Optional | - | 18 | | `card` | [`GetCardTokenResponse`](../../doc/models/get-card-token-response.md) | Optional | - | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "id": "id8", 25 | "type": "type2", 26 | "created_at": "2016-03-13T12:52:32.123Z", 27 | "expires_at": "expires_at2", 28 | "card": { 29 | "last_four_digits": "last_four_digits2", 30 | "holder_name": "holder_name2", 31 | "holder_document": "holder_document0", 32 | "exp_month": 228, 33 | "exp_year": 68 34 | } 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/get-transaction-report-file-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Transaction Report File Response 3 | 4 | ## Structure 5 | 6 | `GetTransactionReportFileResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `name` | `str` | Optional | - | 13 | | `date` | `datetime` | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "name": "name8", 20 | "date": "2016-03-13T12:52:32.123Z" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-transfer-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Transfer Response 3 | 4 | Transfer response 5 | 6 | ## Structure 7 | 8 | `GetTransferResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | Id | 15 | | `amount` | `int` | Optional | Transfer amount | 16 | | `status` | `str` | Optional | Transfer status | 17 | | `created_at` | `datetime` | Optional | Transfer creation date | 18 | | `updated_at` | `datetime` | Optional | Transfer last update date | 19 | | `bank_account` | [`GetBankAccountResponse`](../../doc/models/get-bank-account-response.md) | Optional | Bank account | 20 | | `metadata` | `Dict[str, str]` | Optional | Metadata | 21 | 22 | ## Example (as JSON) 23 | 24 | ```json 25 | { 26 | "id": "id2", 27 | "amount": 146, 28 | "status": "status4", 29 | "created_at": "2016-03-13T12:52:32.123Z", 30 | "updated_at": "2016-03-13T12:52:32.123Z" 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /doc/models/get-transfer-settings-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Transfer Settings Response 3 | 4 | ## Structure 5 | 6 | `GetTransferSettingsResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `transfer_enabled` | `bool` | Optional | - | 13 | | `transfer_interval` | `str` | Optional | - | 14 | | `transfer_day` | `int` | Optional | - | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "transfer_enabled": false, 21 | "transfer_interval": "transfer_interval0", 22 | "transfer_day": 52 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/get-transfer-source-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Transfer Source Response 3 | 4 | ## Structure 5 | 6 | `GetTransferSourceResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `source_id` | `str` | Optional | - | 13 | | `mtype` | `str` | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "source_id": "source_id0", 20 | "type": "type4" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-transfer-target-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Transfer Target Response 3 | 4 | ## Structure 5 | 6 | `GetTransferTargetResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `target_id` | `str` | Optional | - | 13 | | `mtype` | `str` | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "target_id": "target_id0", 20 | "type": "type0" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-transfer.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Transfer 3 | 4 | ## Structure 5 | 6 | `GetTransfer` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `id` | `str` | Required | - | 13 | | `gateway_id` | `str` | Required | - | 14 | | `amount` | `int` | Required | - | 15 | | `status` | `str` | Required | - | 16 | | `created_at` | `datetime` | Required | - | 17 | | `updated_at` | `datetime` | Required | - | 18 | | `metadata` | `Dict[str, str]` | Optional | - | 19 | | `fee` | `int` | Optional | - | 20 | | `funding_date` | `datetime` | Optional | - | 21 | | `funding_estimated_date` | `datetime` | Optional | - | 22 | | `mtype` | `str` | Required | - | 23 | | `source` | [`GetTransferSourceResponse`](../../doc/models/get-transfer-source-response.md) | Required | - | 24 | | `target` | [`GetTransferTargetResponse`](../../doc/models/get-transfer-target-response.md) | Required | - | 25 | 26 | ## Example (as JSON) 27 | 28 | ```json 29 | { 30 | "id": "id8", 31 | "gateway_id": "gateway_id8", 32 | "amount": 122, 33 | "status": "status0", 34 | "created_at": "2016-03-13T12:52:32.123Z", 35 | "updated_at": "2016-03-13T12:52:32.123Z", 36 | "metadata": { 37 | "key0": "metadata5" 38 | }, 39 | "fee": 80, 40 | "funding_date": "2016-03-13T12:52:32.123Z", 41 | "funding_estimated_date": "2016-03-13T12:52:32.123Z", 42 | "type": "type8", 43 | "source": { 44 | "source_id": "source_id8", 45 | "type": "type6" 46 | }, 47 | "target": { 48 | "target_id": "target_id2", 49 | "type": "type8" 50 | } 51 | } 52 | ``` 53 | 54 | -------------------------------------------------------------------------------- /doc/models/get-usage-report-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Usage Report Response 3 | 4 | ## Structure 5 | 6 | `GetUsageReportResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `url` | `str` | Optional | - | 13 | | `usage_report_url` | `str` | Optional | - | 14 | | `grouped_report_url` | `str` | Optional | - | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "url": "url2", 21 | "usage_report_url": "usage_report_url0", 22 | "grouped_report_url": "grouped_report_url0" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/get-usage-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Usage Response 3 | 4 | Response object for getting a usage 5 | 6 | ## Structure 7 | 8 | `GetUsageResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `id` | `str` | Optional | Id | 15 | | `quantity` | `int` | Optional | Quantity | 16 | | `description` | `str` | Optional | Description | 17 | | `used_at` | `datetime` | Optional | Used at | 18 | | `created_at` | `datetime` | Optional | Creation date | 19 | | `status` | `str` | Optional | Status | 20 | | `deleted_at` | `datetime` | Optional | - | 21 | | `subscription_item` | [`GetSubscriptionItemResponse`](../../doc/models/get-subscription-item-response.md) | Optional | Subscription item | 22 | | `code` | `str` | Optional | Identification code in the client system | 23 | | `group` | `str` | Optional | Identification group in the client system | 24 | | `amount` | `int` | Optional | Field used in item scheme type 'Percent' | 25 | 26 | ## Example (as JSON) 27 | 28 | ```json 29 | { 30 | "id": "id2", 31 | "quantity": 34, 32 | "description": "description2", 33 | "used_at": "2016-03-13T12:52:32.123Z", 34 | "created_at": "2016-03-13T12:52:32.123Z" 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/get-voucher-transaction-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Voucher Transaction Response 3 | 4 | Response for voucher transactions 5 | 6 | ## Structure 7 | 8 | `GetVoucherTransactionResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | 17 | | --- | --- | --- | --- | 18 | | `statement_descriptor` | `str` | Optional | Text that will appear on the voucher's statement | 19 | | `acquirer_name` | `str` | Optional | Acquirer name | 20 | | `acquirer_affiliation_code` | `str` | Optional | Acquirer affiliation code | 21 | | `acquirer_tid` | `str` | Optional | Acquirer TID | 22 | | `acquirer_nsu` | `str` | Optional | Acquirer NSU | 23 | | `acquirer_auth_code` | `str` | Optional | Acquirer authorization code | 24 | | `acquirer_message` | `str` | Optional | acquirer_message | 25 | | `acquirer_return_code` | `str` | Optional | Acquirer return code | 26 | | `operation_type` | `str` | Optional | Operation type | 27 | | `card` | [`GetCardResponse`](../../doc/models/get-card-response.md) | Optional | Card data | 28 | 29 | ## Example (as JSON) 30 | 31 | ```json 32 | { 33 | "gateway_id": "gateway_id8", 34 | "amount": 40, 35 | "status": "status6", 36 | "success": false, 37 | "created_at": "2016-03-13T12:52:32.123Z", 38 | "statement_descriptor": "statement_descriptor6", 39 | "acquirer_name": "acquirer_name0", 40 | "acquirer_affiliation_code": "acquirer_affiliation_code2", 41 | "acquirer_tid": "acquirer_tid4", 42 | "acquirer_nsu": "acquirer_nsu4" 43 | } 44 | ``` 45 | 46 | -------------------------------------------------------------------------------- /doc/models/get-withdraw-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Withdraw Response 3 | 4 | ## Structure 5 | 6 | `GetWithdrawResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `id` | `str` | Optional | - | 13 | | `gateway_id` | `str` | Optional | - | 14 | | `amount` | `int` | Optional | - | 15 | | `status` | `str` | Optional | - | 16 | | `created_at` | `datetime` | Optional | - | 17 | | `updated_at` | `datetime` | Optional | - | 18 | | `metadata` | `List[str]` | Optional | - | 19 | | `fee` | `int` | Optional | - | 20 | | `funding_date` | `datetime` | Optional | - | 21 | | `funding_estimated_date` | `datetime` | Optional | - | 22 | | `mtype` | `str` | Optional | - | 23 | | `source` | [`GetWithdrawSourceResponse`](../../doc/models/get-withdraw-source-response.md) | Optional | - | 24 | | `target` | [`GetWithdrawTargetResponse`](../../doc/models/get-withdraw-target-response.md) | Optional | - | 25 | 26 | ## Example (as JSON) 27 | 28 | ```json 29 | { 30 | "id": "id6", 31 | "gateway_id": "gateway_id4", 32 | "amount": 78, 33 | "status": "status8", 34 | "created_at": "2016-03-13T12:52:32.123Z" 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/get-withdraw-source-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Withdraw Source Response 3 | 4 | ## Structure 5 | 6 | `GetWithdrawSourceResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `source_id` | `str` | Optional | - | 13 | | `mtype` | `str` | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "source_id": "source_id2", 20 | "type": "type8" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-withdraw-target-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Withdraw Target Response 3 | 4 | ## Structure 5 | 6 | `GetWithdrawTargetResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `target_id` | `str` | Optional | - | 13 | | `mtype` | `str` | Optional | - | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "target_id": "target_id4", 20 | "type": "type6" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/list-access-tokens-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Access Tokens Response 3 | 4 | Response object for listing access tokens 5 | 6 | ## Structure 7 | 8 | `ListAccessTokensResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetAccessTokenResponse]`](../../doc/models/get-access-token-response.md) | Optional | The access token objects | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "code": "code8", 25 | "status": "status2", 26 | "created_at": "2016-03-13T12:52:32.123Z", 27 | "customer": { 28 | "id": "id0", 29 | "name": "name0", 30 | "email": "email6", 31 | "delinquent": false, 32 | "created_at": "2016-03-13T12:52:32.123Z" 33 | } 34 | } 35 | ], 36 | "paging": { 37 | "total": 6, 38 | "previous": "previous2", 39 | "next": "next8" 40 | } 41 | } 42 | ``` 43 | 44 | -------------------------------------------------------------------------------- /doc/models/list-addresses-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Addresses Response 3 | 4 | Response object for listing addresses 5 | 6 | ## Structure 7 | 8 | `ListAddressesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetAddressResponse]`](../../doc/models/get-address-response.md) | Optional | The address objects | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "street": "street0", 25 | "number": "number8", 26 | "complement": "complement6", 27 | "zip_code": "zip_code4" 28 | }, 29 | { 30 | "id": "id0", 31 | "street": "street0", 32 | "number": "number8", 33 | "complement": "complement6", 34 | "zip_code": "zip_code4" 35 | }, 36 | { 37 | "id": "id0", 38 | "street": "street0", 39 | "number": "number8", 40 | "complement": "complement6", 41 | "zip_code": "zip_code4" 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-anticipation-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Anticipation Response 3 | 4 | Anticipations 5 | 6 | ## Structure 7 | 8 | `ListAnticipationResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetAnticipationResponse]`](../../doc/models/get-anticipation-response.md) | Optional | Anticipations | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "requested_amount": 16, 25 | "approved_amount": 70, 26 | "recipient": { 27 | "id": "id8", 28 | "name": "name8", 29 | "email": "email8", 30 | "document": "document8", 31 | "description": "description2" 32 | }, 33 | "pgid": "pgid6" 34 | } 35 | ], 36 | "paging": { 37 | "total": 6, 38 | "previous": "previous2", 39 | "next": "next8" 40 | } 41 | } 42 | ``` 43 | 44 | -------------------------------------------------------------------------------- /doc/models/list-balance-operation-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Balance Operation Response 3 | 4 | Response object for listing BalanceOperation objects 5 | 6 | ## Structure 7 | 8 | `ListBalanceOperationResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetBalanceOperationResponse]`](../../doc/models/get-balance-operation-response.md) | Optional | The BalanceOperation object | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | - | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "status": "status2", 25 | "balance_amount": "balance_amount0", 26 | "balance_old_amount": "balance_old_amount8", 27 | "type": "type0" 28 | }, 29 | { 30 | "id": "id0", 31 | "status": "status2", 32 | "balance_amount": "balance_amount0", 33 | "balance_old_amount": "balance_old_amount8", 34 | "type": "type0" 35 | }, 36 | { 37 | "id": "id0", 38 | "status": "status2", 39 | "balance_amount": "balance_amount0", 40 | "balance_old_amount": "balance_old_amount8", 41 | "type": "type0" 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-cards-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Cards Response 3 | 4 | Response object for listing cards 5 | 6 | ## Structure 7 | 8 | `ListCardsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetCardResponse]`](../../doc/models/get-card-response.md) | Optional | The card objects | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "last_four_digits": "last_four_digits6", 25 | "brand": "brand4", 26 | "holder_name": "holder_name6", 27 | "exp_month": 240 28 | }, 29 | { 30 | "id": "id0", 31 | "last_four_digits": "last_four_digits6", 32 | "brand": "brand4", 33 | "holder_name": "holder_name6", 34 | "exp_month": 240 35 | }, 36 | { 37 | "id": "id0", 38 | "last_four_digits": "last_four_digits6", 39 | "brand": "brand4", 40 | "holder_name": "holder_name6", 41 | "exp_month": 240 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-charges-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Charges Response 3 | 4 | Response object for listing charges 5 | 6 | ## Structure 7 | 8 | `ListChargesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetChargeResponse]`](../../doc/models/get-charge-response.md) | Optional | The charge objects | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "code": "code8", 25 | "gateway_id": "gateway_id0", 26 | "amount": 236, 27 | "status": "status2" 28 | }, 29 | { 30 | "id": "id0", 31 | "code": "code8", 32 | "gateway_id": "gateway_id0", 33 | "amount": 236, 34 | "status": "status2" 35 | }, 36 | { 37 | "id": "id0", 38 | "code": "code8", 39 | "gateway_id": "gateway_id0", 40 | "amount": 236, 41 | "status": "status2" 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-customers-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Customers Response 3 | 4 | Response for listing the customers 5 | 6 | ## Structure 7 | 8 | `ListCustomersResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetCustomerResponse]`](../../doc/models/get-customer-response.md) | Optional | The customer object | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "name": "name0", 25 | "email": "email6", 26 | "delinquent": false, 27 | "created_at": "2016-03-13T12:52:32.123Z" 28 | }, 29 | { 30 | "id": "id0", 31 | "name": "name0", 32 | "email": "email6", 33 | "delinquent": false, 34 | "created_at": "2016-03-13T12:52:32.123Z" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-cycles-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Cycles Response 3 | 4 | Response object for listing subscription cycles 5 | 6 | ## Structure 7 | 8 | `ListCyclesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetPeriodResponse]`](../../doc/models/get-period-response.md) | Optional | The subscription cycles objects | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "start_at": "2016-03-13T12:52:32.123Z", 24 | "end_at": "2016-03-13T12:52:32.123Z", 25 | "id": "id0", 26 | "billing_at": "2016-03-13T12:52:32.123Z", 27 | "subscription": { 28 | "id": "id4", 29 | "code": "code2", 30 | "start_at": "2016-03-13T12:52:32.123Z", 31 | "interval": "interval2", 32 | "interval_count": 234 33 | } 34 | }, 35 | { 36 | "start_at": "2016-03-13T12:52:32.123Z", 37 | "end_at": "2016-03-13T12:52:32.123Z", 38 | "id": "id0", 39 | "billing_at": "2016-03-13T12:52:32.123Z", 40 | "subscription": { 41 | "id": "id4", 42 | "code": "code2", 43 | "start_at": "2016-03-13T12:52:32.123Z", 44 | "interval": "interval2", 45 | "interval_count": 234 46 | } 47 | } 48 | ], 49 | "paging": { 50 | "total": 6, 51 | "previous": "previous2", 52 | "next": "next8" 53 | } 54 | } 55 | ``` 56 | 57 | -------------------------------------------------------------------------------- /doc/models/list-discounts-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Discounts Response 3 | 4 | ## Structure 5 | 6 | `ListDiscountsResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `data` | [`List[GetDiscountResponse]`](../../doc/models/get-discount-response.md) | Optional | The Discounts response | 13 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "data": [ 20 | { 21 | "id": "id0", 22 | "value": 95.62, 23 | "discount_type": "discount_type8", 24 | "status": "status2", 25 | "created_at": "2016-03-13T12:52:32.123Z" 26 | }, 27 | { 28 | "id": "id0", 29 | "value": 95.62, 30 | "discount_type": "discount_type8", 31 | "status": "status2", 32 | "created_at": "2016-03-13T12:52:32.123Z" 33 | } 34 | ], 35 | "paging": { 36 | "total": 6, 37 | "previous": "previous2", 38 | "next": "next8" 39 | } 40 | } 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /doc/models/list-increments-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Increments Response 3 | 4 | ## Structure 5 | 6 | `ListIncrementsResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `data` | [`List[GetIncrementResponse]`](../../doc/models/get-increment-response.md) | Optional | The Increments response | 13 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "data": [ 20 | { 21 | "id": "id0", 22 | "value": 95.62, 23 | "increment_type": "increment_type2", 24 | "status": "status2", 25 | "created_at": "2016-03-13T12:52:32.123Z" 26 | } 27 | ], 28 | "paging": { 29 | "total": 6, 30 | "previous": "previous2", 31 | "next": "next8" 32 | } 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/list-invoices-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Invoices Response 3 | 4 | Response object for listing invoices 5 | 6 | ## Structure 7 | 8 | `ListInvoicesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetInvoiceResponse]`](../../doc/models/get-invoice-response.md) | Optional | The Invoice objects | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "code": "code8", 25 | "url": "url4", 26 | "amount": 236, 27 | "status": "status2" 28 | }, 29 | { 30 | "id": "id0", 31 | "code": "code8", 32 | "url": "url4", 33 | "amount": 236, 34 | "status": "status2" 35 | }, 36 | { 37 | "id": "id0", 38 | "code": "code8", 39 | "url": "url4", 40 | "amount": 236, 41 | "status": "status2" 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-order-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Order Response 3 | 4 | Response object for listing order objects 5 | 6 | ## Structure 7 | 8 | `ListOrderResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetOrderResponse]`](../../doc/models/get-order-response.md) | Optional | The order object | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "code": "code8", 25 | "amount": 236, 26 | "currency": "currency0", 27 | "closed": false 28 | }, 29 | { 30 | "id": "id0", 31 | "code": "code8", 32 | "amount": 236, 33 | "currency": "currency0", 34 | "closed": false 35 | }, 36 | { 37 | "id": "id0", 38 | "code": "code8", 39 | "amount": 236, 40 | "currency": "currency0", 41 | "closed": false 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-payables-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Payables Response 3 | 4 | Response object for listing payable objects 5 | 6 | ## Structure 7 | 8 | `ListPayablesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetPayableResponse]`](../../doc/models/get-payable-response.md) | Optional | The payable object | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": 138, 24 | "status": "status2", 25 | "amount": 236, 26 | "fee": 194, 27 | "anticipation_fee": 142 28 | } 29 | ], 30 | "paging": { 31 | "total": 6, 32 | "previous": "previous2", 33 | "next": "next8" 34 | } 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/list-plans-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Plans Response 3 | 4 | Response object for listing plans 5 | 6 | ## Structure 7 | 8 | `ListPlansResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetPlanResponse]`](../../doc/models/get-plan-response.md) | Optional | The plan objects | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "name": "name0", 25 | "description": "description0", 26 | "url": "url4", 27 | "statement_descriptor": "statement_descriptor0" 28 | }, 29 | { 30 | "id": "id0", 31 | "name": "name0", 32 | "description": "description0", 33 | "url": "url4", 34 | "statement_descriptor": "statement_descriptor0" 35 | }, 36 | { 37 | "id": "id0", 38 | "name": "name0", 39 | "description": "description0", 40 | "url": "url4", 41 | "statement_descriptor": "statement_descriptor0" 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-recipient-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Recipient Response 3 | 4 | Response for the listing recipient method 5 | 6 | ## Structure 7 | 8 | `ListRecipientResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetRecipientResponse]`](../../doc/models/get-recipient-response.md) | Optional | Recipients | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "name": "name0", 25 | "email": "email6", 26 | "document": "document4", 27 | "description": "description0" 28 | }, 29 | { 30 | "id": "id0", 31 | "name": "name0", 32 | "email": "email6", 33 | "document": "document4", 34 | "description": "description0" 35 | }, 36 | { 37 | "id": "id0", 38 | "name": "name0", 39 | "email": "email6", 40 | "document": "document4", 41 | "description": "description0" 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-subscription-items-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Subscription Items Response 3 | 4 | Response model for listing subscription items 5 | 6 | ## Structure 7 | 8 | `ListSubscriptionItemsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetSubscriptionItemResponse]`](../../doc/models/get-subscription-item-response.md) | Optional | The subscription items | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "description": "description0", 25 | "status": "status2", 26 | "created_at": "2016-03-13T12:52:32.123Z", 27 | "updated_at": "2016-03-13T12:52:32.123Z" 28 | }, 29 | { 30 | "id": "id0", 31 | "description": "description0", 32 | "status": "status2", 33 | "created_at": "2016-03-13T12:52:32.123Z", 34 | "updated_at": "2016-03-13T12:52:32.123Z" 35 | }, 36 | { 37 | "id": "id0", 38 | "description": "description0", 39 | "status": "status2", 40 | "created_at": "2016-03-13T12:52:32.123Z", 41 | "updated_at": "2016-03-13T12:52:32.123Z" 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-subscriptions-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Subscriptions Response 3 | 4 | Response object for listing subscriptions 5 | 6 | ## Structure 7 | 8 | `ListSubscriptionsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetSubscriptionResponse]`](../../doc/models/get-subscription-response.md) | Optional | The subscription objects | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "code": "code8", 25 | "start_at": "2016-03-13T12:52:32.123Z", 26 | "interval": "interval8", 27 | "interval_count": 108 28 | }, 29 | { 30 | "id": "id0", 31 | "code": "code8", 32 | "start_at": "2016-03-13T12:52:32.123Z", 33 | "interval": "interval8", 34 | "interval_count": 108 35 | }, 36 | { 37 | "id": "id0", 38 | "code": "code8", 39 | "start_at": "2016-03-13T12:52:32.123Z", 40 | "interval": "interval8", 41 | "interval_count": 108 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-transactions-files-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Transactions Files Response 3 | 4 | Response object for listing of transactions files 5 | 6 | ## Structure 7 | 8 | `ListTransactionsFilesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetTransactionReportFileResponse]`](../../doc/models/get-transaction-report-file-response.md) | Optional | - | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "name": "name0", 24 | "date": "2016-03-13T12:52:32.123Z" 25 | }, 26 | { 27 | "name": "name0", 28 | "date": "2016-03-13T12:52:32.123Z" 29 | }, 30 | { 31 | "name": "name0", 32 | "date": "2016-03-13T12:52:32.123Z" 33 | } 34 | ], 35 | "paging": { 36 | "total": 6, 37 | "previous": "previous2", 38 | "next": "next8" 39 | } 40 | } 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /doc/models/list-transfer-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Transfer Response 3 | 4 | List of paginated transfer objects 5 | 6 | ## Structure 7 | 8 | `ListTransferResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetTransferResponse]`](../../doc/models/get-transfer-response.md) | Optional | Transfers | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "amount": 236, 25 | "status": "status2", 26 | "created_at": "2016-03-13T12:52:32.123Z", 27 | "updated_at": "2016-03-13T12:52:32.123Z" 28 | }, 29 | { 30 | "id": "id0", 31 | "amount": 236, 32 | "status": "status2", 33 | "created_at": "2016-03-13T12:52:32.123Z", 34 | "updated_at": "2016-03-13T12:52:32.123Z" 35 | }, 36 | { 37 | "id": "id0", 38 | "amount": 236, 39 | "status": "status2", 40 | "created_at": "2016-03-13T12:52:32.123Z", 41 | "updated_at": "2016-03-13T12:52:32.123Z" 42 | } 43 | ], 44 | "paging": { 45 | "total": 6, 46 | "previous": "previous2", 47 | "next": "next8" 48 | } 49 | } 50 | ``` 51 | 52 | -------------------------------------------------------------------------------- /doc/models/list-transfers.md: -------------------------------------------------------------------------------- 1 | 2 | # List Transfers 3 | 4 | ## Structure 5 | 6 | `ListTransfers` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `data` | [`List[GetTransfer]`](../../doc/models/get-transfer.md) | Required | The Increments response | 13 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Required | Paging object | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "data": [ 20 | { 21 | "id": "id0", 22 | "gateway_id": "gateway_id0", 23 | "amount": 236, 24 | "status": "status2", 25 | "created_at": "2016-03-13T12:52:32.123Z", 26 | "updated_at": "2016-03-13T12:52:32.123Z", 27 | "metadata": { 28 | "key0": "metadata7", 29 | "key1": "metadata6" 30 | }, 31 | "fee": 194, 32 | "funding_date": "2016-03-13T12:52:32.123Z", 33 | "funding_estimated_date": "2016-03-13T12:52:32.123Z", 34 | "type": "type0", 35 | "source": { 36 | "source_id": "source_id8", 37 | "type": "type6" 38 | }, 39 | "target": { 40 | "target_id": "target_id2", 41 | "type": "type8" 42 | } 43 | } 44 | ], 45 | "paging": { 46 | "total": 6, 47 | "previous": "previous2", 48 | "next": "next8" 49 | } 50 | } 51 | ``` 52 | 53 | -------------------------------------------------------------------------------- /doc/models/list-usages-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Usages Response 3 | 4 | Response model for listing the usages from a subscription item 5 | 6 | ## Structure 7 | 8 | `ListUsagesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `data` | [`List[GetUsageResponse]`](../../doc/models/get-usage-response.md) | Optional | The usage objects | 15 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id0", 24 | "quantity": 94, 25 | "description": "description0", 26 | "used_at": "2016-03-13T12:52:32.123Z", 27 | "created_at": "2016-03-13T12:52:32.123Z" 28 | } 29 | ], 30 | "paging": { 31 | "total": 6, 32 | "previous": "previous2", 33 | "next": "next8" 34 | } 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /doc/models/list-withdrawals.md: -------------------------------------------------------------------------------- 1 | 2 | # List Withdrawals 3 | 4 | ## Structure 5 | 6 | `ListWithdrawals` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `data` | [`List[GetWithdrawResponse]`](../../doc/models/get-withdraw-response.md) | Required | The Increments response | 13 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Required | Paging object | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "data": [ 20 | { 21 | "id": "id0", 22 | "gateway_id": "gateway_id0", 23 | "amount": 236, 24 | "status": "status2", 25 | "created_at": "2016-03-13T12:52:32.123Z" 26 | } 27 | ], 28 | "paging": { 29 | "total": 6, 30 | "previous": "previous2", 31 | "next": "next8" 32 | } 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/paging-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Paging Response 3 | 4 | Object used for returning lists of objects with pagination 5 | 6 | ## Structure 7 | 8 | `PagingResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `total` | `int` | Optional | Total number of pages | 15 | | `previous` | `str` | Optional | Previous page | 16 | | `next` | `str` | Optional | Next page | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "total": 80, 23 | "previous": "previous2", 24 | "next": "next2" 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/pix-additional-information.md: -------------------------------------------------------------------------------- 1 | 2 | # Pix Additional Information 3 | 4 | Pix Additional Information 5 | 6 | ## Structure 7 | 8 | `PixAdditionalInformation` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `name` | `str` | Optional | - | 15 | | `value` | `str` | Optional | - | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "Name": "Name6", 22 | "Value": "Value6" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/update-address-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Address Request 3 | 4 | Request for updating an address 5 | 6 | ## Structure 7 | 8 | `UpdateAddressRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `number` | `str` | Required | Number | 15 | | `complement` | `str` | Required | Complement | 16 | | `metadata` | `Dict[str, str]` | Required | Metadata | 17 | | `line_2` | `str` | Required | Line 2 for address | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "number": "number6", 24 | "complement": "complement8", 25 | "metadata": { 26 | "key0": "metadata7", 27 | "key1": "metadata8" 28 | }, 29 | "line_2": "line_24" 30 | } 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /doc/models/update-automatic-anticipation-settings-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Automatic Anticipation Settings Request 3 | 4 | ## Structure 5 | 6 | `UpdateAutomaticAnticipationSettingsRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `enabled` | `bool` | Optional | - | 13 | | `mtype` | `str` | Optional | - | 14 | | `volume_percentage` | `int` | Optional | - | 15 | | `delay` | `int` | Optional | - | 16 | | `days` | `int` | Optional | - | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "enabled": false, 23 | "type": "type8", 24 | "volume_percentage": 132, 25 | "delay": 158, 26 | "days": 66 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/update-card-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Card Request 3 | 4 | Request for updating a card 5 | 6 | ## Structure 7 | 8 | `UpdateCardRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `holder_name` | `str` | Required | Holder name | 15 | | `exp_month` | `int` | Required | Expiration month | 16 | | `exp_year` | `int` | Required | Expiration year | 17 | | `billing_address_id` | `str` | Optional | Id of the address to be used as billing address | 18 | | `billing_address` | [`CreateAddressRequest`](../../doc/models/create-address-request.md) | Required | Billing address | 19 | | `metadata` | `Dict[str, str]` | Required | Metadata | 20 | | `label` | `str` | Required | - | 21 | 22 | ## Example (as JSON) 23 | 24 | ```json 25 | { 26 | "holder_name": "holder_name6", 27 | "exp_month": 236, 28 | "exp_year": 60, 29 | "billing_address_id": "billing_address_id6", 30 | "billing_address": { 31 | "street": "street8", 32 | "number": "number4", 33 | "zip_code": "zip_code2", 34 | "neighborhood": "neighborhood4", 35 | "city": "city2", 36 | "state": "state6", 37 | "country": "country2", 38 | "complement": "complement6", 39 | "metadata": { 40 | "key0": "metadata5", 41 | "key1": "metadata6" 42 | }, 43 | "line_1": "line_18", 44 | "line_2": "line_26" 45 | }, 46 | "metadata": { 47 | "key0": "metadata3", 48 | "key1": "metadata4", 49 | "key2": "metadata5" 50 | }, 51 | "label": "label0" 52 | } 53 | ``` 54 | 55 | -------------------------------------------------------------------------------- /doc/models/update-charge-card-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Charge Card Request 3 | 4 | Request for updating card data 5 | 6 | ## Structure 7 | 8 | `UpdateChargeCardRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `update_subscription` | `bool` | Required | Indicates if the subscriptions using this card must also be updated | 15 | | `card_id` | `str` | Required | Card id | 16 | | `card` | [`CreateCardRequest`](../../doc/models/create-card-request.md) | Required | Card data | 17 | | `recurrence` | `bool` | Required | Indicates a recurrence | 18 | | `initiated_type` | `str` | Optional | - | 19 | | `recurrence_model` | `str` | Optional | - | 20 | | `payment_origin` | [`CreatePaymentOriginRequest`](../../doc/models/create-payment-origin-request.md) | Optional | - | 21 | | `indirect_acceptor` | `str` | Optional | Business model identifier | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "update_subscription": false, 28 | "card_id": "card_id2", 29 | "card": { 30 | "type": "credit", 31 | "number": "number6", 32 | "holder_name": "holder_name2", 33 | "exp_month": 228, 34 | "exp_year": 68, 35 | "cvv": "cvv4" 36 | }, 37 | "recurrence": false, 38 | "initiated_type": "initiated_type8", 39 | "recurrence_model": "recurrence_model6", 40 | "payment_origin": { 41 | "brand_id": "brand_id8", 42 | "charge_id": "charge_id2" 43 | }, 44 | "indirect_acceptor": "indirect_acceptor2" 45 | } 46 | ``` 47 | 48 | -------------------------------------------------------------------------------- /doc/models/update-charge-due-date-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Charge Due Date Request 3 | 4 | Request for updating a charge due date 5 | 6 | ## Structure 7 | 8 | `UpdateChargeDueDateRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `due_at` | `datetime` | Optional | The charge's new due date | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "due_at": "2016-03-13T12:52:32.123Z" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/update-current-cycle-end-date-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Current Cycle End Date Request 3 | 4 | Request to update the end date of the current subscription cycle 5 | 6 | ## Structure 7 | 8 | `UpdateCurrentCycleEndDateRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `end_at` | `datetime` | Optional | Current cycle end date | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "end_at": "2016-03-13T12:52:32.123Z" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/update-current-cycle-status-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Current Cycle Status Request 3 | 4 | ## Structure 5 | 6 | `UpdateCurrentCycleStatusRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `status` | `str` | Required | Status | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "status": "status8" 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /doc/models/update-customer-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Customer Request 3 | 4 | Request for updating a customer 5 | 6 | ## Structure 7 | 8 | `UpdateCustomerRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `name` | `str` | Optional | Name | 15 | | `email` | `str` | Optional | Email | 16 | | `document` | `str` | Optional | Document number | 17 | | `mtype` | `str` | Optional | Person type | 18 | | `address` | [`CreateAddressRequest`](../../doc/models/create-address-request.md) | Optional | Address | 19 | | `metadata` | `Dict[str, str]` | Optional | Metadata | 20 | | `phones` | [`CreatePhonesRequest`](../../doc/models/create-phones-request.md) | Optional | - | 21 | | `code` | `str` | Optional | Código de referência do cliente no sistema da loja. Max: 52 caracteres | 22 | | `gender` | `str` | Optional | Gênero do cliente | 23 | | `document_type` | `str` | Optional | - | 24 | 25 | ## Example (as JSON) 26 | 27 | ```json 28 | { 29 | "name": "name8", 30 | "email": "email8", 31 | "document": "document2", 32 | "type": "type2", 33 | "address": { 34 | "street": "street6", 35 | "number": "number4", 36 | "zip_code": "zip_code0", 37 | "neighborhood": "neighborhood2", 38 | "city": "city6", 39 | "state": "state2", 40 | "country": "country0", 41 | "complement": "complement2", 42 | "metadata": { 43 | "key0": "metadata3", 44 | "key1": "metadata2", 45 | "key2": "metadata1" 46 | }, 47 | "line_1": "line_10", 48 | "line_2": "line_24" 49 | } 50 | } 51 | ``` 52 | 53 | -------------------------------------------------------------------------------- /doc/models/update-invoice-status-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Invoice Status Request 3 | 4 | Invoice Update Status Request 5 | 6 | ## Structure 7 | 8 | `UpdateInvoiceStatusRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `status` | `str` | Required | Status | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "status": "status8" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/update-metadata-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Metadata Request 3 | 4 | Request for updating an metadata 5 | 6 | ## Structure 7 | 8 | `UpdateMetadataRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `metadata` | `Dict[str, str]` | Required | Metadata | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "metadata": { 21 | "key0": "metadata7", 22 | "key1": "metadata6" 23 | } 24 | } 25 | ``` 26 | 27 | -------------------------------------------------------------------------------- /doc/models/update-order-item-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Order Item Request 3 | 4 | Update Order item Request 5 | 6 | ## Structure 7 | 8 | `UpdateOrderItemRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `amount` | `int` | Required | - | 15 | | `description` | `str` | Required | - | 16 | | `quantity` | `int` | Required | - | 17 | | `category` | `str` | Required | - | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "amount": 130, 24 | "description": "description4", 25 | "quantity": 244, 26 | "category": "category2" 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/update-order-status-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Order Status Request 3 | 4 | ## Structure 5 | 6 | `UpdateOrderStatusRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `status` | `str` | Required | Order status | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "status": "status6" 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /doc/models/update-plan-item-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Plan Item Request 3 | 4 | Request for updating a plan item 5 | 6 | ## Structure 7 | 8 | `UpdatePlanItemRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `name` | `str` | Required | Item name | 15 | | `description` | `str` | Required | Description | 16 | | `status` | `str` | Required | Item status | 17 | | `pricing_scheme` | [`UpdatePricingSchemeRequest`](../../doc/models/update-pricing-scheme-request.md) | Required | Pricing scheme | 18 | | `quantity` | `int` | Optional | Quantity | 19 | | `cycles` | `int` | Optional | Number of cycles that the item will be charged | 20 | 21 | ## Example (as JSON) 22 | 23 | ```json 24 | { 25 | "name": "name6", 26 | "description": "description6", 27 | "status": "status8", 28 | "pricing_scheme": { 29 | "scheme_type": "scheme_type8", 30 | "price_brackets": [ 31 | { 32 | "start_quantity": 144, 33 | "price": 174, 34 | "end_quantity": 152, 35 | "overage_price": 166 36 | } 37 | ], 38 | "price": 166, 39 | "minimum_price": 6, 40 | "percentage": 251.76 41 | }, 42 | "quantity": 200, 43 | "cycles": 36 44 | } 45 | ``` 46 | 47 | -------------------------------------------------------------------------------- /doc/models/update-price-bracket-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Price Bracket Request 3 | 4 | Request for updating a price bracket 5 | 6 | ## Structure 7 | 8 | `UpdatePriceBracketRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `start_quantity` | `int` | Required | Start quantity of the bracket | 15 | | `price` | `int` | Required | Price | 16 | | `end_quantity` | `int` | Optional | End quantity of the bracket | 17 | | `overage_price` | `int` | Optional | Overage price | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "start_quantity": 154, 24 | "price": 164, 25 | "end_quantity": 162, 26 | "overage_price": 176 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/update-pricing-scheme-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Pricing Scheme Request 3 | 4 | Request for updating a pricing scheme 5 | 6 | ## Structure 7 | 8 | `UpdatePricingSchemeRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `scheme_type` | `str` | Required | Scheme type | 15 | | `price_brackets` | [`List[UpdatePriceBracketRequest]`](../../doc/models/update-price-bracket-request.md) | Required | Price brackets | 16 | | `price` | `int` | Optional | Price | 17 | | `minimum_price` | `int` | Optional | Minimum price | 18 | | `percentage` | `float` | Optional | percentual value used in pricing_scheme Percent | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "scheme_type": "scheme_type0", 25 | "price_brackets": [ 26 | { 27 | "start_quantity": 144, 28 | "price": 174, 29 | "end_quantity": 152, 30 | "overage_price": 166 31 | } 32 | ], 33 | "price": 162, 34 | "minimum_price": 2, 35 | "percentage": 62.28 36 | } 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /doc/models/update-recipient-bank-account-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Recipient Bank Account Request 3 | 4 | Updates the default bank account for a recipient 5 | 6 | ## Structure 7 | 8 | `UpdateRecipientBankAccountRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `bank_account` | [`CreateBankAccountRequest`](../../doc/models/create-bank-account-request.md) | Required | Bank account | 15 | | `payment_mode` | `str` | Required | Payment mode

**Default**: `'bank_transfer'` | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "bank_account": { 22 | "holder_name": "holder_name0", 23 | "holder_type": "holder_type6", 24 | "holder_document": "holder_document8", 25 | "bank": "bank2", 26 | "branch_number": "branch_number0", 27 | "branch_check_digit": "branch_check_digit0", 28 | "account_number": "account_number4", 29 | "account_check_digit": "account_check_digit0", 30 | "type": "type6", 31 | "metadata": { 32 | "key0": "metadata1", 33 | "key1": "metadata0" 34 | }, 35 | "pix_key": "pix_key2" 36 | }, 37 | "payment_mode": "bank_transfer" 38 | } 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /doc/models/update-recipient-code-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Recipient Code Request 3 | 4 | Update code for a recipient 5 | 6 | ## Structure 7 | 8 | `UpdateRecipientCodeRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `code` | `str` | Required | Code | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "code": "code6" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/update-recipient-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Recipient Request 3 | 4 | Request for updating a Recipient 5 | 6 | ## Structure 7 | 8 | `UpdateRecipientRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `name` | `str` | Required | Name | 15 | | `email` | `str` | Required | Email | 16 | | `description` | `str` | Required | Description | 17 | | `mtype` | `str` | Required | Type | 18 | | `status` | `str` | Required | Status | 19 | | `metadata` | `Dict[str, str]` | Required | Metadata | 20 | 21 | ## Example (as JSON) 22 | 23 | ```json 24 | { 25 | "name": "name0", 26 | "email": "email6", 27 | "description": "description0", 28 | "type": "type0", 29 | "status": "status8", 30 | "metadata": { 31 | "key0": "metadata3", 32 | "key1": "metadata4" 33 | } 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /doc/models/update-subscription-affiliation-id-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Subscription Affiliation Id Request 3 | 4 | Request for updating a Subscription Affiliation Id 5 | 6 | ## Structure 7 | 8 | `UpdateSubscriptionAffiliationIdRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `gateway_affiliation_id` | `str` | Required | - | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "gateway_affiliation_id": "gateway_affiliation_id8" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/update-subscription-billing-date-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Subscription Billing Date Request 3 | 4 | Request for updating the due date from a subscription 5 | 6 | ## Structure 7 | 8 | `UpdateSubscriptionBillingDateRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `next_billing_at` | `datetime` | Required | The date when the next subscription billing must occur | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "next_billing_at": "2016-03-13T12:52:32.123Z" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/update-subscription-card-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Subscription Card Request 3 | 4 | Request for updating the card from a subscription 5 | 6 | ## Structure 7 | 8 | `UpdateSubscriptionCardRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `card` | [`CreateCardRequest`](../../doc/models/create-card-request.md) | Required | Credit card data | 15 | | `card_id` | `str` | Required | Credit card id | 16 | | `indirect_acceptor` | `str` | Optional | Business model identifier | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "card": { 23 | "type": "credit", 24 | "number": "number6", 25 | "holder_name": "holder_name2", 26 | "exp_month": 228, 27 | "exp_year": 68, 28 | "cvv": "cvv4" 29 | }, 30 | "card_id": "card_id0", 31 | "indirect_acceptor": "indirect_acceptor0" 32 | } 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /doc/models/update-subscription-due-days-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Subscription Due Days Request 3 | 4 | ## Structure 5 | 6 | `UpdateSubscriptionDueDaysRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `boleto_due_days` | `int` | Required | - | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "boleto_due_days": 56 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /doc/models/update-subscription-item-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Subscription Item Request 3 | 4 | Request for updating a subscription item 5 | 6 | ## Structure 7 | 8 | `UpdateSubscriptionItemRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `description` | `str` | Required | Description | 15 | | `status` | `str` | Required | Status | 16 | | `pricing_scheme` | [`UpdatePricingSchemeRequest`](../../doc/models/update-pricing-scheme-request.md) | Required | Pricing scheme | 17 | | `name` | `str` | Required | Item name | 18 | | `cycles` | `int` | Optional | Number of cycles that the item will be charged | 19 | | `quantity` | `int` | Optional | Quantity | 20 | | `minimum_price` | `int` | Optional | Minimum price | 21 | 22 | ## Example (as JSON) 23 | 24 | ```json 25 | { 26 | "description": "description2", 27 | "status": "status4", 28 | "pricing_scheme": { 29 | "scheme_type": "scheme_type8", 30 | "price_brackets": [ 31 | { 32 | "start_quantity": 144, 33 | "price": 174, 34 | "end_quantity": 152, 35 | "overage_price": 166 36 | } 37 | ], 38 | "price": 166, 39 | "minimum_price": 6, 40 | "percentage": 251.76 41 | }, 42 | "name": "name2", 43 | "cycles": 108, 44 | "quantity": 128, 45 | "minimum_price": 140 46 | } 47 | ``` 48 | 49 | -------------------------------------------------------------------------------- /doc/models/update-subscription-minimum-price-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Subscription Minimum Price Request 3 | 4 | Atualização do valor mínimo da assinatura 5 | 6 | ## Structure 7 | 8 | `UpdateSubscriptionMinimumPriceRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `minimum_price` | `int` | Optional | Valor mínimo da assinatura | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "minimum_price": 212 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/update-subscription-payment-method-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Subscription Payment Method Request 3 | 4 | Request for updating a subscription's payment method 5 | 6 | ## Structure 7 | 8 | `UpdateSubscriptionPaymentMethodRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `payment_method` | `str` | Required | The new payment method | 15 | | `card_id` | `str` | Required | Card id | 16 | | `card` | [`CreateCardRequest`](../../doc/models/create-card-request.md) | Required | Card data | 17 | | `card_token` | `str` | Optional | The Card Token | 18 | | `boleto` | [`CreateSubscriptionBoletoRequest`](../../doc/models/create-subscription-boleto-request.md) | Optional | Information about fines and interest on the "boleto" used from payment | 19 | | `indirect_acceptor` | `str` | Optional | Business model identifier | 20 | 21 | ## Example (as JSON) 22 | 23 | ```json 24 | { 25 | "payment_method": "payment_method4", 26 | "card_id": "card_id2", 27 | "card": { 28 | "type": "credit", 29 | "number": "number6", 30 | "holder_name": "holder_name2", 31 | "exp_month": 228, 32 | "exp_year": 68, 33 | "cvv": "cvv4" 34 | }, 35 | "card_token": "card_token4", 36 | "boleto": { 37 | "interest": { 38 | "days": 156, 39 | "type": "type0", 40 | "amount": 230 41 | }, 42 | "fine": { 43 | "days": 138, 44 | "type": "type2", 45 | "amount": 212 46 | }, 47 | "max_days_to_pay_past_due": 118 48 | }, 49 | "indirect_acceptor": "indirect_acceptor2" 50 | } 51 | ``` 52 | 53 | -------------------------------------------------------------------------------- /doc/models/update-subscription-split-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Subscription Split Request 3 | 4 | ## Structure 5 | 6 | `UpdateSubscriptionSplitRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `enabled` | `bool` | Required | Defines if the split is enabled | 13 | | `rules` | [`List[CreateSplitRequest]`](../../doc/models/create-split-request.md) | Required | Split | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "enabled": false, 20 | "rules": [ 21 | { 22 | "type": "type2", 23 | "amount": 118, 24 | "recipient_id": "recipient_id2", 25 | "options": { 26 | "liable": false, 27 | "charge_processing_fee": false, 28 | "charge_remainder_fee": false 29 | }, 30 | "split_rule_id": "split_rule_id0" 31 | } 32 | ] 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/update-subscription-start-at-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Subscription Start at Request 3 | 4 | Request for updating the start date from a subscription 5 | 6 | ## Structure 7 | 8 | `UpdateSubscriptionStartAtRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `start_at` | `datetime` | Required | The date when the subscription periods will start | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "start_at": "2016-03-13T12:52:32.123Z" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/update-transfer-settings-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Transfer Settings Request 3 | 4 | ## Structure 5 | 6 | `UpdateTransferSettingsRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | 11 | | --- | --- | --- | --- | 12 | | `transfer_enabled` | `str` | Required | - | 13 | | `transfer_interval` | `str` | Required | - | 14 | | `transfer_day` | `str` | Required | - | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "transfer_enabled": "transfer_enabled4", 21 | "transfer_interval": "transfer_interval0", 22 | "transfer_day": "transfer_day0" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/rfc3339-date-time.md: -------------------------------------------------------------------------------- 1 | 2 | # RFC3339DateTime 3 | 4 | A utility class for wrapping datetime to support RFC3339 date format. 5 | 6 | ## Methods 7 | 8 | | Name | Description | 9 | | --- | --- | 10 | | from_datetime | Converts a datetime object to an RFC 3339 date string. | 11 | | from_value | Parses an RFC 3339 date string into a datetime object. | 12 | 13 | -------------------------------------------------------------------------------- /doc/unix-date-time.md: -------------------------------------------------------------------------------- 1 | 2 | # UnixDateTime 3 | 4 | A utility class for wrapping datetime to support Unix date format. 5 | 6 | ## Methods 7 | 8 | | Name | Description | 9 | | --- | --- | 10 | | from_datetime | Converts a datetime object to a Unix timestamp (seconds since epoch). | 11 | | from_value | Parses a Unix timestamp into a datetime object. | 12 | 13 | -------------------------------------------------------------------------------- /pagarmeapisdk/__init__.py: -------------------------------------------------------------------------------- 1 | __all__ = [ 2 | 'api_helper', 3 | 'configuration', 4 | 'controllers', 5 | 'exceptions', 6 | 'http', 7 | 'models', 8 | 'pagarmeapisdk_client', 9 | ] 10 | -------------------------------------------------------------------------------- /pagarmeapisdk/api_helper.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | pagarmeapisdk 5 | 6 | This file was automatically generated by APIMATIC v3.0 ( 7 | https://www.apimatic.io ). 8 | """ 9 | 10 | from apimatic_core.utilities.api_helper import ApiHelper 11 | 12 | 13 | class APIHelper(ApiHelper): 14 | 15 | """A Helper Class for various functions associated with API Calls. 16 | 17 | This class contains static methods for operations that need to be 18 | performed during API requests. All of the methods inside this class are 19 | static methods, there is no need to ever initialise an instance of this 20 | class. 21 | 22 | """ -------------------------------------------------------------------------------- /pagarmeapisdk/controllers/__init__.py: -------------------------------------------------------------------------------- 1 | __all__ = [ 2 | 'base_controller', 3 | 'subscriptions_controller', 4 | 'orders_controller', 5 | 'plans_controller', 6 | 'invoices_controller', 7 | 'customers_controller', 8 | 'charges_controller', 9 | 'recipients_controller', 10 | 'tokens_controller', 11 | 'transactions_controller', 12 | 'transfers_controller', 13 | 'payables_controller', 14 | 'balance_operations_controller', 15 | ] 16 | -------------------------------------------------------------------------------- /pagarmeapisdk/exceptions/__init__.py: -------------------------------------------------------------------------------- 1 | __all__ = [ 2 | 'api_exception', 3 | 'error_exception', 4 | ] 5 | -------------------------------------------------------------------------------- /pagarmeapisdk/exceptions/api_exception.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | pagarmeapisdk 5 | 6 | This file was automatically generated by APIMATIC v3.0 ( 7 | https://www.apimatic.io ). 8 | """ 9 | 10 | 11 | class APIException(Exception): 12 | 13 | """Class that handles HTTP Exceptions when fetching API Endpoints. 14 | 15 | Attributes: 16 | response_code (int): The status code of the response. 17 | response (HttpResponse): The HttpResponse of the API call. 18 | 19 | """ 20 | 21 | def __init__(self, 22 | reason, 23 | response): 24 | """Constructor for the APIException class 25 | 26 | Args: 27 | reason (string): The reason (or error message) for the Exception 28 | to be raised. 29 | response (HttpResponse): The HttpResponse of the API call. 30 | 31 | """ 32 | super(APIException, self).__init__(reason) 33 | self.reason = reason 34 | self.response = response 35 | self.response_code = response.status_code 36 | 37 | def __str__(self): 38 | return (f'{self.__class__.__name__}(' 39 | f'status_code={self.response_code!s}, ' 40 | f'message={self.reason!s})') 41 | -------------------------------------------------------------------------------- /pagarmeapisdk/http/__init__.py: -------------------------------------------------------------------------------- 1 | __all__ = [ 2 | 'auth', 3 | 'http_method_enum', 4 | 'http_request', 5 | 'http_response', 6 | 'http_call_back', 7 | ] 8 | -------------------------------------------------------------------------------- /pagarmeapisdk/http/auth/__init__.py: -------------------------------------------------------------------------------- 1 | __all__ = [ 2 | 'basic_auth', 3 | ] 4 | -------------------------------------------------------------------------------- /pagarmeapisdk/http/http_call_back.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | pagarmeapisdk 5 | 6 | This file was automatically generated by APIMATIC v3.0 ( 7 | https://www.apimatic.io ). 8 | """ 9 | 10 | from apimatic_core.http.http_callback import HttpCallBack 11 | 12 | 13 | class HttpCallBack(HttpCallBack): 14 | 15 | """An interface for the callback to be called before and after the 16 | HTTP call for an endpoint is made. 17 | 18 | This class should not be instantiated but should be used as a base class 19 | for HttpCallBack classes. 20 | 21 | """ -------------------------------------------------------------------------------- /pagarmeapisdk/http/http_method_enum.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | pagarmeapisdk 5 | 6 | This file was automatically generated by APIMATIC v3.0 ( 7 | https://www.apimatic.io ). 8 | """ 9 | 10 | from apimatic_core_interfaces.types.http_method_enum import HttpMethodEnum 11 | 12 | 13 | class HttpMethodEnum(HttpMethodEnum): 14 | 15 | """Enumeration of an HTTP Method 16 | 17 | Attributes: 18 | GET: A GET Request 19 | POST: A POST Request 20 | PUT: A PUT Request 21 | PATCH: A PATCH Request 22 | DELETE: A DELETE Request 23 | 24 | """ -------------------------------------------------------------------------------- /pagarmeapisdk/http/http_response.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | pagarmeapisdk 5 | 6 | This file was automatically generated by APIMATIC v3.0 ( 7 | https://www.apimatic.io ). 8 | """ 9 | 10 | from apimatic_core.http.response.http_response import HttpResponse 11 | 12 | 13 | class HttpResponse(HttpResponse): 14 | 15 | """Information about an HTTP Response including its status code, returned 16 | headers, and raw body 17 | 18 | Attributes: 19 | status_code (int): The status code response from the server that 20 | corresponds to this response. 21 | reason_phrase (string): The reason phrase returned by the server. 22 | headers (dict): A dictionary of headers (key : value) that were 23 | returned with the response 24 | text (string): The Raw body of the HTTP Response as a string 25 | request (HttpRequest): The request that resulted in this response. 26 | 27 | """ 28 | 29 | def __init__(self, 30 | status_code, 31 | reason_phrase, 32 | headers, 33 | text, 34 | request): 35 | """Constructor for the HttpResponse class 36 | 37 | Args: 38 | status_code (int): The response status code. 39 | reason_phrase (string): The response reason phrase. 40 | headers (dict): The response headers. 41 | text (string): The raw body from the server. 42 | request (HttpRequest): The request that resulted in this response. 43 | 44 | """ 45 | super().__init__(status_code, reason_phrase, headers, text, request) 46 | -------------------------------------------------------------------------------- /pagarmeapisdk/utilities/__init__.py: -------------------------------------------------------------------------------- 1 | __all__ = [ 2 | 'file_wrapper', 3 | ] 4 | -------------------------------------------------------------------------------- /pagarmeapisdk/utilities/file_wrapper.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | pagarmeapisdk 5 | 6 | This file was automatically generated by APIMATIC v3.0 ( 7 | https://www.apimatic.io ). 8 | """ 9 | 10 | from apimatic_core.types.file_wrapper import FileWrapper as CoreFileWrapper 11 | 12 | 13 | class FileWrapper(CoreFileWrapper): 14 | """A wrapper to allow passing in content type for file uploads.""" 15 | 16 | def __init__(self, file, content_type='application/octet-stream'): 17 | super().__init__(file, content_type) 18 | 19 | def __repr__(self): 20 | return (f'{self.__class__.__name__}(' 21 | f'file={self._file_stream!r}, ' 22 | f'content_type={self.content_type!r})') 23 | 24 | def __str__(self): 25 | return (f'{self.__class__.__name__}(' 26 | f'file={self._file_stream!s}, ' 27 | f'content_type={self.content_type!s})') 28 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | build-backend = "setuptools.build_meta" 3 | requires = ["setuptools>=61.0"] 4 | [project] 5 | name = "pagarmeapisdk" 6 | description = "Pagarme API" 7 | version = "6.8.17" 8 | requires-python = ">=3.7" 9 | authors = [{name = "Pagar.me Pagamentos S/A", email = "suporte@pagar.me"}] 10 | dependencies = ["apimatic-core~=0.2.0, >= 0.2.17", "apimatic-core-interfaces~=0.1.0, >= 0.1.5", "apimatic-requests-client-adapter~=0.1.0, >= 0.1.6"] 11 | [project.optional-dependencies] 12 | testutils = ["pytest>=7.2.2"] 13 | [tool.setuptools.packages.find] 14 | exclude = ["tests", "tests.*"] 15 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | apimatic-core~=0.2.0, >= 0.2.17 2 | apimatic-core-interfaces~=0.1.0, >= 0.1.5 3 | apimatic-requests-client-adapter~=0.1.0, >= 0.1.6 4 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Setuptools v62.6 doesn't support editable installs with just 'pyproject.toml' (PEP 660). 3 | # Keep this file until it does! 4 | 5 | [meta-data] 6 | # wheel doesn't yet read license_files from pyproject.toml - tools.setuptools 7 | # Keep it here until it does! 8 | license_files = 9 | LICENSE 10 | 11 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest>=7.2.2 2 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py{37,38,39,310,311} 3 | 4 | [testenv] 5 | commands = pytest 6 | deps = 7 | pytest 8 | --------------------------------------------------------------------------------