├── .editorconfig ├── .eslintignore ├── .eslintrc.json ├── .gitignore ├── LICENSE ├── README.md ├── doc ├── api-error.md ├── api-response.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-client-options.md ├── http-request.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 │ ├── custom-error.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 └── retry-configuration.md ├── jest.config.js ├── package.json ├── src ├── authProvider.ts ├── authentication.ts ├── client.ts ├── clientAdapter.ts ├── clientInterface.ts ├── configuration.ts ├── controllers │ ├── balanceOperationsController.ts │ ├── baseController.ts │ ├── chargesController.ts │ ├── customersController.ts │ ├── invoicesController.ts │ ├── ordersController.ts │ ├── payablesController.ts │ ├── plansController.ts │ ├── recipientsController.ts │ ├── subscriptionsController.ts │ ├── tokensController.ts │ ├── transactionsController.ts │ └── transfersController.ts ├── core.ts ├── defaultConfiguration.ts ├── errors │ └── customError.ts ├── index.ts ├── models │ ├── createAccessTokenRequest.ts │ ├── createAddressRequest.ts │ ├── createAnticipationRequest.ts │ ├── createAntifraudRequest.ts │ ├── createApplePayHeaderRequest.ts │ ├── createApplePayRequest.ts │ ├── createAutomaticAnticipationSettingsRequest.ts │ ├── createBankAccountRefundingDTO.ts │ ├── createBankAccountRequest.ts │ ├── createBankTransferPaymentRequest.ts │ ├── createBoletoPaymentRequest.ts │ ├── createCancelChargeRequest.ts │ ├── createCancelChargeSplitRulesRequest.ts │ ├── createCancelSubscriptionRequest.ts │ ├── createCaptureChargeRequest.ts │ ├── createCardOptionsRequest.ts │ ├── createCardPayloadRequest.ts │ ├── createCardPaymentContactlessPOIRequest.ts │ ├── createCardPaymentContactlessRequest.ts │ ├── createCardRequest.ts │ ├── createCardTokenRequest.ts │ ├── createCashPaymentRequest.ts │ ├── createChargeRequest.ts │ ├── createCheckoutBankTransferRequest.ts │ ├── createCheckoutBoletoPaymentRequest.ts │ ├── createCheckoutCardInstallmentOptionRequest.ts │ ├── createCheckoutCreditCardPaymentRequest.ts │ ├── createCheckoutDebitCardPaymentRequest.ts │ ├── createCheckoutPaymentRequest.ts │ ├── createCheckoutPixPaymentRequest.ts │ ├── createClearSaleRequest.ts │ ├── createConfirmPaymentRequest.ts │ ├── createCreditCardPaymentRequest.ts │ ├── createCustomerRequest.ts │ ├── createDebitCardPaymentRequest.ts │ ├── createDeviceRequest.ts │ ├── createDiscountRequest.ts │ ├── createEmvDataDecryptRequest.ts │ ├── createEmvDataDukptDecryptRequest.ts │ ├── createEmvDataTlvDecryptRequest.ts │ ├── createEmvDecryptRequest.ts │ ├── createFineRequest.ts │ ├── createGooglePayHeaderRequest.ts │ ├── createGooglePayIntermediateSigningKeyRequest.ts │ ├── createGooglePayRequest.ts │ ├── createIncrementRequest.ts │ ├── createInterestRequest.ts │ ├── createInvoiceRequest.ts │ ├── createKYCLinkResponse.ts │ ├── createLocationRequest.ts │ ├── createManagingPartnerRequest.ts │ ├── createOrderItemRequest.ts │ ├── createOrderRequest.ts │ ├── createPaymentAuthenticationRequest.ts │ ├── createPaymentOriginRequest.ts │ ├── createPaymentRequest.ts │ ├── createPeriodRequest.ts │ ├── createPhoneRequest.ts │ ├── createPhonesRequest.ts │ ├── createPixPaymentRequest.ts │ ├── createPlanItemRequest.ts │ ├── createPlanRequest.ts │ ├── createPriceBracketRequest.ts │ ├── createPricingSchemeRequest.ts │ ├── createPrivateLabelPaymentRequest.ts │ ├── createRecipientRequest.ts │ ├── createRegisterInformationAddressRequest.ts │ ├── createRegisterInformationBaseRequest.ts │ ├── createRegisterInformationCorporationRequest.ts │ ├── createRegisterInformationIndividualRequest.ts │ ├── createRegisterInformationPhoneRequest.ts │ ├── createSetupRequest.ts │ ├── createShippingRequest.ts │ ├── createSplitOptionsRequest.ts │ ├── createSplitRequest.ts │ ├── createSubMerchantRequest.ts │ ├── createSubscriptionBoletoRequest.ts │ ├── createSubscriptionItemRequest.ts │ ├── createSubscriptionRequest.ts │ ├── createSubscriptionSplitRequest.ts │ ├── createThreeDSecureRequest.ts │ ├── createTokenRequest.ts │ ├── createTransactionReportFileRequest.ts │ ├── createTransfer.ts │ ├── createTransferRequest.ts │ ├── createTransferSettingsRequest.ts │ ├── createUsageRequest.ts │ ├── createVoucherPaymentRequest.ts │ ├── createWithdrawRequest.ts │ ├── discriminatedSchemas.ts │ ├── getAccessTokenResponse.ts │ ├── getAddressResponse.ts │ ├── getAnticipationLimitResponse.ts │ ├── getAnticipationLimitsResponse.ts │ ├── getAnticipationResponse.ts │ ├── getAntifraudResponse.ts │ ├── getAutomaticAnticipationResponse.ts │ ├── getBalanceOperationResponse.ts │ ├── getBalanceResponse.ts │ ├── getBankAccountResponse.ts │ ├── getBankTransferTransactionResponse.ts │ ├── getBillingAddressResponse.ts │ ├── getBoletoTransactionResponse.ts │ ├── getCardResponse.ts │ ├── getCardTokenResponse.ts │ ├── getCashTransactionResponse.ts │ ├── getChargeResponse.ts │ ├── getChargesSummaryResponse.ts │ ├── getCheckoutBankTransferPaymentResponse.ts │ ├── getCheckoutBoletoPaymentResponse.ts │ ├── getCheckoutCardInstallmentOptionsResponse.ts │ ├── getCheckoutCreditCardPaymentResponse.ts │ ├── getCheckoutDebitCardPaymentResponse.ts │ ├── getCheckoutPaymentResponse.ts │ ├── getCheckoutPaymentSettingsResponse.ts │ ├── getCheckoutPixPaymentResponse.ts │ ├── getCreditCardTransactionResponse.ts │ ├── getCustomerResponse.ts │ ├── getDebitCardTransactionResponse.ts │ ├── getDeviceResponse.ts │ ├── getDiscountResponse.ts │ ├── getFineResponse.ts │ ├── getGatewayErrorResponse.ts │ ├── getGatewayRecipientResponse.ts │ ├── getGatewayResponseResponse.ts │ ├── getIncrementResponse.ts │ ├── getIntegrationResponse.ts │ ├── getInterestResponse.ts │ ├── getInvoiceItemResponse.ts │ ├── getInvoiceResponse.ts │ ├── getLocationResponse.ts │ ├── getManagingPartnerResponse.ts │ ├── getMovementObjectBaseResponse.ts │ ├── getMovementObjectFeeCollectionResponse.ts │ ├── getMovementObjectPayableResponse.ts │ ├── getMovementObjectRefundResponse.ts │ ├── getMovementObjectSettlementResponse.ts │ ├── getMovementObjectTransferResponse.ts │ ├── getOrderItemResponse.ts │ ├── getOrderResponse.ts │ ├── getPayableResponse.ts │ ├── getPaymentAuthenticationResponse.ts │ ├── getPaymentOriginResponse.ts │ ├── getPeriodResponse.ts │ ├── getPhoneNumberResponse.ts │ ├── getPhoneResponse.ts │ ├── getPhonesResponse.ts │ ├── getPixBankAccountResponse.ts │ ├── getPixPayerResponse.ts │ ├── getPixTransactionResponse.ts │ ├── getPlanItemResponse.ts │ ├── getPlanResponse.ts │ ├── getPriceBracketResponse.ts │ ├── getPricingSchemeResponse.ts │ ├── getPrivateLabelTransactionResponse.ts │ ├── getRecipientResponse.ts │ ├── getRegisterInformationAddressResponse.ts │ ├── getRegisterInformationResponse.ts │ ├── getRetryTransactionInformationResponse.ts │ ├── getSafetyPayTransactionResponse.ts │ ├── getSetupResponse.ts │ ├── getShippingResponse.ts │ ├── getSplitOptionsResponse.ts │ ├── getSplitResponse.ts │ ├── getSubscriptionBoletoResponse.ts │ ├── getSubscriptionItemResponse.ts │ ├── getSubscriptionResponse.ts │ ├── getSubscriptionSplitResponse.ts │ ├── getThreeDSecureResponse.ts │ ├── getTokenResponse.ts │ ├── getTransactionReportFileResponse.ts │ ├── getTransactionResponse.ts │ ├── getTransfer.ts │ ├── getTransferResponse.ts │ ├── getTransferSettingsResponse.ts │ ├── getTransferSourceResponse.ts │ ├── getTransferTargetResponse.ts │ ├── getUsageReportResponse.ts │ ├── getUsageResponse.ts │ ├── getVoucherTransactionResponse.ts │ ├── getWithdrawResponse.ts │ ├── getWithdrawSourceResponse.ts │ ├── getWithdrawTargetResponse.ts │ ├── listAccessTokensResponse.ts │ ├── listAddressesResponse.ts │ ├── listAnticipationResponse.ts │ ├── listBalanceOperationResponse.ts │ ├── listCardsResponse.ts │ ├── listChargeTransactionsResponse.ts │ ├── listChargesResponse.ts │ ├── listCustomersResponse.ts │ ├── listCyclesResponse.ts │ ├── listDiscountsResponse.ts │ ├── listIncrementsResponse.ts │ ├── listInvoicesResponse.ts │ ├── listOrderResponse.ts │ ├── listPayablesResponse.ts │ ├── listPlansResponse.ts │ ├── listRecipientResponse.ts │ ├── listSubscriptionItemsResponse.ts │ ├── listSubscriptionsResponse.ts │ ├── listTransactionsFilesResponse.ts │ ├── listTransactionsResponse.ts │ ├── listTransferResponse.ts │ ├── listTransfers.ts │ ├── listUsagesResponse.ts │ ├── listWithdrawals.ts │ ├── pagingResponse.ts │ ├── pixAdditionalInformation.ts │ ├── updateAddressRequest.ts │ ├── updateAutomaticAnticipationSettingsRequest.ts │ ├── updateCardRequest.ts │ ├── updateChargeCardRequest.ts │ ├── updateChargeDueDateRequest.ts │ ├── updateChargePaymentMethodRequest.ts │ ├── updateCurrentCycleEndDateRequest.ts │ ├── updateCurrentCycleStatusRequest.ts │ ├── updateCustomerRequest.ts │ ├── updateInvoiceStatusRequest.ts │ ├── updateMetadataRequest.ts │ ├── updateOrderItemRequest.ts │ ├── updateOrderStatusRequest.ts │ ├── updatePlanItemRequest.ts │ ├── updatePlanRequest.ts │ ├── updatePriceBracketRequest.ts │ ├── updatePricingSchemeRequest.ts │ ├── updateRecipientBankAccountRequest.ts │ ├── updateRecipientCodeRequest.ts │ ├── updateRecipientRequest.ts │ ├── updateSubscriptionAffiliationIdRequest.ts │ ├── updateSubscriptionBillingDateRequest.ts │ ├── updateSubscriptionCardRequest.ts │ ├── updateSubscriptionDueDaysRequest.ts │ ├── updateSubscriptionItemRequest.ts │ ├── updateSubscriptionMinimumPriceRequest.ts │ ├── updateSubscriptionPaymentMethodRequest.ts │ ├── updateSubscriptionSplitRequest.ts │ ├── updateSubscriptionStartAtRequest.ts │ └── updateTransferSettingsRequest.ts └── schema.ts ├── tsconfig.base.json ├── tsconfig.cjs.json ├── tsconfig.esm.json └── tsconfig.json /.editorconfig: -------------------------------------------------------------------------------- 1 | # http://editorconfig.org 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | end_of_line = lf 7 | indent_size = 2 8 | indent_style = space 9 | insert_final_newline = true 10 | max_line_length = 80 11 | trim_trailing_whitespace = true 12 | 13 | [*.md] 14 | max_line_length = 0 15 | trim_trailing_whitespace = false 16 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | *.log 2 | .DS_Store 3 | node_modules 4 | dist 5 | coverage -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "es2021": true 5 | }, 6 | "extends": [ 7 | "eslint:recommended", 8 | "plugin:@typescript-eslint/recommended" 9 | ], 10 | "overrides": [ 11 | ], 12 | "parser": "@typescript-eslint/parser", 13 | "parserOptions": { 14 | "ecmaVersion": "latest", 15 | "sourceType": "module" 16 | }, 17 | "plugins": [ 18 | "@typescript-eslint" 19 | ], 20 | 21 | "rules": { 22 | "@typescript-eslint/no-explicit-any": "off", 23 | "@typescript-eslint/no-namespace": "off", 24 | "@typescript-eslint/ban-types": "off", 25 | "no-irregular-whitespace": "off" 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.log 2 | .DS_Store 3 | node_modules 4 | dist 5 | coverage -------------------------------------------------------------------------------- /doc/api-error.md: -------------------------------------------------------------------------------- 1 | 2 | # ApiError 3 | 4 | Thrown when the HTTP status code is not okay. 5 | 6 | The ApiError extends the ApiResponse interface, so all ApiResponse properties are available. 7 | 8 | ## Properties 9 | 10 | | Name | Type | Description | 11 | | --- | --- | --- | 12 | | request | [`HttpRequest`](../doc/http-request.md) | Original request that resulted in this response. | 13 | | statusCode | `number` | Response status code. | 14 | | headers | `Record` | Response headers. | 15 | | result | `T` | Response data. | 16 | | body | `string \| Blob \| NodeJS.ReadableStream` | Original body from the response. | 17 | 18 | -------------------------------------------------------------------------------- /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 | Setter | 11 | | --- | --- | --- | --- | 12 | | BasicAuthUserName | `string` | The username to use with basic authentication | `username` | 13 | | BasicAuthPassword | `string` | The password to use with basic authentication | `password` | 14 | 15 | 16 | 17 | **Note:** Auth credentials can be set using `basicAuthCredentials` object in the client. 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 | ```ts 26 | const client = new Client({ 27 | basicAuthCredentials: { 28 | username: 'BasicAuthUserName', 29 | password: 'BasicAuthPassword' 30 | }, 31 | }); 32 | ``` 33 | 34 | 35 | -------------------------------------------------------------------------------- /doc/http-client-options.md: -------------------------------------------------------------------------------- 1 | 2 | # HttpClientOptions 3 | 4 | Represents the HTTP client configurations for API calls. 5 | 6 | ## Properties 7 | 8 | | Name | Type | Description | 9 | | --- | --- | --- | 10 | | timeout | `number` | Timeout in milliseconds. | 11 | | httpAgent | `any` | Custom http agent to be used when performing http requests. | 12 | | httpsAgent | `any` | Custom https agent to be used when performing http requests. | 13 | | retryConfig | [`Partial`](../doc/retry-configuration.md) | Configurations to retry requests. | 14 | 15 | -------------------------------------------------------------------------------- /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 | | `expiresIn` | `number \| undefined` | 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-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` | `number` | Required | Amount requested for the anticipation | 15 | | `timeframe` | `string` | Required | Timeframe | 16 | | `paymentDate` | `string` | 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 | | `type` | `string` | 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 | | `publicKeyHash` | `string \| undefined` | Optional | SHA–256 hash, Base64 string codified | 15 | | `ephemeralPublicKey` | `string` | Required | X.509 encoded key bytes, Base64 encoded as a string | 16 | | `transactionId` | `string \| undefined` | 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-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` | `boolean` | Required | - | 13 | | `type` | `string` | Required | - | 14 | | `volumePercentage` | `number` | Required | - | 15 | | `delay` | `number` | Required | - | 16 | | `days` | `number[]` | 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-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` | `string` | Required | Bank | 15 | | `retries` | `number` | 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` | `string` | Required | The split rule gateway id | 15 | | `amount` | `number` | Required | The split rule amount | 16 | | `type` | `string` | 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 | | `cancelPendingInvoices` | `boolean` | 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-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 | | `verifyCard` | `boolean` | 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 | | `type` | `string \| null \| undefined` | Optional | - | 13 | | `googlePay` | [`CreateGooglePayRequest \| null \| undefined`](../../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 | | `systemName` | `string` | Required | system name | 13 | | `model` | `string` | Required | model | 14 | | `provider` | `string` | Required | provider | 15 | | `serialNumber` | `string` | Required | serial number | 16 | | `versionNumber` | `string` | 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-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` | `string` | Required | Credit card number | 15 | | `holderName` | `string` | Required | Holder name, as written on the card | 16 | | `expMonth` | `number` | Required | The expiration month | 17 | | `expYear` | `number` | Required | The expiration year, that can be informed with 2 or 4 digits | 18 | | `cvv` | `string` | Required | The card's security code | 19 | | `brand` | `string` | Required | Card brand | 20 | | `label` | `string` | 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` | `string` | Required | Description | 13 | | `confirm` | `boolean` | 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` | `string[]` | Required | Bank | 15 | | `retries` | `number` | 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` | `string` | Required | Bank identifier | 13 | | `instructions` | `string` | Required | Instructions | 14 | | `dueAt` | `string` | 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` | `number` | Required | Installment quantity | 15 | | `total` | `number` | 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-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 | | `statementDescriptor` | `string \| undefined` | 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 | | `expiresAt` | `string \| undefined` | Optional | Expires at | 15 | | `expiresIn` | `number \| undefined` | Optional | Expires in | 16 | | `additionalInformation` | [`PixAdditionalInformation[] \| undefined`](../../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 | | `customSla` | `number` | 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` | `string` | Required | Description | 13 | | `amount` | `number \| undefined` | Optional | Amount | 14 | | `code` | `string` | 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-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` | `string \| undefined` | 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` | `number` | Required | The discount value | 15 | | `discountType` | `string` | Required | Discount type. Can be either flat or percentage. | 16 | | `itemId` | `string` | Required | The item where the discount will be applied | 17 | | `cycles` | `number \| undefined` | Optional | Number of cycles that the discount will be applied | 18 | | `description` | `string \| undefined` | 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` | `string` | Required | Emv Decrypt cipher type | 13 | | `dukpt` | [`CreateEmvDataDukptDecryptRequest \| undefined`](../../doc/models/create-emv-data-dukpt-decrypt-request.md) | Optional | Dukpt data request | 14 | | `tags` | [`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` | `string` | 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` | `string` | Required | Emv tag | 13 | | `lenght` | `string` | Required | Emv lenght | 14 | | `value` | `string` | 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-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` | `number` | Required | Days | 15 | | `type` | `string` | Required | Type | 16 | | `amount` | `number` | 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 | | `ephemeralPublicKey` | `string` | 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 | | `signedKey` | `string \| null \| undefined` | Optional | Uma mensagem codificada em Base64 com a descrição de pagamento da chave. | 15 | | `signatures` | `string[] \| null \| undefined` | 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-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` | `number` | Required | The increment value | 15 | | `incrementType` | `string` | Required | Increment type. Can be either flat or percentage. | 16 | | `itemId` | `string` | Required | The item where the increment will be applied | 17 | | `cycles` | `number \| undefined` | Optional | Number of cycles that the increment will be applied | 18 | | `description` | `string \| undefined` | 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` | `number` | Required | Days | 15 | | `type` | `string` | Required | Type | 16 | | `amount` | `number` | 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` | `Record` | 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 | | `base64` | `string \| null \| undefined` | Optional | Base64 | 15 | | `url` | `string \| null \| undefined` | Optional | URL | 16 | | `expirationDate` | `string \| null \| undefined` | 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` | `string` | Required | Latitude | 15 | | `longitude` | `string` | 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` | `number` | Required | Amount | 15 | | `description` | `string` | Required | Description | 16 | | `quantity` | `number` | Required | Quantity | 17 | | `category` | `string` | Required | Category | 18 | | `code` | `string \| undefined` | 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 | | `type` | `string` | Required | The Authentication type | 15 | | `threedSecure` | [`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 | | `brandId` | `string \| null \| undefined` | Optional | - | 15 | | `chargeId` | `string \| null \| undefined` | 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 | | `endAt` | `string \| undefined` | 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 | | `countryCode` | `string \| undefined` | Optional | - | 13 | | `number` | `string \| undefined` | Optional | - | 14 | | `areaCode` | `string \| undefined` | Optional | - | 15 | | `type` | `string \| null \| undefined` | 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 | | `homePhone` | [`CreatePhoneRequest \| undefined`](../../doc/models/create-phone-request.md) | Optional | - | 13 | | `mobilePhone` | [`CreatePhoneRequest \| undefined`](../../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 | | `expiresAt` | `string \| undefined` | Optional | Datetime when pix payment will expire | 15 | | `expiresIn` | `number \| undefined` | Optional | Seconds until pix payment expires | 16 | | `additionalInformation` | [`PixAdditionalInformation[] \| undefined`](../../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-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 | | `startQuantity` | `number` | Required | Start quantity | 15 | | `price` | `number` | Required | Price | 16 | | `endQuantity` | `number \| undefined` | Optional | End quantity | 17 | | `overagePrice` | `number \| undefined` | 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-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` | `string` | Required | - | 15 | | `complementary` | `string` | Required | - | 16 | | `streetNumber` | `string` | Required | - | 17 | | `neighborhood` | `string` | Required | - | 18 | | `city` | `string` | Required | - | 19 | | `state` | `string` | Required | - | 20 | | `zipCode` | `string` | Required | - | 21 | | `referencePoint` | `string` | 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` | `string` | Required | - | 15 | | `document` | `string` | Required | - | 16 | | `type` | `string` | Required | "individual" ou "corporation" | 17 | | `siteUrl` | `string \| null \| undefined` | Optional | - | 18 | | `phoneNumbers` | [`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-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` | `string` | Required | - | 15 | | `number` | `string` | Required | - | 16 | | `type` | `string` | 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` | `boolean \| undefined` | Optional | Liable options | 15 | | `chargeProcessingFee` | `boolean \| undefined` | Optional | Charge processing fee | 16 | | `chargeRemainderFee` | `boolean \| undefined` | 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 | | `type` | `string` | Required | Split type | 15 | | `amount` | `number` | Required | Amount | 16 | | `recipientId` | `string` | Required | Recipient id | 17 | | `options` | [`CreateSplitOptionsRequest \| undefined`](../../doc/models/create-split-options-request.md) | Optional | The split options request | 18 | | `splitRuleId` | `string \| undefined` | 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 \| undefined`](../../doc/models/create-interest-request.md) | Optional | - | 15 | | `fine` | [`CreateFineRequest \| undefined`](../../doc/models/create-fine-request.md) | Optional | - | 16 | | `maxDaysToPayPastDue` | `number \| null \| undefined` | 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` | `boolean` | Required | Defines if the split is enabled | 13 | | `rules` | [`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-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 | | `type` | `string` | 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` | `string` | Required | - | 13 | | `startAt` | `string \| undefined` | Optional | - | 14 | | `endAt` | `string \| undefined` | 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` | `number` | Required | Transfer amount | 15 | | `metadata` | `Record` | 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 | | `transferEnabled` | `boolean` | Required | - | 15 | | `transferInterval` | `string` | Required | - | 16 | | `transferDay` | `number` | 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` | `number` | Required | - | 13 | | `sourceId` | `string` | Required | - | 14 | | `targetId` | `string` | Required | - | 15 | | `metadata` | `string[] \| undefined` | 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` | `number` | Required | - | 15 | | `description` | `string` | Required | - | 16 | | `usedAt` | `string` | Required | - | 17 | | `code` | `string \| undefined` | Optional | Identification code in the client system | 18 | | `group` | `string \| undefined` | Optional | identification group in the client system | 19 | | `amount` | `number \| undefined` | 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-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` | `number` | Required | - | 13 | | `metadata` | `Record \| undefined` | 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/custom-error.md: -------------------------------------------------------------------------------- 1 | 2 | # Custom Error 3 | 4 | Api Error Exception 5 | 6 | ## Structure 7 | 8 | `CustomError` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | 13 | | --- | --- | --- | --- | 14 | | `message` | `string \| null` | Required | - | 15 | | `errors` | `unknown \| null` | Required | - | 16 | | `request` | `unknown \| null` | 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` | `string \| null \| undefined` | Optional | - | 15 | | `code` | `string \| null \| undefined` | Optional | - | 16 | | `status` | `string \| null \| undefined` | Optional | - | 17 | | `createdAt` | `string \| null \| undefined` | Optional | - | 18 | | `customer` | [`GetCustomerResponse \| null \| undefined`](../../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-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` | `number \| null \| undefined` | Optional | Amount | 15 | | `anticipationFee` | `number \| null \| undefined` | 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 \| null \| undefined`](../../doc/models/get-anticipation-limit-response.md) | Optional | Max limit | 15 | | `min` | [`GetAnticipationLimitResponse \| null \| undefined`](../../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-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` | `string \| null \| undefined` | Optional | - | 13 | | `returnCode` | `string \| null \| undefined` | Optional | - | 14 | | `returnMessage` | `string \| null \| undefined` | Optional | - | 15 | | `providerName` | `string \| null \| undefined` | Optional | - | 16 | | `score` | `string \| null \| undefined` | 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` | `boolean \| null \| undefined` | Optional | - | 13 | | `type` | `string \| null \| undefined` | Optional | - | 14 | | `volumePercentage` | `number \| null \| undefined` | Optional | - | 15 | | `delay` | `number \| null \| undefined` | Optional | - | 16 | | `days` | `number[] \| null \| undefined` | 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-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 | | `lastFourDigits` | `string \| null \| undefined` | Optional | - | 15 | | `holderName` | `string \| null \| undefined` | Optional | - | 16 | | `holderDocument` | `string \| null \| undefined` | Optional | - | 17 | | `expMonth` | `number \| null \| undefined` | Optional | - | 18 | | `expYear` | `number \| null \| undefined` | Optional | - | 19 | | `brand` | `string \| null \| undefined` | Optional | - | 20 | | `type` | `string \| null \| undefined` | Optional | - | 21 | | `label` | `string \| null \| undefined` | 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` | `string \| null \| undefined` | 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` | `number \| null \| undefined` | 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` | `string[] \| null \| undefined` | 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 | | `dueAt` | `string \| null \| undefined` | Optional | Data de vencimento do boleto | 13 | | `instructions` | `string \| null \| undefined` | 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` | `bigint \| null` | Required | Número de parcelas | 13 | | `total` | `number \| null` | 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-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 | | `statementDescriptor` | `string \| null \| undefined` | Optional | Descrição na fatura | 13 | | `authentication` | [`GetPaymentAuthenticationResponse \| null \| undefined`](../../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-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 | | `expiresAt` | `string \| null \| undefined` | Optional | Expires at | 15 | | `additionalInformation` | [`PixAdditionalInformation[] \| null \| undefined`](../../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-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` | `string \| null \| undefined` | Optional | Device's platform name | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "platform": "platform8" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /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` | `number \| null \| undefined` | Optional | Days | 15 | | `type` | `string \| null \| undefined` | Optional | Type | 16 | | `amount` | `number \| null \| undefined` | 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` | `string \| null \| undefined` | 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` | `string \| null \| undefined` | Optional | Gateway name | 15 | | `status` | `string \| null \| undefined` | Optional | Status of the recipient on the gateway | 16 | | `pgid` | `string \| null \| undefined` | Optional | Recipient id on the gateway | 17 | | `createdAt` | `string \| null \| undefined` | Optional | Creation date | 18 | | `updatedAt` | `string \| null \| undefined` | 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` | `string \| null \| undefined` | Optional | The error code | 15 | | `errors` | [`GetGatewayErrorResponse[] \| null \| undefined`](../../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-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` | `string \| undefined` | 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` | `number \| null \| undefined` | Optional | Days | 15 | | `type` | `string \| null \| undefined` | Optional | Type | 16 | | `amount` | `number \| null \| undefined` | 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` | `string \| null \| undefined` | Optional | Latitude | 15 | | `longitude` | `string \| null \| undefined` | Optional | Longitude | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "latitude": "latitude6", 22 | "longitude": "longitude4" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /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` | `string \| null \| undefined` | Optional | - | 19 | | `paymentDate` | `string \| null \| undefined` | Optional | - | 20 | | `recipientId` | `string \| null \| undefined` | 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-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 | | `type` | `string \| null \| undefined` | Optional | - | 15 | | `threedSecure` | [`GetThreeDSecureResponse \| null \| undefined`](../../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 | | `chargeId` | `string \| undefined` | Optional | - | 13 | | `brandId` | `string \| undefined` | 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-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` | `string \| null \| undefined` | Optional | - | 15 | | `number` | `string \| null \| undefined` | Optional | - | 16 | | `type` | `string \| null \| undefined` | 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 | | `countryCode` | `string \| null \| undefined` | Optional | - | 13 | | `number` | `string \| null \| undefined` | Optional | - | 14 | | `areaCode` | `string \| null \| undefined` | 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 | | `homePhone` | [`GetPhoneResponse \| null \| undefined`](../../doc/models/get-phone-response.md) | Optional | - | 13 | | `mobilePhone` | [`GetPhoneResponse \| null \| undefined`](../../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 | | `bankName` | `string \| null \| undefined` | Optional | - | 15 | | `ispb` | `string \| null \| undefined` | Optional | - | 16 | | `branchCode` | `string \| null \| undefined` | Optional | - | 17 | | `accountNumber` | `string \| null \| undefined` | 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` | `string \| null \| undefined` | Optional | - | 15 | | `document` | `string \| null \| undefined` | Optional | - | 16 | | `documentType` | `string \| null \| undefined` | Optional | - | 17 | | `bankAccount` | [`GetPixBankAccountResponse \| null \| undefined`](../../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-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 | | `startQuantity` | `number \| null \| undefined` | Optional | - | 15 | | `price` | `number \| null \| undefined` | Optional | - | 16 | | `endQuantity` | `number \| null \| undefined` | Optional | - | 17 | | `overagePrice` | `number \| null \| undefined` | 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-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 | | `brandFailureReturnCode` | `string \| null` | Required | - | 15 | | `transactionLimit` | `number \| null` | Required | - | 16 | | `transactionDateLimit` | `string \| null` | 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-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` | `string \| null \| undefined` | Optional | - | 15 | | `description` | `string \| null \| undefined` | Optional | - | 16 | | `amount` | `number \| null \| undefined` | Optional | - | 17 | | `status` | `string \| null \| undefined` | 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-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` | `boolean \| null \| undefined` | Optional | - | 13 | | `chargeProcessingFee` | `boolean \| null \| undefined` | Optional | - | 14 | | `chargeRemainderFee` | `string \| null \| undefined` | 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-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 \| null \| undefined`](../../doc/models/get-interest-response.md) | Optional | Interest | 15 | | `fine` | [`GetFineResponse \| null \| undefined`](../../doc/models/get-fine-response.md) | Optional | Fine | 16 | | `maxDaysToPayPastDue` | `number \| null \| undefined` | 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-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` | `string \| null \| undefined` | Optional | MPI Vendor | 15 | | `eci` | `string \| null \| undefined` | Optional | Electronic Commerce Indicator (ECI) (Opcional) | 16 | | `cavv` | `string \| null \| undefined` | Optional | Online payment cryptogram, definido pelo 3-D Secure. | 17 | | `transactionId` | `string \| null \| undefined` | Optional | Identificador da transação (XID) | 18 | | `successUrl` | `string \| null \| undefined` | 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` | `string \| null \| undefined` | Optional | - | 15 | | `type` | `string \| null \| undefined` | Optional | - | 16 | | `createdAt` | `string \| null \| undefined` | Optional | - | 17 | | `expiresAt` | `string \| null \| undefined` | Optional | - | 18 | | `card` | [`GetCardTokenResponse \| null \| undefined`](../../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` | `string \| null \| undefined` | Optional | - | 13 | | `date` | `string \| null \| undefined` | 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-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 | | `transferEnabled` | `boolean \| null \| undefined` | Optional | - | 13 | | `transferInterval` | `string \| null \| undefined` | Optional | - | 14 | | `transferDay` | `number \| null \| undefined` | 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 | | `sourceId` | `string \| null \| undefined` | Optional | - | 13 | | `type` | `string \| null \| undefined` | 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 | | `targetId` | `string \| null \| undefined` | Optional | - | 13 | | `type` | `string \| null \| undefined` | 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-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` | `string \| null \| undefined` | Optional | - | 13 | | `usageReportUrl` | `string \| null \| undefined` | Optional | - | 14 | | `groupedReportUrl` | `string \| null \| undefined` | 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-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 | | `sourceId` | `string \| null \| undefined` | Optional | - | 13 | | `type` | `string \| null \| undefined` | 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 | | `targetId` | `string \| null \| undefined` | Optional | - | 13 | | `type` | `string \| null \| undefined` | 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-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` | [`GetAnticipationResponse[] \| null \| undefined`](../../doc/models/get-anticipation-response.md) | Optional | Anticipations | 15 | | `paging` | [`PagingResponse \| null \| undefined`](../../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-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` | [`GetIncrementResponse[] \| null \| undefined`](../../doc/models/get-increment-response.md) | Optional | The Increments response | 13 | | `paging` | [`PagingResponse \| null \| undefined`](../../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-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` | [`GetPayableResponse[] \| null \| undefined`](../../doc/models/get-payable-response.md) | Optional | The payable object | 15 | | `paging` | [`PagingResponse \| null \| undefined`](../../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-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` | [`GetTransactionReportFileResponse[] \| null \| undefined`](../../doc/models/get-transaction-report-file-response.md) | Optional | - | 15 | | `paging` | [`PagingResponse \| null \| undefined`](../../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-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` | [`GetUsageResponse[] \| null \| undefined`](../../doc/models/get-usage-response.md) | Optional | The usage objects | 15 | | `paging` | [`PagingResponse \| null \| undefined`](../../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` | [`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` | `number \| null \| undefined` | Optional | Total number of pages | 15 | | `previous` | `string \| null \| undefined` | Optional | Previous page | 16 | | `next` | `string \| null \| undefined` | 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` | `string \| null \| undefined` | Optional | - | 15 | | `value` | `string \| null \| undefined` | 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` | `string` | Required | Number | 15 | | `complement` | `string` | Required | Complement | 16 | | `metadata` | `Record` | Required | Metadata | 17 | | `line2` | `string` | 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` | `boolean \| undefined` | Optional | - | 13 | | `type` | `string \| undefined` | Optional | - | 14 | | `volumePercentage` | `number \| undefined` | Optional | - | 15 | | `delay` | `number \| undefined` | Optional | - | 16 | | `days` | `number \| undefined` | 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-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 | | `dueAt` | `string \| undefined` | 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 | | `endAt` | `string \| undefined` | 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` | `string` | Required | Status | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "status": "status8" 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /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` | `string` | 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` | `Record` | 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` | `number` | Required | - | 15 | | `description` | `string` | Required | - | 16 | | `quantity` | `number` | Required | - | 17 | | `category` | `string` | 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` | `string` | Required | Order status | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "status": "status6" 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /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 | | `startQuantity` | `number` | Required | Start quantity of the bracket | 15 | | `price` | `number` | Required | Price | 16 | | `endQuantity` | `number \| undefined` | Optional | End quantity of the bracket | 17 | | `overagePrice` | `number \| undefined` | 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-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` | `string` | 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` | `string` | Required | Name | 15 | | `email` | `string` | Required | Email | 16 | | `description` | `string` | Required | Description | 17 | | `type` | `string` | Required | Type | 18 | | `status` | `string` | Required | Status | 19 | | `metadata` | `Record` | 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 | | `gatewayAffiliationId` | `string` | 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 | | `nextBillingAt` | `string` | 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 | | `cardId` | `string` | Required | Credit card id | 16 | | `indirectAcceptor` | `string \| undefined` | 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 | | `boletoDueDays` | `number` | Required | - | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "boleto_due_days": 56 19 | } 20 | ``` 21 | 22 | -------------------------------------------------------------------------------- /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 | | `minimumPrice` | `number \| undefined` | 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-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` | `boolean` | Required | Defines if the split is enabled | 13 | | `rules` | [`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 | | `startAt` | `string` | 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 | | `transferEnabled` | `string` | Required | - | 13 | | `transferInterval` | `string` | Required | - | 14 | | `transferDay` | `string` | 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/retry-configuration.md: -------------------------------------------------------------------------------- 1 | 2 | # RetryConfiguration 3 | 4 | Represents the retry configurations for API calls. 5 | 6 | ## Properties 7 | 8 | | Name | Type | Description | 9 | | --- | --- | --- | 10 | | maxNumberOfRetries | `number` | Maximum number of retries.
*Default*: `0` | 11 | | retryOnTimeout | `boolean` | Whether to retry on request timeout.
*Default*: `true` | 12 | | retryInterval | `number` | Interval before next retry. Used in calculation of wait time for next request in case of failure.
*Default*: `1` | 13 | | maximumRetryWaitTime | `number` | Overall wait time for the requests getting retried.
*Default*: `0` | 14 | | backoffFactor | `number` | Used in calculation of wait time for next request in case of failure.
*Default*: `2` | 15 | | httpStatusCodesToRetry | `number[]` | Http status codes to retry against.
*Default*: `[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]` | 16 | | httpMethodsToRetry | `HttpMethod[]` | Http methods to retry against.
*Default*: `['GET', 'PUT']` | 17 | 18 | -------------------------------------------------------------------------------- /jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | testEnvironment: 'node', 3 | preset: 'ts-jest', 4 | transform: { 5 | '^.+\\.tsx?$': ['ts-jest', { tsconfig: 'tsconfig.base.json' }], 6 | }, 7 | }; 8 | -------------------------------------------------------------------------------- /src/authProvider.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { 8 | basicAuthenticationProvider, 9 | compositeAuthenticationProvider, 10 | } from './authentication'; 11 | import { Configuration } from './configuration'; 12 | 13 | export function createAuthProviderFromConfig(config: Partial) { 14 | const authConfig = { 15 | httpBasic: 16 | config.basicAuthCredentials && 17 | basicAuthenticationProvider( 18 | config.basicAuthCredentials.username, 19 | config.basicAuthCredentials.password 20 | ), 21 | }; 22 | 23 | return compositeAuthenticationProvider< 24 | keyof typeof authConfig, 25 | typeof authConfig 26 | >(authConfig); 27 | } 28 | -------------------------------------------------------------------------------- /src/authentication.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | export * from '@apimatic/authentication-adapters'; 8 | -------------------------------------------------------------------------------- /src/clientAdapter.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | export * from '@apimatic/axios-client-adapter'; 8 | -------------------------------------------------------------------------------- /src/clientInterface.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { createAuthProviderFromConfig } from './authProvider'; 8 | import { AuthenticatorInterface, RequestBuilderFactory } from './core'; 9 | 10 | export interface ClientInterface { 11 | getRequestBuilderFactory(): SdkRequestBuilderFactory; 12 | } 13 | 14 | export type SdkRequestBuilderFactory = RequestBuilderFactory< 15 | Server, 16 | AuthParams 17 | >; 18 | 19 | export type SdkRequestBuilder = ReturnType; 20 | 21 | export type Server = 'default'; 22 | 23 | export type AuthParams = ReturnType< 24 | typeof createAuthProviderFromConfig 25 | > extends AuthenticatorInterface 26 | ? X 27 | : never; 28 | -------------------------------------------------------------------------------- /src/configuration.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { HttpClientOptions } from './clientAdapter'; 8 | 9 | /** An interface for all configuration parameters required by the SDK. */ 10 | export interface Configuration { 11 | timeout: number; 12 | serviceRefererName: string; 13 | environment: Environment; 14 | /** @deprecated use basicAuthCredentials field instead */ 15 | basicAuthUserName?: string; 16 | /** @deprecated use basicAuthCredentials field instead */ 17 | basicAuthPassword?: string; 18 | basicAuthCredentials?: { 19 | username: string; 20 | password: string; 21 | }; 22 | httpClientOptions?: Partial; 23 | unstable_httpClientOptions?: any; 24 | } 25 | 26 | /** Environments available for API */ 27 | export enum Environment { 28 | Production = 'production', 29 | } 30 | -------------------------------------------------------------------------------- /src/controllers/baseController.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { ClientInterface, SdkRequestBuilderFactory } from '../clientInterface'; 8 | 9 | /** Base class for all controllers */ 10 | export class BaseController { 11 | /** Create a request builder */ 12 | protected createRequest: SdkRequestBuilderFactory; 13 | 14 | constructor(client: ClientInterface) { 15 | this.createRequest = client.getRequestBuilderFactory(); 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /src/core.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | export * from '@apimatic/core'; 8 | -------------------------------------------------------------------------------- /src/defaultConfiguration.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { Configuration, Environment } from './configuration'; 8 | import { RetryConfiguration } from './core'; 9 | 10 | /** Default values for the configuration parameters of the client. */ 11 | export const DEFAULT_CONFIGURATION: Configuration = { 12 | timeout: 0, 13 | serviceRefererName: '', 14 | environment: Environment.Production, 15 | }; 16 | 17 | /** Default values for retry configuration parameters. */ 18 | export const DEFAULT_RETRY_CONFIG: RetryConfiguration = { 19 | maxNumberOfRetries: 0, 20 | retryOnTimeout: true, 21 | retryInterval: 1, 22 | maximumRetryWaitTime: 0, 23 | backoffFactor: 2, 24 | httpStatusCodesToRetry: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], 25 | httpMethodsToRetry: ['GET', 'PUT'], 26 | }; 27 | -------------------------------------------------------------------------------- /src/errors/customError.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { ApiError } from '../core'; 8 | 9 | /** 10 | * Creates an instance of Custom 11 | */ 12 | interface Custom { 13 | message: string | null; 14 | errors?: unknown | null; 15 | request?: unknown | null; 16 | } 17 | 18 | export class CustomError extends ApiError {} 19 | -------------------------------------------------------------------------------- /src/models/createAccessTokenRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, optional, Schema } from '../schema'; 8 | 9 | /** Request for creating a new Access Token */ 10 | export interface CreateAccessTokenRequest { 11 | /** Minutes to expire the token */ 12 | expiresIn?: number; 13 | } 14 | 15 | export const createAccessTokenRequestSchema: Schema = object( 16 | { expiresIn: ['expires_in', optional(number())] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/createAnticipationRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, Schema, string } from '../schema'; 8 | 9 | /** Request for creating an anticipation */ 10 | export interface CreateAnticipationRequest { 11 | /** Amount requested for the anticipation */ 12 | amount: number; 13 | /** Timeframe */ 14 | timeframe: string; 15 | /** Payment date */ 16 | paymentDate: string; 17 | } 18 | 19 | export const createAnticipationRequestSchema: Schema = object( 20 | { 21 | amount: ['amount', number()], 22 | timeframe: ['timeframe', string()], 23 | paymentDate: ['payment_date', string()], 24 | } 25 | ); 26 | -------------------------------------------------------------------------------- /src/models/createAntifraudRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, object, Schema, string } from '../schema'; 8 | import { 9 | CreateClearSaleRequest, 10 | createClearSaleRequestSchema, 11 | } from './createClearSaleRequest'; 12 | 13 | export interface CreateAntifraudRequest { 14 | type: string; 15 | clearsale: CreateClearSaleRequest; 16 | } 17 | 18 | export const createAntifraudRequestSchema: Schema = object( 19 | { 20 | type: ['type', string()], 21 | clearsale: ['clearsale', lazy(() => createClearSaleRequestSchema)], 22 | } 23 | ); 24 | -------------------------------------------------------------------------------- /src/models/createApplePayHeaderRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, optional, Schema, string } from '../schema'; 8 | 9 | /** The ApplePay header request */ 10 | export interface CreateApplePayHeaderRequest { 11 | /** SHA–256 hash, Base64 string codified */ 12 | publicKeyHash?: string; 13 | /** X.509 encoded key bytes, Base64 encoded as a string */ 14 | ephemeralPublicKey: string; 15 | /** Transaction identifier, generated on Device */ 16 | transactionId?: string; 17 | } 18 | 19 | export const createApplePayHeaderRequestSchema: Schema = object( 20 | { 21 | publicKeyHash: ['public_key_hash', optional(string())], 22 | ephemeralPublicKey: ['ephemeral_public_key', string()], 23 | transactionId: ['transaction_id', optional(string())], 24 | } 25 | ); 26 | -------------------------------------------------------------------------------- /src/models/createAutomaticAnticipationSettingsRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, boolean, number, object, Schema, string } from '../schema'; 8 | 9 | export interface CreateAutomaticAnticipationSettingsRequest { 10 | enabled: boolean; 11 | type: string; 12 | volumePercentage: number; 13 | delay: number; 14 | days: number[]; 15 | } 16 | 17 | export const createAutomaticAnticipationSettingsRequestSchema: Schema = object( 18 | { 19 | enabled: ['enabled', boolean()], 20 | type: ['type', string()], 21 | volumePercentage: ['volume_percentage', number()], 22 | delay: ['delay', number()], 23 | days: ['days', array(number())], 24 | } 25 | ); 26 | -------------------------------------------------------------------------------- /src/models/createBankTransferPaymentRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, Schema, string } from '../schema'; 8 | 9 | /** Request for creating a bank transfer payment */ 10 | export interface CreateBankTransferPaymentRequest { 11 | /** Bank */ 12 | bank: string; 13 | /** Number of retries */ 14 | retries: number; 15 | } 16 | 17 | export const createBankTransferPaymentRequestSchema: Schema = object( 18 | { bank: ['bank', string()], retries: ['retries', number()] } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/createCancelChargeSplitRulesRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, Schema, string } from '../schema'; 8 | 9 | /** Creates a refund with split rules */ 10 | export interface CreateCancelChargeSplitRulesRequest { 11 | /** The split rule gateway id */ 12 | id: string; 13 | /** The split rule amount */ 14 | amount: number; 15 | /** The amount type (flat ou percentage) */ 16 | type: string; 17 | } 18 | 19 | export const createCancelChargeSplitRulesRequestSchema: Schema = object( 20 | { 21 | id: ['id', string()], 22 | amount: ['Amount', number()], 23 | type: ['type', string()], 24 | } 25 | ); 26 | -------------------------------------------------------------------------------- /src/models/createCancelSubscriptionRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { boolean, object, Schema } from '../schema'; 8 | 9 | /** Request for canceling a subscription */ 10 | export interface CreateCancelSubscriptionRequest { 11 | /** Indicates if the pending invoices must also be canceled. */ 12 | cancelPendingInvoices: boolean; 13 | } 14 | 15 | export const createCancelSubscriptionRequestSchema: Schema = object( 16 | { cancelPendingInvoices: ['cancel_pending_invoices', boolean()] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/createCardOptionsRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { boolean, object, Schema } from '../schema'; 8 | 9 | /** Options for creating the card */ 10 | export interface CreateCardOptionsRequest { 11 | /** Indicates if the card should be verified before creation. If true, executes an authorization before saving the card. */ 12 | verifyCard: boolean; 13 | } 14 | 15 | export const createCardOptionsRequestSchema: Schema = object( 16 | { verifyCard: ['verify_card', boolean()] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/createCardPayloadRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, nullable, object, optional, Schema, string } from '../schema'; 8 | import { 9 | CreateGooglePayRequest, 10 | createGooglePayRequestSchema, 11 | } from './createGooglePayRequest'; 12 | 13 | export interface CreateCardPayloadRequest { 14 | type?: string | null; 15 | googlePay?: CreateGooglePayRequest | null; 16 | } 17 | 18 | export const createCardPayloadRequestSchema: Schema = object( 19 | { 20 | type: ['type', optional(nullable(string()))], 21 | googlePay: [ 22 | 'google_pay', 23 | optional(nullable(lazy(() => createGooglePayRequestSchema))), 24 | ], 25 | } 26 | ); 27 | -------------------------------------------------------------------------------- /src/models/createCardPaymentContactlessPOIRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | export interface CreateCardPaymentContactlessPOIRequest { 10 | /** system name */ 11 | systemName: string; 12 | /** model */ 13 | model: string; 14 | /** provider */ 15 | provider: string; 16 | /** serial number */ 17 | serialNumber: string; 18 | /** version number */ 19 | versionNumber: string; 20 | } 21 | 22 | export const createCardPaymentContactlessPOIRequestSchema: Schema = object( 23 | { 24 | systemName: ['system_name', string()], 25 | model: ['model', string()], 26 | provider: ['provider', string()], 27 | serialNumber: ['serial_number', string()], 28 | versionNumber: ['version_number', string()], 29 | } 30 | ); 31 | -------------------------------------------------------------------------------- /src/models/createCashPaymentRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { boolean, object, Schema, string } from '../schema'; 8 | 9 | export interface CreateCashPaymentRequest { 10 | /** Description */ 11 | description: string; 12 | /** Indicates whether cash collection will be confirmed in the act of creation */ 13 | confirm: boolean; 14 | } 15 | 16 | export const createCashPaymentRequestSchema: Schema = object( 17 | { description: ['description', string()], confirm: ['confirm', boolean()] } 18 | ); 19 | -------------------------------------------------------------------------------- /src/models/createCheckoutBankTransferRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, number, object, Schema, string } from '../schema'; 8 | 9 | /** Checkout bank transfer payment request */ 10 | export interface CreateCheckoutBankTransferRequest { 11 | /** Bank */ 12 | bank: string[]; 13 | /** Number of retries for processing */ 14 | retries: number; 15 | } 16 | 17 | export const createCheckoutBankTransferRequestSchema: Schema = object( 18 | { bank: ['bank', array(string())], retries: ['retries', number()] } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/createCheckoutBoletoPaymentRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | export interface CreateCheckoutBoletoPaymentRequest { 10 | /** Bank identifier */ 11 | bank: string; 12 | /** Instructions */ 13 | instructions: string; 14 | /** Due date */ 15 | dueAt: string; 16 | } 17 | 18 | export const createCheckoutBoletoPaymentRequestSchema: Schema = object( 19 | { 20 | bank: ['bank', string()], 21 | instructions: ['instructions', string()], 22 | dueAt: ['due_at', string()], 23 | } 24 | ); 25 | -------------------------------------------------------------------------------- /src/models/createCheckoutCardInstallmentOptionRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, Schema } from '../schema'; 8 | 9 | /** Options for card installment */ 10 | export interface CreateCheckoutCardInstallmentOptionRequest { 11 | /** Installment quantity */ 12 | number: number; 13 | /** Total amount */ 14 | total: number; 15 | } 16 | 17 | export const createCheckoutCardInstallmentOptionRequestSchema: Schema = object( 18 | { number: ['number', number()], total: ['total', number()] } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/createCheckoutDebitCardPaymentRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, object, optional, Schema, string } from '../schema'; 8 | import { 9 | CreatePaymentAuthenticationRequest, 10 | createPaymentAuthenticationRequestSchema, 11 | } from './createPaymentAuthenticationRequest'; 12 | 13 | /** Checkout credit card payment request */ 14 | export interface CreateCheckoutDebitCardPaymentRequest { 15 | /** Card invoice text descriptor */ 16 | statementDescriptor?: string; 17 | /** Creates payment authentication */ 18 | authentication: CreatePaymentAuthenticationRequest; 19 | } 20 | 21 | export const createCheckoutDebitCardPaymentRequestSchema: Schema = object( 22 | { 23 | statementDescriptor: ['statement_descriptor', optional(string())], 24 | authentication: [ 25 | 'authentication', 26 | lazy(() => createPaymentAuthenticationRequestSchema), 27 | ], 28 | } 29 | ); 30 | -------------------------------------------------------------------------------- /src/models/createClearSaleRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, Schema } from '../schema'; 8 | 9 | export interface CreateClearSaleRequest { 10 | customSla: number; 11 | } 12 | 13 | export const createClearSaleRequestSchema: Schema = object( 14 | { customSla: ['custom_sla', number()] } 15 | ); 16 | -------------------------------------------------------------------------------- /src/models/createConfirmPaymentRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface CreateConfirmPaymentRequest { 10 | /** Description */ 11 | description: string; 12 | /** Amount */ 13 | amount?: number; 14 | /** Code reference */ 15 | code: string; 16 | } 17 | 18 | export const createConfirmPaymentRequestSchema: Schema = object( 19 | { 20 | description: ['description', string()], 21 | amount: ['Amount', optional(number())], 22 | code: ['Code', string()], 23 | } 24 | ); 25 | -------------------------------------------------------------------------------- /src/models/createDeviceRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, optional, Schema, string } from '../schema'; 8 | 9 | /** Request for creating a device */ 10 | export interface CreateDeviceRequest { 11 | /** Device's platform */ 12 | platform?: string; 13 | } 14 | 15 | export const createDeviceRequestSchema: Schema = object({ 16 | platform: ['platform', optional(string())], 17 | }); 18 | -------------------------------------------------------------------------------- /src/models/createDiscountRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Request for creating a new discount */ 10 | export interface CreateDiscountRequest { 11 | /** The discount value */ 12 | value: number; 13 | /** Discount type. Can be either flat or percentage. */ 14 | discountType: string; 15 | /** The item where the discount will be applied */ 16 | itemId: string; 17 | /** Number of cycles that the discount will be applied */ 18 | cycles?: number; 19 | /** Description */ 20 | description?: string; 21 | } 22 | 23 | export const createDiscountRequestSchema: Schema = object( 24 | { 25 | value: ['value', number()], 26 | discountType: ['discount_type', string()], 27 | itemId: ['item_id', string()], 28 | cycles: ['cycles', optional(number())], 29 | description: ['description', optional(string())], 30 | } 31 | ); 32 | -------------------------------------------------------------------------------- /src/models/createEmvDataDukptDecryptRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | export interface CreateEmvDataDukptDecryptRequest { 10 | /** Key serial number */ 11 | ksn: string; 12 | } 13 | 14 | export const createEmvDataDukptDecryptRequestSchema: Schema = object( 15 | { ksn: ['ksn', string()] } 16 | ); 17 | -------------------------------------------------------------------------------- /src/models/createEmvDataTlvDecryptRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | export interface CreateEmvDataTlvDecryptRequest { 10 | /** Emv tag */ 11 | tag: string; 12 | /** Emv lenght */ 13 | lenght: string; 14 | /** Emv value */ 15 | value: string; 16 | } 17 | 18 | export const createEmvDataTlvDecryptRequestSchema: Schema = object( 19 | { 20 | tag: ['tag', string()], 21 | lenght: ['lenght', string()], 22 | value: ['value', string()], 23 | } 24 | ); 25 | -------------------------------------------------------------------------------- /src/models/createFineRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, Schema, string } from '../schema'; 8 | 9 | /** Fine Request */ 10 | export interface CreateFineRequest { 11 | /** Days */ 12 | days: number; 13 | /** Type */ 14 | type: string; 15 | /** Amount */ 16 | amount: number; 17 | } 18 | 19 | export const createFineRequestSchema: Schema = object({ 20 | days: ['days', number()], 21 | type: ['type', string()], 22 | amount: ['amount', number()], 23 | }); 24 | -------------------------------------------------------------------------------- /src/models/createGooglePayHeaderRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | /** The GooglePay header request */ 10 | export interface CreateGooglePayHeaderRequest { 11 | /** X.509 encoded key bytes, Base64 encoded as a string */ 12 | ephemeralPublicKey: string; 13 | } 14 | 15 | export const createGooglePayHeaderRequestSchema: Schema = object( 16 | { ephemeralPublicKey: ['ephemeral_public_key', string()] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/createGooglePayIntermediateSigningKeyRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** The GooglePay Intermediate Signing Key Request */ 10 | export interface CreateGooglePayIntermediateSigningKeyRequest { 11 | /** Uma mensagem codificada em Base64 com a descrição de pagamento da chave. */ 12 | signedKey?: string | null; 13 | /** Verifica se a origem da chave de assinatura intermediária é o Google. É codificada em Base64 e criada usando o ECDSA. */ 14 | signatures?: string[] | null; 15 | } 16 | 17 | export const createGooglePayIntermediateSigningKeyRequestSchema: Schema = object( 18 | { 19 | signedKey: ['signed_key', optional(nullable(string()))], 20 | signatures: ['signatures', optional(nullable(array(string())))], 21 | } 22 | ); 23 | -------------------------------------------------------------------------------- /src/models/createInterestRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, Schema, string } from '../schema'; 8 | 9 | /** Interest Request */ 10 | export interface CreateInterestRequest { 11 | /** Days */ 12 | days: number; 13 | /** Type */ 14 | type: string; 15 | /** Amount */ 16 | amount: number; 17 | } 18 | 19 | export const createInterestRequestSchema: Schema = object( 20 | { 21 | days: ['days', number()], 22 | type: ['type', string()], 23 | amount: ['amount', number()], 24 | } 25 | ); 26 | -------------------------------------------------------------------------------- /src/models/createInvoiceRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { dict, object, Schema, string } from '../schema'; 8 | 9 | /** Request for creating a new Invoice */ 10 | export interface CreateInvoiceRequest { 11 | /** Metadata */ 12 | metadata: Record; 13 | } 14 | 15 | export const createInvoiceRequestSchema: Schema = object({ 16 | metadata: ['metadata', dict(string())], 17 | }); 18 | -------------------------------------------------------------------------------- /src/models/createKYCLinkResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** KYC Link */ 10 | export interface CreateKYCLinkResponse { 11 | /** Base64 */ 12 | base64?: string | null; 13 | /** URL */ 14 | url?: string | null; 15 | /** Expiration Date */ 16 | expirationDate?: string | null; 17 | } 18 | 19 | export const createKYCLinkResponseSchema: Schema = object( 20 | { 21 | base64: ['base64', optional(nullable(string()))], 22 | url: ['url', optional(nullable(string()))], 23 | expirationDate: ['expiration_date', optional(nullable(string()))], 24 | } 25 | ); 26 | -------------------------------------------------------------------------------- /src/models/createLocationRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | /** Request for creating a location */ 10 | export interface CreateLocationRequest { 11 | /** Latitude */ 12 | latitude: string; 13 | /** Longitude */ 14 | longitude: string; 15 | } 16 | 17 | export const createLocationRequestSchema: Schema = object( 18 | { latitude: ['latitude', string()], longitude: ['longitude', string()] } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/createOrderItemRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Request for creating an order item */ 10 | export interface CreateOrderItemRequest { 11 | /** Amount */ 12 | amount: number; 13 | /** Description */ 14 | description: string; 15 | /** Quantity */ 16 | quantity: number; 17 | /** Category */ 18 | category: string; 19 | /** The item code passed by the client */ 20 | code?: string; 21 | } 22 | 23 | export const createOrderItemRequestSchema: Schema = object( 24 | { 25 | amount: ['amount', number()], 26 | description: ['description', string()], 27 | quantity: ['quantity', number()], 28 | category: ['category', string()], 29 | code: ['code', optional(string())], 30 | } 31 | ); 32 | -------------------------------------------------------------------------------- /src/models/createPaymentAuthenticationRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, object, Schema, string } from '../schema'; 8 | import { 9 | CreateThreeDSecureRequest, 10 | createThreeDSecureRequestSchema, 11 | } from './createThreeDSecureRequest'; 12 | 13 | /** The payment authentication request */ 14 | export interface CreatePaymentAuthenticationRequest { 15 | /** The Authentication type */ 16 | type: string; 17 | /** The 3D-S authentication object */ 18 | threedSecure: CreateThreeDSecureRequest; 19 | } 20 | 21 | export const createPaymentAuthenticationRequestSchema: Schema = object( 22 | { 23 | type: ['type', string()], 24 | threedSecure: [ 25 | 'threed_secure', 26 | lazy(() => createThreeDSecureRequestSchema), 27 | ], 28 | } 29 | ); 30 | -------------------------------------------------------------------------------- /src/models/createPaymentOriginRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Request object for PaymentOrigin */ 10 | export interface CreatePaymentOriginRequest { 11 | brandId?: string | null; 12 | chargeId?: string | null; 13 | } 14 | 15 | export const createPaymentOriginRequestSchema: Schema = object( 16 | { 17 | brandId: ['brand_id', optional(nullable(string()))], 18 | chargeId: ['charge_id', optional(nullable(string()))], 19 | } 20 | ); 21 | -------------------------------------------------------------------------------- /src/models/createPeriodRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, optional, Schema, string } from '../schema'; 8 | 9 | export interface CreatePeriodRequest { 10 | endAt?: string; 11 | } 12 | 13 | export const createPeriodRequestSchema: Schema = object({ 14 | endAt: ['end_at', optional(string())], 15 | }); 16 | -------------------------------------------------------------------------------- /src/models/createPhoneRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface CreatePhoneRequest { 10 | countryCode?: string; 11 | number?: string; 12 | areaCode?: string; 13 | type?: string | null; 14 | } 15 | 16 | export const createPhoneRequestSchema: Schema = object({ 17 | countryCode: ['country_code', optional(string())], 18 | number: ['number', optional(string())], 19 | areaCode: ['area_code', optional(string())], 20 | type: ['Type', optional(nullable(string()))], 21 | }); 22 | -------------------------------------------------------------------------------- /src/models/createPhonesRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, object, optional, Schema } from '../schema'; 8 | import { 9 | CreatePhoneRequest, 10 | createPhoneRequestSchema, 11 | } from './createPhoneRequest'; 12 | 13 | export interface CreatePhonesRequest { 14 | homePhone?: CreatePhoneRequest; 15 | mobilePhone?: CreatePhoneRequest; 16 | } 17 | 18 | export const createPhonesRequestSchema: Schema = object({ 19 | homePhone: ['home_phone', optional(lazy(() => createPhoneRequestSchema))], 20 | mobilePhone: ['mobile_phone', optional(lazy(() => createPhoneRequestSchema))], 21 | }); 22 | -------------------------------------------------------------------------------- /src/models/createPriceBracketRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, optional, Schema } from '../schema'; 8 | 9 | /** Request for creating a price bracket */ 10 | export interface CreatePriceBracketRequest { 11 | /** Start quantity */ 12 | startQuantity: number; 13 | /** Price */ 14 | price: number; 15 | /** End quantity */ 16 | endQuantity?: number; 17 | /** Overage price */ 18 | overagePrice?: number; 19 | } 20 | 21 | export const createPriceBracketRequestSchema: Schema = object( 22 | { 23 | startQuantity: ['start_quantity', number()], 24 | price: ['price', number()], 25 | endQuantity: ['end_quantity', optional(number())], 26 | overagePrice: ['overage_price', optional(number())], 27 | } 28 | ); 29 | -------------------------------------------------------------------------------- /src/models/createRegisterInformationPhoneRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | /** Register Information Phone */ 10 | export interface CreateRegisterInformationPhoneRequest { 11 | ddd: string; 12 | number: string; 13 | type: string; 14 | } 15 | 16 | export const createRegisterInformationPhoneRequestSchema: Schema = object( 17 | { 18 | ddd: ['ddd', string()], 19 | number: ['number', string()], 20 | type: ['type', string()], 21 | } 22 | ); 23 | -------------------------------------------------------------------------------- /src/models/createSetupRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, number, object, Schema, string } from '../schema'; 8 | import { 9 | CreatePaymentRequest, 10 | createPaymentRequestSchema, 11 | } from './createPaymentRequest'; 12 | 13 | /** Request for creating a Setup for a subscription. The setup is an order that will be created at the subscription creation. */ 14 | export interface CreateSetupRequest { 15 | /** Setup amount */ 16 | amount: number; 17 | /** Description */ 18 | description: string; 19 | /** Payment data */ 20 | payment: CreatePaymentRequest; 21 | } 22 | 23 | export const createSetupRequestSchema: Schema = object({ 24 | amount: ['amount', number()], 25 | description: ['description', string()], 26 | payment: ['payment', lazy(() => createPaymentRequestSchema)], 27 | }); 28 | -------------------------------------------------------------------------------- /src/models/createSplitOptionsRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { boolean, object, optional, Schema } from '../schema'; 8 | 9 | /** The Split Options Request */ 10 | export interface CreateSplitOptionsRequest { 11 | /** Liable options */ 12 | liable?: boolean; 13 | /** Charge processing fee */ 14 | chargeProcessingFee?: boolean; 15 | chargeRemainderFee?: boolean; 16 | } 17 | 18 | export const createSplitOptionsRequestSchema: Schema = object( 19 | { 20 | liable: ['liable', optional(boolean())], 21 | chargeProcessingFee: ['charge_processing_fee', optional(boolean())], 22 | chargeRemainderFee: ['charge_remainder_fee', optional(boolean())], 23 | } 24 | ); 25 | -------------------------------------------------------------------------------- /src/models/createSubscriptionSplitRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, boolean, lazy, object, Schema } from '../schema'; 8 | import { 9 | CreateSplitRequest, 10 | createSplitRequestSchema, 11 | } from './createSplitRequest'; 12 | 13 | export interface CreateSubscriptionSplitRequest { 14 | /** Defines if the split is enabled */ 15 | enabled: boolean; 16 | /** Split */ 17 | rules: CreateSplitRequest[]; 18 | } 19 | 20 | export const createSubscriptionSplitRequestSchema: Schema = object( 21 | { 22 | enabled: ['enabled', boolean()], 23 | rules: ['rules', array(lazy(() => createSplitRequestSchema))], 24 | } 25 | ); 26 | -------------------------------------------------------------------------------- /src/models/createTokenRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, object, Schema, string } from '../schema'; 8 | import { 9 | CreateCardTokenRequest, 10 | createCardTokenRequestSchema, 11 | } from './createCardTokenRequest'; 12 | 13 | /** Token data */ 14 | export interface CreateTokenRequest { 15 | /** Token type */ 16 | type: string; 17 | /** Card data */ 18 | card: CreateCardTokenRequest; 19 | } 20 | 21 | export const createTokenRequestSchema: Schema = object({ 22 | type: ['type', string()], 23 | card: ['card', lazy(() => createCardTokenRequestSchema)], 24 | }); 25 | -------------------------------------------------------------------------------- /src/models/createTransactionReportFileRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, optional, Schema, string } from '../schema'; 8 | 9 | export interface CreateTransactionReportFileRequest { 10 | name: string; 11 | startAt?: string; 12 | endAt?: string; 13 | } 14 | 15 | export const createTransactionReportFileRequestSchema: Schema = object( 16 | { 17 | name: ['name', string()], 18 | startAt: ['start_at', optional(string())], 19 | endAt: ['end_at', optional(string())], 20 | } 21 | ); 22 | -------------------------------------------------------------------------------- /src/models/createTransfer.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, number, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface CreateTransfer { 10 | amount: number; 11 | sourceId: string; 12 | targetId: string; 13 | metadata?: string[]; 14 | } 15 | 16 | export const createTransferSchema: Schema = object({ 17 | amount: ['amount', number()], 18 | sourceId: ['source_id', string()], 19 | targetId: ['target_id', string()], 20 | metadata: ['metadata', optional(array(string()))], 21 | }); 22 | -------------------------------------------------------------------------------- /src/models/createTransferRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { dict, number, object, Schema, string } from '../schema'; 8 | 9 | /** Request for creating a transfer */ 10 | export interface CreateTransferRequest { 11 | /** Transfer amount */ 12 | amount: number; 13 | /** Metadata */ 14 | metadata: Record; 15 | } 16 | 17 | export const createTransferRequestSchema: Schema = object( 18 | { amount: ['amount', number()], metadata: ['metadata', dict(string())] } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/createTransferSettingsRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { boolean, number, object, Schema, string } from '../schema'; 8 | 9 | /** Informações de transferência do recebedor */ 10 | export interface CreateTransferSettingsRequest { 11 | transferEnabled: boolean; 12 | transferInterval: string; 13 | transferDay: number; 14 | } 15 | 16 | export const createTransferSettingsRequestSchema: Schema = object( 17 | { 18 | transferEnabled: ['transfer_enabled', boolean()], 19 | transferInterval: ['transfer_interval', string()], 20 | transferDay: ['transfer_day', number()], 21 | } 22 | ); 23 | -------------------------------------------------------------------------------- /src/models/createUsageRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Request for creating a usage */ 10 | export interface CreateUsageRequest { 11 | quantity: number; 12 | description: string; 13 | usedAt: string; 14 | /** Identification code in the client system */ 15 | code?: string; 16 | /** identification group in the client system */ 17 | group?: string; 18 | /** Field used in item scheme type 'Percent' */ 19 | amount?: number; 20 | } 21 | 22 | export const createUsageRequestSchema: Schema = object({ 23 | quantity: ['quantity', number()], 24 | description: ['description', string()], 25 | usedAt: ['used_at', string()], 26 | code: ['code', optional(string())], 27 | group: ['group', optional(string())], 28 | amount: ['amount', optional(number())], 29 | }); 30 | -------------------------------------------------------------------------------- /src/models/createWithdrawRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { dict, number, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface CreateWithdrawRequest { 10 | amount: number; 11 | metadata?: Record; 12 | } 13 | 14 | export const createWithdrawRequestSchema: Schema = object( 15 | { 16 | amount: ['amount', number()], 17 | metadata: ['metadata', optional(dict(string()))], 18 | } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/getAnticipationLimitResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, number, object, optional, Schema } from '../schema'; 8 | 9 | /** Anticipation limit */ 10 | export interface GetAnticipationLimitResponse { 11 | /** Amount */ 12 | amount?: number | null; 13 | /** Anticipation fee */ 14 | anticipationFee?: number | null; 15 | } 16 | 17 | export const getAnticipationLimitResponseSchema: Schema = object( 18 | { 19 | amount: ['amount', optional(nullable(number()))], 20 | anticipationFee: ['anticipation_fee', optional(nullable(number()))], 21 | } 22 | ); 23 | -------------------------------------------------------------------------------- /src/models/getAnticipationLimitsResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetAnticipationLimitResponse, 10 | getAnticipationLimitResponseSchema, 11 | } from './getAnticipationLimitResponse'; 12 | 13 | /** Anticipation limits */ 14 | export interface GetAnticipationLimitsResponse { 15 | /** Max limit */ 16 | max?: GetAnticipationLimitResponse | null; 17 | /** Min limit */ 18 | min?: GetAnticipationLimitResponse | null; 19 | } 20 | 21 | export const getAnticipationLimitsResponseSchema: Schema = object( 22 | { 23 | max: [ 24 | 'max', 25 | optional(nullable(lazy(() => getAnticipationLimitResponseSchema))), 26 | ], 27 | min: [ 28 | 'min', 29 | optional(nullable(lazy(() => getAnticipationLimitResponseSchema))), 30 | ], 31 | } 32 | ); 33 | -------------------------------------------------------------------------------- /src/models/getAntifraudResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetAntifraudResponse { 10 | status?: string | null; 11 | returnCode?: string | null; 12 | returnMessage?: string | null; 13 | providerName?: string | null; 14 | score?: string | null; 15 | } 16 | 17 | export const getAntifraudResponseSchema: Schema = object({ 18 | status: ['status', optional(nullable(string()))], 19 | returnCode: ['return_code', optional(nullable(string()))], 20 | returnMessage: ['return_message', optional(nullable(string()))], 21 | providerName: ['provider_name', optional(nullable(string()))], 22 | score: ['score', optional(nullable(string()))], 23 | }); 24 | -------------------------------------------------------------------------------- /src/models/getAutomaticAnticipationResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { 8 | array, 9 | boolean, 10 | nullable, 11 | number, 12 | object, 13 | optional, 14 | Schema, 15 | string, 16 | } from '../schema'; 17 | 18 | export interface GetAutomaticAnticipationResponse { 19 | enabled?: boolean | null; 20 | type?: string | null; 21 | volumePercentage?: number | null; 22 | delay?: number | null; 23 | days?: number[] | null; 24 | } 25 | 26 | export const getAutomaticAnticipationResponseSchema: Schema = object( 27 | { 28 | enabled: ['enabled', optional(nullable(boolean()))], 29 | type: ['type', optional(nullable(string()))], 30 | volumePercentage: ['volume_percentage', optional(nullable(number()))], 31 | delay: ['delay', optional(nullable(number()))], 32 | days: ['days', optional(nullable(array(number())))], 33 | } 34 | ); 35 | -------------------------------------------------------------------------------- /src/models/getChargesSummaryResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, number, object, optional, Schema } from '../schema'; 8 | 9 | export interface GetChargesSummaryResponse { 10 | total?: number | null; 11 | } 12 | 13 | export const getChargesSummaryResponseSchema: Schema = object( 14 | { total: ['total', optional(nullable(number()))] } 15 | ); 16 | -------------------------------------------------------------------------------- /src/models/getCheckoutBankTransferPaymentResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Bank transfer checkout response */ 10 | export interface GetCheckoutBankTransferPaymentResponse { 11 | /** bank list response */ 12 | bank?: string[] | null; 13 | } 14 | 15 | export const getCheckoutBankTransferPaymentResponseSchema: Schema = object( 16 | { bank: ['bank', optional(nullable(array(string())))] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/getCheckoutBoletoPaymentResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetCheckoutBoletoPaymentResponse { 10 | /** Data de vencimento do boleto */ 11 | dueAt?: string | null; 12 | /** Instruções do boleto */ 13 | instructions?: string | null; 14 | } 15 | 16 | export const getCheckoutBoletoPaymentResponseSchema: Schema = object( 17 | { 18 | dueAt: ['due_at', optional(nullable(string()))], 19 | instructions: ['instructions', optional(nullable(string()))], 20 | } 21 | ); 22 | -------------------------------------------------------------------------------- /src/models/getCheckoutCardInstallmentOptionsResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { bigint, nullable, number, object, Schema } from '../schema'; 8 | 9 | export interface GetCheckoutCardInstallmentOptionsResponse { 10 | /** Número de parcelas */ 11 | number: bigint | null; 12 | /** Valor total da compra */ 13 | total: number | null; 14 | } 15 | 16 | export const getCheckoutCardInstallmentOptionsResponseSchema: Schema = object( 17 | { 18 | number: ['number', nullable(bigint())], 19 | total: ['total', nullable(number())], 20 | } 21 | ); 22 | -------------------------------------------------------------------------------- /src/models/getCheckoutDebitCardPaymentResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, nullable, object, optional, Schema, string } from '../schema'; 8 | import { 9 | GetPaymentAuthenticationResponse, 10 | getPaymentAuthenticationResponseSchema, 11 | } from './getPaymentAuthenticationResponse'; 12 | 13 | export interface GetCheckoutDebitCardPaymentResponse { 14 | /** Descrição na fatura */ 15 | statementDescriptor?: string | null; 16 | /** Payment Authentication response object data */ 17 | authentication?: GetPaymentAuthenticationResponse | null; 18 | } 19 | 20 | export const getCheckoutDebitCardPaymentResponseSchema: Schema = object( 21 | { 22 | statementDescriptor: ['statement_descriptor', optional(nullable(string()))], 23 | authentication: [ 24 | 'authentication', 25 | optional(nullable(lazy(() => getPaymentAuthenticationResponseSchema))), 26 | ], 27 | } 28 | ); 29 | -------------------------------------------------------------------------------- /src/models/getDeviceResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Response object for geetting an order device */ 10 | export interface GetDeviceResponse { 11 | /** Device's platform name */ 12 | platform?: string | null; 13 | } 14 | 15 | export const getDeviceResponseSchema: Schema = object({ 16 | platform: ['platform', optional(nullable(string()))], 17 | }); 18 | -------------------------------------------------------------------------------- /src/models/getFineResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, number, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Fine Response */ 10 | export interface GetFineResponse { 11 | /** Days */ 12 | days?: number | null; 13 | /** Type */ 14 | type?: string | null; 15 | /** Amount */ 16 | amount?: number | null; 17 | } 18 | 19 | export const getFineResponseSchema: Schema = object({ 20 | days: ['days', optional(nullable(number()))], 21 | type: ['type', optional(nullable(string()))], 22 | amount: ['amount', optional(nullable(number()))], 23 | }); 24 | -------------------------------------------------------------------------------- /src/models/getGatewayErrorResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Gateway Response */ 10 | export interface GetGatewayErrorResponse { 11 | /** The message error */ 12 | message?: string | null; 13 | } 14 | 15 | export const getGatewayErrorResponseSchema: Schema = object( 16 | { message: ['message', optional(nullable(string()))] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/getGatewayResponseResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { 8 | array, 9 | lazy, 10 | nullable, 11 | object, 12 | optional, 13 | Schema, 14 | string, 15 | } from '../schema'; 16 | import { 17 | GetGatewayErrorResponse, 18 | getGatewayErrorResponseSchema, 19 | } from './getGatewayErrorResponse'; 20 | 21 | /** The Transaction Gateway Response */ 22 | export interface GetGatewayResponseResponse { 23 | /** The error code */ 24 | code?: string | null; 25 | /** The gateway response errors list */ 26 | errors?: GetGatewayErrorResponse[] | null; 27 | } 28 | 29 | export const getGatewayResponseResponseSchema: Schema = object( 30 | { 31 | code: ['code', optional(nullable(string()))], 32 | errors: [ 33 | 'errors', 34 | optional(nullable(array(lazy(() => getGatewayErrorResponseSchema)))), 35 | ], 36 | } 37 | ); 38 | -------------------------------------------------------------------------------- /src/models/getIntegrationResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetIntegrationResponse { 10 | code?: string; 11 | } 12 | 13 | export const getIntegrationResponseSchema: Schema = object( 14 | { code: ['code', optional(string())] } 15 | ); 16 | -------------------------------------------------------------------------------- /src/models/getInterestResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, number, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Interest Response */ 10 | export interface GetInterestResponse { 11 | /** Days */ 12 | days?: number | null; 13 | /** Type */ 14 | type?: string | null; 15 | /** Amount */ 16 | amount?: number | null; 17 | } 18 | 19 | export const getInterestResponseSchema: Schema = object({ 20 | days: ['days', optional(nullable(number()))], 21 | type: ['type', optional(nullable(string()))], 22 | amount: ['amount', optional(nullable(number()))], 23 | }); 24 | -------------------------------------------------------------------------------- /src/models/getLocationResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Response object for geetting an order location request */ 10 | export interface GetLocationResponse { 11 | /** Latitude */ 12 | latitude?: string | null; 13 | /** Longitude */ 14 | longitude?: string | null; 15 | } 16 | 17 | export const getLocationResponseSchema: Schema = object({ 18 | latitude: ['latitude', optional(nullable(string()))], 19 | longitude: ['longitude', optional(nullable(string()))], 20 | }); 21 | -------------------------------------------------------------------------------- /src/models/getPaymentAuthenticationResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, nullable, object, optional, Schema, string } from '../schema'; 8 | import { 9 | GetThreeDSecureResponse, 10 | getThreeDSecureResponseSchema, 11 | } from './getThreeDSecureResponse'; 12 | 13 | /** Payment Authentication response */ 14 | export interface GetPaymentAuthenticationResponse { 15 | type?: string | null; 16 | /** 3D-S payment authentication response */ 17 | threedSecure?: GetThreeDSecureResponse | null; 18 | } 19 | 20 | export const getPaymentAuthenticationResponseSchema: Schema = object( 21 | { 22 | type: ['type', optional(nullable(string()))], 23 | threedSecure: [ 24 | 'threed_secure', 25 | optional(nullable(lazy(() => getThreeDSecureResponseSchema))), 26 | ], 27 | } 28 | ); 29 | -------------------------------------------------------------------------------- /src/models/getPaymentOriginResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetPaymentOriginResponse { 10 | chargeId?: string; 11 | brandId?: string; 12 | } 13 | 14 | export const getPaymentOriginResponseSchema: Schema = object( 15 | { 16 | chargeId: ['charge_id', optional(string())], 17 | brandId: ['brand_id', optional(string())], 18 | } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/getPhoneNumberResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Response object for getting an PhoneNumberResponse */ 10 | export interface GetPhoneNumberResponse { 11 | ddd?: string | null; 12 | number?: string | null; 13 | type?: string | null; 14 | } 15 | 16 | export const getPhoneNumberResponseSchema: Schema = object( 17 | { 18 | ddd: ['ddd', optional(nullable(string()))], 19 | number: ['number', optional(nullable(string()))], 20 | type: ['type', optional(nullable(string()))], 21 | } 22 | ); 23 | -------------------------------------------------------------------------------- /src/models/getPhoneResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetPhoneResponse { 10 | countryCode?: string | null; 11 | number?: string | null; 12 | areaCode?: string | null; 13 | } 14 | 15 | export const getPhoneResponseSchema: Schema = object({ 16 | countryCode: ['country_code', optional(nullable(string()))], 17 | number: ['number', optional(nullable(string()))], 18 | areaCode: ['area_code', optional(nullable(string()))], 19 | }); 20 | -------------------------------------------------------------------------------- /src/models/getPhonesResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { GetPhoneResponse, getPhoneResponseSchema } from './getPhoneResponse'; 9 | 10 | export interface GetPhonesResponse { 11 | homePhone?: GetPhoneResponse | null; 12 | mobilePhone?: GetPhoneResponse | null; 13 | } 14 | 15 | export const getPhonesResponseSchema: Schema = object({ 16 | homePhone: [ 17 | 'home_phone', 18 | optional(nullable(lazy(() => getPhoneResponseSchema))), 19 | ], 20 | mobilePhone: [ 21 | 'mobile_phone', 22 | optional(nullable(lazy(() => getPhoneResponseSchema))), 23 | ], 24 | }); 25 | -------------------------------------------------------------------------------- /src/models/getPixBankAccountResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Payer's bank details. */ 10 | export interface GetPixBankAccountResponse { 11 | bankName?: string | null; 12 | ispb?: string | null; 13 | branchCode?: string | null; 14 | accountNumber?: string | null; 15 | } 16 | 17 | export const getPixBankAccountResponseSchema: Schema = object( 18 | { 19 | bankName: ['bank_name', optional(nullable(string()))], 20 | ispb: ['ispb', optional(nullable(string()))], 21 | branchCode: ['branch_code', optional(nullable(string()))], 22 | accountNumber: ['account_number', optional(nullable(string()))], 23 | } 24 | ); 25 | -------------------------------------------------------------------------------- /src/models/getPixPayerResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, nullable, object, optional, Schema, string } from '../schema'; 8 | import { 9 | GetPixBankAccountResponse, 10 | getPixBankAccountResponseSchema, 11 | } from './getPixBankAccountResponse'; 12 | 13 | /** Pix payer data. */ 14 | export interface GetPixPayerResponse { 15 | name?: string | null; 16 | document?: string | null; 17 | documentType?: string | null; 18 | bankAccount?: GetPixBankAccountResponse | null; 19 | } 20 | 21 | export const getPixPayerResponseSchema: Schema = object({ 22 | name: ['name', optional(nullable(string()))], 23 | document: ['document', optional(nullable(string()))], 24 | documentType: ['document_type', optional(nullable(string()))], 25 | bankAccount: [ 26 | 'bank_account', 27 | optional(nullable(lazy(() => getPixBankAccountResponseSchema))), 28 | ], 29 | }); 30 | -------------------------------------------------------------------------------- /src/models/getPriceBracketResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, number, object, optional, Schema } from '../schema'; 8 | 9 | /** Response object for getting a price bracket */ 10 | export interface GetPriceBracketResponse { 11 | startQuantity?: number | null; 12 | price?: number | null; 13 | endQuantity?: number | null; 14 | overagePrice?: number | null; 15 | } 16 | 17 | export const getPriceBracketResponseSchema: Schema = object( 18 | { 19 | startQuantity: ['start_quantity', optional(nullable(number()))], 20 | price: ['price', optional(nullable(number()))], 21 | endQuantity: ['end_quantity', optional(nullable(number()))], 22 | overagePrice: ['overage_price', optional(nullable(number()))], 23 | } 24 | ); 25 | -------------------------------------------------------------------------------- /src/models/getRetryTransactionInformationResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, number, object, Schema, string } from '../schema'; 8 | 9 | /** Response object for getting an RetryTransactionInformation */ 10 | export interface GetRetryTransactionInformationResponse { 11 | brandFailureReturnCode: string | null; 12 | transactionLimit: number | null; 13 | transactionDateLimit: string | null; 14 | } 15 | 16 | export const getRetryTransactionInformationResponseSchema: Schema = object( 17 | { 18 | brandFailureReturnCode: ['brand_failure_return_code', nullable(string())], 19 | transactionLimit: ['transaction_limit', nullable(number())], 20 | transactionDateLimit: ['transaction_date_limit', nullable(string())], 21 | } 22 | ); 23 | -------------------------------------------------------------------------------- /src/models/getSetupResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, number, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Response object for getting the setup from a subscription */ 10 | export interface GetSetupResponse { 11 | id?: string | null; 12 | description?: string | null; 13 | amount?: number | null; 14 | status?: string | null; 15 | } 16 | 17 | export const getSetupResponseSchema: Schema = object({ 18 | id: ['id', optional(nullable(string()))], 19 | description: ['description', optional(nullable(string()))], 20 | amount: ['amount', optional(nullable(number()))], 21 | status: ['status', optional(nullable(string()))], 22 | }); 23 | -------------------------------------------------------------------------------- /src/models/getSplitOptionsResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { boolean, nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetSplitOptionsResponse { 10 | liable?: boolean | null; 11 | chargeProcessingFee?: boolean | null; 12 | chargeRemainderFee?: string | null; 13 | } 14 | 15 | export const getSplitOptionsResponseSchema: Schema = object( 16 | { 17 | liable: ['liable', optional(nullable(boolean()))], 18 | chargeProcessingFee: [ 19 | 'charge_processing_fee', 20 | optional(nullable(boolean())), 21 | ], 22 | chargeRemainderFee: ['charge_remainder_fee', optional(nullable(string()))], 23 | } 24 | ); 25 | -------------------------------------------------------------------------------- /src/models/getSubscriptionSplitResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { 8 | array, 9 | boolean, 10 | lazy, 11 | nullable, 12 | object, 13 | optional, 14 | Schema, 15 | } from '../schema'; 16 | import { GetSplitResponse, getSplitResponseSchema } from './getSplitResponse'; 17 | 18 | export interface GetSubscriptionSplitResponse { 19 | /** Defines if the split is enabled */ 20 | enabled?: boolean | null; 21 | /** Split */ 22 | rules?: GetSplitResponse[] | null; 23 | } 24 | 25 | export const getSubscriptionSplitResponseSchema: Schema = object( 26 | { 27 | enabled: ['enabled', optional(nullable(boolean()))], 28 | rules: [ 29 | 'rules', 30 | optional(nullable(array(lazy(() => getSplitResponseSchema)))), 31 | ], 32 | } 33 | ); 34 | -------------------------------------------------------------------------------- /src/models/getTokenResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, nullable, object, optional, Schema, string } from '../schema'; 8 | import { 9 | GetCardTokenResponse, 10 | getCardTokenResponseSchema, 11 | } from './getCardTokenResponse'; 12 | 13 | /** Token data */ 14 | export interface GetTokenResponse { 15 | id?: string | null; 16 | type?: string | null; 17 | createdAt?: string | null; 18 | expiresAt?: string | null; 19 | card?: GetCardTokenResponse | null; 20 | } 21 | 22 | export const getTokenResponseSchema: Schema = object({ 23 | id: ['id', optional(nullable(string()))], 24 | type: ['type', optional(nullable(string()))], 25 | createdAt: ['created_at', optional(nullable(string()))], 26 | expiresAt: ['expires_at', optional(nullable(string()))], 27 | card: ['card', optional(nullable(lazy(() => getCardTokenResponseSchema)))], 28 | }); 29 | -------------------------------------------------------------------------------- /src/models/getTransactionReportFileResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetTransactionReportFileResponse { 10 | name?: string | null; 11 | date?: string | null; 12 | } 13 | 14 | export const getTransactionReportFileResponseSchema: Schema = object( 15 | { 16 | name: ['name', optional(nullable(string()))], 17 | date: ['date', optional(nullable(string()))], 18 | } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/getTransferSettingsResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { 8 | boolean, 9 | nullable, 10 | number, 11 | object, 12 | optional, 13 | Schema, 14 | string, 15 | } from '../schema'; 16 | 17 | export interface GetTransferSettingsResponse { 18 | transferEnabled?: boolean | null; 19 | transferInterval?: string | null; 20 | transferDay?: number | null; 21 | } 22 | 23 | export const getTransferSettingsResponseSchema: Schema = object( 24 | { 25 | transferEnabled: ['transfer_enabled', optional(nullable(boolean()))], 26 | transferInterval: ['transfer_interval', optional(nullable(string()))], 27 | transferDay: ['transfer_day', optional(nullable(number()))], 28 | } 29 | ); 30 | -------------------------------------------------------------------------------- /src/models/getTransferSourceResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetTransferSourceResponse { 10 | sourceId?: string | null; 11 | type?: string | null; 12 | } 13 | 14 | export const getTransferSourceResponseSchema: Schema = object( 15 | { 16 | sourceId: ['source_id', optional(nullable(string()))], 17 | type: ['type', optional(nullable(string()))], 18 | } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/getTransferTargetResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetTransferTargetResponse { 10 | targetId?: string | null; 11 | type?: string | null; 12 | } 13 | 14 | export const getTransferTargetResponseSchema: Schema = object( 15 | { 16 | targetId: ['target_id', optional(nullable(string()))], 17 | type: ['type', optional(nullable(string()))], 18 | } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/getUsageReportResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetUsageReportResponse { 10 | url?: string | null; 11 | usageReportUrl?: string | null; 12 | groupedReportUrl?: string | null; 13 | } 14 | 15 | export const getUsageReportResponseSchema: Schema = object( 16 | { 17 | url: ['url', optional(nullable(string()))], 18 | usageReportUrl: ['usage_report_url', optional(nullable(string()))], 19 | groupedReportUrl: ['grouped_report_url', optional(nullable(string()))], 20 | } 21 | ); 22 | -------------------------------------------------------------------------------- /src/models/getWithdrawSourceResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetWithdrawSourceResponse { 10 | sourceId?: string | null; 11 | type?: string | null; 12 | } 13 | 14 | export const getWithdrawSourceResponseSchema: Schema = object( 15 | { 16 | sourceId: ['source_id', optional(nullable(string()))], 17 | type: ['type', optional(nullable(string()))], 18 | } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/getWithdrawTargetResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface GetWithdrawTargetResponse { 10 | targetId?: string | null; 11 | type?: string | null; 12 | } 13 | 14 | export const getWithdrawTargetResponseSchema: Schema = object( 15 | { 16 | targetId: ['target_id', optional(nullable(string()))], 17 | type: ['type', optional(nullable(string()))], 18 | } 19 | ); 20 | -------------------------------------------------------------------------------- /src/models/listAccessTokensResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetAccessTokenResponse, 10 | getAccessTokenResponseSchema, 11 | } from './getAccessTokenResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Response object for listing access tokens */ 15 | export interface ListAccessTokensResponse { 16 | /** The access token objects */ 17 | data?: GetAccessTokenResponse[] | null; 18 | /** Paging object */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listAccessTokensResponseSchema: Schema = object( 23 | { 24 | data: [ 25 | 'data', 26 | optional(nullable(array(lazy(() => getAccessTokenResponseSchema)))), 27 | ], 28 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 29 | } 30 | ); 31 | -------------------------------------------------------------------------------- /src/models/listAddressesResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetAddressResponse, 10 | getAddressResponseSchema, 11 | } from './getAddressResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Response object for listing addresses */ 15 | export interface ListAddressesResponse { 16 | /** The address objects */ 17 | data?: GetAddressResponse[] | null; 18 | /** Paging object */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listAddressesResponseSchema: Schema = object( 23 | { 24 | data: [ 25 | 'data', 26 | optional(nullable(array(lazy(() => getAddressResponseSchema)))), 27 | ], 28 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 29 | } 30 | ); 31 | -------------------------------------------------------------------------------- /src/models/listAnticipationResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetAnticipationResponse, 10 | getAnticipationResponseSchema, 11 | } from './getAnticipationResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Anticipations */ 15 | export interface ListAnticipationResponse { 16 | /** Anticipations */ 17 | data?: GetAnticipationResponse[] | null; 18 | /** Paging */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listAnticipationResponseSchema: Schema = object( 23 | { 24 | data: [ 25 | 'data', 26 | optional(nullable(array(lazy(() => getAnticipationResponseSchema)))), 27 | ], 28 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 29 | } 30 | ); 31 | -------------------------------------------------------------------------------- /src/models/listCardsResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { GetCardResponse, getCardResponseSchema } from './getCardResponse'; 9 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 10 | 11 | /** Response object for listing cards */ 12 | export interface ListCardsResponse { 13 | /** The card objects */ 14 | data?: GetCardResponse[] | null; 15 | /** Paging object */ 16 | paging?: PagingResponse | null; 17 | } 18 | 19 | export const listCardsResponseSchema: Schema = object({ 20 | data: ['data', optional(nullable(array(lazy(() => getCardResponseSchema))))], 21 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 22 | }); 23 | -------------------------------------------------------------------------------- /src/models/listChargesResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetChargeResponse, 10 | getChargeResponseSchema, 11 | } from './getChargeResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Response object for listing charges */ 15 | export interface ListChargesResponse { 16 | /** The charge objects */ 17 | data?: GetChargeResponse[] | null; 18 | /** Paging object */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listChargesResponseSchema: Schema = object({ 23 | data: [ 24 | 'data', 25 | optional(nullable(array(lazy(() => getChargeResponseSchema)))), 26 | ], 27 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 28 | }); 29 | -------------------------------------------------------------------------------- /src/models/listCustomersResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetCustomerResponse, 10 | getCustomerResponseSchema, 11 | } from './getCustomerResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Response for listing the customers */ 15 | export interface ListCustomersResponse { 16 | /** The customer object */ 17 | data?: GetCustomerResponse[] | null; 18 | /** Paging object */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listCustomersResponseSchema: Schema = object( 23 | { 24 | data: [ 25 | 'data', 26 | optional(nullable(array(lazy(() => getCustomerResponseSchema)))), 27 | ], 28 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 29 | } 30 | ); 31 | -------------------------------------------------------------------------------- /src/models/listCyclesResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetPeriodResponse, 10 | getPeriodResponseSchema, 11 | } from './getPeriodResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Response object for listing subscription cycles */ 15 | export interface ListCyclesResponse { 16 | /** The subscription cycles objects */ 17 | data?: GetPeriodResponse[] | null; 18 | /** Paging object */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listCyclesResponseSchema: Schema = object({ 23 | data: [ 24 | 'data', 25 | optional(nullable(array(lazy(() => getPeriodResponseSchema)))), 26 | ], 27 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 28 | }); 29 | -------------------------------------------------------------------------------- /src/models/listDiscountsResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetDiscountResponse, 10 | getDiscountResponseSchema, 11 | } from './getDiscountResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | export interface ListDiscountsResponse { 15 | /** The Discounts response */ 16 | data?: GetDiscountResponse[] | null; 17 | /** Paging object */ 18 | paging?: PagingResponse | null; 19 | } 20 | 21 | export const listDiscountsResponseSchema: Schema = object( 22 | { 23 | data: [ 24 | 'data', 25 | optional(nullable(array(lazy(() => getDiscountResponseSchema)))), 26 | ], 27 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 28 | } 29 | ); 30 | -------------------------------------------------------------------------------- /src/models/listIncrementsResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetIncrementResponse, 10 | getIncrementResponseSchema, 11 | } from './getIncrementResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | export interface ListIncrementsResponse { 15 | /** The Increments response */ 16 | data?: GetIncrementResponse[] | null; 17 | /** Paging object */ 18 | paging?: PagingResponse | null; 19 | } 20 | 21 | export const listIncrementsResponseSchema: Schema = object( 22 | { 23 | data: [ 24 | 'data', 25 | optional(nullable(array(lazy(() => getIncrementResponseSchema)))), 26 | ], 27 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 28 | } 29 | ); 30 | -------------------------------------------------------------------------------- /src/models/listInvoicesResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetInvoiceResponse, 10 | getInvoiceResponseSchema, 11 | } from './getInvoiceResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Response object for listing invoices */ 15 | export interface ListInvoicesResponse { 16 | /** The Invoice objects */ 17 | data?: GetInvoiceResponse[] | null; 18 | /** Paging object */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listInvoicesResponseSchema: Schema = object({ 23 | data: [ 24 | 'data', 25 | optional(nullable(array(lazy(() => getInvoiceResponseSchema)))), 26 | ], 27 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 28 | }); 29 | -------------------------------------------------------------------------------- /src/models/listOrderResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { GetOrderResponse, getOrderResponseSchema } from './getOrderResponse'; 9 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 10 | 11 | /** Response object for listing order objects */ 12 | export interface ListOrderResponse { 13 | /** The order object */ 14 | data?: GetOrderResponse[] | null; 15 | /** Paging object */ 16 | paging?: PagingResponse | null; 17 | } 18 | 19 | export const listOrderResponseSchema: Schema = object({ 20 | data: ['data', optional(nullable(array(lazy(() => getOrderResponseSchema))))], 21 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 22 | }); 23 | -------------------------------------------------------------------------------- /src/models/listPayablesResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetPayableResponse, 10 | getPayableResponseSchema, 11 | } from './getPayableResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Response object for listing payable objects */ 15 | export interface ListPayablesResponse { 16 | /** The payable object */ 17 | data?: GetPayableResponse[] | null; 18 | /** Paging object */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listPayablesResponseSchema: Schema = object({ 23 | data: [ 24 | 'data', 25 | optional(nullable(array(lazy(() => getPayableResponseSchema)))), 26 | ], 27 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 28 | }); 29 | -------------------------------------------------------------------------------- /src/models/listPlansResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { GetPlanResponse, getPlanResponseSchema } from './getPlanResponse'; 9 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 10 | 11 | /** Response object for listing plans */ 12 | export interface ListPlansResponse { 13 | /** The plan objects */ 14 | data?: GetPlanResponse[] | null; 15 | /** Paging object */ 16 | paging?: PagingResponse | null; 17 | } 18 | 19 | export const listPlansResponseSchema: Schema = object({ 20 | data: ['data', optional(nullable(array(lazy(() => getPlanResponseSchema))))], 21 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 22 | }); 23 | -------------------------------------------------------------------------------- /src/models/listRecipientResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetRecipientResponse, 10 | getRecipientResponseSchema, 11 | } from './getRecipientResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Response for the listing recipient method */ 15 | export interface ListRecipientResponse { 16 | /** Recipients */ 17 | data?: GetRecipientResponse[] | null; 18 | /** Paging */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listRecipientResponseSchema: Schema = object( 23 | { 24 | data: [ 25 | 'data', 26 | optional(nullable(array(lazy(() => getRecipientResponseSchema)))), 27 | ], 28 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 29 | } 30 | ); 31 | -------------------------------------------------------------------------------- /src/models/listSubscriptionsResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetSubscriptionResponse, 10 | getSubscriptionResponseSchema, 11 | } from './getSubscriptionResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** Response object for listing subscriptions */ 15 | export interface ListSubscriptionsResponse { 16 | /** The subscription objects */ 17 | data?: GetSubscriptionResponse[] | null; 18 | /** Paging object */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listSubscriptionsResponseSchema: Schema = object( 23 | { 24 | data: [ 25 | 'data', 26 | optional(nullable(array(lazy(() => getSubscriptionResponseSchema)))), 27 | ], 28 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 29 | } 30 | ); 31 | -------------------------------------------------------------------------------- /src/models/listTransferResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { 9 | GetTransferResponse, 10 | getTransferResponseSchema, 11 | } from './getTransferResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | /** List of paginated transfer objects */ 15 | export interface ListTransferResponse { 16 | /** Transfers */ 17 | data?: GetTransferResponse[] | null; 18 | /** Paging */ 19 | paging?: PagingResponse | null; 20 | } 21 | 22 | export const listTransferResponseSchema: Schema = object({ 23 | data: [ 24 | 'data', 25 | optional(nullable(array(lazy(() => getTransferResponseSchema)))), 26 | ], 27 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 28 | }); 29 | -------------------------------------------------------------------------------- /src/models/listTransfers.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, object, Schema } from '../schema'; 8 | import { GetTransfer, getTransferSchema } from './getTransfer'; 9 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 10 | 11 | export interface ListTransfers { 12 | /** The Increments response */ 13 | data: GetTransfer[]; 14 | /** Paging object */ 15 | paging: PagingResponse; 16 | } 17 | 18 | export const listTransfersSchema: Schema = object({ 19 | data: ['data', array(lazy(() => getTransferSchema))], 20 | paging: ['paging', lazy(() => pagingResponseSchema)], 21 | }); 22 | -------------------------------------------------------------------------------- /src/models/listUsagesResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, nullable, object, optional, Schema } from '../schema'; 8 | import { GetUsageResponse, getUsageResponseSchema } from './getUsageResponse'; 9 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 10 | 11 | /** Response model for listing the usages from a subscription item */ 12 | export interface ListUsagesResponse { 13 | /** The usage objects */ 14 | data?: GetUsageResponse[] | null; 15 | /** Paging object */ 16 | paging?: PagingResponse | null; 17 | } 18 | 19 | export const listUsagesResponseSchema: Schema = object({ 20 | data: ['data', optional(nullable(array(lazy(() => getUsageResponseSchema))))], 21 | paging: ['paging', optional(nullable(lazy(() => pagingResponseSchema)))], 22 | }); 23 | -------------------------------------------------------------------------------- /src/models/listWithdrawals.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, lazy, object, Schema } from '../schema'; 8 | import { 9 | GetWithdrawResponse, 10 | getWithdrawResponseSchema, 11 | } from './getWithdrawResponse'; 12 | import { PagingResponse, pagingResponseSchema } from './pagingResponse'; 13 | 14 | export interface ListWithdrawals { 15 | /** The Increments response */ 16 | data: GetWithdrawResponse[]; 17 | /** Paging object */ 18 | paging: PagingResponse; 19 | } 20 | 21 | export const listWithdrawalsSchema: Schema = object({ 22 | data: ['data', array(lazy(() => getWithdrawResponseSchema))], 23 | paging: ['paging', lazy(() => pagingResponseSchema)], 24 | }); 25 | -------------------------------------------------------------------------------- /src/models/pagingResponse.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, number, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Object used for returning lists of objects with pagination */ 10 | export interface PagingResponse { 11 | /** Total number of pages */ 12 | total?: number | null; 13 | /** Previous page */ 14 | previous?: string | null; 15 | /** Next page */ 16 | next?: string | null; 17 | } 18 | 19 | export const pagingResponseSchema: Schema = object({ 20 | total: ['total', optional(nullable(number()))], 21 | previous: ['previous', optional(nullable(string()))], 22 | next: ['next', optional(nullable(string()))], 23 | }); 24 | -------------------------------------------------------------------------------- /src/models/pixAdditionalInformation.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { nullable, object, optional, Schema, string } from '../schema'; 8 | 9 | /** Pix Additional Information */ 10 | export interface PixAdditionalInformation { 11 | name?: string | null; 12 | value?: string | null; 13 | } 14 | 15 | export const pixAdditionalInformationSchema: Schema = object( 16 | { 17 | name: ['Name', optional(nullable(string()))], 18 | value: ['Value', optional(nullable(string()))], 19 | } 20 | ); 21 | -------------------------------------------------------------------------------- /src/models/updateAddressRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { dict, object, Schema, string } from '../schema'; 8 | 9 | /** Request for updating an address */ 10 | export interface UpdateAddressRequest { 11 | /** Number */ 12 | number: string; 13 | /** Complement */ 14 | complement: string; 15 | /** Metadata */ 16 | metadata: Record; 17 | /** Line 2 for address */ 18 | line2: string; 19 | } 20 | 21 | export const updateAddressRequestSchema: Schema = object({ 22 | number: ['number', string()], 23 | complement: ['complement', string()], 24 | metadata: ['metadata', dict(string())], 25 | line2: ['line_2', string()], 26 | }); 27 | -------------------------------------------------------------------------------- /src/models/updateAutomaticAnticipationSettingsRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { boolean, number, object, optional, Schema, string } from '../schema'; 8 | 9 | export interface UpdateAutomaticAnticipationSettingsRequest { 10 | enabled?: boolean; 11 | type?: string; 12 | volumePercentage?: number; 13 | delay?: number; 14 | days?: number; 15 | } 16 | 17 | export const updateAutomaticAnticipationSettingsRequestSchema: Schema = object( 18 | { 19 | enabled: ['enabled', optional(boolean())], 20 | type: ['type', optional(string())], 21 | volumePercentage: ['volume_percentage', optional(number())], 22 | delay: ['delay', optional(number())], 23 | days: ['days', optional(number())], 24 | } 25 | ); 26 | -------------------------------------------------------------------------------- /src/models/updateChargeDueDateRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, optional, Schema, string } from '../schema'; 8 | 9 | /** Request for updating a charge due date */ 10 | export interface UpdateChargeDueDateRequest { 11 | /** The charge's new due date */ 12 | dueAt?: string; 13 | } 14 | 15 | export const updateChargeDueDateRequestSchema: Schema = object( 16 | { dueAt: ['due_at', optional(string())] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/updateCurrentCycleEndDateRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, optional, Schema, string } from '../schema'; 8 | 9 | /** Request to update the end date of the current subscription cycle */ 10 | export interface UpdateCurrentCycleEndDateRequest { 11 | /** Current cycle end date */ 12 | endAt?: string; 13 | } 14 | 15 | export const updateCurrentCycleEndDateRequestSchema: Schema = object( 16 | { endAt: ['end_at', optional(string())] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/updateCurrentCycleStatusRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | export interface UpdateCurrentCycleStatusRequest { 10 | /** Status */ 11 | status: string; 12 | } 13 | 14 | export const updateCurrentCycleStatusRequestSchema: Schema = object( 15 | { status: ['status', string()] } 16 | ); 17 | -------------------------------------------------------------------------------- /src/models/updateInvoiceStatusRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | /** Invoice Update Status Request */ 10 | export interface UpdateInvoiceStatusRequest { 11 | /** Status */ 12 | status: string; 13 | } 14 | 15 | export const updateInvoiceStatusRequestSchema: Schema = object( 16 | { status: ['status', string()] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/updateMetadataRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { dict, object, Schema, string } from '../schema'; 8 | 9 | /** Request for updating an metadata */ 10 | export interface UpdateMetadataRequest { 11 | /** Metadata */ 12 | metadata: Record; 13 | } 14 | 15 | export const updateMetadataRequestSchema: Schema = object( 16 | { metadata: ['metadata', dict(string())] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/updateOrderItemRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, Schema, string } from '../schema'; 8 | 9 | /** Update Order item Request */ 10 | export interface UpdateOrderItemRequest { 11 | amount: number; 12 | description: string; 13 | quantity: number; 14 | category: string; 15 | } 16 | 17 | export const updateOrderItemRequestSchema: Schema = object( 18 | { 19 | amount: ['amount', number()], 20 | description: ['description', string()], 21 | quantity: ['quantity', number()], 22 | category: ['category', string()], 23 | } 24 | ); 25 | -------------------------------------------------------------------------------- /src/models/updateOrderStatusRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | export interface UpdateOrderStatusRequest { 10 | /** Order status */ 11 | status: string; 12 | } 13 | 14 | export const updateOrderStatusRequestSchema: Schema = object( 15 | { status: ['status', string()] } 16 | ); 17 | -------------------------------------------------------------------------------- /src/models/updatePriceBracketRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, optional, Schema } from '../schema'; 8 | 9 | /** Request for updating a price bracket */ 10 | export interface UpdatePriceBracketRequest { 11 | /** Start quantity of the bracket */ 12 | startQuantity: number; 13 | /** Price */ 14 | price: number; 15 | /** End quantity of the bracket */ 16 | endQuantity?: number; 17 | /** Overage price */ 18 | overagePrice?: number; 19 | } 20 | 21 | export const updatePriceBracketRequestSchema: Schema = object( 22 | { 23 | startQuantity: ['start_quantity', number()], 24 | price: ['price', number()], 25 | endQuantity: ['end_quantity', optional(number())], 26 | overagePrice: ['overage_price', optional(number())], 27 | } 28 | ); 29 | -------------------------------------------------------------------------------- /src/models/updateRecipientBankAccountRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, object, Schema, string } from '../schema'; 8 | import { 9 | CreateBankAccountRequest, 10 | createBankAccountRequestSchema, 11 | } from './createBankAccountRequest'; 12 | 13 | /** Updates the default bank account for a recipient */ 14 | export interface UpdateRecipientBankAccountRequest { 15 | /** Bank account */ 16 | bankAccount: CreateBankAccountRequest; 17 | /** Payment mode */ 18 | paymentMode: string; 19 | } 20 | 21 | export const updateRecipientBankAccountRequestSchema: Schema = object( 22 | { 23 | bankAccount: ['bank_account', lazy(() => createBankAccountRequestSchema)], 24 | paymentMode: ['payment_mode', string()], 25 | } 26 | ); 27 | -------------------------------------------------------------------------------- /src/models/updateRecipientCodeRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | /** Update code for a recipient */ 10 | export interface UpdateRecipientCodeRequest { 11 | /** Code */ 12 | code: string; 13 | } 14 | 15 | export const updateRecipientCodeRequestSchema: Schema = object( 16 | { code: ['code', string()] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/updateRecipientRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { dict, object, Schema, string } from '../schema'; 8 | 9 | /** Request for updating a Recipient */ 10 | export interface UpdateRecipientRequest { 11 | /** Name */ 12 | name: string; 13 | /** Email */ 14 | email: string; 15 | /** Description */ 16 | description: string; 17 | /** Type */ 18 | type: string; 19 | /** Status */ 20 | status: string; 21 | /** Metadata */ 22 | metadata: Record; 23 | } 24 | 25 | export const updateRecipientRequestSchema: Schema = object( 26 | { 27 | name: ['name', string()], 28 | email: ['email', string()], 29 | description: ['description', string()], 30 | type: ['type', string()], 31 | status: ['status', string()], 32 | metadata: ['metadata', dict(string())], 33 | } 34 | ); 35 | -------------------------------------------------------------------------------- /src/models/updateSubscriptionAffiliationIdRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | /** Request for updating a Subscription Affiliation Id */ 10 | export interface UpdateSubscriptionAffiliationIdRequest { 11 | gatewayAffiliationId: string; 12 | } 13 | 14 | export const updateSubscriptionAffiliationIdRequestSchema: Schema = object( 15 | { gatewayAffiliationId: ['gateway_affiliation_id', string()] } 16 | ); 17 | -------------------------------------------------------------------------------- /src/models/updateSubscriptionBillingDateRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | /** Request for updating the due date from a subscription */ 10 | export interface UpdateSubscriptionBillingDateRequest { 11 | /** The date when the next subscription billing must occur */ 12 | nextBillingAt: string; 13 | } 14 | 15 | export const updateSubscriptionBillingDateRequestSchema: Schema = object( 16 | { nextBillingAt: ['next_billing_at', string()] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/updateSubscriptionCardRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { lazy, object, optional, Schema, string } from '../schema'; 8 | import { 9 | CreateCardRequest, 10 | createCardRequestSchema, 11 | } from './createCardRequest'; 12 | 13 | /** Request for updating the card from a subscription */ 14 | export interface UpdateSubscriptionCardRequest { 15 | /** Credit card data */ 16 | card: CreateCardRequest; 17 | /** Credit card id */ 18 | cardId: string; 19 | /** Business model identifier */ 20 | indirectAcceptor?: string; 21 | } 22 | 23 | export const updateSubscriptionCardRequestSchema: Schema = object( 24 | { 25 | card: ['card', lazy(() => createCardRequestSchema)], 26 | cardId: ['card_id', string()], 27 | indirectAcceptor: ['indirect_acceptor', optional(string())], 28 | } 29 | ); 30 | -------------------------------------------------------------------------------- /src/models/updateSubscriptionDueDaysRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, Schema } from '../schema'; 8 | 9 | export interface UpdateSubscriptionDueDaysRequest { 10 | boletoDueDays: number; 11 | } 12 | 13 | export const updateSubscriptionDueDaysRequestSchema: Schema = object( 14 | { boletoDueDays: ['boleto_due_days', number()] } 15 | ); 16 | -------------------------------------------------------------------------------- /src/models/updateSubscriptionMinimumPriceRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { number, object, optional, Schema } from '../schema'; 8 | 9 | /** Atualização do valor mínimo da assinatura */ 10 | export interface UpdateSubscriptionMinimumPriceRequest { 11 | /** Valor mínimo da assinatura */ 12 | minimumPrice?: number; 13 | } 14 | 15 | export const updateSubscriptionMinimumPriceRequestSchema: Schema = object( 16 | { minimumPrice: ['minimum_price', optional(number())] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/updateSubscriptionSplitRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { array, boolean, lazy, object, Schema } from '../schema'; 8 | import { 9 | CreateSplitRequest, 10 | createSplitRequestSchema, 11 | } from './createSplitRequest'; 12 | 13 | export interface UpdateSubscriptionSplitRequest { 14 | /** Defines if the split is enabled */ 15 | enabled: boolean; 16 | /** Split */ 17 | rules: CreateSplitRequest[]; 18 | } 19 | 20 | export const updateSubscriptionSplitRequestSchema: Schema = object( 21 | { 22 | enabled: ['enabled', boolean()], 23 | rules: ['rules', array(lazy(() => createSplitRequestSchema))], 24 | } 25 | ); 26 | -------------------------------------------------------------------------------- /src/models/updateSubscriptionStartAtRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | /** Request for updating the start date from a subscription */ 10 | export interface UpdateSubscriptionStartAtRequest { 11 | /** The date when the subscription periods will start */ 12 | startAt: string; 13 | } 14 | 15 | export const updateSubscriptionStartAtRequestSchema: Schema = object( 16 | { startAt: ['start_at', string()] } 17 | ); 18 | -------------------------------------------------------------------------------- /src/models/updateTransferSettingsRequest.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | import { object, Schema, string } from '../schema'; 8 | 9 | export interface UpdateTransferSettingsRequest { 10 | transferEnabled: string; 11 | transferInterval: string; 12 | transferDay: string; 13 | } 14 | 15 | export const updateTransferSettingsRequestSchema: Schema = object( 16 | { 17 | transferEnabled: ['transfer_enabled', string()], 18 | transferInterval: ['transfer_interval', string()], 19 | transferDay: ['transfer_day', string()], 20 | } 21 | ); 22 | -------------------------------------------------------------------------------- /src/schema.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * PagarmeApiSDKLib 3 | * 4 | * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). 5 | */ 6 | 7 | export * from '@apimatic/schema'; 8 | -------------------------------------------------------------------------------- /tsconfig.base.json: -------------------------------------------------------------------------------- 1 | { 2 | "include": ["src", "types"], 3 | "compilerOptions": { 4 | "importHelpers": true, 5 | "declaration": true, 6 | "declarationMap": true, 7 | "sourceMap": true, 8 | "rootDir": "./src", 9 | "strict": true, 10 | "noUnusedLocals": true, 11 | "noUnusedParameters": true, 12 | "noImplicitReturns": true, 13 | "noFallthroughCasesInSwitch": true, 14 | "moduleResolution": "node", 15 | "jsx": "react", 16 | "esModuleInterop": true, 17 | "useUnknownInCatchVariables": false 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /tsconfig.cjs.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./tsconfig.base.json", 3 | "compilerOptions": { 4 | "module": "CommonJS", 5 | "outDir": "dist/cjs", 6 | "declarationDir": "dist/types" 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /tsconfig.esm.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./tsconfig.base.json", 3 | "compilerOptions": { 4 | "module": "esnext", 5 | "lib": ["esnext"], 6 | "outDir": "dist/esm", 7 | "declarationDir": "dist/types", 8 | "target": "ES2017" 9 | } 10 | } 11 | 12 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "include": ["src", "types"], 3 | "compilerOptions": { 4 | "module": "esnext", 5 | "lib": ["esnext"], 6 | "importHelpers": true, 7 | "declaration": true, 8 | "sourceMap": true, 9 | "rootDir": "./src", 10 | "strict": true, 11 | "noUnusedLocals": true, 12 | "noUnusedParameters": true, 13 | "noImplicitReturns": true, 14 | "noFallthroughCasesInSwitch": true, 15 | "moduleResolution": "node", 16 | "target": "ES2017", 17 | "jsx": "react", 18 | "esModuleInterop": true 19 | } 20 | } 21 | --------------------------------------------------------------------------------