├── .gitattributes ├── .gitignore ├── .phan └── config.php ├── LICENSE ├── README.md ├── composer.json ├── doc ├── api-exception.md ├── client.md ├── controllers │ ├── balance-operations.md │ ├── charges.md │ ├── customers.md │ ├── invoices.md │ ├── orders.md │ ├── payables.md │ ├── plans.md │ ├── recipients.md │ ├── sellers.md │ ├── subscriptions.md │ ├── tokens.md │ ├── transactions.md │ └── transfers.md ├── http-request.md ├── http-response.md ├── models │ ├── cancel-split-request.md │ ├── 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-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-request.md │ ├── create-increment-request.md │ ├── create-interest-request.md │ ├── create-invoice-request.md │ ├── create-location-request.md │ ├── create-order-item-request.md │ ├── create-order-request.md │ ├── create-payment-authentication-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-seller-request.md │ ├── create-setup-request.md │ ├── create-shipping-request.md │ ├── create-split-options-request.md │ ├── create-split-request.md │ ├── create-sub-merchant-request.md │ ├── create-subscription-boleto-request.md │ ├── create-subscription-item-request.md │ ├── create-subscription-request.md │ ├── create-subscription-split-request.md │ ├── create-three-d-secure-request.md │ ├── create-token-request.md │ ├── create-transaction-report-file-request.md │ ├── create-transfer-request.md │ ├── create-transfer-settings-request.md │ ├── create-transfer.md │ ├── create-usage-request.md │ ├── create-voucher-payment-request.md │ ├── create-withdraw-request.md │ ├── error-exception.md │ ├── get-access-token-response.md │ ├── get-address-response.md │ ├── get-anticipation-limit-response.md │ ├── get-anticipation-limits-response.md │ ├── get-anticipation-response.md │ ├── get-antifraud-response.md │ ├── get-automatic-anticipation-response.md │ ├── get-balance-operation-response.md │ ├── get-balance-response.md │ ├── get-bank-account-response.md │ ├── get-bank-transfer-transaction-response.md │ ├── get-billing-address-response.md │ ├── get-boleto-transaction-response.md │ ├── get-card-response.md │ ├── get-card-token-response.md │ ├── get-cash-transaction-response.md │ ├── get-charge-response.md │ ├── get-charges-summary-response.md │ ├── get-checkout-bank-transfer-payment-response.md │ ├── get-checkout-boleto-payment-response.md │ ├── get-checkout-card-installment-options-response.md │ ├── get-checkout-credit-card-payment-response.md │ ├── get-checkout-debit-card-payment-response.md │ ├── get-checkout-payment-response.md │ ├── get-checkout-payment-settings-response.md │ ├── get-checkout-pix-payment-response.md │ ├── get-credit-card-transaction-response.md │ ├── get-customer-response.md │ ├── get-debit-card-transaction-response.md │ ├── get-device-response.md │ ├── get-discount-response.md │ ├── get-fine-response.md │ ├── get-gateway-error-response.md │ ├── get-gateway-recipient-response.md │ ├── get-gateway-response-response.md │ ├── get-increment-response.md │ ├── get-interest-response.md │ ├── get-invoice-item-response.md │ ├── get-invoice-response.md │ ├── get-location-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-transfer-response.md │ ├── get-order-item-response.md │ ├── get-order-response.md │ ├── get-payable-response.md │ ├── get-payment-authentication-response.md │ ├── get-period-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-safety-pay-transaction-response.md │ ├── get-seller-response.md │ ├── get-sellers-request.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-seller-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-request.md │ ├── update-seller-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 └── utility-classes.md ├── examples ├── address │ ├── CreateAddress.php │ └── GetAdressById.php ├── card │ ├── CreateCard.php │ └── GetCard.php ├── charges │ ├── CancelCharge.php │ ├── CancelChargePartial.php │ ├── CaptureCharge.php │ └── GetChargeById.php ├── customer │ ├── CreateCustomer.php │ └── GetCustomerById.php ├── invoice │ └── GetInvoiceById.php ├── marketplace │ ├── CreateAnticipation.php │ ├── CreateRecipient.php │ └── GetRecipientById.php └── orders │ ├── CreateOrderBoleto.php │ ├── CreateOrderCreditCard.php │ ├── CreateOrderPix.php │ ├── CreateOrderSplit.php │ └── GetOrders.php ├── phpcs-ruleset.xml └── src ├── ApiHelper.php ├── AuthManagerInterface.php ├── BasicAuthCredentials.php ├── BasicAuthManager.php ├── ConfigurationDefaults.php ├── ConfigurationInterface.php ├── Controllers ├── BalanceOperationsController.php ├── BaseController.php ├── ChargesController.php ├── CustomersController.php ├── InvoicesController.php ├── OrdersController.php ├── PayablesController.php ├── PlansController.php ├── RecipientsController.php ├── SellersController.php ├── SubscriptionsController.php ├── TokensController.php ├── TransactionsController.php └── TransfersController.php ├── Environment.php ├── Exceptions ├── ApiException.php ├── ErrorException.php └── Exception.php ├── Http ├── HttpCallBack.php ├── HttpContext.php ├── HttpMethod.php ├── HttpRequest.php └── HttpResponse.php ├── Models ├── Builders │ ├── CreateAccessTokenRequestBuilder.php │ ├── CreateAddressRequestBuilder.php │ ├── CreateAnticipationRequestBuilder.php │ ├── CreateAntifraudRequestBuilder.php │ ├── CreateApplePayHeaderRequestBuilder.php │ ├── CreateApplePayRequestBuilder.php │ ├── CreateAutomaticAnticipationSettingsRequestBuilder.php │ ├── CreateBankAccountRefundingDTOBuilder.php │ ├── CreateBankAccountRequestBuilder.php │ ├── CreateBankTransferPaymentRequestBuilder.php │ ├── CreateBoletoPaymentRequestBuilder.php │ ├── CreateCancelChargeRequestBuilder.php │ ├── CreateCancelChargeSplitRulesRequestBuilder.php │ ├── CreateCancelSubscriptionRequestBuilder.php │ ├── CreateCaptureChargeRequestBuilder.php │ ├── CreateCardOptionsRequestBuilder.php │ ├── CreateCardPaymentContactlessPOIRequestBuilder.php │ ├── CreateCardPaymentContactlessRequestBuilder.php │ ├── CreateCardRequestBuilder.php │ ├── CreateCardTokenRequestBuilder.php │ ├── CreateCashPaymentRequestBuilder.php │ ├── CreateChargeRequestBuilder.php │ ├── CreateCheckoutBankTransferRequestBuilder.php │ ├── CreateCheckoutBoletoPaymentRequestBuilder.php │ ├── CreateCheckoutCardInstallmentOptionRequestBuilder.php │ ├── CreateCheckoutCreditCardPaymentRequestBuilder.php │ ├── CreateCheckoutDebitCardPaymentRequestBuilder.php │ ├── CreateCheckoutPaymentRequestBuilder.php │ ├── CreateCheckoutPixPaymentRequestBuilder.php │ ├── CreateClearSaleRequestBuilder.php │ ├── CreateConfirmPaymentRequestBuilder.php │ ├── CreateCreditCardPaymentRequestBuilder.php │ ├── CreateCustomerRequestBuilder.php │ ├── CreateDebitCardPaymentRequestBuilder.php │ ├── CreateDeviceRequestBuilder.php │ ├── CreateDiscountRequestBuilder.php │ ├── CreateEmvDataDecryptRequestBuilder.php │ ├── CreateEmvDataDukptDecryptRequestBuilder.php │ ├── CreateEmvDataTlvDecryptRequestBuilder.php │ ├── CreateEmvDecryptRequestBuilder.php │ ├── CreateFineRequestBuilder.php │ ├── CreateGooglePayHeaderRequestBuilder.php │ ├── CreateGooglePayRequestBuilder.php │ ├── CreateIncrementRequestBuilder.php │ ├── CreateInterestRequestBuilder.php │ ├── CreateInvoiceRequestBuilder.php │ ├── CreateLocationRequestBuilder.php │ ├── CreateOrderItemRequestBuilder.php │ ├── CreateOrderRequestBuilder.php │ ├── CreatePaymentAuthenticationRequestBuilder.php │ ├── CreatePaymentRequestBuilder.php │ ├── CreatePeriodRequestBuilder.php │ ├── CreatePhoneRequestBuilder.php │ ├── CreatePhonesRequestBuilder.php │ ├── CreatePixPaymentRequestBuilder.php │ ├── CreatePlanItemRequestBuilder.php │ ├── CreatePlanRequestBuilder.php │ ├── CreatePriceBracketRequestBuilder.php │ ├── CreatePricingSchemeRequestBuilder.php │ ├── CreatePrivateLabelPaymentRequestBuilder.php │ ├── CreateRecipientRequestBuilder.php │ ├── CreateSetupRequestBuilder.php │ ├── CreateShippingRequestBuilder.php │ ├── CreateSplitOptionsRequestBuilder.php │ ├── CreateSplitRequestBuilder.php │ ├── CreateSubMerchantRequestBuilder.php │ ├── CreateSubscriptionBoletoRequestBuilder.php │ ├── CreateSubscriptionItemRequestBuilder.php │ ├── CreateSubscriptionRequestBuilder.php │ ├── CreateSubscriptionSplitRequestBuilder.php │ ├── CreateThreeDSecureRequestBuilder.php │ ├── CreateTokenRequestBuilder.php │ ├── CreateTransactionReportFileRequestBuilder.php │ ├── CreateTransferBuilder.php │ ├── CreateTransferRequestBuilder.php │ ├── CreateTransferSettingsRequestBuilder.php │ ├── CreateUsageRequestBuilder.php │ ├── CreateVoucherPaymentRequestBuilder.php │ ├── CreateWithdrawRequestBuilder.php │ ├── GetAccessTokenResponseBuilder.php │ ├── GetAddressResponseBuilder.php │ ├── GetAnticipationLimitResponseBuilder.php │ ├── GetAnticipationLimitsResponseBuilder.php │ ├── GetAnticipationResponseBuilder.php │ ├── GetAntifraudResponseBuilder.php │ ├── GetAutomaticAnticipationResponseBuilder.php │ ├── GetBalanceOperationResponseBuilder.php │ ├── GetBalanceResponseBuilder.php │ ├── GetBankAccountResponseBuilder.php │ ├── GetBankTransferTransactionResponseBuilder.php │ ├── GetBillingAddressResponseBuilder.php │ ├── GetBoletoTransactionResponseBuilder.php │ ├── GetCardResponseBuilder.php │ ├── GetCardTokenResponseBuilder.php │ ├── GetCashTransactionResponseBuilder.php │ ├── GetChargeResponseBuilder.php │ ├── GetChargesSummaryResponseBuilder.php │ ├── GetCheckoutBankTransferPaymentResponseBuilder.php │ ├── GetCheckoutBoletoPaymentResponseBuilder.php │ ├── GetCheckoutCardInstallmentOptionsResponseBuilder.php │ ├── GetCheckoutCreditCardPaymentResponseBuilder.php │ ├── GetCheckoutDebitCardPaymentResponseBuilder.php │ ├── GetCheckoutPaymentResponseBuilder.php │ ├── GetCheckoutPaymentSettingsResponseBuilder.php │ ├── GetCheckoutPixPaymentResponseBuilder.php │ ├── GetCreditCardTransactionResponseBuilder.php │ ├── GetCustomerResponseBuilder.php │ ├── GetDebitCardTransactionResponseBuilder.php │ ├── GetDeviceResponseBuilder.php │ ├── GetDiscountResponseBuilder.php │ ├── GetFineResponseBuilder.php │ ├── GetGatewayErrorResponseBuilder.php │ ├── GetGatewayRecipientResponseBuilder.php │ ├── GetGatewayResponseResponseBuilder.php │ ├── GetIncrementResponseBuilder.php │ ├── GetInterestResponseBuilder.php │ ├── GetInvoiceItemResponseBuilder.php │ ├── GetInvoiceResponseBuilder.php │ ├── GetLocationResponseBuilder.php │ ├── GetMovementObjectBaseResponseBuilder.php │ ├── GetMovementObjectFeeCollectionResponseBuilder.php │ ├── GetMovementObjectPayableResponseBuilder.php │ ├── GetMovementObjectRefundResponseBuilder.php │ ├── GetMovementObjectTransferResponseBuilder.php │ ├── GetOrderItemResponseBuilder.php │ ├── GetOrderResponseBuilder.php │ ├── GetPayableResponseBuilder.php │ ├── GetPaymentAuthenticationResponseBuilder.php │ ├── GetPeriodResponseBuilder.php │ ├── GetPhoneResponseBuilder.php │ ├── GetPhonesResponseBuilder.php │ ├── GetPixBankAccountResponseBuilder.php │ ├── GetPixPayerResponseBuilder.php │ ├── GetPixTransactionResponseBuilder.php │ ├── GetPlanItemResponseBuilder.php │ ├── GetPlanResponseBuilder.php │ ├── GetPriceBracketResponseBuilder.php │ ├── GetPricingSchemeResponseBuilder.php │ ├── GetPrivateLabelTransactionResponseBuilder.php │ ├── GetRecipientResponseBuilder.php │ ├── GetSafetyPayTransactionResponseBuilder.php │ ├── GetSetupResponseBuilder.php │ ├── GetShippingResponseBuilder.php │ ├── GetSplitOptionsResponseBuilder.php │ ├── GetSplitResponseBuilder.php │ ├── GetSubscriptionBoletoResponseBuilder.php │ ├── GetSubscriptionItemResponseBuilder.php │ ├── GetSubscriptionResponseBuilder.php │ ├── GetSubscriptionSplitResponseBuilder.php │ ├── GetThreeDSecureResponseBuilder.php │ ├── GetTokenResponseBuilder.php │ ├── GetTransactionReportFileResponseBuilder.php │ ├── GetTransactionResponseBuilder.php │ ├── GetTransferBuilder.php │ ├── GetTransferResponseBuilder.php │ ├── GetTransferSettingsResponseBuilder.php │ ├── GetTransferSourceResponseBuilder.php │ ├── GetTransferTargetResponseBuilder.php │ ├── GetUsageReportResponseBuilder.php │ ├── GetUsageResponseBuilder.php │ ├── GetVoucherTransactionResponseBuilder.php │ ├── GetWithdrawResponseBuilder.php │ ├── GetWithdrawSourceResponseBuilder.php │ ├── GetWithdrawTargetResponseBuilder.php │ ├── ListAccessTokensResponseBuilder.php │ ├── ListAddressesResponseBuilder.php │ ├── ListAnticipationResponseBuilder.php │ ├── ListBalanceOperationResponseBuilder.php │ ├── ListCardsResponseBuilder.php │ ├── ListChargeTransactionsResponseBuilder.php │ ├── ListChargesResponseBuilder.php │ ├── ListCustomersResponseBuilder.php │ ├── ListCyclesResponseBuilder.php │ ├── ListDiscountsResponseBuilder.php │ ├── ListIncrementsResponseBuilder.php │ ├── ListInvoicesResponseBuilder.php │ ├── ListOrderResponseBuilder.php │ ├── ListPayablesResponseBuilder.php │ ├── ListPlansResponseBuilder.php │ ├── ListRecipientResponseBuilder.php │ ├── ListSubscriptionItemsResponseBuilder.php │ ├── ListSubscriptionsResponseBuilder.php │ ├── ListTransactionsFilesResponseBuilder.php │ ├── ListTransactionsResponseBuilder.php │ ├── ListTransferResponseBuilder.php │ ├── ListTransfersBuilder.php │ ├── ListUsagesResponseBuilder.php │ ├── ListWithdrawalsBuilder.php │ ├── PagingResponseBuilder.php │ ├── PixAdditionalInformationBuilder.php │ ├── UpdateAddressRequestBuilder.php │ ├── UpdateAutomaticAnticipationSettingsRequestBuilder.php │ ├── UpdateCardRequestBuilder.php │ ├── UpdateChargeCardRequestBuilder.php │ ├── UpdateChargeDueDateRequestBuilder.php │ ├── UpdateChargePaymentMethodRequestBuilder.php │ ├── UpdateCurrentCycleEndDateRequestBuilder.php │ ├── UpdateCurrentCycleStatusRequestBuilder.php │ ├── UpdateCustomerRequestBuilder.php │ ├── UpdateInvoiceStatusRequestBuilder.php │ ├── UpdateMetadataRequestBuilder.php │ ├── UpdateOrderItemRequestBuilder.php │ ├── UpdateOrderStatusRequestBuilder.php │ ├── UpdatePlanItemRequestBuilder.php │ ├── UpdatePlanRequestBuilder.php │ ├── UpdatePriceBracketRequestBuilder.php │ ├── UpdatePricingSchemeRequestBuilder.php │ ├── UpdateRecipientBankAccountRequestBuilder.php │ ├── UpdateRecipientRequestBuilder.php │ ├── UpdateSubscriptionAffiliationIdRequestBuilder.php │ ├── UpdateSubscriptionBillingDateRequestBuilder.php │ ├── UpdateSubscriptionCardRequestBuilder.php │ ├── UpdateSubscriptionDueDaysRequestBuilder.php │ ├── UpdateSubscriptionItemRequestBuilder.php │ ├── UpdateSubscriptionMinimumPriceRequestBuilder.php │ ├── UpdateSubscriptionPaymentMethodRequestBuilder.php │ ├── UpdateSubscriptionSplitRequestBuilder.php │ ├── UpdateSubscriptionStartAtRequestBuilder.php │ └── UpdateTransferSettingsRequestBuilder.php ├── CancelSplitRequest.php ├── CreateAccessTokenRequest.php ├── CreateAddressRequest.php ├── CreateAnticipationRequest.php ├── CreateAntifraudRequest.php ├── CreateApplePayHeaderRequest.php ├── CreateApplePayRequest.php ├── CreateAutomaticAnticipationSettingsRequest.php ├── CreateBankAccountRefundingDTO.php ├── CreateBankAccountRequest.php ├── CreateBankTransferPaymentRequest.php ├── CreateBoletoPaymentRequest.php ├── CreateCancelChargeRequest.php ├── CreateCancelChargeSplitRulesRequest.php ├── CreateCancelSubscriptionRequest.php ├── CreateCaptureChargeRequest.php ├── CreateCardOptionsRequest.php ├── CreateCardPaymentContactlessPOIRequest.php ├── CreateCardPaymentContactlessRequest.php ├── CreateCardRequest.php ├── CreateCardTokenRequest.php ├── CreateCashPaymentRequest.php ├── CreateChargeRequest.php ├── CreateCheckoutBankTransferRequest.php ├── CreateCheckoutBoletoPaymentRequest.php ├── CreateCheckoutCardInstallmentOptionRequest.php ├── CreateCheckoutCreditCardPaymentRequest.php ├── CreateCheckoutDebitCardPaymentRequest.php ├── CreateCheckoutPaymentRequest.php ├── CreateCheckoutPixPaymentRequest.php ├── CreateClearSaleRequest.php ├── CreateConfirmPaymentRequest.php ├── CreateCreditCardPaymentRequest.php ├── CreateCustomerRequest.php ├── CreateDebitCardPaymentRequest.php ├── CreateDeviceRequest.php ├── CreateDiscountRequest.php ├── CreateEmvDataDecryptRequest.php ├── CreateEmvDataDukptDecryptRequest.php ├── CreateEmvDataTlvDecryptRequest.php ├── CreateEmvDecryptRequest.php ├── CreateFineRequest.php ├── CreateGooglePayHeaderRequest.php ├── CreateGooglePayRequest.php ├── CreateIncrementRequest.php ├── CreateInterestRequest.php ├── CreateInvoiceRequest.php ├── CreateLocationRequest.php ├── CreateOrderItemRequest.php ├── CreateOrderRequest.php ├── CreatePaymentAuthenticationRequest.php ├── CreatePaymentRequest.php ├── CreatePeriodRequest.php ├── CreatePhoneRequest.php ├── CreatePhonesRequest.php ├── CreatePixPaymentRequest.php ├── CreatePlanItemRequest.php ├── CreatePlanRequest.php ├── CreatePriceBracketRequest.php ├── CreatePricingSchemeRequest.php ├── CreatePrivateLabelPaymentRequest.php ├── CreateRecipientRequest.php ├── CreateSellerRequest.php ├── CreateSetupRequest.php ├── CreateShippingRequest.php ├── CreateSplitOptionsRequest.php ├── CreateSplitRequest.php ├── CreateSubMerchantRequest.php ├── CreateSubscriptionBoletoRequest.php ├── CreateSubscriptionItemRequest.php ├── CreateSubscriptionRequest.php ├── CreateSubscriptionSplitRequest.php ├── CreateThreeDSecureRequest.php ├── CreateTokenRequest.php ├── CreateTransactionReportFileRequest.php ├── CreateTransfer.php ├── CreateTransferRequest.php ├── CreateTransferSettingsRequest.php ├── CreateUsageRequest.php ├── CreateVoucherPaymentRequest.php ├── CreateWithdrawRequest.php ├── GetAccessTokenResponse.php ├── GetAddressResponse.php ├── GetAnticipationLimitResponse.php ├── GetAnticipationLimitsResponse.php ├── GetAnticipationResponse.php ├── GetAntifraudResponse.php ├── GetAutomaticAnticipationResponse.php ├── GetBalanceOperationResponse.php ├── GetBalanceResponse.php ├── GetBankAccountResponse.php ├── GetBankTransferTransactionResponse.php ├── GetBillingAddressResponse.php ├── GetBoletoTransactionResponse.php ├── GetCardResponse.php ├── GetCardTokenResponse.php ├── GetCashTransactionResponse.php ├── GetChargeResponse.php ├── GetChargesSummaryResponse.php ├── GetCheckoutBankTransferPaymentResponse.php ├── GetCheckoutBoletoPaymentResponse.php ├── GetCheckoutCardInstallmentOptionsResponse.php ├── GetCheckoutCreditCardPaymentResponse.php ├── GetCheckoutDebitCardPaymentResponse.php ├── GetCheckoutPaymentResponse.php ├── GetCheckoutPaymentSettingsResponse.php ├── GetCheckoutPixPaymentResponse.php ├── GetCreditCardTransactionResponse.php ├── GetCustomerResponse.php ├── GetDebitCardTransactionResponse.php ├── GetDeviceResponse.php ├── GetDiscountResponse.php ├── GetFineResponse.php ├── GetGatewayErrorResponse.php ├── GetGatewayRecipientResponse.php ├── GetGatewayResponseResponse.php ├── GetIncrementResponse.php ├── GetInterestResponse.php ├── GetInvoiceItemResponse.php ├── GetInvoiceResponse.php ├── GetLocationResponse.php ├── GetMovementObjectBaseResponse.php ├── GetMovementObjectFeeCollectionResponse.php ├── GetMovementObjectPayableResponse.php ├── GetMovementObjectRefundResponse.php ├── GetMovementObjectTransferResponse.php ├── GetOrderItemResponse.php ├── GetOrderResponse.php ├── GetPayableResponse.php ├── GetPaymentAuthenticationResponse.php ├── GetPeriodResponse.php ├── GetPhoneResponse.php ├── GetPhonesResponse.php ├── GetPixBankAccountResponse.php ├── GetPixPayerResponse.php ├── GetPixTransactionResponse.php ├── GetPlanItemResponse.php ├── GetPlanResponse.php ├── GetPriceBracketResponse.php ├── GetPricingSchemeResponse.php ├── GetPrivateLabelTransactionResponse.php ├── GetRecipientResponse.php ├── GetSafetyPayTransactionResponse.php ├── GetSellerResponse.php ├── GetSellersRequest.php ├── GetSetupResponse.php ├── GetShippingResponse.php ├── GetSplitOptionsResponse.php ├── GetSplitResponse.php ├── GetSubscriptionBoletoResponse.php ├── GetSubscriptionItemResponse.php ├── GetSubscriptionResponse.php ├── GetSubscriptionSplitResponse.php ├── GetThreeDSecureResponse.php ├── GetTokenResponse.php ├── GetTransactionReportFileResponse.php ├── GetTransactionResponse.php ├── GetTransfer.php ├── GetTransferResponse.php ├── GetTransferSettingsResponse.php ├── GetTransferSourceResponse.php ├── GetTransferTargetResponse.php ├── GetUsageReportResponse.php ├── GetUsageResponse.php ├── GetVoucherTransactionResponse.php ├── GetWithdrawResponse.php ├── GetWithdrawSourceResponse.php ├── GetWithdrawTargetResponse.php ├── ListAccessTokensResponse.php ├── ListAddressesResponse.php ├── ListAnticipationResponse.php ├── ListBalanceOperationResponse.php ├── ListCardsResponse.php ├── ListChargeTransactionsResponse.php ├── ListChargesResponse.php ├── ListCustomersResponse.php ├── ListCyclesResponse.php ├── ListDiscountsResponse.php ├── ListIncrementsResponse.php ├── ListInvoicesResponse.php ├── ListOrderResponse.php ├── ListPayablesResponse.php ├── ListPlansResponse.php ├── ListRecipientResponse.php ├── ListSellerResponse.php ├── ListSubscriptionItemsResponse.php ├── ListSubscriptionsResponse.php ├── ListTransactionsFilesResponse.php ├── ListTransactionsResponse.php ├── ListTransferResponse.php ├── ListTransfers.php ├── ListUsagesResponse.php ├── ListWithdrawals.php ├── PagingResponse.php ├── PixAdditionalInformation.php ├── UpdateAddressRequest.php ├── UpdateAutomaticAnticipationSettingsRequest.php ├── UpdateCardRequest.php ├── UpdateChargeCardRequest.php ├── UpdateChargeDueDateRequest.php ├── UpdateChargePaymentMethodRequest.php ├── UpdateCurrentCycleEndDateRequest.php ├── UpdateCurrentCycleStatusRequest.php ├── UpdateCustomerRequest.php ├── UpdateInvoiceStatusRequest.php ├── UpdateMetadataRequest.php ├── UpdateOrderItemRequest.php ├── UpdateOrderStatusRequest.php ├── UpdatePlanItemRequest.php ├── UpdatePlanRequest.php ├── UpdatePriceBracketRequest.php ├── UpdatePricingSchemeRequest.php ├── UpdateRecipientBankAccountRequest.php ├── UpdateRecipientRequest.php ├── UpdateSellerRequest.php ├── UpdateSubscriptionAffiliationIdRequest.php ├── UpdateSubscriptionBillingDateRequest.php ├── UpdateSubscriptionCardRequest.php ├── UpdateSubscriptionDueDaysRequest.php ├── UpdateSubscriptionItemRequest.php ├── UpdateSubscriptionMinimumPriceRequest.php ├── UpdateSubscriptionPaymentMethodRequest.php ├── UpdateSubscriptionSplitRequest.php ├── UpdateSubscriptionStartAtRequest.php └── UpdateTransferSettingsRequest.php ├── PagarmeApiSDKClient.php ├── PagarmeApiSDKClientBuilder.php ├── Server.php └── Utils ├── CompatibilityConverter.php └── DateTimeHelper.php /.gitattributes: -------------------------------------------------------------------------------- 1 | **/*.php -lf 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | composer.phar 2 | vendor/ 3 | .phpunit.result.cache 4 | coverage/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | License: 2 | ======== 3 | The MIT License (MIT) 4 | http://opensource.org/licenses/MIT 5 | 6 | Copyright (c) 2014 - 2023 APIMATIC Limited 7 | 8 | Permission is hereby granted, free of charge, to any person obtaining a copy 9 | of this software and associated documentation files (the "Software"), to deal 10 | in the Software without restriction, including without limitation the rights 11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 12 | copies of the Software, and to permit persons to whom the Software is 13 | furnished to do so, subject to the following conditions: 14 | 15 | The above copyright notice and this permission notice shall be included in 16 | all copies or substantial portions of the Software. 17 | 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 24 | THE SOFTWARE. 25 | 26 | Trade Mark: 27 | ========== 28 | APIMATIC is a trade mark for APIMATIC Limited -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pagarme/pagarme-php-sdk", 3 | "description": "Pagarme API", 4 | "type": "library", 5 | "keywords": [ 6 | "PagarmeApiSDK", 7 | "API", 8 | "SDK" 9 | ], 10 | "homepage": "https://github.com/pagarme/", 11 | "license": [ 12 | "MIT" 13 | ], 14 | "authors": [ 15 | { 16 | "name": "Pagar.me Pagamentos S/A", 17 | "email": "suporte@pagar.me", 18 | "homepage": "https://github.com/pagarme/" 19 | } 20 | ], 21 | "require": { 22 | "php": "^7.2 || ^8.0", 23 | "ext-json": "*", 24 | "apimatic/unirest-php": "^4.0.0", 25 | "apimatic/core-interfaces": "~0.1.0", 26 | "apimatic/core": "~0.3.0" 27 | }, 28 | "require-dev": { 29 | "squizlabs/php_codesniffer": "^3.5", 30 | "phan/phan": "5.4.2" 31 | }, 32 | "autoload": { 33 | "psr-4": { 34 | "PagarmeApiSDKLib\\": "src/" 35 | } 36 | }, 37 | "autoload-dev": { 38 | "psr-4": { 39 | "PagarmeApiSDKLib\\Tests\\": "tests/" 40 | } 41 | }, 42 | "scripts": { 43 | "lint-src": "phpcs --standard=phpcs-ruleset.xml src/", 44 | "lint-src-fix": "phpcbf --standard=phpcs-ruleset.xml src/", 45 | "analyze": "phan --allow-polyfill-parser", 46 | "lint": [ 47 | "@lint-src" 48 | ] 49 | } 50 | } -------------------------------------------------------------------------------- /doc/api-exception.md: -------------------------------------------------------------------------------- 1 | 2 | # ApiException 3 | 4 | Thrown when there is a network error or HTTP response status code is not okay. 5 | 6 | ## Methods 7 | 8 | | Name | Type | Description | 9 | | --- | --- | --- | 10 | | getHttpRequest() | [`HttpRequest`](http-request.md) | Returns the HTTP request. | 11 | | getHttpResponse() | ?[`HttpResponse`](http-response.md) | Returns the HTTP response. | 12 | | hasResponse() | bool | Is the response available? | 13 | 14 | -------------------------------------------------------------------------------- /doc/controllers/transactions.md: -------------------------------------------------------------------------------- 1 | # Transactions 2 | 3 | ```php 4 | $transactionsController = $client->getTransactionsController(); 5 | ``` 6 | 7 | ## Class Name 8 | 9 | `TransactionsController` 10 | 11 | 12 | # Get Transaction 13 | 14 | ```php 15 | function getTransaction(string $transactionId): GetTransactionResponse 16 | ``` 17 | 18 | ## Parameters 19 | 20 | | Parameter | Type | Tags | Description | 21 | | --- | --- | --- | --- | 22 | | `transactionId` | `string` | Template, Required | - | 23 | 24 | ## Response Type 25 | 26 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 27 | 28 | ## Example Usage 29 | 30 | ```php 31 | $transactionId = 'transaction_id8'; 32 | 33 | $result = $transactionsController->getTransaction($transactionId); 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/http-request.md: -------------------------------------------------------------------------------- 1 | 2 | # HttpRequest 3 | 4 | Represents a single Http Request. 5 | 6 | ## Methods 7 | 8 | | Name | Type | Description | 9 | | --- | --- | --- | 10 | | getHttpMethod() | string | The HTTP method of the request. | 11 | | getQueryUrl() | string | The endpoint URL for the API request. | 12 | | getHeaders() | array | Request headers. | 13 | | getParameters() | array | Input parameters for the body. | 14 | 15 | -------------------------------------------------------------------------------- /doc/http-response.md: -------------------------------------------------------------------------------- 1 | 2 | # HttpResponse 3 | 4 | Http response received. 5 | 6 | ## Methods 7 | 8 | | Name | Type | Description | 9 | | --- | --- | --- | 10 | | getStatusCode() | int | The status code of the response. | 11 | | getHeaders() | array | Response headers. | 12 | | getRawBody() | string | Raw body of the response. | 13 | 14 | -------------------------------------------------------------------------------- /doc/models/cancel-split-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Cancel Split Request 3 | 4 | Split 5 | 6 | ## Structure 7 | 8 | `CancelSplitRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `type` | `string` | Required | Split type | getType(): string | setType(string type): void | 15 | | `amount` | `int` | Required | Amount | getAmount(): int | setAmount(int amount): void | 16 | | `recipientId` | `string` | Required | Recipient id | getRecipientId(): string | setRecipientId(string recipientId): void | 17 | | `options` | [`?CreateSplitOptionsRequest`](/doc/models/create-split-options-request.md) | Optional | The split options request | getOptions(): ?CreateSplitOptionsRequest | setOptions(?CreateSplitOptionsRequest options): void | 18 | | `splitRuleID` | `?string` | Optional | Rule id | getSplitRuleID(): ?string | setSplitRuleID(?string splitRuleID): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "type": "type0", 25 | "amount": 46, 26 | "recipient_id": "recipient_id0", 27 | "options": null, 28 | "Split_Rule_ID": null 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `expiresIn` | `?int` | Optional | Minutes to expire the token | getExpiresIn(): ?int | setExpiresIn(?int expiresIn): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "expires_in": 226 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `amount` | `int` | Required | Amount requested for the anticipation | getAmount(): int | setAmount(int amount): void | 15 | | `timeframe` | `string` | Required | Timeframe | getTimeframe(): string | setTimeframe(string timeframe): void | 16 | | `paymentDate` | `DateTime` | Required | Payment date | getPaymentDate(): \DateTime | setPaymentDate(\DateTime paymentDate): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "amount": 46, 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `type` | `string` | Required | - | getType(): string | setType(string type): void | 13 | | `clearsale` | [`CreateClearSaleRequest`](../../doc/models/create-clear-sale-request.md) | Required | - | getClearsale(): CreateClearSaleRequest | setClearsale(CreateClearSaleRequest clearsale): void | 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `publicKeyHash` | `?string` | Optional | SHA–256 hash, Base64 string codified | getPublicKeyHash(): ?string | setPublicKeyHash(?string publicKeyHash): void | 15 | | `ephemeralPublicKey` | `string` | Required | X.509 encoded key bytes, Base64 encoded as a string | getEphemeralPublicKey(): string | setEphemeralPublicKey(string ephemeralPublicKey): void | 16 | | `transactionId` | `?string` | Optional | Transaction identifier, generated on Device | getTransactionId(): ?string | setTransactionId(?string transactionId): void | 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `enabled` | `bool` | Required | - | getEnabled(): bool | setEnabled(bool enabled): void | 13 | | `type` | `string` | Required | - | getType(): string | setType(string type): void | 14 | | `volumePercentage` | `int` | Required | - | getVolumePercentage(): int | setVolumePercentage(int volumePercentage): void | 15 | | `delay` | `int` | Required | - | getDelay(): int | setDelay(int delay): void | 16 | | `days` | `int[]` | Required | - | getDays(): array | setDays(array days): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "enabled": false, 23 | "type": "type0", 24 | "volume_percentage": 62, 25 | "delay": 228, 26 | "days": [ 27 | 188, 28 | 189, 29 | 190 30 | ] 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `bank` | `string` | Required | Bank | getBank(): string | setBank(string bank): void | 15 | | `retries` | `int` | Required | Number of retries | getRetries(): int | setRetries(int retries): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "bank": "bank8", 22 | "retries": 230 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `id` | `string` | Required | The split rule gateway id | getId(): string | setId(string id): void | 15 | | `amount` | `int` | Required | The split rule amount | getAmount(): int | setAmount(int amount): void | 16 | | `type` | `string` | Required | The amount type (flat ou percentage) | getType(): string | setType(string type): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "id": "id0", 23 | "Amount": 156, 24 | "type": "type0" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `cancelPendingInvoices` | `bool` | Required | Indicates if the pending invoices must also be canceled.
**Default**: `true` | getCancelPendingInvoices(): bool | setCancelPendingInvoices(bool cancelPendingInvoices): void | 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `verifyCard` | `bool` | Required | Indicates if the card should be verified before creation. If true, executes an authorization before saving the card. | getVerifyCard(): bool | setVerifyCard(bool verifyCard): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "verify_card": false 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `systemName` | `string` | Required | system name | getSystemName(): string | setSystemName(string systemName): void | 13 | | `model` | `string` | Required | model | getModel(): string | setModel(string model): void | 14 | | `provider` | `string` | Required | provider | getProvider(): string | setProvider(string provider): void | 15 | | `serialNumber` | `string` | Required | serial number | getSerialNumber(): string | setSerialNumber(string serialNumber): void | 16 | | `versionNumber` | `string` | Required | version number | getVersionNumber(): string | setVersionNumber(string versionNumber): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "system_name": "system_name0", 23 | "model": "model2", 24 | "provider": "provider8", 25 | "serial_number": "serial_number6", 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `number` | `string` | Required | Credit card number | getNumber(): string | setNumber(string number): void | 15 | | `holderName` | `string` | Required | Holder name, as written on the card | getHolderName(): string | setHolderName(string holderName): void | 16 | | `expMonth` | `int` | Required | The expiration month | getExpMonth(): int | setExpMonth(int expMonth): void | 17 | | `expYear` | `int` | Required | The expiration year, that can be informed with 2 or 4 digits | getExpYear(): int | setExpYear(int expYear): void | 18 | | `cvv` | `string` | Required | The card's security code | getCvv(): string | setCvv(string cvv): void | 19 | | `brand` | `string` | Required | Card brand | getBrand(): string | setBrand(string brand): void | 20 | | `label` | `string` | Required | - | getLabel(): string | setLabel(string label): void | 21 | 22 | ## Example (as JSON) 23 | 24 | ```json 25 | { 26 | "number": "number2", 27 | "holder_name": "holder_name4", 28 | "exp_month": 42, 29 | "exp_year": 254, 30 | "cvv": "cvv2", 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `description` | `string` | Required | Description | getDescription(): string | setDescription(string description): void | 13 | | `confirm` | `bool` | Required | Indicates whether cash collection will be confirmed in the act of creation | getConfirm(): bool | setConfirm(bool confirm): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "description": "description0", 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `bank` | `string[]` | Required | Bank | getBank(): array | setBank(array bank): void | 15 | | `retries` | `int` | Required | Number of retries for processing | getRetries(): int | setRetries(int retries): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "bank": [ 22 | "bank7" 23 | ], 24 | "retries": 230 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `bank` | `string` | Required | Bank identifier | getBank(): string | setBank(string bank): void | 13 | | `instructions` | `string` | Required | Instructions | getInstructions(): string | setInstructions(string instructions): void | 14 | | `dueAt` | `DateTime` | Required | Due date | getDueAt(): \DateTime | setDueAt(\DateTime dueAt): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "bank": "bank8", 21 | "instructions": "instructions2", 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `number` | `int` | Required | Installment quantity | getNumber(): int | setNumber(int number): void | 15 | | `total` | `int` | Required | Total amount | getTotal(): int | setTotal(int total): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "number": 158, 22 | "total": 10 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `statementDescriptor` | `?string` | Optional | Card invoice text descriptor | getStatementDescriptor(): ?string | setStatementDescriptor(?string statementDescriptor): void | 15 | | `authentication` | [`CreatePaymentAuthenticationRequest`](../../doc/models/create-payment-authentication-request.md) | Required | Creates payment authentication | getAuthentication(): CreatePaymentAuthenticationRequest | setAuthentication(CreatePaymentAuthenticationRequest authentication): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "statement_descriptor": "statement_descriptor0", 22 | "authentication": { 23 | "type": "type2", 24 | "threed_secure": { 25 | "mpi": "mpi6", 26 | "cavv": "cavv2", 27 | "eci": "eci6", 28 | "transaction_id": "transaction_id4", 29 | "success_url": "success_url8", 30 | "ds_transaction_id": "ds_transaction_id4" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `expiresAt` | `?DateTime` | Optional | Expires at | getExpiresAt(): ?\DateTime | setExpiresAt(?\DateTime expiresAt): void | 15 | | `expiresIn` | `?int` | Optional | Expires in | getExpiresIn(): ?int | setExpiresIn(?int expiresIn): void | 16 | | `additionalInformation` | [`?(PixAdditionalInformation[])`](../../doc/models/pix-additional-information.md) | Optional | Additional information | getAdditionalInformation(): ?array | setAdditionalInformation(?array additionalInformation): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "expires_at": "2016-03-13T12:52:32.123Z", 23 | "expires_in": 226, 24 | "additional_information": [ 25 | { 26 | "Name": "Name5", 27 | "Value": "Value7" 28 | }, 29 | { 30 | "Name": "Name6", 31 | "Value": "Value6" 32 | } 33 | ] 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `customSla` | `int` | Required | - | getCustomSla(): int | setCustomSla(int customSla): void | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "custom_sla": 224 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `description` | `string` | Required | Description | getDescription(): string | setDescription(string description): void | 13 | | `amount` | `?int` | Optional | Amount | getAmount(): ?int | setAmount(?int amount): void | 14 | | `code` | `string` | Required | Code reference | getCode(): string | setCode(string code): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "description": "description0", 21 | "Amount": 156, 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `platform` | `?string` | Optional | Device's platform | getPlatform(): ?string | setPlatform(?string platform): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "platform": "platform6" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `value` | `float` | Required | The discount value | getValue(): float | setValue(float value): void | 15 | | `discountType` | `string` | Required | Discount type. Can be either flat or percentage. | getDiscountType(): string | setDiscountType(string discountType): void | 16 | | `itemId` | `string` | Required | The item where the discount will be applied | getItemId(): string | setItemId(string itemId): void | 17 | | `cycles` | `?int` | Optional | Number of cycles that the discount will be applied | getCycles(): ?int | setCycles(?int cycles): void | 18 | | `description` | `?string` | Optional | Description | getDescription(): ?string | setDescription(?string description): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "value": 251.52, 25 | "discount_type": "discount_type8", 26 | "item_id": "item_id0", 27 | "cycles": 168, 28 | "description": "description0" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `cipher` | `string` | Required | Emv Decrypt cipher type | getCipher(): string | setCipher(string cipher): void | 13 | | `dukpt` | [`?CreateEmvDataDukptDecryptRequest`](../../doc/models/create-emv-data-dukpt-decrypt-request.md) | Optional | Dukpt data request | getDukpt(): ?CreateEmvDataDukptDecryptRequest | setDukpt(?CreateEmvDataDukptDecryptRequest dukpt): void | 14 | | `tags` | [`CreateEmvDataTlvDecryptRequest[]`](../../doc/models/create-emv-data-tlv-decrypt-request.md) | Required | Encrypted tags list | getTags(): array | setTags(array tags): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "cipher": "cipher4", 21 | "tags": [ 22 | { 23 | "tag": "tag9", 24 | "lenght": "lenght7", 25 | "value": "value7" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `ksn` | `string` | Required | Key serial number | getKsn(): string | setKsn(string ksn): void | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "ksn": "ksn4" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `tag` | `string` | Required | Emv tag | getTag(): string | setTag(string tag): void | 13 | | `lenght` | `string` | Required | Emv lenght | getLenght(): string | setLenght(string lenght): void | 14 | | `value` | `string` | Required | Emv value | getValue(): string | setValue(string value): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "tag": "tag6", 21 | "lenght": "lenght8", 22 | "value": "value2" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `days` | `int` | Required | Days | getDays(): int | setDays(int days): void | 15 | | `type` | `string` | Required | Type | getType(): string | setType(string type): void | 16 | | `amount` | `int` | Required | Amount | getAmount(): int | setAmount(int amount): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "days": 120, 23 | "type": "\"percentage\" or \"flat\"", 24 | "amount": 46 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `ephemeralPublicKey` | `string` | Required | X.509 encoded key bytes, Base64 encoded as a string | getEphemeralPublicKey(): string | setEphemeralPublicKey(string ephemeralPublicKey): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "ephemeral_public_key": "ephemeral_public_key0" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/create-google-pay-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Google Pay Request 3 | 4 | The GooglePay Token Payment Request 5 | 6 | ## Structure 7 | 8 | `CreateGooglePayRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `version` | `string` | Required | The token version | getVersion(): string | setVersion(string version): void | 15 | | `data` | `string` | Required | The cryptography data | getData(): string | setData(string data): void | 16 | | `header` | [`CreateGooglePayHeaderRequest`](../../doc/models/create-google-pay-header-request.md) | Required | The GooglePay header request | getHeader(): CreateGooglePayHeaderRequest | setHeader(CreateGooglePayHeaderRequest header): void | 17 | | `signature` | `string` | Required | Detached PKCS #7 signature, Base64 encoded as string | getSignature(): string | setSignature(string signature): void | 18 | | `merchantIdentifier` | `string` | Required | GooglePay Merchant identifier | getMerchantIdentifier(): string | setMerchantIdentifier(string merchantIdentifier): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "version": "version4", 25 | "data": "data0", 26 | "header": { 27 | "ephemeral_public_key": "ephemeral_public_key6" 28 | }, 29 | "signature": "signature8", 30 | "merchant_identifier": "merchant_identifier4" 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `value` | `float` | Required | The increment value | getValue(): float | setValue(float value): void | 15 | | `incrementType` | `string` | Required | Increment type. Can be either flat or percentage. | getIncrementType(): string | setIncrementType(string incrementType): void | 16 | | `itemId` | `string` | Required | The item where the increment will be applied | getItemId(): string | setItemId(string itemId): void | 17 | | `cycles` | `?int` | Optional | Number of cycles that the increment will be applied | getCycles(): ?int | setCycles(?int cycles): void | 18 | | `description` | `?string` | Optional | Description | getDescription(): ?string | setDescription(?string description): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "value": 251.52, 25 | "increment_type": "increment_type8", 26 | "item_id": "item_id0", 27 | "cycles": 168, 28 | "description": "description0" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `days` | `int` | Required | Days | getDays(): int | setDays(int days): void | 15 | | `type` | `string` | Required | Type | getType(): string | setType(string type): void | 16 | | `amount` | `int` | Required | Amount | getAmount(): int | setAmount(int amount): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "days": 120, 23 | "type": "\"percentage\" or \"flat\"", 24 | "amount": 46 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `metadata` | `array` | Required | Metadata | getMetadata(): array | setMetadata(array metadata): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "metadata": { 21 | "key0": "metadata3", 22 | "key1": "metadata4", 23 | "key2": "metadata5" 24 | } 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `latitude` | `string` | Required | Latitude | getLatitude(): string | setLatitude(string latitude): void | 15 | | `longitude` | `string` | Required | Longitude | getLongitude(): string | setLongitude(string longitude): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "latitude": "latitude6", 22 | "longitude": "longitude4" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `amount` | `int` | Required | Amount | getAmount(): int | setAmount(int amount): void | 15 | | `description` | `string` | Required | Description | getDescription(): string | setDescription(string description): void | 16 | | `quantity` | `int` | Required | Quantity | getQuantity(): int | setQuantity(int quantity): void | 17 | | `category` | `string` | Required | Category | getCategory(): string | setCategory(string category): void | 18 | | `code` | `?string` | Optional | The item code passed by the client | getCode(): ?string | setCode(?string code): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "amount": 46, 25 | "description": "description0", 26 | "quantity": 68, 27 | "category": "category2", 28 | "code": "code8" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `type` | `string` | Required | The Authentication type | getType(): string | setType(string type): void | 15 | | `threedSecure` | [`CreateThreeDSecureRequest`](../../doc/models/create-three-d-secure-request.md) | Required | The 3D-S authentication object | getThreedSecure(): CreateThreeDSecureRequest | setThreedSecure(CreateThreeDSecureRequest threedSecure): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "type": "type0", 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-period-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Create Period Request 3 | 4 | ## Structure 5 | 6 | `CreatePeriodRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `endAt` | `?DateTime` | Optional | - | getEndAt(): ?\DateTime | setEndAt(?\DateTime endAt): void | 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `countryCode` | `?string` | Optional | - | getCountryCode(): ?string | setCountryCode(?string countryCode): void | 13 | | `number` | `?string` | Optional | - | getNumber(): ?string | setNumber(?string number): void | 14 | | `areaCode` | `?string` | Optional | - | getAreaCode(): ?string | setAreaCode(?string areaCode): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "country_code": "country_code0", 21 | "number": "number2", 22 | "area_code": "area_code0" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `homePhone` | [`?CreatePhoneRequest`](../../doc/models/create-phone-request.md) | Optional | - | getHomePhone(): ?CreatePhoneRequest | setHomePhone(?CreatePhoneRequest homePhone): void | 13 | | `mobilePhone` | [`?CreatePhoneRequest`](../../doc/models/create-phone-request.md) | Optional | - | getMobilePhone(): ?CreatePhoneRequest | setMobilePhone(?CreatePhoneRequest mobilePhone): void | 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/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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `expiresAt` | `?DateTime` | Optional | Datetime when pix payment will expire | getExpiresAt(): ?\DateTime | setExpiresAt(?\DateTime expiresAt): void | 15 | | `expiresIn` | `?int` | Optional | Seconds until pix payment expires | getExpiresIn(): ?int | setExpiresIn(?int expiresIn): void | 16 | | `additionalInformation` | [`?(PixAdditionalInformation[])`](../../doc/models/pix-additional-information.md) | Optional | Pix additional information | getAdditionalInformation(): ?array | setAdditionalInformation(?array additionalInformation): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "expires_at": "2016-03-13T12:52:32.123Z", 23 | "expires_in": 226, 24 | "additional_information": [ 25 | { 26 | "Name": "Name5", 27 | "Value": "Value7" 28 | }, 29 | { 30 | "Name": "Name6", 31 | "Value": "Value6" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `startQuantity` | `int` | Required | Start quantity | getStartQuantity(): int | setStartQuantity(int startQuantity): void | 15 | | `price` | `int` | Required | Price | getPrice(): int | setPrice(int price): void | 16 | | `endQuantity` | `?int` | Optional | End quantity | getEndQuantity(): ?int | setEndQuantity(?int endQuantity): void | 17 | | `overagePrice` | `?int` | Optional | Overage price | getOveragePrice(): ?int | setOveragePrice(?int overagePrice): void | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "start_quantity": 46, 24 | "price": 16, 25 | "end_quantity": 54, 26 | "overage_price": 68 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `liable` | `?bool` | Optional | Liable options | getLiable(): ?bool | setLiable(?bool liable): void | 15 | | `chargeProcessingFee` | `?bool` | Optional | Charge processing fee | getChargeProcessingFee(): ?bool | setChargeProcessingFee(?bool chargeProcessingFee): void | 16 | | `chargeRemainderFee` | `?bool` | Optional | - | getChargeRemainderFee(): ?bool | setChargeRemainderFee(?bool chargeRemainderFee): void | 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `type` | `string` | Required | Split type | getType(): string | setType(string type): void | 15 | | `amount` | `int` | Required | Amount | getAmount(): int | setAmount(int amount): void | 16 | | `recipientId` | `string` | Required | Recipient id | getRecipientId(): string | setRecipientId(string recipientId): void | 17 | | `options` | [`?CreateSplitOptionsRequest`](../../doc/models/create-split-options-request.md) | Optional | The split options request | getOptions(): ?CreateSplitOptionsRequest | setOptions(?CreateSplitOptionsRequest options): void | 18 | | `splitRuleId` | `?string` | Optional | Rule code used in cancellation. | getSplitRuleId(): ?string | setSplitRuleId(?string splitRuleId): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "type": "type0", 25 | "amount": 46, 26 | "recipient_id": "recipient_id0", 27 | "options": { 28 | "liable": false, 29 | "charge_processing_fee": false, 30 | "charge_remainder_fee": false 31 | }, 32 | "split_rule_id": "split_rule_id2" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `interest` | [`?CreateInterestRequest`](../../doc/models/create-interest-request.md) | Optional | - | getInterest(): ?CreateInterestRequest | setInterest(?CreateInterestRequest interest): void | 15 | | `fine` | [`?CreateFineRequest`](../../doc/models/create-fine-request.md) | Optional | - | getFine(): ?CreateFineRequest | setFine(?CreateFineRequest fine): void | 16 | | `maxDaysToPayPastDue` | `?int` | Optional | - | getMaxDaysToPayPastDue(): ?int | setMaxDaysToPayPastDue(?int maxDaysToPayPastDue): void | 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": 122 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `enabled` | `bool` | Required | Defines if the split is enabled | getEnabled(): bool | setEnabled(bool enabled): void | 13 | | `rules` | [`CreateSplitRequest[]`](../../doc/models/create-split-request.md) | Required | Split | getRules(): array | setRules(array rules): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "enabled": false, 20 | "rules": [ 21 | { 22 | "type": "type6", 23 | "amount": 210, 24 | "recipient_id": "recipient_id6", 25 | "options": { 26 | "liable": false, 27 | "charge_processing_fee": false, 28 | "charge_remainder_fee": false 29 | }, 30 | "split_rule_id": "split_rule_id6" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `type` | `string` | Required | Token type
**Default**: `'card'` | getType(): string | setType(string type): void | 15 | | `card` | [`CreateCardTokenRequest`](../../doc/models/create-card-token-request.md) | Required | Card data | getCard(): CreateCardTokenRequest | setCard(CreateCardTokenRequest card): void | 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `name` | `string` | Required | - | getName(): string | setName(string name): void | 13 | | `startAt` | `?DateTime` | Optional | - | getStartAt(): ?\DateTime | setStartAt(?\DateTime startAt): void | 14 | | `endAt` | `?string` | Optional | - | getEndAt(): ?string | setEndAt(?string endAt): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "name": "name0", 21 | "start_at": "2016-03-13T12:52:32.123Z", 22 | "end_at": "end_at0" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `amount` | `int` | Required | Transfer amount | getAmount(): int | setAmount(int amount): void | 15 | | `metadata` | `array` | Required | Metadata | getMetadata(): array | setMetadata(array metadata): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "amount": 46, 22 | "metadata": { 23 | "key0": "metadata3", 24 | "key1": "metadata4", 25 | "key2": "metadata5" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `transferEnabled` | `bool` | Required | - | getTransferEnabled(): bool | setTransferEnabled(bool transferEnabled): void | 15 | | `transferInterval` | `string` | Required | - | getTransferInterval(): string | setTransferInterval(string transferInterval): void | 16 | | `transferDay` | `int` | Required | - | getTransferDay(): int | setTransferDay(int transferDay): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "transfer_enabled": false, 23 | "transfer_interval": "transfer_interval0", 24 | "transfer_day": 18 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `amount` | `int` | Required | - | getAmount(): int | setAmount(int amount): void | 13 | | `sourceId` | `string` | Required | - | getSourceId(): string | setSourceId(string sourceId): void | 14 | | `targetId` | `string` | Required | - | getTargetId(): string | setTargetId(string targetId): void | 15 | | `metadata` | `?(string[])` | Optional | - | getMetadata(): ?array | setMetadata(?array metadata): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "amount": 46, 22 | "source_id": "source_id6", 23 | "target_id": "target_id0", 24 | "metadata": [ 25 | "metadata3", 26 | "metadata4", 27 | "metadata5" 28 | ] 29 | } 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `quantity` | `int` | Required | - | getQuantity(): int | setQuantity(int quantity): void | 15 | | `description` | `string` | Required | - | getDescription(): string | setDescription(string description): void | 16 | | `usedAt` | `DateTime` | Required | - | getUsedAt(): \DateTime | setUsedAt(\DateTime usedAt): void | 17 | | `code` | `?string` | Optional | Identification code in the client system | getCode(): ?string | setCode(?string code): void | 18 | | `group` | `?string` | Optional | identification group in the client system | getGroup(): ?string | setGroup(?string group): void | 19 | | `amount` | `?int` | Optional | Field used in item scheme type 'Percent' | getAmount(): ?int | setAmount(?int amount): void | 20 | 21 | ## Example (as JSON) 22 | 23 | ```json 24 | { 25 | "quantity": 68, 26 | "description": "description0", 27 | "used_at": "2016-03-13T12:52:32.123Z", 28 | "code": "code8", 29 | "group": "group8", 30 | "amount": 46 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `amount` | `int` | Required | - | getAmount(): int | setAmount(int amount): void | 13 | | `metadata` | `?array` | Optional | - | getMetadata(): ?array | setMetadata(?array metadata): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "amount": 46, 20 | "metadata": { 21 | "key0": "metadata3", 22 | "key1": "metadata4", 23 | "key2": "metadata5" 24 | } 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /doc/models/error-exception.md: -------------------------------------------------------------------------------- 1 | 2 | # Error Exception 3 | 4 | Api Error Exception 5 | 6 | ## Structure 7 | 8 | `ErrorException` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `message` | `?string` | Required | - | getMessage(): ?string | setMessage(?string message): void | 15 | | `errors` | `?array` | Required | - | getErrors(): ?array | setErrors(?array errors): void | 16 | | `request` | `?array` | Required | - | getRequest(): ?array | setRequest(?array request): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "message": "message0", 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `id` | `?string` | Optional | - | getId(): ?string | setId(?string id): void | 15 | | `code` | `?string` | Optional | - | getCode(): ?string | setCode(?string code): void | 16 | | `status` | `?string` | Optional | - | getStatus(): ?string | setStatus(?string status): void | 17 | | `createdAt` | `?DateTime` | Optional | - | getCreatedAt(): ?\DateTime | setCreatedAt(?\DateTime createdAt): void | 18 | | `customer` | [`?GetCustomerResponse`](../../doc/models/get-customer-response.md) | Optional | - | getCustomer(): ?GetCustomerResponse | setCustomer(?GetCustomerResponse customer): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "id": "id0", 25 | "code": "code8", 26 | "status": "status8", 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `amount` | `?int` | Optional | Amount | getAmount(): ?int | setAmount(?int amount): void | 15 | | `anticipationFee` | `?int` | Optional | Anticipation fee | getAnticipationFee(): ?int | setAnticipationFee(?int anticipationFee): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "amount": 46, 22 | "anticipation_fee": 140 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `max` | [`?GetAnticipationLimitResponse`](../../doc/models/get-anticipation-limit-response.md) | Optional | Max limit | getMax(): ?GetAnticipationLimitResponse | setMax(?GetAnticipationLimitResponse max): void | 15 | | `min` | [`?GetAnticipationLimitResponse`](../../doc/models/get-anticipation-limit-response.md) | Optional | Min limit | getMin(): ?GetAnticipationLimitResponse | setMin(?GetAnticipationLimitResponse min): void | 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `status` | `?string` | Optional | - | getStatus(): ?string | setStatus(?string status): void | 13 | | `returnCode` | `?string` | Optional | - | getReturnCode(): ?string | setReturnCode(?string returnCode): void | 14 | | `returnMessage` | `?string` | Optional | - | getReturnMessage(): ?string | setReturnMessage(?string returnMessage): void | 15 | | `providerName` | `?string` | Optional | - | getProviderName(): ?string | setProviderName(?string providerName): void | 16 | | `score` | `?string` | Optional | - | getScore(): ?string | setScore(?string score): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "status": "status8", 23 | "return_code": "return_code0", 24 | "return_message": "return_message2", 25 | "provider_name": "provider_name2", 26 | "score": "score0" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `enabled` | `?bool` | Optional | - | getEnabled(): ?bool | setEnabled(?bool enabled): void | 13 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 14 | | `volumePercentage` | `?int` | Optional | - | getVolumePercentage(): ?int | setVolumePercentage(?int volumePercentage): void | 15 | | `delay` | `?int` | Optional | - | getDelay(): ?int | setDelay(?int delay): void | 16 | | `days` | `?(int[])` | Optional | - | getDays(): ?array | setDays(?array days): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "enabled": false, 23 | "type": "type0", 24 | "volume_percentage": 62, 25 | "delay": 228, 26 | "days": [ 27 | 188, 28 | 189, 29 | 190 30 | ] 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /doc/models/get-balance-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Balance Response 3 | 4 | Balance 5 | 6 | ## Structure 7 | 8 | `GetBalanceResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `currency` | `?string` | Optional | Currency | getCurrency(): ?string | setCurrency(?string currency): void | 15 | | `availableAmount` | `?int` | Optional | Amount available for transferring | getAvailableAmount(): ?int | setAvailableAmount(?int availableAmount): void | 16 | | `recipient` | [`?GetRecipientResponse`](../../doc/models/get-recipient-response.md) | Optional | Recipient | getRecipient(): ?GetRecipientResponse | setRecipient(?GetRecipientResponse recipient): void | 17 | | `transferredAmount` | `?int` | Optional | - | getTransferredAmount(): ?int | setTransferredAmount(?int transferredAmount): void | 18 | | `waitingFundsAmount` | `?int` | Optional | - | getWaitingFundsAmount(): ?int | setWaitingFundsAmount(?int waitingFundsAmount): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "currency": "currency0", 25 | "available_amount": 182, 26 | "recipient": { 27 | "id": "id8", 28 | "name": "name8", 29 | "email": "email8", 30 | "document": "document8", 31 | "description": "description2" 32 | }, 33 | "transferred_amount": 228, 34 | "waiting_funds_amount": 252 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `lastFourDigits` | `?string` | Optional | - | getLastFourDigits(): ?string | setLastFourDigits(?string lastFourDigits): void | 15 | | `holderName` | `?string` | Optional | - | getHolderName(): ?string | setHolderName(?string holderName): void | 16 | | `holderDocument` | `?string` | Optional | - | getHolderDocument(): ?string | setHolderDocument(?string holderDocument): void | 17 | | `expMonth` | `?int` | Optional | - | getExpMonth(): ?int | setExpMonth(?int expMonth): void | 18 | | `expYear` | `?int` | Optional | - | getExpYear(): ?int | setExpYear(?int expYear): void | 19 | | `brand` | `?string` | Optional | - | getBrand(): ?string | setBrand(?string brand): void | 20 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 21 | | `label` | `?string` | Optional | - | getLabel(): ?string | setLabel(?string label): void | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "last_four_digits": "last_four_digits6", 28 | "holder_name": "holder_name4", 29 | "holder_document": "holder_document6", 30 | "exp_month": 42, 31 | "exp_year": 254 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 | Getter | Setter | 17 | | --- | --- | --- | --- | --- | --- | 18 | | `description` | `?string` | Optional | Description | getDescription(): ?string | setDescription(?string description): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "gateway_id": "gateway_id0", 25 | "amount": 226, 26 | "status": "status2", 27 | "success": false, 28 | "created_at": "2016-03-13T12:52:32.123Z", 29 | "transaction_type": "cash", 30 | "description": "description0" 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `total` | `?int` | Optional | - | getTotal(): ?int | setTotal(?int total): void | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "total": 10 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `bank` | `?(string[])` | Optional | bank list response | getBank(): ?array | setBank(?array bank): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "bank": [ 21 | "bank7" 22 | ] 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `dueAt` | `?DateTime` | Optional | Data de vencimento do boleto | getDueAt(): ?\DateTime | setDueAt(?\DateTime dueAt): void | 13 | | `instructions` | `?string` | Optional | Instruções do boleto | getInstructions(): ?string | setInstructions(?string instructions): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "due_at": "2016-03-13T12:52:32.123Z", 20 | "instructions": "instructions2" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `number` | `?string` | Required | Número de parcelas | getNumber(): ?string | setNumber(?string number): void | 13 | | `total` | `?int` | Required | Valor total da compra | getTotal(): ?int | setTotal(?int total): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "number": "number2", 20 | "total": 10 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `statementDescriptor` | `?string` | Optional | Descrição na fatura | getStatementDescriptor(): ?string | setStatementDescriptor(?string statementDescriptor): void | 13 | | `authentication` | [`?GetPaymentAuthenticationResponse`](../../doc/models/get-payment-authentication-response.md) | Optional | Payment Authentication response object data | getAuthentication(): ?GetPaymentAuthenticationResponse | setAuthentication(?GetPaymentAuthenticationResponse authentication): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "statement_descriptor": "statement_descriptor0", 20 | "authentication": { 21 | "type": "type2", 22 | "threed_secure": { 23 | "mpi": "mpi6", 24 | "eci": "eci6", 25 | "cavv": "cavv2", 26 | "transaction_Id": "transaction_Id8", 27 | "success_url": "success_url8" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `expiresAt` | `?DateTime` | Optional | Expires at | getExpiresAt(): ?\DateTime | setExpiresAt(?\DateTime expiresAt): void | 15 | | `additionalInformation` | [`?(PixAdditionalInformation[])`](../../doc/models/pix-additional-information.md) | Optional | Additional information | getAdditionalInformation(): ?array | setAdditionalInformation(?array additionalInformation): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "expires_at": "2016-03-13T12:52:32.123Z", 22 | "additional_information": [ 23 | { 24 | "Name": "Name5", 25 | "Value": "Value7" 26 | }, 27 | { 28 | "Name": "Name6", 29 | "Value": "Value6" 30 | } 31 | ] 32 | } 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `platform` | `?string` | Optional | Device's platform name | getPlatform(): ?string | setPlatform(?string platform): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "platform": "platform6" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `days` | `?int` | Optional | Days | getDays(): ?int | setDays(?int days): void | 15 | | `type` | `?string` | Optional | Type | getType(): ?string | setType(?string type): void | 16 | | `amount` | `?int` | Optional | Amount | getAmount(): ?int | setAmount(?int amount): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "type": "\"percentage\" or \"flat\"", 23 | "days": 120, 24 | "amount": 46 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `message` | `?string` | Optional | The message error | getMessage(): ?string | setMessage(?string message): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "message": "message0" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `gateway` | `?string` | Optional | Gateway name | getGateway(): ?string | setGateway(?string gateway): void | 15 | | `status` | `?string` | Optional | Status of the recipient on the gateway | getStatus(): ?string | setStatus(?string status): void | 16 | | `pgid` | `?string` | Optional | Recipient id on the gateway | getPgid(): ?string | setPgid(?string pgid): void | 17 | | `createdAt` | `?string` | Optional | Creation date | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void | 18 | | `updatedAt` | `?string` | Optional | Last update date | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "gateway": "gateway0", 25 | "status": "status8", 26 | "pgid": "pgid4", 27 | "created_at": "created_at2", 28 | "updated_at": "updated_at4" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `code` | `?string` | Optional | The error code | getCode(): ?string | setCode(?string code): void | 15 | | `errors` | [`?(GetGatewayErrorResponse[])`](../../doc/models/get-gateway-error-response.md) | Optional | The gateway response errors list | getErrors(): ?array | setErrors(?array errors): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "code": "code8", 22 | "errors": [ 23 | { 24 | "message": "message5" 25 | }, 26 | { 27 | "message": "message6" 28 | }, 29 | { 30 | "message": "message7" 31 | } 32 | ] 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `days` | `?int` | Optional | Days | getDays(): ?int | setDays(?int days): void | 15 | | `type` | `?string` | Optional | Type | getType(): ?string | setType(?string type): void | 16 | | `amount` | `?int` | Optional | Amount | getAmount(): ?int | setAmount(?int amount): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "type": "\"percentage\" or \"flat\"", 23 | "days": 120, 24 | "amount": 46 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `latitude` | `?string` | Optional | Latitude | getLatitude(): ?string | setLatitude(?string latitude): void | 15 | | `longitude` | `?string` | Optional | Longitude | getLongitude(): ?string | setLongitude(?string longitude): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "latitude": "latitude6", 22 | "longitude": "longitude4" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /doc/models/get-movement-object-base-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Movement Object Base Response 3 | 4 | Generic response object for getting a MovementObjectBase. 5 | 6 | ## Structure 7 | 8 | `GetMovementObjectBaseResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `object` | `?string` | Optional | - | getObject(): ?string | setObject(?string object): void | 15 | | `id` | `?string` | Optional | - | getId(): ?string | setId(?string id): void | 16 | | `status` | `?string` | Optional | - | getStatus(): ?string | setStatus(?string status): void | 17 | | `amount` | `?string` | Optional | - | getAmount(): ?string | setAmount(?string amount): void | 18 | | `createdAt` | `?string` | Optional | - | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void | 19 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 20 | | `chargeId` | `?string` | Optional | - | getChargeId(): ?string | setChargeId(?string chargeId): void | 21 | | `gatewayId` | `?string` | Optional | - | getGatewayId(): ?string | setGatewayId(?string gatewayId): void | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "object": "MovementObject", 28 | "id": "id0", 29 | "status": "status8", 30 | "amount": "amount8", 31 | "created_at": "created_at2" 32 | } 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 17 | | --- | --- | --- | --- | --- | --- | 18 | | `description` | `?string` | Optional | - | getDescription(): ?string | setDescription(?string description): void | 19 | | `paymentDate` | `?string` | Optional | - | getPaymentDate(): ?string | setPaymentDate(?string paymentDate): void | 20 | | `recipientId` | `?string` | Optional | - | getRecipientId(): ?string | setRecipientId(?string recipientId): void | 21 | 22 | ## Example (as JSON) 23 | 24 | ```json 25 | { 26 | "object": "feeCollection", 27 | "id": "id4", 28 | "status": "status4", 29 | "amount": "amount6", 30 | "created_at": "created_at2", 31 | "description": "description0", 32 | "payment_date": "payment_date8", 33 | "recipient_id": "recipient_id0" 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /doc/models/get-order-item-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Order Item Response 3 | 4 | Response object for getting an order item 5 | 6 | ## Structure 7 | 8 | `GetOrderItemResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `id` | `?string` | Optional | Id | getId(): ?string | setId(?string id): void | 15 | | `amount` | `?int` | Optional | - | getAmount(): ?int | setAmount(?int amount): void | 16 | | `description` | `?string` | Optional | - | getDescription(): ?string | setDescription(?string description): void | 17 | | `quantity` | `?int` | Optional | - | getQuantity(): ?int | setQuantity(?int quantity): void | 18 | | `category` | `?string` | Optional | Category | getCategory(): ?string | setCategory(?string category): void | 19 | | `code` | `?string` | Optional | Code | getCode(): ?string | setCode(?string code): void | 20 | 21 | ## Example (as JSON) 22 | 23 | ```json 24 | { 25 | "id": "id0", 26 | "amount": 46, 27 | "description": "description0", 28 | "quantity": 68, 29 | "category": "category2" 30 | } 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 15 | | `threedSecure` | [`?GetThreeDSecureResponse`](../../doc/models/get-three-d-secure-response.md) | Optional | 3D-S payment authentication response | getThreedSecure(): ?GetThreeDSecureResponse | setThreedSecure(?GetThreeDSecureResponse threedSecure): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "type": "type0", 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-phone-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Phone Response 3 | 4 | ## Structure 5 | 6 | `GetPhoneResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `countryCode` | `?string` | Optional | - | getCountryCode(): ?string | setCountryCode(?string countryCode): void | 13 | | `number` | `?string` | Optional | - | getNumber(): ?string | setNumber(?string number): void | 14 | | `areaCode` | `?string` | Optional | - | getAreaCode(): ?string | setAreaCode(?string areaCode): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "country_code": "country_code0", 21 | "number": "number2", 22 | "area_code": "area_code0" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `homePhone` | [`?GetPhoneResponse`](../../doc/models/get-phone-response.md) | Optional | - | getHomePhone(): ?GetPhoneResponse | setHomePhone(?GetPhoneResponse homePhone): void | 13 | | `mobilePhone` | [`?GetPhoneResponse`](../../doc/models/get-phone-response.md) | Optional | - | getMobilePhone(): ?GetPhoneResponse | setMobilePhone(?GetPhoneResponse mobilePhone): void | 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `bankName` | `?string` | Optional | - | getBankName(): ?string | setBankName(?string bankName): void | 15 | | `ispb` | `?string` | Optional | - | getIspb(): ?string | setIspb(?string ispb): void | 16 | | `branchCode` | `?string` | Optional | - | getBranchCode(): ?string | setBranchCode(?string branchCode): void | 17 | | `accountNumber` | `?string` | Optional | - | getAccountNumber(): ?string | setAccountNumber(?string accountNumber): void | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "bank_name": "bank_name4", 24 | "ispb": "ispb4", 25 | "branch_code": "branch_code8", 26 | "account_number": "account_number0" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `name` | `?string` | Optional | - | getName(): ?string | setName(?string name): void | 15 | | `document` | `?string` | Optional | - | getDocument(): ?string | setDocument(?string document): void | 16 | | `documentType` | `?string` | Optional | - | getDocumentType(): ?string | setDocumentType(?string documentType): void | 17 | | `bankAccount` | [`?GetPixBankAccountResponse`](../../doc/models/get-pix-bank-account-response.md) | Optional | - | getBankAccount(): ?GetPixBankAccountResponse | setBankAccount(?GetPixBankAccountResponse bankAccount): void | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "name": "name0", 24 | "document": "document6", 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `startQuantity` | `?int` | Optional | - | getStartQuantity(): ?int | setStartQuantity(?int startQuantity): void | 15 | | `price` | `?int` | Optional | - | getPrice(): ?int | setPrice(?int price): void | 16 | | `endQuantity` | `?int` | Optional | - | getEndQuantity(): ?int | setEndQuantity(?int endQuantity): void | 17 | | `overagePrice` | `?int` | Optional | - | getOveragePrice(): ?int | setOveragePrice(?int overagePrice): void | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "start_quantity": 46, 24 | "price": 16, 25 | "end_quantity": 54, 26 | "overage_price": 68 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/get-safety-pay-transaction-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Safety Pay Transaction Response 3 | 4 | Response object for getting a safety pay transaction 5 | 6 | ## Structure 7 | 8 | `GetSafetyPayTransactionResponse` 9 | 10 | ## Inherits From 11 | 12 | [`GetTransactionResponse`](../../doc/models/get-transaction-response.md) 13 | 14 | ## Fields 15 | 16 | | Name | Type | Tags | Description | Getter | Setter | 17 | | --- | --- | --- | --- | --- | --- | 18 | | `url` | `?string` | Optional | Payment url | getUrl(): ?string | setUrl(?string url): void | 19 | | `bankTid` | `?string` | Optional | Transaction identifier on bank | getBankTid(): ?string | setBankTid(?string bankTid): void | 20 | | `paidAt` | `?DateTime` | Optional | Payment date | getPaidAt(): ?\DateTime | setPaidAt(?\DateTime paidAt): void | 21 | | `paidAmount` | `?int` | Optional | Paid amount | getPaidAmount(): ?int | setPaidAmount(?int paidAmount): void | 22 | 23 | ## Example (as JSON) 24 | 25 | ```json 26 | { 27 | "gateway_id": "gateway_id6", 28 | "amount": 62, 29 | "status": "status6", 30 | "success": false, 31 | "created_at": "2016-03-13T12:52:32.123Z", 32 | "transaction_type": "safetypay", 33 | "url": "url4", 34 | "bank_tid": "bank_tid4", 35 | "paid_at": "2016-03-13T12:52:32.123Z", 36 | "paid_amount": 210 37 | } 38 | ``` 39 | 40 | -------------------------------------------------------------------------------- /doc/models/get-sellers-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Sellers Request 3 | 4 | ## Structure 5 | 6 | `GetSellersRequest` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `name` | `string` | Required | - | getName(): string | setName(string name): void | 13 | | `document` | `string` | Required | - | getDocument(): string | setDocument(string document): void | 14 | | `code` | `string` | Required | - | getCode(): string | setCode(string code): void | 15 | | `status` | `string` | Required | - | getStatus(): string | setStatus(string status): void | 16 | | `type` | `string` | Required | - | getType(): string | setType(string type): void | 17 | | `createdSince` | `?string` | Optional | - | getCreatedSince(): ?string | setCreatedSince(?string createdSince): void | 18 | | `createdUntil` | `?string` | Optional | - | getCreatedUntil(): ?string | setCreatedUntil(?string createdUntil): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "name": "name0", 25 | "document": "document6", 26 | "code": "code8", 27 | "status": "status8", 28 | "type": "type0", 29 | "created_Since": null, 30 | "created_Until": null 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `id` | `?string` | Optional | - | getId(): ?string | setId(?string id): void | 15 | | `description` | `?string` | Optional | - | getDescription(): ?string | setDescription(?string description): void | 16 | | `amount` | `?int` | Optional | - | getAmount(): ?int | setAmount(?int amount): void | 17 | | `status` | `?string` | Optional | - | getStatus(): ?string | setStatus(?string status): void | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "id": "id0", 24 | "description": "description0", 25 | "amount": 46, 26 | "status": "status8" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `liable` | `?bool` | Optional | - | getLiable(): ?bool | setLiable(?bool liable): void | 13 | | `chargeProcessingFee` | `?bool` | Optional | - | getChargeProcessingFee(): ?bool | setChargeProcessingFee(?bool chargeProcessingFee): void | 14 | | `chargeRemainderFee` | `?string` | Optional | - | getChargeRemainderFee(): ?string | setChargeRemainderFee(?string chargeRemainderFee): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "liable": false, 21 | "charge_processing_fee": false, 22 | "charge_remainder_fee": "charge_remainder_fee8" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `interest` | [`?GetInterestResponse`](../../doc/models/get-interest-response.md) | Optional | Interest | getInterest(): ?GetInterestResponse | setInterest(?GetInterestResponse interest): void | 15 | | `fine` | [`?GetFineResponse`](../../doc/models/get-fine-response.md) | Optional | Fine | getFine(): ?GetFineResponse | setFine(?GetFineResponse fine): void | 16 | | `maxDaysToPayPastDue` | `?int` | Optional | - | getMaxDaysToPayPastDue(): ?int | setMaxDaysToPayPastDue(?int maxDaysToPayPastDue): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "interest": { 23 | "days": 2, 24 | "type": "percentage", 25 | "amount": 20 26 | }, 27 | "fine": { 28 | "days": 2, 29 | "type": "flat", 30 | "amount": 10 31 | }, 32 | "max_days_to_pay_past_due": 2 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /doc/models/get-subscription-split-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Subscription Split Response 3 | 4 | ## Structure 5 | 6 | `GetSubscriptionSplitResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `enabled` | `?bool` | Optional | Defines if the split is enabled | getEnabled(): ?bool | setEnabled(?bool enabled): void | 13 | | `rules` | [`?(GetSplitResponse[])`](../../doc/models/get-split-response.md) | Optional | Split | getRules(): ?array | setRules(?array rules): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "enabled": false, 20 | "rules": [ 21 | { 22 | "type": "type6", 23 | "amount": 210, 24 | "recipient": { 25 | "id": "id4", 26 | "name": "name4", 27 | "email": "email2", 28 | "document": "document2", 29 | "description": "description6" 30 | }, 31 | "gateway_id": "gateway_id6", 32 | "options": { 33 | "liable": false, 34 | "charge_processing_fee": false, 35 | "charge_remainder_fee": "charge_remainder_fee6" 36 | } 37 | } 38 | ] 39 | } 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `mpi` | `?string` | Optional | MPI Vendor | getMpi(): ?string | setMpi(?string mpi): void | 15 | | `eci` | `?string` | Optional | Electronic Commerce Indicator (ECI) (Opcional) | getEci(): ?string | setEci(?string eci): void | 16 | | `cavv` | `?string` | Optional | Online payment cryptogram, definido pelo 3-D Secure. | getCavv(): ?string | setCavv(?string cavv): void | 17 | | `transactionId` | `?string` | Optional | Identificador da transação (XID) | getTransactionId(): ?string | setTransactionId(?string transactionId): void | 18 | | `successUrl` | `?string` | Optional | Url de redirecionamento de sucessso | getSuccessUrl(): ?string | setSuccessUrl(?string successUrl): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "mpi": "mpi2", 25 | "eci": "eci0", 26 | "cavv": "cavv4", 27 | "transaction_Id": "transaction_Id4", 28 | "success_url": "success_url2" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `id` | `?string` | Optional | - | getId(): ?string | setId(?string id): void | 15 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 16 | | `createdAt` | `?DateTime` | Optional | - | getCreatedAt(): ?\DateTime | setCreatedAt(?\DateTime createdAt): void | 17 | | `expiresAt` | `?string` | Optional | - | getExpiresAt(): ?string | setExpiresAt(?string expiresAt): void | 18 | | `card` | [`?GetCardTokenResponse`](../../doc/models/get-card-token-response.md) | Optional | - | getCard(): ?GetCardTokenResponse | setCard(?GetCardTokenResponse card): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "id": "id0", 25 | "type": "type0", 26 | "created_at": "2016-03-13T12:52:32.123Z", 27 | "expires_at": "expires_at6", 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `name` | `?string` | Optional | - | getName(): ?string | setName(?string name): void | 13 | | `date` | `?DateTime` | Optional | - | getDate(): ?\DateTime | setDate(?\DateTime date): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "name": "name0", 20 | "date": "2016-03-13T12:52:32.123Z" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/get-transfer-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Transfer Response 3 | 4 | Transfer response 5 | 6 | ## Structure 7 | 8 | `GetTransferResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `id` | `?string` | Optional | Id | getId(): ?string | setId(?string id): void | 15 | | `amount` | `?int` | Optional | Transfer amount | getAmount(): ?int | setAmount(?int amount): void | 16 | | `status` | `?string` | Optional | Transfer status | getStatus(): ?string | setStatus(?string status): void | 17 | | `createdAt` | `?DateTime` | Optional | Transfer creation date | getCreatedAt(): ?\DateTime | setCreatedAt(?\DateTime createdAt): void | 18 | | `updatedAt` | `?DateTime` | Optional | Transfer last update date | getUpdatedAt(): ?\DateTime | setUpdatedAt(?\DateTime updatedAt): void | 19 | | `bankAccount` | [`?GetBankAccountResponse`](../../doc/models/get-bank-account-response.md) | Optional | Bank account | getBankAccount(): ?GetBankAccountResponse | setBankAccount(?GetBankAccountResponse bankAccount): void | 20 | | `metadata` | `?array` | Optional | Metadata | getMetadata(): ?array | setMetadata(?array metadata): void | 21 | 22 | ## Example (as JSON) 23 | 24 | ```json 25 | { 26 | "id": "id0", 27 | "amount": 46, 28 | "status": "status8", 29 | "created_at": "2016-03-13T12:52:32.123Z", 30 | "updated_at": "2016-03-13T12:52:32.123Z" 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /doc/models/get-transfer-settings-response.md: -------------------------------------------------------------------------------- 1 | 2 | # Get Transfer Settings Response 3 | 4 | ## Structure 5 | 6 | `GetTransferSettingsResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `transferEnabled` | `?bool` | Optional | - | getTransferEnabled(): ?bool | setTransferEnabled(?bool transferEnabled): void | 13 | | `transferInterval` | `?string` | Optional | - | getTransferInterval(): ?string | setTransferInterval(?string transferInterval): void | 14 | | `transferDay` | `?int` | Optional | - | getTransferDay(): ?int | setTransferDay(?int transferDay): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "transfer_enabled": false, 21 | "transfer_interval": "transfer_interval0", 22 | "transfer_day": 18 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `sourceId` | `?string` | Optional | - | getSourceId(): ?string | setSourceId(?string sourceId): void | 13 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "source_id": "source_id6", 20 | "type": "type0" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `targetId` | `?string` | Optional | - | getTargetId(): ?string | setTargetId(?string targetId): void | 13 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `url` | `?string` | Optional | - | getUrl(): ?string | setUrl(?string url): void | 13 | | `usageReportUrl` | `?string` | Optional | - | getUsageReportUrl(): ?string | setUsageReportUrl(?string usageReportUrl): void | 14 | | `groupedReportUrl` | `?string` | Optional | - | getGroupedReportUrl(): ?string | setGroupedReportUrl(?string groupedReportUrl): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "url": "url4", 21 | "usage_report_url": "usage_report_url2", 22 | "grouped_report_url": "grouped_report_url2" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `sourceId` | `?string` | Optional | - | getSourceId(): ?string | setSourceId(?string sourceId): void | 13 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "source_id": "source_id6", 20 | "type": "type0" 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `targetId` | `?string` | Optional | - | getTargetId(): ?string | setTargetId(?string targetId): void | 13 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "target_id": "target_id0", 20 | "type": "type0" 21 | } 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /doc/models/list-addresses-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Addresses Response 3 | 4 | Response object for listing addresses 5 | 6 | ## Structure 7 | 8 | `ListAddressesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetAddressResponse[])`](../../doc/models/get-address-response.md) | Optional | The address objects | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "street": "street5", 25 | "number": "number3", 26 | "complement": "complement1", 27 | "zip_code": "zip_code9" 28 | }, 29 | { 30 | "id": "id6", 31 | "street": "street6", 32 | "number": "number4", 33 | "complement": "complement2", 34 | "zip_code": "zip_code0" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-balance-operation-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Balance Operation Response 3 | 4 | Response object for listing BalanceOperation objects 5 | 6 | ## Structure 7 | 8 | `ListBalanceOperationResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetBalanceOperationResponse[])`](../../doc/models/get-balance-operation-response.md) | Optional | The BalanceOperation object | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | - | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "status": "status7", 25 | "balance_amount": "balance_amount5", 26 | "balance_old_amount": "balance_old_amount3", 27 | "type": "type5" 28 | }, 29 | { 30 | "id": "id6", 31 | "status": "status8", 32 | "balance_amount": "balance_amount6", 33 | "balance_old_amount": "balance_old_amount4", 34 | "type": "type6" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-cards-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Cards Response 3 | 4 | Response object for listing cards 5 | 6 | ## Structure 7 | 8 | `ListCardsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetCardResponse[])`](../../doc/models/get-card-response.md) | Optional | The card objects | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "last_four_digits": "last_four_digits1", 25 | "brand": "brand9", 26 | "holder_name": "holder_name1", 27 | "exp_month": 125 28 | }, 29 | { 30 | "id": "id6", 31 | "last_four_digits": "last_four_digits2", 32 | "brand": "brand0", 33 | "holder_name": "holder_name2", 34 | "exp_month": 126 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-charge-transactions-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Charge Transactions Response 3 | 4 | Response object for listing charge transactions 5 | 6 | ## Structure 7 | 8 | `ListChargeTransactionsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetTransactionResponse[])`](../../doc/models/get-transaction-response.md) | Optional | The charge transactions objects | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "gateway_id": "gateway_id5", 24 | "amount": 121, 25 | "status": "status7", 26 | "success": true, 27 | "created_at": "2016-03-13T12:52:32.123Z", 28 | "transaction_type": "transaction" 29 | }, 30 | { 31 | "gateway_id": "gateway_id6", 32 | "amount": 122, 33 | "status": "status8", 34 | "success": false, 35 | "created_at": "2016-03-13T12:52:32.123Z", 36 | "transaction_type": "transaction" 37 | } 38 | ], 39 | "paging": { 40 | "total": 6, 41 | "previous": "previous2", 42 | "next": "next8" 43 | } 44 | } 45 | ``` 46 | 47 | -------------------------------------------------------------------------------- /doc/models/list-charges-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Charges Response 3 | 4 | Response object for listing charges 5 | 6 | ## Structure 7 | 8 | `ListChargesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetChargeResponse[])`](../../doc/models/get-charge-response.md) | Optional | The charge objects | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "code": "code3", 25 | "gateway_id": "gateway_id5", 26 | "amount": 121, 27 | "status": "status7" 28 | }, 29 | { 30 | "id": "id6", 31 | "code": "code4", 32 | "gateway_id": "gateway_id6", 33 | "amount": 122, 34 | "status": "status8" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-customers-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Customers Response 3 | 4 | Response for listing the customers 5 | 6 | ## Structure 7 | 8 | `ListCustomersResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetCustomerResponse[])`](../../doc/models/get-customer-response.md) | Optional | The customer object | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "name": "name5", 25 | "email": "email9", 26 | "delinquent": true, 27 | "created_at": "2016-03-13T12:52:32.123Z" 28 | }, 29 | { 30 | "id": "id6", 31 | "name": "name6", 32 | "email": "email0", 33 | "delinquent": false, 34 | "created_at": "2016-03-13T12:52:32.123Z" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-discounts-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Discounts Response 3 | 4 | ## Structure 5 | 6 | `ListDiscountsResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `data` | [`?(GetDiscountResponse[])`](../../doc/models/get-discount-response.md) | Optional | The Discounts response | getData(): ?array | setData(?array data): void | 13 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "data": [ 20 | { 21 | "id": "id5", 22 | "value": 145.67, 23 | "discount_type": "discount_type3", 24 | "status": "status7", 25 | "created_at": "2016-03-13T12:52:32.123Z" 26 | }, 27 | { 28 | "id": "id6", 29 | "value": 145.68, 30 | "discount_type": "discount_type4", 31 | "status": "status8", 32 | "created_at": "2016-03-13T12:52:32.123Z" 33 | } 34 | ], 35 | "paging": { 36 | "total": 6, 37 | "previous": "previous2", 38 | "next": "next8" 39 | } 40 | } 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /doc/models/list-increments-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Increments Response 3 | 4 | ## Structure 5 | 6 | `ListIncrementsResponse` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `data` | [`?(GetIncrementResponse[])`](../../doc/models/get-increment-response.md) | Optional | The Increments response | getData(): ?array | setData(?array data): void | 13 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "data": [ 20 | { 21 | "id": "id5", 22 | "value": 145.67, 23 | "increment_type": "increment_type7", 24 | "status": "status7", 25 | "created_at": "2016-03-13T12:52:32.123Z" 26 | }, 27 | { 28 | "id": "id6", 29 | "value": 145.68, 30 | "increment_type": "increment_type8", 31 | "status": "status8", 32 | "created_at": "2016-03-13T12:52:32.123Z" 33 | } 34 | ], 35 | "paging": { 36 | "total": 6, 37 | "previous": "previous2", 38 | "next": "next8" 39 | } 40 | } 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /doc/models/list-invoices-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Invoices Response 3 | 4 | Response object for listing invoices 5 | 6 | ## Structure 7 | 8 | `ListInvoicesResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetInvoiceResponse[])`](../../doc/models/get-invoice-response.md) | Optional | The Invoice objects | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "code": "code3", 25 | "url": "url9", 26 | "amount": 121, 27 | "status": "status7" 28 | }, 29 | { 30 | "id": "id6", 31 | "code": "code4", 32 | "url": "url0", 33 | "amount": 122, 34 | "status": "status8" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetPayableResponse[])`](../../doc/models/get-payable-response.md) | Optional | The payable object | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": 23, 24 | "status": "status7", 25 | "amount": 121, 26 | "fee": 79, 27 | "anticipation_fee": 27 28 | }, 29 | { 30 | "id": 24, 31 | "status": "status8", 32 | "amount": 122, 33 | "fee": 80, 34 | "anticipation_fee": 28 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-plans-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Plans Response 3 | 4 | Response object for listing plans 5 | 6 | ## Structure 7 | 8 | `ListPlansResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetPlanResponse[])`](../../doc/models/get-plan-response.md) | Optional | The plan objects | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "name": "name5", 25 | "description": "description5", 26 | "url": "url9", 27 | "statement_descriptor": "statement_descriptor5" 28 | }, 29 | { 30 | "id": "id6", 31 | "name": "name6", 32 | "description": "description6", 33 | "url": "url0", 34 | "statement_descriptor": "statement_descriptor6" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-recipient-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Recipient Response 3 | 4 | Response for the listing recipient method 5 | 6 | ## Structure 7 | 8 | `ListRecipientResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetRecipientResponse[])`](../../doc/models/get-recipient-response.md) | Optional | Recipients | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "name": "name5", 25 | "email": "email9", 26 | "document": "document9", 27 | "description": "description5" 28 | }, 29 | { 30 | "id": "id6", 31 | "name": "name6", 32 | "email": "email0", 33 | "document": "document0", 34 | "description": "description6" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-subscription-items-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Subscription Items Response 3 | 4 | Response model for listing subscription items 5 | 6 | ## Structure 7 | 8 | `ListSubscriptionItemsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetSubscriptionItemResponse[])`](../../doc/models/get-subscription-item-response.md) | Optional | The subscription items | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "description": "description5", 25 | "status": "status7", 26 | "created_at": "2016-03-13T12:52:32.123Z", 27 | "updated_at": "2016-03-13T12:52:32.123Z" 28 | }, 29 | { 30 | "id": "id6", 31 | "description": "description6", 32 | "status": "status8", 33 | "created_at": "2016-03-13T12:52:32.123Z", 34 | "updated_at": "2016-03-13T12:52:32.123Z" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-subscriptions-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Subscriptions Response 3 | 4 | Response object for listing subscriptions 5 | 6 | ## Structure 7 | 8 | `ListSubscriptionsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetSubscriptionResponse[])`](../../doc/models/get-subscription-response.md) | Optional | The subscription objects | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "code": "code3", 25 | "start_at": "2016-03-13T12:52:32.123Z", 26 | "interval": "interval3", 27 | "interval_count": 249 28 | }, 29 | { 30 | "id": "id6", 31 | "code": "code4", 32 | "start_at": "2016-03-13T12:52:32.123Z", 33 | "interval": "interval4", 34 | "interval_count": 250 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetTransactionReportFileResponse[])`](../../doc/models/get-transaction-report-file-response.md) | Optional | - | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "name": "name5", 24 | "date": "2016-03-13T12:52:32.123Z" 25 | }, 26 | { 27 | "name": "name6", 28 | "date": "2016-03-13T12:52:32.123Z" 29 | } 30 | ], 31 | "paging": { 32 | "total": 6, 33 | "previous": "previous2", 34 | "next": "next8" 35 | } 36 | } 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /doc/models/list-transactions-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Transactions Response 3 | 4 | Response object for listing transactions 5 | 6 | ## Structure 7 | 8 | `ListTransactionsResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetTransactionResponse[])`](../../doc/models/get-transaction-response.md) | Optional | The transaction objects | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "gateway_id": "gateway_id5", 24 | "amount": 121, 25 | "status": "status7", 26 | "success": true, 27 | "created_at": "2016-03-13T12:52:32.123Z", 28 | "transaction_type": "transaction" 29 | }, 30 | { 31 | "gateway_id": "gateway_id6", 32 | "amount": 122, 33 | "status": "status8", 34 | "success": false, 35 | "created_at": "2016-03-13T12:52:32.123Z", 36 | "transaction_type": "transaction" 37 | } 38 | ], 39 | "paging": { 40 | "total": 6, 41 | "previous": "previous2", 42 | "next": "next8" 43 | } 44 | } 45 | ``` 46 | 47 | -------------------------------------------------------------------------------- /doc/models/list-transfer-response.md: -------------------------------------------------------------------------------- 1 | 2 | # List Transfer Response 3 | 4 | List of paginated transfer objects 5 | 6 | ## Structure 7 | 8 | `ListTransferResponse` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetTransferResponse[])`](../../doc/models/get-transfer-response.md) | Optional | Transfers | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "amount": 121, 25 | "status": "status7", 26 | "created_at": "2016-03-13T12:52:32.123Z", 27 | "updated_at": "2016-03-13T12:52:32.123Z" 28 | }, 29 | { 30 | "id": "id6", 31 | "amount": 122, 32 | "status": "status8", 33 | "created_at": "2016-03-13T12:52:32.123Z", 34 | "updated_at": "2016-03-13T12:52:32.123Z" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `data` | [`?(GetUsageResponse[])`](../../doc/models/get-usage-response.md) | Optional | The usage objects | getData(): ?array | setData(?array data): void | 15 | | `paging` | [`?PagingResponse`](../../doc/models/paging-response.md) | Optional | Paging object | getPaging(): ?PagingResponse | setPaging(?PagingResponse paging): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "data": [ 22 | { 23 | "id": "id5", 24 | "quantity": 235, 25 | "description": "description5", 26 | "used_at": "2016-03-13T12:52:32.123Z", 27 | "created_at": "2016-03-13T12:52:32.123Z" 28 | }, 29 | { 30 | "id": "id6", 31 | "quantity": 236, 32 | "description": "description6", 33 | "used_at": "2016-03-13T12:52:32.123Z", 34 | "created_at": "2016-03-13T12:52:32.123Z" 35 | } 36 | ], 37 | "paging": { 38 | "total": 6, 39 | "previous": "previous2", 40 | "next": "next8" 41 | } 42 | } 43 | ``` 44 | 45 | -------------------------------------------------------------------------------- /doc/models/list-withdrawals.md: -------------------------------------------------------------------------------- 1 | 2 | # List Withdrawals 3 | 4 | ## Structure 5 | 6 | `ListWithdrawals` 7 | 8 | ## Fields 9 | 10 | | Name | Type | Tags | Description | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `data` | [`GetWithdrawResponse[]`](../../doc/models/get-withdraw-response.md) | Required | The Increments response | getData(): array | setData(array data): void | 13 | | `paging` | [`PagingResponse`](../../doc/models/paging-response.md) | Required | Paging object | getPaging(): PagingResponse | setPaging(PagingResponse paging): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "data": [ 20 | { 21 | "id": "id5", 22 | "gateway_id": "gateway_id5", 23 | "amount": 121, 24 | "status": "status7", 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `total` | `?int` | Optional | Total number of pages | getTotal(): ?int | setTotal(?int total): void | 15 | | `previous` | `?string` | Optional | Previous page | getPrevious(): ?string | setPrevious(?string previous): void | 16 | | `next` | `?string` | Optional | Next page | getNext(): ?string | setNext(?string next): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "total": 10, 23 | "previous": "previous8", 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `name` | `?string` | Optional | - | getName(): ?string | setName(?string name): void | 15 | | `value` | `?string` | Optional | - | getValue(): ?string | setValue(?string value): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "Name": "Name0", 22 | "Value": "Value2" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `number` | `string` | Required | Number | getNumber(): string | setNumber(string number): void | 15 | | `complement` | `string` | Required | Complement | getComplement(): string | setComplement(string complement): void | 16 | | `metadata` | `array` | Required | Metadata | getMetadata(): array | setMetadata(array metadata): void | 17 | | `line2` | `string` | Required | Line 2 for address | getLine2(): string | setLine2(string line2): void | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "number": "number2", 24 | "complement": "complement4", 25 | "metadata": { 26 | "key0": "metadata3", 27 | "key1": "metadata4", 28 | "key2": "metadata5" 29 | }, 30 | "line_2": "line_28" 31 | } 32 | ``` 33 | 34 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `enabled` | `?bool` | Optional | - | getEnabled(): ?bool | setEnabled(?bool enabled): void | 13 | | `type` | `?string` | Optional | - | getType(): ?string | setType(?string type): void | 14 | | `volumePercentage` | `?int` | Optional | - | getVolumePercentage(): ?int | setVolumePercentage(?int volumePercentage): void | 15 | | `delay` | `?int` | Optional | - | getDelay(): ?int | setDelay(?int delay): void | 16 | | `days` | `?int` | Optional | - | getDays(): ?int | setDays(?int days): void | 17 | 18 | ## Example (as JSON) 19 | 20 | ```json 21 | { 22 | "enabled": false, 23 | "type": "type0", 24 | "volume_percentage": 62, 25 | "delay": 228, 26 | "days": 120 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/update-charge-card-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Charge Card Request 3 | 4 | Request for updating card data 5 | 6 | ## Structure 7 | 8 | `UpdateChargeCardRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `updateSubscription` | `bool` | Required | Indicates if the subscriptions using this card must also be updated | getUpdateSubscription(): bool | setUpdateSubscription(bool updateSubscription): void | 15 | | `cardId` | `string` | Required | Card id | getCardId(): string | setCardId(string cardId): void | 16 | | `card` | [`CreateCardRequest`](../../doc/models/create-card-request.md) | Required | Card data | getCard(): CreateCardRequest | setCard(CreateCardRequest card): void | 17 | | `recurrence` | `bool` | Required | Indicates a recurrence | getRecurrence(): bool | setRecurrence(bool recurrence): void | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "update_subscription": false, 24 | "card_id": "card_id4", 25 | "card": { 26 | "type": "credit", 27 | "number": "number6", 28 | "holder_name": "holder_name2", 29 | "exp_month": 228, 30 | "exp_year": 68, 31 | "cvv": "cvv4" 32 | }, 33 | "recurrence": false 34 | } 35 | ``` 36 | 37 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `dueAt` | `?DateTime` | Optional | The charge's new due date | getDueAt(): ?\DateTime | setDueAt(?\DateTime dueAt): void | 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `endAt` | `?DateTime` | Optional | Current cycle end date | getEndAt(): ?\DateTime | setEndAt(?\DateTime endAt): void | 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `status` | `string` | Required | Status | getStatus(): string | setStatus(string status): void | 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `status` | `string` | Required | Status | getStatus(): string | setStatus(string status): void | 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `metadata` | `array` | Required | Metadata | getMetadata(): array | setMetadata(array metadata): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "metadata": { 21 | "key0": "metadata3", 22 | "key1": "metadata4", 23 | "key2": "metadata5" 24 | } 25 | } 26 | ``` 27 | 28 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `amount` | `int` | Required | - | getAmount(): int | setAmount(int amount): void | 15 | | `description` | `string` | Required | - | getDescription(): string | setDescription(string description): void | 16 | | `quantity` | `int` | Required | - | getQuantity(): int | setQuantity(int quantity): void | 17 | | `category` | `string` | Required | - | getCategory(): string | setCategory(string category): void | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "amount": 46, 24 | "description": "description0", 25 | "quantity": 68, 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `status` | `string` | Required | Order status | getStatus(): string | setStatus(string status): void | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "status": "status8" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `startQuantity` | `int` | Required | Start quantity of the bracket | getStartQuantity(): int | setStartQuantity(int startQuantity): void | 15 | | `price` | `int` | Required | Price | getPrice(): int | setPrice(int price): void | 16 | | `endQuantity` | `?int` | Optional | End quantity of the bracket | getEndQuantity(): ?int | setEndQuantity(?int endQuantity): void | 17 | | `overagePrice` | `?int` | Optional | Overage price | getOveragePrice(): ?int | setOveragePrice(?int overagePrice): void | 18 | 19 | ## Example (as JSON) 20 | 21 | ```json 22 | { 23 | "start_quantity": 46, 24 | "price": 16, 25 | "end_quantity": 54, 26 | "overage_price": 68 27 | } 28 | ``` 29 | 30 | -------------------------------------------------------------------------------- /doc/models/update-pricing-scheme-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Pricing Scheme Request 3 | 4 | Request for updating a pricing scheme 5 | 6 | ## Structure 7 | 8 | `UpdatePricingSchemeRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `schemeType` | `string` | Required | Scheme type | getSchemeType(): string | setSchemeType(string schemeType): void | 15 | | `priceBrackets` | [`UpdatePriceBracketRequest[]`](../../doc/models/update-price-bracket-request.md) | Required | Price brackets | getPriceBrackets(): array | setPriceBrackets(array priceBrackets): void | 16 | | `price` | `?int` | Optional | Price | getPrice(): ?int | setPrice(?int price): void | 17 | | `minimumPrice` | `?int` | Optional | Minimum price | getMinimumPrice(): ?int | setMinimumPrice(?int minimumPrice): void | 18 | | `percentage` | `?float` | Optional | percentual value used in pricing_scheme Percent | getPercentage(): ?float | setPercentage(?float percentage): void | 19 | 20 | ## Example (as JSON) 21 | 22 | ```json 23 | { 24 | "scheme_type": "scheme_type0", 25 | "price_brackets": [ 26 | { 27 | "start_quantity": 193, 28 | "price": 125, 29 | "end_quantity": 201, 30 | "overage_price": 215 31 | } 32 | ], 33 | "price": 16, 34 | "minimum_price": 176, 35 | "percentage": 4.18 36 | } 37 | ``` 38 | 39 | -------------------------------------------------------------------------------- /doc/models/update-recipient-bank-account-request.md: -------------------------------------------------------------------------------- 1 | 2 | # Update Recipient Bank Account Request 3 | 4 | Updates the default bank account for a recipient 5 | 6 | ## Structure 7 | 8 | `UpdateRecipientBankAccountRequest` 9 | 10 | ## Fields 11 | 12 | | Name | Type | Tags | Description | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `bankAccount` | [`CreateBankAccountRequest`](../../doc/models/create-bank-account-request.md) | Required | Bank account | getBankAccount(): CreateBankAccountRequest | setBankAccount(CreateBankAccountRequest bankAccount): void | 15 | | `paymentMode` | `string` | Required | Payment mode
**Default**: `'bank_transfer'` | getPaymentMode(): string | setPaymentMode(string paymentMode): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "bank_account": { 22 | "holder_name": "holder_name0", 23 | "holder_type": "holder_type6", 24 | "holder_document": "holder_document8", 25 | "bank": "bank2", 26 | "branch_number": "branch_number0", 27 | "branch_check_digit": "branch_check_digit0", 28 | "account_number": "account_number4", 29 | "account_check_digit": "account_check_digit0", 30 | "type": "type6", 31 | "metadata": { 32 | "key0": "metadata1", 33 | "key1": "metadata0" 34 | }, 35 | "pix_key": "pix_key2" 36 | }, 37 | "payment_mode": "bank_transfer" 38 | } 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /doc/models/update-recipient-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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `name` | `string` | Required | Name | getName(): string | setName(string name): void | 15 | | `email` | `string` | Required | Email | getEmail(): string | setEmail(string email): void | 16 | | `description` | `string` | Required | Description | getDescription(): string | setDescription(string description): void | 17 | | `type` | `string` | Required | Type | getType(): string | setType(string type): void | 18 | | `status` | `string` | Required | Status | getStatus(): string | setStatus(string status): void | 19 | | `metadata` | `array` | Required | Metadata | getMetadata(): array | setMetadata(array metadata): void | 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 | "key2": "metadata5" 34 | } 35 | } 36 | ``` 37 | 38 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `gatewayAffiliationId` | `string` | Required | - | getGatewayAffiliationId(): string | setGatewayAffiliationId(string gatewayAffiliationId): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "gateway_affiliation_id": "gateway_affiliation_id4" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `nextBillingAt` | `DateTime` | Required | The date when the next subscription billing must occur | getNextBillingAt(): \DateTime | setNextBillingAt(\DateTime nextBillingAt): void | 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `card` | [`CreateCardRequest`](../../doc/models/create-card-request.md) | Required | Credit card data | getCard(): CreateCardRequest | setCard(CreateCardRequest card): void | 15 | | `cardId` | `string` | Required | Credit card id | getCardId(): string | setCardId(string cardId): void | 16 | 17 | ## Example (as JSON) 18 | 19 | ```json 20 | { 21 | "card": { 22 | "type": "credit", 23 | "number": "number6", 24 | "holder_name": "holder_name2", 25 | "exp_month": 228, 26 | "exp_year": 68, 27 | "cvv": "cvv4" 28 | }, 29 | "card_id": "card_id4" 30 | } 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `boletoDueDays` | `int` | Required | - | getBoletoDueDays(): int | setBoletoDueDays(int boletoDueDays): void | 13 | 14 | ## Example (as JSON) 15 | 16 | ```json 17 | { 18 | "boleto_due_days": 194 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `minimumPrice` | `?int` | Optional | Valor mínimo da assinatura | getMinimumPrice(): ?int | setMinimumPrice(?int minimumPrice): void | 15 | 16 | ## Example (as JSON) 17 | 18 | ```json 19 | { 20 | "minimum_price": 176 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `enabled` | `bool` | Required | Defines if the split is enabled | getEnabled(): bool | setEnabled(bool enabled): void | 13 | | `rules` | [`CreateSplitRequest[]`](../../doc/models/create-split-request.md) | Required | Split | getRules(): array | setRules(array rules): void | 14 | 15 | ## Example (as JSON) 16 | 17 | ```json 18 | { 19 | "enabled": false, 20 | "rules": [ 21 | { 22 | "type": "type6", 23 | "amount": 210, 24 | "recipient_id": "recipient_id6", 25 | "options": { 26 | "liable": false, 27 | "charge_processing_fee": false, 28 | "charge_remainder_fee": false 29 | }, 30 | "split_rule_id": "split_rule_id6" 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 | Getter | Setter | 13 | | --- | --- | --- | --- | --- | --- | 14 | | `startAt` | `DateTime` | Required | The date when the subscription periods will start | getStartAt(): \DateTime | setStartAt(\DateTime startAt): void | 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 | Getter | Setter | 11 | | --- | --- | --- | --- | --- | --- | 12 | | `transferEnabled` | `string` | Required | - | getTransferEnabled(): string | setTransferEnabled(string transferEnabled): void | 13 | | `transferInterval` | `string` | Required | - | getTransferInterval(): string | setTransferInterval(string transferInterval): void | 14 | | `transferDay` | `string` | Required | - | getTransferDay(): string | setTransferDay(string transferDay): void | 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/utility-classes.md: -------------------------------------------------------------------------------- 1 | 2 | # Utility Classes Documentation 3 | 4 | ## FileWrapper 5 | 6 | Thrown when there is a network error or HTTP response status code is not okay. 7 | 8 | ## Constructor Args 9 | 10 | | Name | Type | Description | 11 | | --- | --- | --- | 12 | | $realFilePath | string | The path of the file to wrap. | 13 | | $mimeType | ?mimeType | The mime-type to be sent with the file. | 14 | | $filename | ?string | The name to be used when sending the file. | 15 | 16 | ## Methods 17 | 18 | | Name | Type | Description | 19 | | --- | --- | --- | 20 | | getFilename() | ?string | Get name of the file to be used in the upload data. | 21 | | getMimeType() | ?string | Get the mime-type to be sent with the file. | 22 | 23 | -------------------------------------------------------------------------------- /examples/address/CreateAddress.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 7 | ->basicAuthPassword('BasicAuthPassword') 8 | ->build(); 9 | 10 | $customerController = $client->getCustomersController(); 11 | 12 | $address = new PagarmeApiSDKLib\Models\CreateAddressRequest( 13 | "Malibu Point", 14 | "10880", 15 | "90265", 16 | "Central Malibu", 17 | "Malibu", 18 | "CA", 19 | "US", 20 | "complement1", 21 | ['key0' => 'metadata7', 'key1' => 'metadata6'], 22 | "line1", 23 | "line2" 24 | ); 25 | 26 | $customerId = "cus_z6WBYzNhlioYX"; 27 | $result = $customerController->createAddress($customerId, $address); 28 | 29 | echo json_encode($result, JSON_PRETTY_PRINT); 30 | } 31 | catch (Exception $ex) { 32 | echo var_dump($ex, JSON_PRETTY_PRINT); 33 | } 34 | ?> -------------------------------------------------------------------------------- /examples/address/GetAdressById.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $customerController = $client->getCustomersController(); 12 | 13 | $customerId = "cus_z6WBYzNhlioYX"; 14 | $addressId = "addr_zba6e5RuDCQn6"; 15 | $result = $customerController->getAddress($customerId, $addressId); 16 | 17 | echo json_encode($result, JSON_PRETTY_PRINT); 18 | } 19 | catch (Exception $ex) 20 | { 21 | echo var_dump($ex, JSON_PRETTY_PRINT); 22 | } 23 | ?> -------------------------------------------------------------------------------- /examples/card/GetCard.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $customerController = $client->getCustomersController(); 12 | 13 | $customerId = "cus_z6WBYzNhliZd2"; 14 | $cardId = "card_R4e0W1K4l5gx"; 15 | $result = $customerController->getCard($customerId, $cardId); 16 | 17 | echo json_encode($result, JSON_PRETTY_PRINT); 18 | } 19 | catch (Exception $ex) 20 | { 21 | echo var_dump($ex, JSON_PRETTY_PRINT); 22 | } 23 | ?> -------------------------------------------------------------------------------- /examples/charges/CancelCharge.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $chargeController = $client->getChargesController(); 12 | 13 | $chargeId = "ch_Yb916oootPg6pjP"; 14 | $result = $chargeController->cancelCharge($chargeId); 15 | 16 | echo json_encode($result, JSON_PRETTY_PRINT); 17 | } 18 | catch (Exception $ex) 19 | { 20 | echo var_dump($ex, JSON_PRETTY_PRINT); 21 | } 22 | ?> -------------------------------------------------------------------------------- /examples/charges/CancelChargePartial.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $chargeController = $client->getChargesController(); 12 | 13 | $chargeId = "ch_BrW2jVuuin1E7D"; 14 | 15 | $request = new PagarmeApiSDKLib\Models\CreateCancelChargeRequest(""); 16 | $request->setAmount(1000); 17 | 18 | $result = $chargeController->cancelCharge($chargeId, $request); 19 | 20 | echo json_encode($result, JSON_PRETTY_PRINT); 21 | } 22 | catch (Exception $ex) 23 | { 24 | echo var_dump($ex, JSON_PRETTY_PRINT); 25 | } 26 | ?> -------------------------------------------------------------------------------- /examples/charges/CaptureCharge.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $chargeController = $client->getChargesController(); 12 | 13 | $chargeId = "ch_e9LwArrZIBk2zGp"; 14 | 15 | $result = $chargeController->captureCharge($chargeId); 16 | 17 | echo json_encode($result, JSON_PRETTY_PRINT); 18 | } 19 | catch (Exception $ex) 20 | { 21 | echo var_dump($ex, JSON_PRETTY_PRINT); 22 | } 23 | ?> -------------------------------------------------------------------------------- /examples/charges/GetChargeById.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $chargeController = $client->getChargesController(); 12 | 13 | $chargeId = "ch_Yb916jjjtPg6pjP"; 14 | $result = $chargeController->getCharge($chargeId); 15 | 16 | echo json_encode($result, JSON_PRETTY_PRINT); 17 | } 18 | catch (Exception $ex) 19 | { 20 | echo var_dump($ex, JSON_PRETTY_PRINT); 21 | } 22 | ?> -------------------------------------------------------------------------------- /examples/customer/GetCustomerById.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $customerController = $client->getCustomersController(); 12 | 13 | $customerId = "cus_z6WBYzNhggXZd2"; 14 | $result = $customerController->getCustomer($customerId); 15 | 16 | echo json_encode($result, JSON_PRETTY_PRINT); 17 | } 18 | catch (Exception $ex) 19 | { 20 | echo var_dump($ex, JSON_PRETTY_PRINT); 21 | } 22 | ?> -------------------------------------------------------------------------------- /examples/invoice/GetInvoiceById.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $invoiceController = $client->getInvoicesController(); 12 | 13 | $invoiceId = "invoiceId"; 14 | $result = $customerController->getInvoice($invoiceId); 15 | 16 | echo json_encode($result, JSON_PRETTY_PRINT); 17 | } 18 | catch (Exception $ex) 19 | { 20 | echo var_dump($ex, JSON_PRETTY_PRINT); 21 | } 22 | ?> -------------------------------------------------------------------------------- /examples/marketplace/CreateAnticipation.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $recipientController = $client->getRecipientsController(); 12 | 13 | $request = new PagarmeApiSDKLib\Models\CreateAnticipationRequest(1000, "start", datetime::createFromFormat("Y-m-d", "2020-12-12")); 14 | $recipientId = "recipientId"; 15 | $result = $recipientController->createAnticipation($recipientId, $request); 16 | 17 | echo json_encode($result, JSON_PRETTY_PRINT); 18 | } 19 | catch (Exception $ex) 20 | { 21 | echo var_dump($ex, JSON_PRETTY_PRINT); 22 | } 23 | ?> -------------------------------------------------------------------------------- /examples/marketplace/CreateRecipient.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $recipientController = $client->getRecipientsController(); 12 | 13 | $banckAccount = new PagarmeApiSDKLib\Models\CreateBankAccountRequest("Tony stark", "individual", "26224451990", "341", "1234", "6", "1234", "6", "checking", 14 | ['key0' => 'metadata7', 'key1' => 'metadata6'], ""); 15 | 16 | $request = new PagarmeApiSDKLib\Models\CreateRecipientRequest("Tony Stark", "stark@pagar.me", "Recebedor TonyStark", "26224451990", "individual", $banckAccount, 17 | ['key0' => 'metadata7', 'key1' => 'metadata6'],"1","bank_transfer" ); 18 | 19 | $result = $recipientController->createRecipient($request); 20 | 21 | echo json_encode($result, JSON_PRETTY_PRINT); 22 | } 23 | catch (Exception $ex) 24 | { 25 | echo var_dump($ex, JSON_PRETTY_PRINT); 26 | } 27 | ?> -------------------------------------------------------------------------------- /examples/marketplace/GetRecipientById.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 8 | ->basicAuthPassword('BasicAuthPassword') 9 | ->build(); 10 | 11 | $recipientController = $client->getRecipientsController(); 12 | 13 | $recipientId = "rp_xO1jpA5so6Ighjb"; 14 | $result = $recipientController->getRecipient($recipientId); 15 | 16 | echo json_encode($result, JSON_PRETTY_PRINT); 17 | } 18 | catch (Exception $ex) 19 | { 20 | echo var_dump($ex, JSON_PRETTY_PRINT); 21 | } 22 | ?> -------------------------------------------------------------------------------- /examples/orders/GetOrders.php: -------------------------------------------------------------------------------- 1 | basicAuthUserName('basicAuthUserName') 7 | ->basicAuthPassword('BasicAuthPassword') 8 | ->build(); 9 | 10 | $ordersController = $client->getOrdersController(); 11 | 12 | $result = $ordersController->getOrders(); 13 | echo json_encode($result, JSON_PRETTY_PRINT); 14 | } 15 | catch (Exception $ex) { 16 | echo var_dump($ex, JSON_PRETTY_PRINT); 17 | } 18 | ?> -------------------------------------------------------------------------------- /phpcs-ruleset.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /src/AuthManagerInterface.php: -------------------------------------------------------------------------------- 1 | requestBuilder(RequestMethod::GET, '/transactions/{transaction_id}') 30 | ->auth('global') 31 | ->parameters(TemplateParam::init('transaction_id', $transactionId)); 32 | 33 | $_resHandler = $this->responseHandler()->type(GetTransactionResponse::class); 34 | 35 | return $this->execute($_reqBuilder, $_resHandler); 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /src/Environment.php: -------------------------------------------------------------------------------- 1 | request; 28 | } 29 | 30 | /** 31 | * Returns the HTTP Response 32 | * 33 | * @return HttpResponse response 34 | */ 35 | public function getResponse(): HttpResponse 36 | { 37 | return $this->response; 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/Http/HttpMethod.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create anticipation request Builder object. 35 | */ 36 | public static function init(int $amount, string $timeframe, \DateTime $paymentDate): self 37 | { 38 | return new self(new CreateAnticipationRequest($amount, $timeframe, $paymentDate)); 39 | } 40 | 41 | /** 42 | * Initializes a new create anticipation request object. 43 | */ 44 | public function build(): CreateAnticipationRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateAntifraudRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 32 | } 33 | 34 | /** 35 | * Initializes a new create antifraud request Builder object. 36 | */ 37 | public static function init(string $type, CreateClearSaleRequest $clearsale): self 38 | { 39 | return new self(new CreateAntifraudRequest($type, $clearsale)); 40 | } 41 | 42 | /** 43 | * Initializes a new create antifraud request object. 44 | */ 45 | public function build(): CreateAntifraudRequest 46 | { 47 | return CoreHelper::clone($this->instance); 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateBankTransferPaymentRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create bank transfer payment request Builder object. 35 | */ 36 | public static function init(string $bank, int $retries): self 37 | { 38 | return new self(new CreateBankTransferPaymentRequest($bank, $retries)); 39 | } 40 | 41 | /** 42 | * Initializes a new create bank transfer payment request object. 43 | */ 44 | public function build(): CreateBankTransferPaymentRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateCancelChargeSplitRulesRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create cancel charge split rules request Builder object. 35 | */ 36 | public static function init(string $id, int $amount, string $type): self 37 | { 38 | return new self(new CreateCancelChargeSplitRulesRequest($id, $amount, $type)); 39 | } 40 | 41 | /** 42 | * Initializes a new create cancel charge split rules request object. 43 | */ 44 | public function build(): CreateCancelChargeSplitRulesRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateCancelSubscriptionRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create cancel subscription request Builder object. 35 | */ 36 | public static function init(bool $cancelPendingInvoices): self 37 | { 38 | return new self(new CreateCancelSubscriptionRequest($cancelPendingInvoices)); 39 | } 40 | 41 | /** 42 | * Initializes a new create cancel subscription request object. 43 | */ 44 | public function build(): CreateCancelSubscriptionRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateCardOptionsRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create card options request Builder object. 35 | */ 36 | public static function init(bool $verifyCard): self 37 | { 38 | return new self(new CreateCardOptionsRequest($verifyCard)); 39 | } 40 | 41 | /** 42 | * Initializes a new create card options request object. 43 | */ 44 | public function build(): CreateCardOptionsRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateCashPaymentRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create cash payment request Builder object. 35 | */ 36 | public static function init(string $description, bool $confirm): self 37 | { 38 | return new self(new CreateCashPaymentRequest($description, $confirm)); 39 | } 40 | 41 | /** 42 | * Initializes a new create cash payment request object. 43 | */ 44 | public function build(): CreateCashPaymentRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateCheckoutBankTransferRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create checkout bank transfer request Builder object. 35 | */ 36 | public static function init(array $bank, int $retries): self 37 | { 38 | return new self(new CreateCheckoutBankTransferRequest($bank, $retries)); 39 | } 40 | 41 | /** 42 | * Initializes a new create checkout bank transfer request object. 43 | */ 44 | public function build(): CreateCheckoutBankTransferRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateCheckoutBoletoPaymentRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create checkout boleto payment request Builder object. 35 | */ 36 | public static function init(string $bank, string $instructions, \DateTime $dueAt): self 37 | { 38 | return new self(new CreateCheckoutBoletoPaymentRequest($bank, $instructions, $dueAt)); 39 | } 40 | 41 | /** 42 | * Initializes a new create checkout boleto payment request object. 43 | */ 44 | public function build(): CreateCheckoutBoletoPaymentRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateClearSaleRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create clear sale request Builder object. 35 | */ 36 | public static function init(int $customSla): self 37 | { 38 | return new self(new CreateClearSaleRequest($customSla)); 39 | } 40 | 41 | /** 42 | * Initializes a new create clear sale request object. 43 | */ 44 | public function build(): CreateClearSaleRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateDeviceRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create device request Builder object. 35 | */ 36 | public static function init(): self 37 | { 38 | return new self(new CreateDeviceRequest()); 39 | } 40 | 41 | /** 42 | * Sets platform field. 43 | */ 44 | public function platform(?string $value): self 45 | { 46 | $this->instance->setPlatform($value); 47 | return $this; 48 | } 49 | 50 | /** 51 | * Initializes a new create device request object. 52 | */ 53 | public function build(): CreateDeviceRequest 54 | { 55 | return CoreHelper::clone($this->instance); 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateEmvDataDukptDecryptRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create emv data dukpt decrypt request Builder object. 35 | */ 36 | public static function init(string $ksn): self 37 | { 38 | return new self(new CreateEmvDataDukptDecryptRequest($ksn)); 39 | } 40 | 41 | /** 42 | * Initializes a new create emv data dukpt decrypt request object. 43 | */ 44 | public function build(): CreateEmvDataDukptDecryptRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateEmvDataTlvDecryptRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create emv data tlv decrypt request Builder object. 35 | */ 36 | public static function init(string $tag, string $lenght, string $value): self 37 | { 38 | return new self(new CreateEmvDataTlvDecryptRequest($tag, $lenght, $value)); 39 | } 40 | 41 | /** 42 | * Initializes a new create emv data tlv decrypt request object. 43 | */ 44 | public function build(): CreateEmvDataTlvDecryptRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateFineRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create fine request Builder object. 35 | */ 36 | public static function init(int $days, string $type, int $amount): self 37 | { 38 | return new self(new CreateFineRequest($days, $type, $amount)); 39 | } 40 | 41 | /** 42 | * Initializes a new create fine request object. 43 | */ 44 | public function build(): CreateFineRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateGooglePayHeaderRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create google pay header request Builder object. 35 | */ 36 | public static function init(string $ephemeralPublicKey): self 37 | { 38 | return new self(new CreateGooglePayHeaderRequest($ephemeralPublicKey)); 39 | } 40 | 41 | /** 42 | * Initializes a new create google pay header request object. 43 | */ 44 | public function build(): CreateGooglePayHeaderRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateInterestRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create interest request Builder object. 35 | */ 36 | public static function init(int $days, string $type, int $amount): self 37 | { 38 | return new self(new CreateInterestRequest($days, $type, $amount)); 39 | } 40 | 41 | /** 42 | * Initializes a new create interest request object. 43 | */ 44 | public function build(): CreateInterestRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateInvoiceRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create invoice request Builder object. 35 | */ 36 | public static function init(array $metadata): self 37 | { 38 | return new self(new CreateInvoiceRequest($metadata)); 39 | } 40 | 41 | /** 42 | * Initializes a new create invoice request object. 43 | */ 44 | public function build(): CreateInvoiceRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateLocationRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create location request Builder object. 35 | */ 36 | public static function init(string $latitude, string $longitude): self 37 | { 38 | return new self(new CreateLocationRequest($latitude, $longitude)); 39 | } 40 | 41 | /** 42 | * Initializes a new create location request object. 43 | */ 44 | public function build(): CreateLocationRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreatePeriodRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create period request Builder object. 35 | */ 36 | public static function init(): self 37 | { 38 | return new self(new CreatePeriodRequest()); 39 | } 40 | 41 | /** 42 | * Sets end at field. 43 | */ 44 | public function endAt(?\DateTime $value): self 45 | { 46 | $this->instance->setEndAt($value); 47 | return $this; 48 | } 49 | 50 | /** 51 | * Initializes a new create period request object. 52 | */ 53 | public function build(): CreatePeriodRequest 54 | { 55 | return CoreHelper::clone($this->instance); 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateSetupRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 32 | } 33 | 34 | /** 35 | * Initializes a new create setup request Builder object. 36 | */ 37 | public static function init(int $amount, string $description, CreatePaymentRequest $payment): self 38 | { 39 | return new self(new CreateSetupRequest($amount, $description, $payment)); 40 | } 41 | 42 | /** 43 | * Initializes a new create setup request object. 44 | */ 45 | public function build(): CreateSetupRequest 46 | { 47 | return CoreHelper::clone($this->instance); 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateSubscriptionSplitRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create subscription split request Builder object. 35 | */ 36 | public static function init(bool $enabled, array $rules): self 37 | { 38 | return new self(new CreateSubscriptionSplitRequest($enabled, $rules)); 39 | } 40 | 41 | /** 42 | * Initializes a new create subscription split request object. 43 | */ 44 | public function build(): CreateSubscriptionSplitRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateTokenRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 32 | } 33 | 34 | /** 35 | * Initializes a new create token request Builder object. 36 | */ 37 | public static function init(string $type, CreateCardTokenRequest $card): self 38 | { 39 | return new self(new CreateTokenRequest($type, $card)); 40 | } 41 | 42 | /** 43 | * Initializes a new create token request object. 44 | */ 45 | public function build(): CreateTokenRequest 46 | { 47 | return CoreHelper::clone($this->instance); 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateTransferBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create transfer Builder object. 35 | */ 36 | public static function init(int $amount, string $sourceId, string $targetId): self 37 | { 38 | return new self(new CreateTransfer($amount, $sourceId, $targetId)); 39 | } 40 | 41 | /** 42 | * Sets metadata field. 43 | */ 44 | public function metadata(?array $value): self 45 | { 46 | $this->instance->setMetadata($value); 47 | return $this; 48 | } 49 | 50 | /** 51 | * Initializes a new create transfer object. 52 | */ 53 | public function build(): CreateTransfer 54 | { 55 | return CoreHelper::clone($this->instance); 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateTransferRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create transfer request Builder object. 35 | */ 36 | public static function init(int $amount, array $metadata): self 37 | { 38 | return new self(new CreateTransferRequest($amount, $metadata)); 39 | } 40 | 41 | /** 42 | * Initializes a new create transfer request object. 43 | */ 44 | public function build(): CreateTransferRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/CreateTransferSettingsRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new create transfer settings request Builder object. 35 | */ 36 | public static function init(bool $transferEnabled, string $transferInterval, int $transferDay): self 37 | { 38 | return new self(new CreateTransferSettingsRequest($transferEnabled, $transferInterval, $transferDay)); 39 | } 40 | 41 | /** 42 | * Initializes a new create transfer settings request object. 43 | */ 44 | public function build(): CreateTransferSettingsRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/ListTransfersBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 32 | } 33 | 34 | /** 35 | * Initializes a new list transfers Builder object. 36 | */ 37 | public static function init(array $data, PagingResponse $paging): self 38 | { 39 | return new self(new ListTransfers($data, $paging)); 40 | } 41 | 42 | /** 43 | * Initializes a new list transfers object. 44 | */ 45 | public function build(): ListTransfers 46 | { 47 | return CoreHelper::clone($this->instance); 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/Models/Builders/ListWithdrawalsBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 32 | } 33 | 34 | /** 35 | * Initializes a new list withdrawals Builder object. 36 | */ 37 | public static function init(array $data, PagingResponse $paging): self 38 | { 39 | return new self(new ListWithdrawals($data, $paging)); 40 | } 41 | 42 | /** 43 | * Initializes a new list withdrawals object. 44 | */ 45 | public function build(): ListWithdrawals 46 | { 47 | return CoreHelper::clone($this->instance); 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateAddressRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update address request Builder object. 35 | */ 36 | public static function init(string $number, string $complement, array $metadata, string $line2): self 37 | { 38 | return new self(new UpdateAddressRequest($number, $complement, $metadata, $line2)); 39 | } 40 | 41 | /** 42 | * Initializes a new update address request object. 43 | */ 44 | public function build(): UpdateAddressRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateCurrentCycleStatusRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update current cycle status request Builder object. 35 | */ 36 | public static function init(string $status): self 37 | { 38 | return new self(new UpdateCurrentCycleStatusRequest($status)); 39 | } 40 | 41 | /** 42 | * Initializes a new update current cycle status request object. 43 | */ 44 | public function build(): UpdateCurrentCycleStatusRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateInvoiceStatusRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update invoice status request Builder object. 35 | */ 36 | public static function init(string $status): self 37 | { 38 | return new self(new UpdateInvoiceStatusRequest($status)); 39 | } 40 | 41 | /** 42 | * Initializes a new update invoice status request object. 43 | */ 44 | public function build(): UpdateInvoiceStatusRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateMetadataRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update metadata request Builder object. 35 | */ 36 | public static function init(array $metadata): self 37 | { 38 | return new self(new UpdateMetadataRequest($metadata)); 39 | } 40 | 41 | /** 42 | * Initializes a new update metadata request object. 43 | */ 44 | public function build(): UpdateMetadataRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateOrderItemRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update order item request Builder object. 35 | */ 36 | public static function init(int $amount, string $description, int $quantity, string $category): self 37 | { 38 | return new self(new UpdateOrderItemRequest($amount, $description, $quantity, $category)); 39 | } 40 | 41 | /** 42 | * Initializes a new update order item request object. 43 | */ 44 | public function build(): UpdateOrderItemRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateOrderStatusRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update order status request Builder object. 35 | */ 36 | public static function init(string $status): self 37 | { 38 | return new self(new UpdateOrderStatusRequest($status)); 39 | } 40 | 41 | /** 42 | * Initializes a new update order status request object. 43 | */ 44 | public function build(): UpdateOrderStatusRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateSubscriptionBillingDateRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update subscription billing date request Builder object. 35 | */ 36 | public static function init(\DateTime $nextBillingAt): self 37 | { 38 | return new self(new UpdateSubscriptionBillingDateRequest($nextBillingAt)); 39 | } 40 | 41 | /** 42 | * Initializes a new update subscription billing date request object. 43 | */ 44 | public function build(): UpdateSubscriptionBillingDateRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateSubscriptionCardRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 32 | } 33 | 34 | /** 35 | * Initializes a new update subscription card request Builder object. 36 | */ 37 | public static function init(CreateCardRequest $card, string $cardId): self 38 | { 39 | return new self(new UpdateSubscriptionCardRequest($card, $cardId)); 40 | } 41 | 42 | /** 43 | * Initializes a new update subscription card request object. 44 | */ 45 | public function build(): UpdateSubscriptionCardRequest 46 | { 47 | return CoreHelper::clone($this->instance); 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateSubscriptionDueDaysRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update subscription due days request Builder object. 35 | */ 36 | public static function init(int $boletoDueDays): self 37 | { 38 | return new self(new UpdateSubscriptionDueDaysRequest($boletoDueDays)); 39 | } 40 | 41 | /** 42 | * Initializes a new update subscription due days request object. 43 | */ 44 | public function build(): UpdateSubscriptionDueDaysRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateSubscriptionSplitRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update subscription split request Builder object. 35 | */ 36 | public static function init(bool $enabled, array $rules): self 37 | { 38 | return new self(new UpdateSubscriptionSplitRequest($enabled, $rules)); 39 | } 40 | 41 | /** 42 | * Initializes a new update subscription split request object. 43 | */ 44 | public function build(): UpdateSubscriptionSplitRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateSubscriptionStartAtRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update subscription start at request Builder object. 35 | */ 36 | public static function init(\DateTime $startAt): self 37 | { 38 | return new self(new UpdateSubscriptionStartAtRequest($startAt)); 39 | } 40 | 41 | /** 42 | * Initializes a new update subscription start at request object. 43 | */ 44 | public function build(): UpdateSubscriptionStartAtRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Models/Builders/UpdateTransferSettingsRequestBuilder.php: -------------------------------------------------------------------------------- 1 | instance = $instance; 31 | } 32 | 33 | /** 34 | * Initializes a new update transfer settings request Builder object. 35 | */ 36 | public static function init(string $transferEnabled, string $transferInterval, string $transferDay): self 37 | { 38 | return new self(new UpdateTransferSettingsRequest($transferEnabled, $transferInterval, $transferDay)); 39 | } 40 | 41 | /** 42 | * Initializes a new update transfer settings request object. 43 | */ 44 | public function build(): UpdateTransferSettingsRequest 45 | { 46 | return CoreHelper::clone($this->instance); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Server.php: -------------------------------------------------------------------------------- 1 |