{"openapi":"3.0.0","paths":{"/v1/health":{"get":{"operationId":"HealthController_getHealth","summary":"Checks if Edubank API is online and services available","description":"Checks if Edubank API is online and services available","parameters":[],"responses":{"200":{"description":"Edubank API is online"},"429":{"description":"Too many requests"},"500":{"description":"Edubank API is offline"}},"tags":["Health"]}},"/v1/buyers/search":{"get":{"operationId":"BuyersController_getBuyerByTax","summary":"Search for a buyer by Tax_id","description":"Search for a buyer by Tax_id","parameters":[{"name":"tax_id","required":true,"in":"query","description":"Buyer's tax id","example":"76537741807","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankBuyers"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Buyers"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/buyers/{buyer_id}":{"get":{"operationId":"BuyersController_getBuyerById","summary":"Search for a buyer by id","description":"Search for a buyer by id","parameters":[{"name":"buyer_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankBuyers"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Buyers"],"security":[{"x-api-key":[]},{"authorization":[]}]},"put":{"operationId":"BuyersController_updateBuyer","summary":"Update an existing buyer's details","description":"Update an existing buyer's details","parameters":[{"name":"buyer_id","required":true,"in":"path","description":"Buyer id","example":"39c784f7bf754698aa078a261cf42439","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankBuyerDto"}}}},"responses":{"200":{"description":"The object has been successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankBuyers"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Buyers"],"security":[{"x-api-key":[]},{"authorization":[]}]},"delete":{"operationId":"BuyersController_deleteBuyer","summary":"Delete a buyer","description":"Delete a buyer","parameters":[{"name":"buyer_id","required":true,"in":"path","description":"Buyer id","example":"39c784f7bf754698aa078a261cf42439","schema":{"type":"string"}}],"responses":{"200":{"description":"The object has been successfully deleted"},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Buyers"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/buyers":{"post":{"operationId":"BuyersController_createBuyer","summary":"Register a new buyer","description":"Register a new buyer","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankBuyerDto"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankBuyers"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Buyers"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/cards/{card_id}":{"get":{"operationId":"CardsController_getCardById","summary":"Get card by card_id","description":"Get card by card_id","parameters":[{"name":"card_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankCardDetails"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Cards"],"security":[{"x-api-key":[]},{"authorization":[]}]},"delete":{"operationId":"CardsController_deleteAssociatedCard","summary":"Delete card by card_id","description":"Delete card by card_id","parameters":[{"name":"card_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The object has been successfully deleted"},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Cards"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/cards":{"post":{"operationId":"CardsController_associateToBuyer","summary":"Allows you to associate a credit card with a buyer","description":"The last credit card associated with the buyer will always be considered the DEFAULT.\n\n**Card data must be encrypted and must follow the object structure below:**\n```json\n{\n  \"holder_name\": \"John Doe\",\n  \"card_number\": \"4716588836362104\",\n  \"expiration_month\": \"12\",\n  \"expiration_year\": \"2025\",\n  \"security_code\": \"123\"\n}\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankCardAddToBuyer"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankCardDetails"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Cards"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/subscriptions":{"get":{"operationId":"SubscriptionsController_getAllSubscriptions","summary":"Gets all seller subscriptions","description":"Returns all subscription data corresponding to the seller of the request","parameters":[{"name":"page","required":true,"in":"query","description":"Select the page","schema":{"default":0,"type":"string"}},{"name":"limit","required":true,"in":"query","description":"Limits the number of objects returned, which can be between 1 and 100","schema":{"default":10,"type":"string"}},{"name":"sort","required":true,"in":"query","description":"Determine how to sort the list by object creation date","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},{"name":"reference_id","required":false,"in":"query","description":"Subscription reference_id","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllSubscriptionsDto"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Subscriptions"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/subscriptions/{subscription_id}":{"get":{"operationId":"SubscriptionsController_getSubscriptionById","summary":"Gets subscription data by ID","description":"Returns all subscription data corresponding to the specified id","parameters":[{"name":"subscription_id","required":true,"in":"path","description":"Subscription ID","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankSubscription"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Subscriptions"],"security":[{"x-api-key":[]},{"authorization":[]}]},"delete":{"operationId":"SubscriptionsRemoveController_createSubscriptionProposal","summary":"Remove a subscription and associated card","description":"Delete the card associated with the buyer and delete the subscription","parameters":[{"name":"subscription_id","required":true,"in":"path","description":"Subscription ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankSubscription"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Subscriptions"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/subscriptions/proposal":{"post":{"operationId":"SubscriptionsProposalController_createSubscriptionProposal","summary":"Creates a subscription proposal that must be authorized by the buyer","description":"Authorization can be done through the feature **v1/subscriptions/{subscription_id}/subscribe**","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankSubscriptionProposalDto"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankSubscription"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Subscriptions"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/subscriptions/{subscription_id}/subscribe":{"post":{"operationId":"SubscriptionsSubscribeController_createSubscriptionProposal","summary":"Authorizes the subscription proposal","description":"Registers the authorization given by the buyer for the subscription proposal and activates it","parameters":[{"name":"subscription_id","required":true,"in":"path","description":"Subscription ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankSubscriptionSubscribeDto"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankSubscription"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Subscriptions"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/subscriptions/{subscription_id}/card":{"post":{"operationId":"SubscriptionsUpdateController_updateSubscriptionCard","summary":"Associate a new card with an active/authorized subscription","description":"Register a new card and associate the signature. The current card will be deleted","parameters":[{"name":"subscription_id","required":true,"in":"path","description":"Subscription ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionUpdateBody"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankSubscription"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Subscriptions"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/subscriptions/{subscription_id}/invoice/{invoice_id}/retry":{"post":{"operationId":"SubscriptionsInvoiceController_createSubscriptionProposal","summary":"Make a new charge attempt","description":"The new attempt will generate a new invoice and the notification process is the same as for automatically generated invoices. If a reference_id is provided, it will be used when sending the notification.\n\n**The new attempt will take up to 10 minutes**","parameters":[{"name":"subscription_id","required":true,"in":"path","description":"Subscription ID","schema":{"type":"string"}},{"name":"invoice_id","required":true,"in":"path","description":"Invoice ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionInvoiceRetryBody"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankSubscription"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Subscriptions"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/transactions":{"get":{"operationId":"TransactionsController_getTransactionBySeller","summary":"Get all transactions","description":"Retrieve all transactions associated with the `SELLER-ID`","parameters":[{"name":"page","required":true,"in":"query","description":"Select the page","schema":{"default":0,"type":"string"}},{"name":"limit","required":true,"in":"query","description":"Limits the number of objects returned, which can be between 1 and 100","schema":{"default":10,"type":"string"}},{"name":"sort","required":true,"in":"query","description":"Determine how to sort the list by object creation date","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},{"name":"reference_id","required":false,"in":"query","description":"To find a transaction with a specific reference_id","schema":{"type":"string"}},{"name":"payment_received_at_range_gte","required":false,"in":"query","description":"Payments expected on a date greater than. FORMAT: YYYY-MM-DD","schema":{"type":"string"}},{"name":"payment_received_at_range_lte","required":false,"in":"query","description":"Payments expected on a date lower than. FORMAT: YYYY-MM-DD","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionResponse"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]},"post":{"operationId":"TransactionsController_createTransaction","summary":"Create a transaction","description":"Creating Transactions for Future Payment Association\n\nIn the case where the transaction allows the bank slip payment method, the property `transaction_details.payment_limit_date` must be later than `transaction_details.due_date`\n\n## SANDBOX Mode\n- The SANDBOX mode enables you to generate transactions within a controlled testing environment.\n\n- In case a transaction is initiated under the SANDBOX mode and is associated with a credit card payment, an immediate response indicating success or failure will be generated based on the provided credit card number, as detailed earlier.\n\n- For transactions involving a PIX or BANK_SLIP payment method, utilize the `v1/transactions/{transaction_id}/settle` endpoint to simulate the payment process. This will trigger a payment notification to be sent to the `notification_url` specified within the transaction.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionDto"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionCreationResponse"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/{transaction_id}":{"get":{"operationId":"TransactionsController_getTransaction","summary":"Get transaction by id","description":"Get transaction by transaction_id","parameters":[{"name":"transaction_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionResponse"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/cards":{"post":{"operationId":"TransactionsController_createTransactionWithCards","summary":"Create a transaction and make the payment directly with a credit card","description":"Create a transaction and make the payment directly with a credit card.\n  ## Data Only - Optional property (Fees can be included in transactions where data_only is not sent) ##\nDataOnly is a protocol similar to 3D Secure (3DS) with the primary goal of reducing fraud rates and increasing approval rates compared to common transactions. By collecting more comprehensive data from the client during the transaction process, issuers can make more informed decisions based on a deeper analysis of the data provided.\n\n### Information required for data only ###\n\n#### color_depth (number, default: 24): \n- Represents the color depth of the palette used to display images, measured in bits per pixel. It indicates how many bits are used to represent the color of each pixel, which impacts the quality of colors displayed on the screen. This value can be obtained from the client browser using the window.screen.colorDepth property.\n\n#### device_type (string, default: BROWSER)\n- Indicates the type of device on which authentication occurs. Helps to identify the usage environment and tailor the user experience to the device. The default value is BROWSER, but it can vary based on the client's device. This information can be obtained from the client browser through user-agent analysis.\n\n#### java_enabled (boolean, default: false)\n- A boolean field indicating whether the client browser has the capability to run Java. It returns true if Java support is enabled and false otherwise. This value can be obtained from the client browser using the navigator.javaEnabled() property.\n\n#### language (string, default: BR)\n- Represents the browser's preferred language in IETF BCP 47 format, containing between 1 and 8 characters. It can be used to adapt the interface to the user's language preference. This value can be obtained from the client browser using the navigator.language property.\n\n#### screen_height (number, default: 500)\n- Represents the total height of the client's screen in pixels. The value can be obtained from the client browser using the screen.height property.\n\n#### screen_width (number, default: 500)\n- Represents the total width of the client's screen in pixels. The value can be obtained from the client browser using the screen.width property.\n\n#### time_zone_offset (number, default: -3)\n- Represents the time difference, in hours, between UTC and the local time of the cardholder's browser. The value typically ranges between -12 and +14. This can be obtained from the client browser using new Date().getTimezoneOffset() and converting it from minutes to hours (with the sign reversed).\n\n#### ip_address (string, example: 10.0.0.1)\n- Represents the client's IP address (IPv4) used to uniquely identify a device on the network. This value can be obtained from the client browser via the navigator.connection property or using external IP detection services. If not provided, the IP address will be automatically extracted from the request made.\n\n### All fields: ##\n```json\n\"data_only\": {\n  \"color_depth\": 24,\n  \"screen_width\": 2560,\n  \"screen_height\": 1440,\n  \"java_enabled\": false,\n  \"device_type\": \"BROWSER\",\n  \"language\": \"BR\",\n  \"time_zone_offset\": -3,\n  \"ip_address\": \"200.164.21.168\"\n}\n```\n\n### Mandatory fields only: ##\n```json\n\"data_only\": {\n  \"color_depth\": 24,\n  \"screen_width\": 2560,\n  \"screen_height\": 1440,\n  \"java_enabled\": false\n}\n```\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionCardsDto"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionSuccessResponseCard"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/pix":{"post":{"operationId":"TransactionsController_createTransactionWithPix","summary":"Create a transaction and make the payment directly with a Pix","description":"Create a transaction and make the payment directly with a Pix","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionPixWithoutBuyerDto"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionSuccessResponsePix"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/bank-slip":{"post":{"operationId":"TransactionsController_createTransactionWithBankSlip","summary":"Create a transaction and generate bank slip for payment","description":"Create a transaction and generate bank slip for payment","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionOneStepDto"}}}},"responses":{"200":{"description":"If the reference_id already exists, an attempt will be made to retrieve the data from a bank slip already created and/or generate a new one if it does not yet exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionSuccessResponseBankSlip"}}}},"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionSuccessResponseBankSlip"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/{transaction_id}/cards":{"post":{"operationId":"TransactionsController_card","summary":"Pay transaction with credit card","description":"Associate a credit card payment with a previously created transaction.\n  ## Data Only - Optional property (Fees can be included in transactions where data_only is not sent) ##\nDataOnly is a protocol similar to 3D Secure (3DS) with the primary goal of reducing fraud rates and increasing approval rates compared to common transactions. By collecting more comprehensive data from the client during the transaction process, issuers can make more informed decisions based on a deeper analysis of the data provided.\n\n### Information required for data only ###\n\n#### color_depth (number, default: 24): \n- Represents the color depth of the palette used to display images, measured in bits per pixel. It indicates how many bits are used to represent the color of each pixel, which impacts the quality of colors displayed on the screen. This value can be obtained from the client browser using the window.screen.colorDepth property.\n\n#### device_type (string, default: BROWSER)\n- Indicates the type of device on which authentication occurs. Helps to identify the usage environment and tailor the user experience to the device. The default value is BROWSER, but it can vary based on the client's device. This information can be obtained from the client browser through user-agent analysis.\n\n#### java_enabled (boolean, default: false)\n- A boolean field indicating whether the client browser has the capability to run Java. It returns true if Java support is enabled and false otherwise. This value can be obtained from the client browser using the navigator.javaEnabled() property.\n\n#### language (string, default: BR)\n- Represents the browser's preferred language in IETF BCP 47 format, containing between 1 and 8 characters. It can be used to adapt the interface to the user's language preference. This value can be obtained from the client browser using the navigator.language property.\n\n#### screen_height (number, default: 500)\n- Represents the total height of the client's screen in pixels. The value can be obtained from the client browser using the screen.height property.\n\n#### screen_width (number, default: 500)\n- Represents the total width of the client's screen in pixels. The value can be obtained from the client browser using the screen.width property.\n\n#### time_zone_offset (number, default: -3)\n- Represents the time difference, in hours, between UTC and the local time of the cardholder's browser. The value typically ranges between -12 and +14. This can be obtained from the client browser using new Date().getTimezoneOffset() and converting it from minutes to hours (with the sign reversed).\n\n#### ip_address (string, example: 10.0.0.1)\n- Represents the client's IP address (IPv4) used to uniquely identify a device on the network. This value can be obtained from the client browser via the navigator.connection property or using external IP detection services. If not provided, the IP address will be automatically extracted from the request made.\n\n### All fields: ##\n```json\n\"data_only\": {\n  \"color_depth\": 24,\n  \"screen_width\": 2560,\n  \"screen_height\": 1440,\n  \"java_enabled\": false,\n  \"device_type\": \"BROWSER\",\n  \"language\": \"BR\",\n  \"time_zone_offset\": -3,\n  \"ip_address\": \"200.164.21.168\"\n}\n```\n\n### Mandatory fields only: ##\n```json\n\"data_only\": {\n  \"color_depth\": 24,\n  \"screen_width\": 2560,\n  \"screen_height\": 1440,\n  \"java_enabled\": false\n}\n```\n","parameters":[{"name":"transaction_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionCardEncryptedDto"}}}},"responses":{"200":{"description":"Payment made successfully"},"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionSuccessResponseCard"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/{transaction_id}/pix":{"post":{"operationId":"TransactionsController_pix","summary":"Generate Pix for payment","description":"Associate a Pix payment with a previously created transaction. A new Pix can be generated for the same transaction when the previous one expires","parameters":[{"name":"transaction_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionPixDto"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionSuccessResponsePix"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/{transaction_id}/pix/{payment_id}/sse":{"get":{"operationId":"TransactionsController_pixSSE","summary":"Wait for Pix payment","description":"This endpoint employs the Server-Sent Events (SSE) resource to establish a communication channel between the client and server.\n\nConsumption of this endpoint is achieved by utilizing an `EventSource`\n\nBelow is a simple example illustrating the usage of the `EventSource`:\n\n```javascript\nconst eventSource = new EventSource(\n  'https://api.edubank.com.br/v1/transactions/{transaction_id}/pix/{payment_id}/sse',\n);\neventSource.onmessage = ({ data }) => {\n  console.log('New message', JSON.parse(data));\n};\n````\n\n## Important point\n- It is crucial to remember that the `x-api-key` and `authorization` must be included in the call to the Edubank API\n- For smoother inclusion of the `x-api-key` and `authorization` headers in the call, we recommend using the `event-source-polyfill` package. You can find this package on [event-source-polyfill](https://www.npmjs.com/package/event-source-polyfill)\n- The `EventSource` should be closed upon receiving the desired message.\n","parameters":[{"name":"payment_id","required":true,"in":"path","schema":{"type":"string"}},{"name":"transaction_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Connection successfully stabilized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankMessageEventPixSse"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"default":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/transactions/{transaction_id}/bank-slip":{"post":{"operationId":"TransactionsController_bankSlip","summary":"Generate bank slip for payment","description":"Associate a bank slip payment with a previously created transaction","parameters":[{"name":"transaction_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionBankSlipDto"}}}},"responses":{"200":{"description":"Payment made successfully"},"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionSuccessResponseBankSlip"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/{transaction_id}/cancel":{"post":{"operationId":"TransactionsController_cancelTransaction","summary":"Cancel a transaction","description":"Cancel a transaction. All generated slips will also be canceled","parameters":[{"name":"transaction_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Edubank transaction has been canceled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionResponse"}}}},"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionResponse"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/{transaction_id}/settle":{"post":{"operationId":"TransactionsController_settleTransaction","summary":"Mark a transaction as paid","description":"Mark a transaction as paid. The term \"settled\" is equivalent to \"mark as paid\"","parameters":[{"name":"transaction_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Edubank transaction has been settled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionResponse"}}}},"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionResponse"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v2/transactions":{"get":{"operationId":"TransactionsV2Controller_getTransactionBySeller","summary":"Returns all transactions generated within the specified due date range","description":"\nReturns all transactions generated within the specified due date range. The date range must not exceed 31 days\n\n**Required Query Parameters:**\n- page: The page number to return in the query\n- limit: The number of items to return per page. Maximum of 100\n- sort: The sort order of items by creation date. Allowed values: ASC (ascending) or DESC (descending)\n- due_date_start: The start of the due date range for filtering transactions\n- due_date_end: The end of the due date range for filtering transactions\n\n**Optional Query Parameters:**\n- include_payments: (Default is false) Returns a payments property for each transaction, showing all associated payment methods\n- include_history: (Default is false) Returns the transaction’s notification history, along with responses (e.g., what the partner’s API responded when receiving notifications). Includes events such as settlements, receivables, and status changes\n- include_summary: (Default is false) Includes a summary at the root of the response object, with a general total of items returned in the query, including those on other pages\n\n**Include Summary:**\nWhen include_summary is set to true, the response will include a summary with the following details:\n- totalTransactions: Total number of transactions returned, counting across all pages\n- totalAmount: Sum of the total transaction values across all pages (in the preferred currency)\n- totalPaid: Total number of paid transactions\n- totalPaidAmount: Total amount of the paid transactions\n- totalPaidDate1: Total number of transactions paid by the best due date\n- totalPaidAmountDate1: Total amount of transactions paid by the best due date\n- totalUnpaid: Total number of unpaid transactions\n- totalUnpaidAmount: Sum of the unpaid transaction amounts (best due date amount)\n- totalUnpaidOverdueAmount: Sum of the unpaid and overdue transaction amounts (gross amount)\n- totalCanceled: Total number of canceled transactions\n- TotalCanceledAmount: Sum of the canceled transaction amounts\n- totalSettled: Total number of settled transactions\n- TotalSettledAmount: Sum of the settled transaction amounts\n- totalVoided: Total number of voided transactions\n- TotalVoidedAmount: Sum of the voided transaction amounts\n","parameters":[{"name":"page","required":true,"in":"query","description":"Select the page","schema":{"default":0,"type":"string"}},{"name":"limit","required":true,"in":"query","description":"Limits the number of objects returned, which can be between 1 and 100","schema":{"default":10,"type":"string"}},{"name":"sort","required":true,"in":"query","description":"Determine how to sort the list by object creation date","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},{"name":"due_date_start","required":false,"in":"query","description":"Due date greater than or equal to. FORMAT: YYYY-MM-DD","example":"2026-07-02","schema":{"type":"string"}},{"name":"due_date_end","required":false,"in":"query","description":"Due date lower than or equal to. FORMAT: YYYY-MM-DD","example":"2026-08-01","schema":{"type":"string"}},{"name":"include_payments","required":false,"in":"query","description":"Include all payments generated for transaction","schema":{"default":false,"type":"boolean"}},{"name":"include_history","required":false,"in":"query","description":"Include transaction event history","schema":{"default":false,"type":"boolean"}},{"name":"include_summary","required":false,"in":"query","description":"Include a summary of all transactions","schema":{"default":false,"type":"boolean"}},{"name":"reference_id","required":false,"in":"query","description":"When refence_id is specified, due dates will not be considered and payments and history properties will always be returned","schema":{"type":"string"}},{"name":"transaction_id","required":false,"in":"query","description":"When transaction_id is specified, due dates will not be considered and payments and history properties will always be returned","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllTransactionResponseV2"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]},{"authorization":[]}]}},"/v1/transactions/{transaction_id}/void":{"post":{"operationId":"TransactionVoidController_transactionVoid","summary":"Refund a payment made","description":"Returns the paid amount of a completed payment","parameters":[{"name":"transaction_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionVoidRequestDto"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionVoidResponse"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v2/transactions/{transaction_id}/bank-slip":{"post":{"operationId":"TransactionBankSlipController_postBankPix","summary":"Create a bank slip with pix","description":"This version allows you to create a Bank Slip with Pix. The new PDF layout includes the Pix code\n\nbank_slip_link is set to HTML by default\n\n#### Limitations\n- Only 2 discounts will be included, even if the transaction has more","parameters":[{"name":"transaction_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionBankSlipPixCreate"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionSuccessResponseBankSlip"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"authorization":[]},{"x-api-key":[]},{"authorization":[]}]}},"/v2/transactions/bank-slip":{"post":{"operationId":"TransactionBankSlipController_postBankPixOneStep","summary":"Create a transaction and generate bank slip with pix","description":"This version allows you to create a Bank Slip with Pix. The new PDF layout includes the Pix code\n\nbank_slip_link is set to HTML by default\n\n#### Limitations\n- Only 2 discounts will be included, even if the transaction has more","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionOneStepDtoHtmlLinkDefault"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionSuccessResponseBankSlip"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"422":{"description":"Error: Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCreationFailure"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"authorization":[]},{"x-api-key":[]},{"authorization":[]}]}},"/v1/transactions/{transaction_id}/email_notifications":{"get":{"operationId":"TransactionEmailNotificationController_getEmailNotificationByTransactionId","summary":"Returns all email notifications sent for the respective transaction","description":"Returns all email notifications sent for the respective transaction. Notifications are sorted in descending order","parameters":[{"name":"transaction_id","required":true,"in":"path","description":"Edubank transaction id","schema":{}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankTransactionEmailNotification"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Transactions"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/receivables":{"get":{"operationId":"ReceivablesController_getAllReceivables","summary":"Get all receivables","description":"The list of items will include the receivables and their respective payments, in other words, the payments that generated the receivables that were CREATED, PAID, REFUNDED and CANCELED.\n\n### For receivables from the \"recipient\" of a split transaction, enter the seller_id recipient in the Authorization. In this case, the body return include main_seller_id\n### If expected_on_range_gte is not informed, the last 90 days will be considered","parameters":[{"name":"page","required":true,"in":"query","description":"Select the page","schema":{"default":0,"type":"string"}},{"name":"limit","required":true,"in":"query","description":"Limits the number of objects returned, which can be between 1 and 100","schema":{"default":10,"type":"string"}},{"name":"sort","required":true,"in":"query","description":"Determine how to sort the list by object creation date","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},{"name":"status","required":false,"in":"query","description":"Status of receivables","example":"PAID","schema":{"enum":["PAID","CREATED","REFUNDED","CANCELED"],"type":"string"}},{"name":"expected_on_range_gte","required":false,"in":"query","description":"Receivables expected on with a date greater than","schema":{"type":"string"}},{"name":"expected_on_range_lte","required":false,"in":"query","description":"Receivables expected on with a date lower than","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdubankReceivablesResponseDto"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Receivables"],"security":[{"authorization":[]},{"x-api-key":[]},{"authorization":[]}]}},"/v1/pos":{"get":{"operationId":"PosActivationController_searchPos","summary":"Search POS by serial number","description":"Retrieves POS details based on the provided serial number. This endpoint allows users to search for a POS by its unique serial number and returns relevant information, including status, model, and registration details","parameters":[{"name":"serial_number","required":true,"in":"query","description":"POS serial number","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPosSearchDto"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["POS"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/pos/activation":{"post":{"operationId":"PosActivationController_activationPos","summary":"Activate POS","description":"Allows you to activate the POS. Upon receiving confirmation of activation, you will be able to use payment, refund and other services","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostPosActivationDto"}}}},"responses":{"201":{"description":"The object has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostActivationResponseDto"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["POS"],"security":[{"x-api-key":[]},{"authorization":[]}]}},"/v1/banking/account_statement":{"get":{"operationId":"AccountStatementController_accountStatement","summary":"Get account statement","description":"Retrieve account statement for authenticated `SELLER-ID`. The maximum search interval is 90 days","parameters":[{"name":"limit","required":true,"in":"query","description":"Limits the number of objects returned, which can be between 1 and 100","schema":{"default":100,"type":"number"}},{"name":"offset","required":true,"in":"query","description":"Index of the first item that will be displayed. Ex (limit=100 and offset=0): The items that will be listed will be from 0 to 99, in this example the next page would be offset 100","schema":{"default":0,"type":"number"}},{"name":"date_begin","required":true,"in":"query","example":"2026-10-02","description":"Date from which the search starts","schema":{"type":"string"}},{"name":"date_end","required":true,"in":"query","example":"2026-10-02","description":"End date for search","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountStatementResponse"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Banking"],"security":[{"authorization":[]},{"x-api-key":[]},{"authorization":[]}]}},"/v1/banking/future_transfer":{"get":{"operationId":"FutureTransferController_futureTransfer","summary":"Get future account transfers","description":"Retrieve future account transfers for authenticated `SELLER-ID`","parameters":[{"name":"limit","required":true,"in":"query","description":"Limits the number of objects returned, which can be between 1 and 100","schema":{"default":100,"type":"number"}},{"name":"offset","required":true,"in":"query","description":"Index of the first item that will be displayed. Ex (limit=100 and offset=0): The items that will be listed will be from 0 to 99, in this example the next page would be offset 100","schema":{"default":0,"type":"number"}},{"name":"expected_date_begin","required":true,"in":"query","example":"2026-10-02","description":"Date from which the search starts. Starts in D+1","schema":{"type":"string"}},{"name":"expected_date_end","required":true,"in":"query","example":"2026-10-02","description":"End date for search","schema":{"type":"string"}}],"responses":{"200":{"description":"The record has been successfully getted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FutureTransferResponse"}}}},"400":{"description":"Client specified an invalid argument, request body or query param","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"401":{"description":"The user is unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"403":{"description":"Authenticated user is not allowed to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatExceptionMessage"}}}}},"tags":["Banking"],"security":[{"authorization":[]},{"x-api-key":[]},{"authorization":[]}]}}},"info":{"title":"API Edubank","description":"Welcome to the API Documentation for our service. This documentation provides comprehensive information on how to integrate and interact with our API to facilitate various operations.\n\n# Integration Overview\n\nIntegrating with our API provides you with powerful tools to enhance your workflow and automate various processes. The `API-KEY` and `SELLER-ID` serve as the foundation for secure communication, allowing you to make requests and retrieve data while maintaining a high level of data protection.\n\nIn the following sections, you will find detailed information on how to use these credentials, encrypt card data, and interact with different API endpoints. We recommend following the documentation sequentially to build a strong understanding of the integration process.\n\nLet's get started with the integration process!\n\n## Prerequisites\n\nBefore you begin integrating with our API, please ensure you have the following credentials:\n\n- **API-KEY (x-api-key)**\n- **SELLER-ID (authorization)**\n\nThese credentials are essential for authorizing your access to the API. The `API-KEY` serves as a secure identifier that allows your application to communicate with our API, while the `SELLER-ID` uniquely identifies your account or organization within our system.\n\n## Obtaining Credentials\n\nFor now, the only way to obtain the `API-KEY` and `SELLER-ID` is by contacting our dedicated team. \n\nPlease reach out to our support team, and they will guide you through the process of acquiring these credentials securely.\n\nWe apologize for any inconvenience this process may cause and appreciate your understanding. This approach helps us maintain a high level of security and control over API access.\n\nFor any inquiries or assistance related to obtaining these credentials, don't hesitate to get in touch. Our team is here to ensure a smooth integration experience for you.\n\n## Authorization and Request Headers\n\nAccessing the API requires the inclusion of the following credentials in your request headers:\n\n- **API-KEY (x-api-key)**\n- **SELLER-ID (authorization)**\n\nThese credentials are crucial for authenticating your requests and ensuring that you have the necessary permissions to interact with the API.\n\nPlease remember to include these credentials in the headers of every API request you initiate. Failing to provide the correct credentials may lead to denied access or incomplete functionality.\n\n### Adding Credentials to the Request Headers\n\nWhen making API requests, you need to include the credentials in the headers as follows:\n\n- **API-KEY (x-api-key)**: Set the `x-api-key` header with your API key value. This key uniquely identifies your integration and authorizes access to the API.\n\n- **SELLER-ID (authorization)**: Set the `authorization` header with your `SELLER-ID` value. This identifier links your requests to your specific account or organization.\n\n# Encrypting Card\n\nBefore sending a card object to the API, it needs to be encrypted. Here's an example of how you can use the `EdubankCard` JavaScript library to encrypt a card object:\n\n```html\n<!DOCTYPE html>\n<html>\n\n<head>\n  <title>Edubank-Card Script</title>\n  <script src=\"https://edubank.com.br/lib/edubank-card.js\"></script>\n  <script type=\"text/javascript\">\n    function handleEncrypt() {\n      const credit_card_object = {\n        \"holder_name\": \"John Doe\",\n        \"card_number\": \"4716588836362104\",\n        \"expiration_month\": \"12\",\n        \"expiration_year\": \"2025\",\n        \"security_code\": \"123\",\n        \"installment_plan\": {\n          \"number_installments\": 5\n        }\n      };\n\n      const encryption_key = \"myEncryptionKey\"; // Replace with your actual encryption key\n      const encrypted_data = EdubankCard.encrypt(credit_card_object, encryption_key);\n      console.log(\"Encrypted data:\", encrypted_data);\n    }\n  </script>\n</head>\n\n<body>\n  <h1>Check the console (F12 in Chrome)</h1>\n  <button onclick=\"handleEncrypt()\">Encrypt Edubank Card</button>\n</body>\n\n</html>\n```\n\nPlease note that the encryption key used in this example, represented as \"myEncryptionKey,\" should be replaced with your actual encryption key. This example demonstrates how to use the EdubankCard JavaScript library to encrypt card data before transmission to the API.\n\n**Important Point:** The encryption key required for proper data encryption will be provided by our team. Make sure to obtain the correct encryption key from our team to ensure the security of your transactions.\n\n## Encrypted Card Object Example\n\nHere's an example of the encrypted card object:\n\n```\nU2FsdGVkX1/vivD9dMVJOCpx4mdLvkPkPXihbLk456V0HVqbaG3Tyuq6ud2k14wxif4qJb45Z8vZ2G+0jHF2qQjHOE/BqiEAEsJszbcqPdwc5Z1z7Rvmivd2PWhrHD1DBWPsA75bdAnVlcb1qKIcXYY6a5IdAcc8ctjLpCJHS+jFRl6hZICmNtQpVJrGHHXAiAKyoNI+MQl59C1cGOJp0D/JE2iRrm14rEki4v1pemFQqnLvLNvYaXlLgVDPlw/N\n```\n\n## Test Credit Card Numbers for Sandbox\n\nDuring testing in the sandbox environment, you can utilize the following credit card numbers for various scenarios:\n\n- Successful payment: 4716588836362104\n- Unauthorized payment: 4716523946363019\n\nKeep in mind that these card numbers are exclusively for testing purposes and should not be employed in a production environment.\n# Notifications\n\nAs part of our commitment to keeping you informed, our notifications system ensures that you receive timely updates when a payment is confirmed. These notifications are sent to the URL specified in the `notification_url` property, which is provided during the creation of a transaction.\n\n## Types of Notifications\n\nHere are the types of notifications we provide:\n\n1. **PAID**: This notification confirms the successful completion of a payment once verified by the buyer's bank.\n\n2. **RECEIVABLE CREATED**: This notification provides details about the scheduled date and amount for the confirmed payment to be received.\n\n3. **RECEIVABLE CREATED - RECIPIENT**: In cases involving payment splits, this notification specifies the date and amount assigned to the recipient SELLER.\n\n4. **RECEIVABLE PAID**: This notification signifies the successful transfer of the payment amount to the SELLER's current account. It is dispatched on the date indicated in the \"RECEIVABLE CREATED\" notification.\n\n5. **RECEIVABLE PAID - RECIPIENT**: Similarly, for payment splits, this notification denotes the transfer of the amount to the recipient SELLER's current account. The date corresponds with that in the \"RECEIVABLE CREATED\" notification.\n\n6. **VOIDED**: This notification is issued when a payment is reversed.\n\n7. **RECEIVABLE CANCELED**: This notification is dispatched when a previously created but unpaid receivable undergoes a payment reversal.\n\n8. **RECEIVABLE REFUNDED**: This notification is sent when a receivable that has been successfully paid experiences a payment refund.\n\n9. **CANCELED**: This notification is sent when a transaction is fully canceled.\n\n10. **SETTLED**: This notification is transmitted when a transaction is confirmed to have been manually settled, indicating that payment clearance originated from an external source rather than Edubank's processing.\n\n11. **SUBSCRIPTION PAID**: This notification confirms the successful completion of a payment that occurred for a subscription.\n\n12. **SUBSCRIPTION OVERDUE**: This notification informs you about a failed payment that occurred for a subscription.\n\n13. **SUBSCRIPTION CANCELED**: This notification informs you that the subscription has been canceled.\n\n14. **SUBSCRIPTION ACTIVE**: This notification informs you that the subscription has been activated/authorized by the buyer.\n\n15. **SUBSCRIPTION EXPIRED**: This notification informs you that the subscription period has expired.\n\n16. **DISPUTED**: This notification is issued when a dispute has been initiated for a payment.\n\n17. **CHARGED_BACK**: This notification is issued when a dispute is completed. The transaction status changes to UNPAID (Enabled to receive new payment). Then the payment is set to canceled and charged back.\n\n**Important Point:** The reference_id of SUBSCRIPTION type events will respect the \"references\" property informed when creating the proposal. If the \"references\" property was not informed, the reference_id will be that of the subscription itself\n\n**Important Points**\n- All notifications utilize the POST method.\n- For enhanced idempotence, each notification is assigned a unique `event_id`. This is particularly valuable in cases where your notification URL might take time to respond even though it's already been registered. In such scenarios, if our servers send the same notification again (with the same `event_id`), you can safely disregard it to prevent duplication.\n- If desired, we can bolster the security of our notifications by appending a custom key-value pair to the request headers. For example, incorporating an `x-api-key` can definitively confirm the origin of the incoming request as Edubank. This extra layer of security fortifies the integration process and fosters trust.\n\nShould this security measure align with your needs, please don't hesitate to reach out to our team. We're here to make your integration experience secure and seamless.\n\n## Reliability Assurance\n\nWe understand the significance of reliable notifications. Our system is designed to ensure the delivery of notifications, even amidst sporadic network challenges. However, we recommend designing your notification handling process to accommodate potential retries and safeguard the integrity of your data.\n\n## Notification Retry Strategy\n\nWhen integrating our notifications system, understanding the retry mechanism is crucial. Notifications play a pivotal role in staying updated about successful payments. We've instituted a strategy to handle scenarios where the initial HTTP response might be unsuccessful.\n\n### Retry Approach\n\nEach notification sent to the `notification_url` expects a successful HTTP response in return, confirming that your system has processed the notification.\n\nHowever, network glitches or temporary issues might hinder a successful response. To counter this, we've implemented a retry strategy. If the initial notification doesn't receive a successful response, our system will make additional attempts at specific intervals.\n\nAbsolutely, here's the improved explanation for the \"Retry Intervals\" section:\n\n### Retry Intervals\n\nOur notifications system incorporates specific retry intervals to ensure the reliable delivery of notifications:\n\n- 1 minute (60 seconds) after the initial failure (if applicable)\n- 5 minutes (300 seconds) after the first retry\n- 10 minutes (600 seconds) after the second retry\n- 1 hour (3600 seconds) after the third retry\n- 3 hours (10800 seconds) after the fourth retry\n- 6 hours (21600 seconds) after the fifth retry\n- 12 hours (43200 seconds) after the sixth retry\n- 24 hours (86400 seconds) after the seventh retry\n\nIt's essential to understand that these retry intervals are implemented exclusively in the event of an initial failure. The first retry interval commences 1 minute after the initial failure, with subsequent intervals following the specified pattern. Importantly, if no failure occurs, no further retry attempts will be triggered.\n\nThese intervals are carefully calibrated to accommodate a range of scenarios and network conditions, significantly enhancing the probability of flawless notification deliveries. By considering both the cumulative nature of these intervals and the initial retry delay, you can formulate a highly effective strategy for adeptly managing your notifications.\n### Handling Retries\n\nIt's crucial to note that during retries, a successful HTTP response from your endpoint is expected. This confirms your system's readiness to receive the notification. If a failed response occurs during any retry attempt, our system persists in making new attempts at the specified intervals.\n\nBy ensuring your endpoint's prompt and appropriate response, you play a pivotal role in upholding the efficiency and reliability of our notifications system. If you face persistent notification issues, our support team is readily available to assist you.\n\n","version":"v2.9.0","contact":{"name":"edubank","url":"https://edubank.com.br/","email":"support@edubank.com.br"},"x-logo":{"url":"https://checkout.edubank.com.br/edubank-logo.png","backgroundColor":"#F0F0F0","altText":"edubank logo"}},"tags":[],"servers":[],"components":{"securitySchemes":{"x-api-key":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key provided by Edubank that must be used in all requests"},"authorization":{"type":"apiKey","in":"header","name":"authorization","description":"Seller ID"}},"schemas":{"EdubankBuyersAddress":{"type":"object","properties":{"city":{"type":"string","description":"City","example":"Rio de Janeiro"},"additional_information":{"type":"string","description":"Additional address data. In this field you can inform complement, references","example":""},"number":{"type":"string","description":"Number","example":"143"},"state_code":{"type":"string","description":"State (UF)","example":"RJ"},"street":{"type":"string","description":"Street / Patio","example":"R. Marquês de Abrantes"},"neighborhood":{"type":"string","description":"Neighborhood","example":"Flamengo"},"zip":{"type":"string","description":"Postal Zone / ZIP Code)","example":"22230061"},"country_code":{"type":"string","description":"Buyer's country code","enum":["BR"],"example":"BR"}},"required":["city","number","state_code","street","neighborhood","zip","country_code"]},"EdubankBuyers":{"type":"object","properties":{"id":{"type":"string","description":"Buyer id","example":"39c784f7bf754698aa078a261cf42439"},"first_name":{"type":"string","description":"Buyer's first name","example":"John"},"last_name":{"type":"string","description":"Buyer's last name","example":"Zeisivig"},"email":{"type":"string","description":"Buyer's email","example":"teste@teste.com"},"taxpayer_id":{"type":"string","description":"Buyer's CPF/CNPJ","example":"76537741807"},"birthdate":{"type":"string","description":"Buyer's date of birth","example":"1990-01-05"},"phone_number":{"type":"string","description":"Buyer's phone number","example":"21987440889"},"address":{"description":"Buyer's address","allOf":[{"$ref":"#/components/schemas/EdubankBuyersAddress"}]}},"required":["first_name","last_name","taxpayer_id","address"]},"FormatExceptionMessage":{"type":"object","properties":{"status_code":{"type":"number"},"message":{"type":"string"},"error":{"type":"object"},"displayed_message":{"type":"string"}}},"EdubankBuyerDto":{"type":"object","properties":{"first_name":{"type":"string","description":"Buyer's first name","example":"John"},"last_name":{"type":"string","description":"Buyer's last name","example":"Zeisivig"},"email":{"type":"string","description":"Buyer's email","example":"teste@teste.com"},"taxpayer_id":{"type":"string","description":"Buyer's CPF/CNPJ","example":"76537741807"},"birthdate":{"type":"string","description":"Buyer's date of birth","example":"1990-01-05"},"phone_number":{"type":"string","description":"Buyer's phone number","example":"21987440889"},"address":{"description":"Buyer's address","allOf":[{"$ref":"#/components/schemas/EdubankBuyersAddress"}]}},"required":["first_name","last_name","taxpayer_id","address"]},"EdubankCardDetails":{"type":"object","properties":{"seller_id":{"type":"string","description":"Seller id"},"buyer_id":{"type":"string","description":"Associated buyer id"},"card_id":{"type":"string","description":"Card id"},"created_at":{"type":"string","example":"2026-09-02T23:59:59+00:00","description":"Date/Time when the card was created"},"updated_at":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"Date/time the card was updated"},"card_brand":{"type":"string","description":"Card brand","example":"MasterCard"},"first4_digits":{"type":"string","description":"First 4 digits of the card","example":"1234"},"last4_digits":{"type":"string","description":"Last 4 digits of the card","example":"6789"},"expiration_month":{"type":"string","description":"Expiration Month of the card","example":"12"},"expiration_year":{"type":"string","description":"Expiration Year of the card","example":"2030"},"holder_name":{"type":"string","description":"Card holder name","example":"Julio Alvarenga"},"is_active":{"type":"boolean","description":"Active card"},"is_valid":{"type":"boolean","description":"Valid card"}},"required":["seller_id","buyer_id","card_id","created_at","card_brand","first4_digits","last4_digits","expiration_month","expiration_year","holder_name"]},"EdubankCardAddToBuyer":{"type":"object","properties":{"encrypted_card":{"type":"string","description":"Encrypted edubank card data","example":"U2FsdGVkX19/KxeUpl25r00ejtEkXsMQhZt/CF/QdJFalEHzW5CoryrX9LzwhMPxLST/yH46PGSSn8uXoPZ8cM46Fj+udK9X/f+UghZzl/QAMKTKCAi785RlfDGWi+VhAXPZJhgka+hXmAoHUQRduE8g5jM75Smkf3xrq9miwQvRbOcC1AwTXL9nC7zhuoKEdmmoi1Vot+xipLEQFXB9Kg==","externalDocs":{"url":"https://api.edubank.com.br/docs#section/Encrypting-Card","description":"Click here and see an example of how to generate the encrypted_card"}},"buyer_id":{"type":"string","description":"Buyer's id","externalDocs":{"url":"https://api.edubank.com.br/docs#tag/Buyers/operation/BuyersController_getBuyerByTax","description":"You can get the buyer_id by searching for the buyer by tax_id if it has already been created or you will need to create a new one"}}},"required":["encrypted_card","buyer_id"]},"EdubankSubscriptionCharge":{"type":"object","properties":{"start_date":{"type":"string","example":"2026-10-02","description":"Date the first invoice will be paid"},"frequency":{"type":"string","description":"Frequency with which the subscription will be charged. DAILY - MONTHLY","enum":["DAILY","MONTHLY"],"example":"MONTHLY"},"duration":{"type":"number","description":"Subscription duration in relation to the chosen frequency","example":1},"amount":{"type":"number","description":"Gross amount to be paid. Ex: 2010 = 20.10","example":10000}},"required":["start_date","frequency","duration","amount"]},"EdubankSubscriptionPermission":{"type":"object","properties":{"authorized":{"type":"boolean","description":"Confirmation of buyer authorization to activate subscription"},"authorized_in":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"Card update date/time. YYYY-MM-DDTHH:mm:ssZ"},"card_id":{"type":"string","description":"Card authorized and registered for signature"}},"required":["authorized","authorized_in","card_id"]},"EdubankSubscriptionReferences":{"type":"object","properties":{"due_date":{"type":"string","example":"2026-10-02","description":"Due date that must be considered to consider the respective reference paid. YYYY-MM-DD"},"reference_id":{"type":"string","example":"my_tuition_246","description":"Reference ID of your application VARCHAR(500)"}},"required":["due_date","reference_id"]},"EdubankSubscription":{"type":"object","properties":{"created_at":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"When the subscription was created. YYYY-MM-DDTHH:mm:ssZ"},"updated_at":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"Last time subscription was updated. YYYY-MM-DDTHH:mm:ssZ"},"seller_id":{"type":"string","description":"Edubank seller id","example":"117a97d225337dmf96bb0b883a1019sj"},"subscription_id":{"type":"string","description":"Edubank subscription id"},"description":{"type":"string","description":"Brief description of what the signature refers to"},"reference_id":{"type":"string","example":"my_subscription_95","description":"Reference ID of your application VARCHAR(500)"},"buyer_id":{"type":"string","description":"Buyer id","example":"39c784f7bf754698aa078a261cf42439"},"status":{"type":"string","description":"Subscription status: PROPOSAL - ACTIVE - CANCELED - SUSPENDED - REACTIVATED","example":"PROPOSAL","enum":["PROPOSAL","ACTIVE","EXPIRED","CANCELED","SUSPENDED","REACTIVATED"]},"expires_in":{"type":"string","example":"2026-10-02","description":"Deadline for signature authorization by the buyer"},"charge":{"description":"Subscription billing details","allOf":[{"$ref":"#/components/schemas/EdubankSubscriptionCharge"}]},"notification_url":{"type":"string","description":"URL that will receive a POST call when the transaction changes","example":"https://api.domain.com.br/v1/edubank-notification"},"subscription_permission":{"description":"Authorization given by the buyer and card that will be used for signature","allOf":[{"$ref":"#/components/schemas/EdubankSubscriptionPermission"}]},"references":{"description":"References for payment notification that will be sent when payment is received for the subscription","type":"array","items":{"$ref":"#/components/schemas/EdubankSubscriptionReferences"}}},"required":["seller_id","subscription_id","description","reference_id","buyer_id","status","expires_in","charge","notification_url","subscription_permission"]},"GetAllSubscriptionsDto":{"type":"object","properties":{"page":{"type":"number","description":"Selected page"},"limit":{"type":"number","description":"Selected limit per page"},"sort":{"type":"string","description":"Selected sort list","enum":["ASC","DESC"]},"last_page":{"type":"number","description":"Last page"},"max_items":{"type":"number","description":"Total items for the defined filter"},"items":{"description":"Subscriptions found by the defined filter","type":"array","items":{"$ref":"#/components/schemas/EdubankSubscription"}}},"required":["page","limit","sort","last_page","max_items","items"]},"EdubankSubscriptionProposalDto":{"type":"object","properties":{"description":{"type":"string","description":"Brief description of what the signature refers to"},"reference_id":{"type":"string","example":"my_subscription_95","description":"Reference ID of your application VARCHAR(500)"},"expires_in":{"type":"string","example":"2026-10-02","description":"Deadline for signature authorization by the buyer"},"charge":{"description":"Subscription billing details","allOf":[{"$ref":"#/components/schemas/EdubankSubscriptionCharge"}]},"notification_url":{"type":"string","description":"URL that will receive a POST call when the transaction changes","example":"https://api.domain.com.br/v1/edubank-notification"},"references":{"description":"References for payment notification that will be sent when payment is received for the subscription","type":"array","items":{"$ref":"#/components/schemas/EdubankSubscriptionReferences"}}},"required":["description","reference_id","expires_in","charge","notification_url"]},"EdubankSubscriptionSubscribeDto":{"type":"object","properties":{"encrypted_card":{"type":"string","description":"Encrypted edubank card data","example":"U2FsdGVkX19/KxeUpl25r00ejtEkXsMQhZt/CF/QdJFalEHzW5CoryrX9LzwhMPxLST/yH46PGSSn8uXoPZ8cM46Fj+udK9X/f+UghZzl/QAMKTKCAi785RlfDGWi+VhAXPZJhgka+hXmAoHUQRduE8g5jM75Smkf3xrq9miwQvRbOcC1AwTXL9nC7zhuoKEdmmoi1Vot+xipLEQFXB9Kg==","externalDocs":{"url":"https://api.edubank.com.br/docs#section/Encrypting-Card","description":"Click here and see an example of how to generate the encrypted_card"}},"authorized":{"type":"boolean","description":"Inform whether the buyer authorized the signature"},"buyer":{"description":"Buyer's data","allOf":[{"$ref":"#/components/schemas/EdubankBuyerDto"}]}},"required":["encrypted_card","authorized","buyer"]},"SubscriptionUpdateBody":{"type":"object","properties":{"encrypted_card":{"type":"string","description":"Encrypted edubank card data","example":"U2FsdGVkX19/KxeUpl25r00ejtEkXsMQhZt/CF/QdJFalEHzW5CoryrX9LzwhMPxLST/yH46PGSSn8uXoPZ8cM46Fj+udK9X/f+UghZzl/QAMKTKCAi785RlfDGWi+VhAXPZJhgka+hXmAoHUQRduE8g5jM75Smkf3xrq9miwQvRbOcC1AwTXL9nC7zhuoKEdmmoi1Vot+xipLEQFXB9Kg==","externalDocs":{"url":"https://api.edubank.com.br/docs#section/Encrypting-Card","description":"Click here and see an example of how to generate the encrypted_card"}}},"required":["encrypted_card"]},"SubscriptionInvoiceRetryBody":{"type":"object","properties":{"reference_id":{"type":"string","example":"my_tuition_306","description":"Reference ID of your application VARCHAR(500)"},"description":{"type":"string","description":"Brief description of what the invoice refers to"}}},"TransactionCreationFailure":{"type":"object","properties":{"status_code":{"type":"number","description":"Http status"},"message":{"type":"string","description":"Error message"}},"required":["message"]},"EdubankTransactionItems":{"type":"object","properties":{"item":{"type":"string","description":"Item Description","example":"Tuition"},"amount":{"type":"string","description":"Item amount","example":"80000"},"reference":{"type":"string","description":"Item reference","example":"11/12"},"note":{"type":"string","description":"Item note","example":"November tuition"}},"required":["item","amount"]},"EdubankLateFee":{"type":"object","properties":{"mode":{"type":"string","description":"Billing mode. Accepted values: FIXED (fixed) or PERCENTAGE (percentage)","example":"PERCENTAGE"},"amount":{"type":"string","description":"Late fee amount. Ex: 2.00","example":"2.00"}},"required":["mode","amount"]},"EdubankInterest":{"type":"object","properties":{"mode":{"type":"string","description":"Billing mode. Accepted values: DAILY_AMOUNT, DAILY_PERCENTAGE","example":"DAILY_PERCENTAGE"},"amount":{"type":"string","description":"Interest fee amount. Ex: 0.033","example":"0.033"}},"required":["mode","amount"]},"EdubankDiscount":{"type":"object","properties":{"mode":{"type":"string","description":"Billing mode. Accepted values: FIXED (fixed) or PERCENTAGE (percentage)","example":"FIXED"},"date_1":{"type":"string","example":"2026-09-22","description":"Deadline for payment to occur with discount 1. It must be before the date entered in \"Due date\""},"amount_1":{"type":"number","description":"Discount 1 amount. Ex: 2010 = 20.10","example":3000},"date_2":{"type":"string","description":"Deadline for payment to occur with discount 2. It must be before the date entered in \"date_1\"","example":"2026-09-26"},"amount_2":{"type":"number","description":"Discount 2 amount. Ex: 2010 = 20.10","example":2500},"date_3":{"type":"string","description":"Deadline for payment to occur with discount 3. It must be before the date entered in \"date_2\"","example":"2026-09-28"},"amount_3":{"type":"number","description":"Discount 3 amount. Ex: 2010 = 20.10","example":2000}},"required":["mode","date_1","amount_1"]},"EdubankTransactionDetails":{"type":"object","properties":{"amount":{"type":"number","description":"Gross amount to be paid. Ex: 2010 = 20.10","example":10000},"due_date":{"type":"string","example":"2026-10-02","description":"Due date"},"payment_limit_date":{"type":"string","example":"2027-01-02","description":"Deadline for payment"},"body_instructions":{"description":"Up to five bank slip instructions","example":["Do not allow payment after 2027-01-02"],"type":"array","items":{"type":"string"}},"late_fee":{"description":"Late fee","allOf":[{"$ref":"#/components/schemas/EdubankLateFee"}]},"interest":{"description":"Interest","allOf":[{"$ref":"#/components/schemas/EdubankInterest"}]},"discount":{"description":"Discounts","allOf":[{"$ref":"#/components/schemas/EdubankDiscount"}]}},"required":["amount","due_date","payment_limit_date"]},"EdubankSplit":{"type":"object","properties":{"recipient":{"type":"string","description":"Recipient seller_id"},"amount":{"type":"number","description":"Value that will be split. Ex: 2010 = 20.10","example":9550},"percentage":{"type":"string","description":"Split percentage","example":"0.1234"},"processing_fee":{"type":"string","description":"Defines which seller should process fees. MAIN = Seller who created the transaction. RECIPIENT = Seller informed in the split.","example":"MAIN"}},"required":["recipient","percentage","processing_fee"]},"EdubankConfirmedPayment":{"type":"object","properties":{"create_at":{"type":"string","example":"2026-09-02T23:59:59+00:00","description":"When payment creation was requested"},"update_at":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"When the last payment update occurred"},"payment_id":{"type":"string","description":"Edubank payment id","example":"d03918d2253e4a22a7bb0b88lap2039d"},"payment_confirmed":{"type":"boolean","description":"The payment has been confirmed","example":false},"payment_canceled":{"type":"boolean","description":"The payment has been canceled","example":false},"payment_voided":{"type":"boolean","description":"The payment has been voided","example":false},"payment_chargeback":{"type":"boolean","description":"Payment was reversed","example":false},"payment_type":{"type":"string","description":"Payment method used","enum":["CREDIT_CARD","DEBIT_CARD","BANK_SLIP","PIX"],"example":"PIX"},"payment_received_at":{"type":"string","example":"2026-09-02T23:59:59+00:00","description":"When payment was received"},"payment_gross_amount":{"type":"number","description":"Gross payment amount"},"payment_amount":{"type":"number","description":"Payment amount"},"receivable_amount":{"type":"number","description":"Amount that will be credited"},"fees":{"type":"string","description":"Fees","example":"0.00"}},"required":["create_at","payment_id","payment_confirmed","payment_canceled","payment_voided","payment_chargeback","payment_type","payment_received_at","payment_gross_amount","payment_amount","receivable_amount","fees"]},"EdubankTransactionResponse":{"type":"object","properties":{"company_logo_url":{"type":"string","description":"URL with the company logo. This logo will be displayed on the checkout page","example":"Optional"},"company_name":{"type":"string","description":"Company name that will be displayed on the checkout page","example":"Optional"},"company_data":{"type":"string","description":"Company data that will be displayed on the checkout page","example":"Optional"},"lose_discount_for":{"type":"array","description":"Payment methods that should lose the applied discount","items":{"type":"string","enum":["CREDIT_CARD","DEBIT_CARD","BANK_SLIP","BANK_SLIP_PIX","PIX","CANCELED","SETTLED","RECEIVABLE","SUBSCRIPTION"]}},"seller_id":{"type":"string","description":"Edubank seller id","example":"117a97d225337dmf96bb0b883a1019sj"},"buyer":{"description":"Buyer's data","allOf":[{"$ref":"#/components/schemas/EdubankBuyers"}]},"transaction_id":{"type":"string","description":"Edubank transaction id","example":"117a97d2253e4a22a7bb0b883a10242c"},"settled":{"type":"boolean","description":"The transaction was confirmed manually. The term \"settled\" is equivalent to \"mark as paid\"","example":false},"canceled":{"type":"boolean","description":"The transaction has been canceled","example":false},"payment_confirmed":{"type":"boolean","description":"Informs if the payment has already been confirmed","example":false},"successfully_paid":{"type":"boolean","description":"Informs whether the payment operation was successful","example":false},"payment_amount":{"type":"number","description":"Confirmed payment amount"},"reference_id":{"type":"string","example":"my_ref_968","description":"Reference ID of your application VARCHAR(500)"},"buyer_id":{"type":"string","description":"Edubank buyer id","example":"11eff0fe1b3b4ece9f930088d797261f"},"amount_to_pay_today":{"type":"number","description":"Amount to be paid today. Ex: 2010 = 20.10","example":"10200"},"expires_in":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"Deadline to allow a credit card or pix payment to be made with this transaction. Default: creation date"},"transaction_limit_date":{"type":"string","example":"2027-09-02","description":"Deadline to use this transaction for payment"},"transaction_description":{"type":"string","description":"Description of the sale for payment","example":"Sale of tickets for the show on the 30th"},"seller_card_fees":{"description":"Seller installment card fees","example":[0.1111,0.2222,0.3333,0.4444,0.5555,0.6666,0.7777,0.8888,0.9999,1.101,1.1111,1.1212],"type":"array","items":{"type":"string"}},"pix_fees":{"type":"string","description":"Seller pix fees","example":"0.5000"},"sandbox":{"type":"boolean","description":"Defines whether the account is in test or production mode","example":true,"default":true},"is_pinpad_transaction":{"type":"boolean","description":"Defines that a transaction is pinpad. In this case, the transaction may respect some specific parameters, such as a different pix fees","example":false,"default":false},"allows_pix":{"type":"boolean","description":"Allows you to pay with pix","example":true},"allows_credit_card":{"type":"boolean","description":"Allows you to pay with credit card","example":true},"allows_bank_slip":{"type":"boolean","description":"Allows you to pay with bank slip","example":true},"transaction_items":{"description":"Edubank transaction items","type":"array","items":{"$ref":"#/components/schemas/EdubankTransactionItems"}},"transaction_details":{"description":"Edubank transaction details","allOf":[{"$ref":"#/components/schemas/EdubankTransactionDetails"}]},"split_rules":{"description":"Split rules for the transaction.<br>All objects in the 'split_rules' array must have the same properties.<br>They must all be by value or by percentage","type":"array","items":{"$ref":"#/components/schemas/EdubankSplit"}},"notification_url":{"type":"string","description":"URL that will receive a POST call when the transaction changes","example":"https://api.domain.com.br/v1/edubank-notification"},"payments":{"description":"List of all payments that were confirmed for this transaction","type":"array","items":{"$ref":"#/components/schemas/EdubankConfirmedPayment"}}},"required":["seller_id","buyer","transaction_id","settled","canceled","payment_confirmed","successfully_paid","reference_id","buyer_id","transaction_limit_date","seller_card_fees","pix_fees","sandbox","allows_pix","allows_credit_card","allows_bank_slip","transaction_details","notification_url"]},"EdubankTransactionDto":{"type":"object","properties":{"reference_id":{"type":"string","example":"my_ref_968","description":"Reference ID of your application VARCHAR(500)"},"transaction_limit_date":{"type":"string","example":"2027-09-02","description":"Deadline to use this transaction for payment"},"transaction_description":{"type":"string","description":"Description of the sale for payment","example":"Sale of tickets for the show on the 30th"},"sandbox":{"type":"boolean","description":"Defines whether the account is in test or production mode","example":true,"default":true},"is_pinpad_transaction":{"type":"boolean","description":"Defines that a transaction is pinpad. In this case, the transaction may respect some specific parameters, such as a different pix fees","example":false,"default":false},"allows_pix":{"type":"boolean","description":"Allows you to pay with pix","example":true},"allows_credit_card":{"type":"boolean","description":"Allows you to pay with credit card","example":true},"allows_bank_slip":{"type":"boolean","description":"Allows you to pay with bank slip","example":true},"transaction_items":{"description":"Edubank transaction items","type":"array","items":{"$ref":"#/components/schemas/EdubankTransactionItems"}},"transaction_details":{"description":"Edubank transaction details","allOf":[{"$ref":"#/components/schemas/EdubankTransactionDetails"}]},"split_rules":{"description":"Split rules for the transaction.<br>All objects in the 'split_rules' array must have the same properties.<br>They must all be by value or by percentage","type":"array","items":{"$ref":"#/components/schemas/EdubankSplit"}},"notification_url":{"type":"string","description":"URL that will receive a POST call when the transaction changes","example":"https://api.domain.com.br/v1/edubank-notification"},"buyer":{"description":"Buyer's data","allOf":[{"$ref":"#/components/schemas/EdubankBuyerDto"}]}},"required":["reference_id","transaction_limit_date","sandbox","allows_pix","allows_credit_card","allows_bank_slip","transaction_details","notification_url","buyer"]},"EdubankTransactionCreationResponse":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Edubank transaction id","example":"117a97d2253e4a22a7bb0b883a10242c"},"amount_to_pay_today":{"type":"number","description":"Amount to be paid today. Ex: 2010 = 20.10","example":"10200"},"expires_in":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"Deadline to allow a credit card or pix payment to be made with this transaction. Default: creation date"},"status_code":{"type":"number","description":"Status code","example":200}},"required":["transaction_id","status_code"]},"EdubankCardDataOnlyDto":{"type":"object","properties":{"color_depth":{"type":"number","description":"Represents the color depth of the palette used to display images, measured in bits per pixel. It indicates how many bits are used to represent the color of each pixel, influencing the quality of the colors displayed on the screen. It can be obtained in the client browser through the window.screen.colorDepth property","default":24},"device_type":{"type":"string","description":"Indicates the type of device on which authentication occurs, helps identify the usage environment and adapt the user experience according to the device. Default value is BROWSER","default":"BROWSER","enum":["BROWSER"]},"java_enabled":{"type":"boolean","description":"Boolean field indicating whether the client browser has the capability to run Java. Returns true if Java support is enabled and false otherwise. The value can be obtained directly from the client browser through the navigator.javaEnabled() property","default":false},"language":{"type":"string","description":"Represents the browser's preferred language, in IETF BCP 47 format, containing between 1 and 8 characters. This value can be used to adapt the interface to the user's language. It can be obtained in the client browser through the navigator.language property","default":"BR"},"screen_height":{"type":"number","description":"The total height of the client screen in pixels. The value is the one returned by the screen.height property","default":500},"screen_width":{"type":"number","description":"The total width of the client screen in pixels. The value is the one returned by the screen.width property","default":500},"time_zone_offset":{"type":"number","description":"Represents the time difference, in hours, between UTC and the local time of the cardholder's browser. Between -12 and +14","default":-3},"ip_address":{"type":"string","description":"Represents the client IP address (IPv4) used to uniquely identify a device on the network. Obtained from the client browser via the navigator.connection property or via IP discovery services. #If not informed, the IP will be extracted from the request made#","example":"10.0.0.1"}},"required":["color_depth","java_enabled","screen_height","screen_width"]},"EdubankTransactionCardsDto":{"type":"object","properties":{"reference_id":{"type":"string","example":"my_ref_968","description":"Reference ID of your application VARCHAR(500)"},"transaction_limit_date":{"type":"string","example":"2027-09-02","description":"Deadline to use this transaction for payment"},"transaction_description":{"type":"string","description":"Description of the sale for payment","example":"Sale of tickets for the show on the 30th"},"sandbox":{"type":"boolean","description":"Defines whether the account is in test or production mode","example":true,"default":true},"is_pinpad_transaction":{"type":"boolean","description":"Defines that a transaction is pinpad. In this case, the transaction may respect some specific parameters, such as a different pix fees","example":false,"default":false},"transaction_items":{"description":"Edubank transaction items","type":"array","items":{"$ref":"#/components/schemas/EdubankTransactionItems"}},"transaction_details":{"description":"Edubank transaction details","allOf":[{"$ref":"#/components/schemas/EdubankTransactionDetails"}]},"split_rules":{"description":"Split rules for the transaction.<br>All objects in the 'split_rules' array must have the same properties.<br>They must all be by value or by percentage","type":"array","items":{"$ref":"#/components/schemas/EdubankSplit"}},"notification_url":{"type":"string","description":"URL that will receive a POST call when the transaction changes","example":"https://api.domain.com.br/v1/edubank-notification"},"encrypted_card":{"type":"string","description":"Encrypted edubank card data","example":"U2FsdGVkX19sBR6NRhBCEmNyN3DJCHgjLZy2Z6cIMFWhO3vFhP+0C4npjEaNbtzmHGbsMhYTunhmExBJDLpVwPpZy9CBM4RN1MYxZ7MZFIWv2vnGTwUmf+MAo1RT2MvMT+UgAdyVE3TOY+UlNZ0nnXKsUExPsCJYdt748fazyxst6CcLwZA1zCZuikxoRK/h+7mLWMEIUzXQevqdZCh/tEZKxr2Fkz0VEuH8ETa4G27hpwAVrEdq1uixHBiGSlq6","externalDocs":{"url":"https://api.edubank.com.br/docs#section/Encrypting-Card","description":"Click here and see an example of how to generate the encrypted_card"}},"data_only":{"description":"Dataonly is a similar modality to 3DS. The goal of the protocol is to reduce the fraud rate and increase approval rates in relation to a common transaction, as more data will be analyzed to support the issuer's decision-making","allOf":[{"$ref":"#/components/schemas/EdubankCardDataOnlyDto"}]}},"required":["reference_id","transaction_limit_date","sandbox","transaction_details","notification_url","encrypted_card"]},"EdubankTransactionSuccessResponseCard":{"type":"object","properties":{"status_code":{"type":"number","description":"Status code","example":200},"transaction_id":{"type":"string","description":"Edubank transaction id"},"transaction_type":{"type":"string","description":"Type of transaction performed. CARD/PIX/BANK_SLIP/BANK_SLIP_PIX"},"status":{"type":"string","description":"Current transaction status"},"payment_id":{"type":"string","description":"Payment id"},"card_brand":{"type":"string","description":"Flag of the credit card used"},"bank_slip_digitable_line":{"type":"string","description":"Digitable line for payment slip"},"pix_base64":{"type":"string","description":"Pix qrcode image in base64"}},"required":["status_code","transaction_id","transaction_type","status","payment_id"]},"EdubankTransactionPixWithoutBuyerDto":{"type":"object","properties":{"reference_id":{"type":"string","example":"my_ref_968","description":"Reference ID of your application VARCHAR(500)"},"transaction_limit_date":{"type":"string","example":"2027-09-02","description":"Deadline to use this transaction for payment"},"transaction_description":{"type":"string","description":"Description of the sale for payment","example":"Sale of tickets for the show on the 30th"},"sandbox":{"type":"boolean","description":"Defines whether the account is in test or production mode","example":true,"default":true},"is_pinpad_transaction":{"type":"boolean","description":"Defines that a transaction is pinpad. In this case, the transaction may respect some specific parameters, such as a different pix fees","example":false,"default":false},"transaction_items":{"description":"Edubank transaction items","type":"array","items":{"$ref":"#/components/schemas/EdubankTransactionItems"}},"transaction_details":{"description":"Edubank transaction details","allOf":[{"$ref":"#/components/schemas/EdubankTransactionDetails"}]},"split_rules":{"description":"Split rules for the transaction.<br>All objects in the 'split_rules' array must have the same properties.<br>They must all be by value or by percentage","type":"array","items":{"$ref":"#/components/schemas/EdubankSplit"}},"notification_url":{"type":"string","description":"URL that will receive a POST call when the transaction changes","example":"https://api.domain.com.br/v1/edubank-notification"}},"required":["reference_id","transaction_limit_date","sandbox","transaction_details","notification_url"]},"EdubankTransactionSuccessResponsePix":{"type":"object","properties":{"status_code":{"type":"number","description":"Status code","example":200},"transaction_id":{"type":"string","description":"Edubank transaction id"},"transaction_type":{"type":"string","description":"Type of transaction performed. CARD/PIX/BANK_SLIP/BANK_SLIP_PIX"},"status":{"type":"string","description":"Current transaction status"},"payment_id":{"type":"string","description":"Payment id"},"bank_slip_digitable_line":{"type":"string","description":"Digitable line for payment slip"},"pix_qrcode":{"type":"string","description":"Pix qrcode"},"pix_base64":{"type":"string","description":"Pix qrcode image in base64"},"pix_expiration":{"type":"string","description":"Pix expiration"}},"required":["status_code","transaction_id","transaction_type","status","payment_id"]},"EdubankTransactionOneStepDto":{"type":"object","properties":{"reference_id":{"type":"string","example":"my_ref_968","description":"Reference ID of your application VARCHAR(500)"},"transaction_limit_date":{"type":"string","example":"2027-09-02","description":"Deadline to use this transaction for payment"},"transaction_description":{"type":"string","description":"Description of the sale for payment","example":"Sale of tickets for the show on the 30th"},"sandbox":{"type":"boolean","description":"Defines whether the account is in test or production mode","example":true,"default":true},"is_pinpad_transaction":{"type":"boolean","description":"Defines that a transaction is pinpad. In this case, the transaction may respect some specific parameters, such as a different pix fees","example":false,"default":false},"transaction_items":{"description":"Edubank transaction items","type":"array","items":{"$ref":"#/components/schemas/EdubankTransactionItems"}},"transaction_details":{"description":"Edubank transaction details","allOf":[{"$ref":"#/components/schemas/EdubankTransactionDetails"}]},"split_rules":{"description":"Split rules for the transaction.<br>All objects in the 'split_rules' array must have the same properties.<br>They must all be by value or by percentage","type":"array","items":{"$ref":"#/components/schemas/EdubankSplit"}},"notification_url":{"type":"string","description":"URL that will receive a POST call when the transaction changes","example":"https://api.domain.com.br/v1/edubank-notification"},"buyer":{"description":"Buyer's data","allOf":[{"$ref":"#/components/schemas/EdubankBuyerDto"}]},"bank_slip_link":{"type":"string","description":"Indicates whether the PDF of the bank slip or the HTML should be returned. DEFAULT is PDF","enum":["PDF","HTML"],"default":"PDF"}},"required":["reference_id","transaction_limit_date","sandbox","transaction_details","notification_url","buyer"]},"EdubankTransactionSuccessResponseBankSlip":{"type":"object","properties":{"status_code":{"type":"number","description":"Status code","example":200},"transaction_id":{"type":"string","description":"Edubank transaction id"},"transaction_type":{"type":"string","description":"Type of transaction performed. CARD/PIX/BANK_SLIP/BANK_SLIP_PIX"},"status":{"type":"string","description":"Current transaction status"},"payment_id":{"type":"string","description":"Payment id"},"bank_slip_link":{"type":"string","description":"URL for payment slip"},"bank_slip_barcode":{"type":"string","description":"Barcode for payment slip"},"bank_slip_digitable_line":{"type":"string","description":"Digitable line for payment slip"},"bank_slip_document_number":{"type":"string","description":"\"Our number\" from the bank slip"},"pix_qrcode":{"type":"string","description":"Pix qrcode"},"pix_base64":{"type":"string","description":"Pix qrcode image in base64"},"pix_expiration":{"type":"string","description":"Pix expiration"}},"required":["status_code","transaction_id","transaction_type","status","payment_id"]},"EdubankTransactionCardEncryptedDto":{"type":"object","properties":{"encrypted_card":{"type":"string","description":"Encrypted edubank card data","example":"U2FsdGVkX19sBR6NRhBCEmNyN3DJCHgjLZy2Z6cIMFWhO3vFhP+0C4npjEaNbtzmHGbsMhYTunhmExBJDLpVwPpZy9CBM4RN1MYxZ7MZFIWv2vnGTwUmf+MAo1RT2MvMT+UgAdyVE3TOY+UlNZ0nnXKsUExPsCJYdt748fazyxst6CcLwZA1zCZuikxoRK/h+7mLWMEIUzXQevqdZCh/tEZKxr2Fkz0VEuH8ETa4G27hpwAVrEdq1uixHBiGSlq6","externalDocs":{"url":"https://api.edubank.com.br/docs#section/Encrypting-Card","description":"Click here and see an example of how to generate the encrypted_card"}},"data_only":{"description":"Dataonly is a similar modality to 3DS. The goal of the protocol is to reduce the fraud rate and increase approval rates in relation to a common transaction, as more data will be analyzed to support the issuer's decision-making","allOf":[{"$ref":"#/components/schemas/EdubankCardDataOnlyDto"}]}},"required":["encrypted_card"]},"EdubankTransactionPixDto":{"type":"object","properties":{"description":{"type":"string","description":"A brief description of the reason for your transaction","example":"Sale with pix"},"pix_expiration_date_time":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"PIX expiration date that exceeds 24 hours. Can only be used when previously configured"}}},"EdubankPixNotification":{"type":"object","properties":{"status":{"type":"string","description":"Transaction status","enum":["PAID","CREATED","CANCELED","REFUNDED","VOIDED","SETTLED","OVERDUE","EXPIRED","ACTIVE","CHARGED_BACK","DISPUTED"]},"payment_id":{"type":"string","description":"Payment id"},"reference_id":{"type":"string","description":"Reference ID of your application VARCHAR(500)"},"payment_type":{"type":"string","description":"Payment type"},"payment_amount":{"type":"number","description":"Payment amount"},"payment_confirmed":{"type":"boolean","description":"If the payment has been confirmed"},"payment_canceled":{"type":"boolean","description":"If the payment has been canceled"},"payment_received_at":{"type":"string","example":"2026-09-02T23:59:59+00:00","description":"When payment was received"},"expected_on":{"type":"string","example":"2026-10-02","description":"Credit date"},"fees":{"type":"string","description":"Fees"},"pix_qrcode":{"type":"string","description":"Pix qrcode"},"pix_expiration":{"type":"string","description":"Pix expiration"},"pix_authorization_code":{"type":"string","description":"Pix settlement authorization code"}},"required":["status","payment_id","reference_id","payment_type","payment_amount","payment_confirmed","payment_canceled","payment_received_at","expected_on","fees","pix_qrcode","pix_expiration","pix_authorization_code"]},"EdubankSendEvent":{"type":"object","properties":{"event_id":{"type":"string","description":"Event id"},"create_at":{"type":"string","description":"When the event was raised"},"seller_id":{"type":"string","description":"Seller id"},"transaction_id":{"type":"string","description":"Transaction id"},"subscription_id":{"type":"string","description":"Subscription id"},"payment_method":{"description":"Payment event","allOf":[{"$ref":"#/components/schemas/EdubankPixNotification"}]}},"required":["event_id","create_at","seller_id","payment_method"]},"EdubankPixSse":{"type":"object","properties":{"status_code":{"type":"number","description":"Status code"},"status":{"type":"string","description":"Event status"},"message":{"type":"string","description":"Event message"},"payment_event":{"description":"Payment event","nullable":true,"allOf":[{"$ref":"#/components/schemas/EdubankSendEvent"}]}},"required":["status_code","status","message","payment_event"]},"EdubankMessageEventPixSse":{"type":"object","properties":{"id":{"type":"string","description":"Message event id"},"data":{"description":"Event data","allOf":[{"$ref":"#/components/schemas/EdubankPixSse"}]}},"required":["id","data"]},"EdubankTransactionBankSlipDto":{"type":"object","properties":{"description":{"type":"string","description":"Description of the product being sold","example":"Sale of tickets for the show on the 30th"},"bank_slip_link":{"type":"string","description":"Indicates whether the PDF of the bank slip or the HTML should be returned. DEFAULT is PDF","enum":["PDF","HTML"],"default":"PDF"}}},"AllowsMethod":{"type":"object","properties":{"pix":{"type":"boolean"},"bank_slip":{"type":"boolean"},"credit_card":{"type":"boolean"}},"required":["pix","bank_slip","credit_card"]},"AllTransactionReponseV2History":{"type":"object","properties":{"event_id":{"type":"string"},"created_at":{"type":"string","example":"2026-09-02T23:59:59+00:00"},"sent_with_success":{"type":"boolean"},"sent_attempts":{"type":"number"},"sent_with_success_in":{"type":"string","example":"2026-09-02T23:59:59+00:00"},"partner_response":{"description":"Partner API Response","type":"array","items":{"type":"string"}}},"required":["event_id","created_at","sent_with_success","sent_attempts","sent_with_success_in","partner_response"]},"AllTransactionResponseV2":{"type":"object","properties":{"created_at":{"type":"string","example":"2026-09-02T23:59:59+00:00"},"updated_at":{"type":"string","example":"2026-10-02T23:59:59+00:00"},"sandbox":{"type":"boolean"},"status":{"type":"string","description":"Current transaction status","enum":["PAID","CANCELED","SETTLED","VOIDED","OPEN"],"example":"OPEN"},"paid_at":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"When the transaction was paid","nullable":true},"paid_with":{"type":"string","description":"Payment method with which the transaction was paid","enum":["PIX","BANK_SLIP","CREDIT_CARD","DEBIT_CARD","BANK_SLIP_PIX_WITH_PIX","BANK_SLIP_PIX_WITH_BARCODE"],"example":"BANK_SLIP_PIX_WITH_BARCODE","nullable":true},"paid_amount":{"type":"number"},"transaction_id":{"type":"string","description":"Edubank transaction id"},"reference_id":{"type":"string"},"seller_id":{"type":"string","description":"Edubank seller id"},"allows":{"description":"Payment methods allowed for transaction","allOf":[{"$ref":"#/components/schemas/AllowsMethod"}]},"buyer":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/EdubankBuyers"}]},"transaction_items":{"nullable":true,"description":"Edubank transaction items","type":"array","items":{"$ref":"#/components/schemas/EdubankTransactionItems"}},"transaction_details":{"description":"Edubank transaction details","allOf":[{"$ref":"#/components/schemas/EdubankTransactionDetails"}]},"split_rules":{"type":"array","items":{"$ref":"#/components/schemas/EdubankSplit"}},"notification_url":{"type":"string"},"history":{"type":"array","items":{"$ref":"#/components/schemas/AllTransactionReponseV2History"}}},"required":["created_at","sandbox","status","paid_with","transaction_id","reference_id","seller_id","allows","transaction_details","notification_url","history"]},"TransactionVoidRequestDto":{"type":"object","properties":{"payment_id":{"type":"string","description":"Payment id"}},"required":["payment_id"]},"TransactionVoidResponse":{"type":"object","properties":{"create_at":{"type":"string","example":"2026-09-02T23:59:59+00:00","description":"Date/time when the reversal was requested"},"update_at":{"type":"string","example":"2026-10-02T23:59:59+00:00","description":"Date/time when the reversal was been updated"},"transaction_id":{"type":"string","description":"Transaction id"},"payment_id":{"type":"string","description":"Payment id"},"amount":{"type":"number","description":"Gross amount to be paid. Ex: 2010 = 20.10","example":10000},"status":{"type":"string","description":"Operation status","example":"succeeded"}},"required":["create_at","transaction_id","payment_id","amount","status"]},"EdubankTransactionBankSlipPixCreate":{"type":"object","properties":{"bank_slip_link":{"type":"string","description":"Indicates whether the PDF of the bank slip or the HTML should be returned","enum":["PDF","HTML"],"default":"HTML"}}},"EdubankTransactionOneStepDtoHtmlLinkDefault":{"type":"object","properties":{"reference_id":{"type":"string","example":"my_ref_968","description":"Reference ID of your application VARCHAR(500)"},"transaction_limit_date":{"type":"string","example":"2027-09-02","description":"Deadline to use this transaction for payment"},"transaction_description":{"type":"string","description":"Description of the sale for payment","example":"Sale of tickets for the show on the 30th"},"sandbox":{"type":"boolean","description":"Defines whether the account is in test or production mode","example":true,"default":true},"is_pinpad_transaction":{"type":"boolean","description":"Defines that a transaction is pinpad. In this case, the transaction may respect some specific parameters, such as a different pix fees","example":false,"default":false},"transaction_items":{"description":"Edubank transaction items","type":"array","items":{"$ref":"#/components/schemas/EdubankTransactionItems"}},"transaction_details":{"description":"Edubank transaction details","allOf":[{"$ref":"#/components/schemas/EdubankTransactionDetails"}]},"split_rules":{"description":"Split rules for the transaction.<br>All objects in the 'split_rules' array must have the same properties.<br>They must all be by value or by percentage","type":"array","items":{"$ref":"#/components/schemas/EdubankSplit"}},"notification_url":{"type":"string","description":"URL that will receive a POST call when the transaction changes","example":"https://api.domain.com.br/v1/edubank-notification"},"buyer":{"description":"Buyer's data","allOf":[{"$ref":"#/components/schemas/EdubankBuyerDto"}]},"bank_slip_link":{"type":"string","description":"Indicates whether the PDF of the bank slip or the HTML should be returned. DEFAULT is HTML","enum":["PDF","HTML"],"default":"HTML"}},"required":["reference_id","transaction_limit_date","sandbox","transaction_details","notification_url","buyer"]},"EdubankTransactionEmailNotification":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Edubank transaction id","example":"117a97d2253e4a22a7bb0b883a10242c"},"email_subject":{"type":"string"},"email_from":{"type":"string","example":"john@edubank.com"},"email_to":{"type":"string","example":"john-zeisivig@gmail.com"},"email_reply_to":{"type":"string","example":"response@seller-domain.com"},"category":{"type":"string","enum":["overdue","billing","payment","unsubscribe"],"example":"billing"},"created_at":{"type":"string","example":"2026-09-02T23:59:59+00:00"},"sent_at":{"type":"string","example":"2026-10-02T23:59:59+00:00"},"delivered":{"type":"boolean"},"delivered_at":{"type":"string","example":"2026-10-02T23:59:59+00:00"},"open":{"type":"boolean"},"open_at":{"type":"string","example":"2026-10-02T23:59:59+00:00"},"rejected":{"type":"boolean"},"rejected_reason":{"type":"string"}},"required":["transaction_id","email_subject","email_from","email_to","email_reply_to","category","created_at","delivered","open","rejected"]},"EdubankReceivables":{"type":"object","properties":{"create_at":{"type":"string","example":"2026-10-02","description":"Create at"},"expected_on":{"type":"string","example":"2026-10-02","description":"Expected on"},"status":{"type":"string","description":"Status of receivables","enum":["PAID","CREATED","REFUNDED","CANCELED"],"example":"CREATED"},"receivable_amount":{"type":"number","description":"Receivable amount","example":198},"main_seller_id":{"type":"string","description":"Edubank main seller_id for split transactions"},"transaction_id":{"type":"string","description":"Edubank transaction id"},"reference_id":{"type":"string","description":"Reference ID of your application VARCHAR(500)"},"payment_id":{"type":"string","description":"Payment id"},"payment_type":{"type":"string","description":"Payment type","example":"PIX"},"paid_with":{"type":"string","description":"When the payment method is BANK_SLIP_PIX, then this property informs whether the payment was made with PIX or BANK_SLIP"},"payment_amount":{"type":"number","description":"Payment amount","example":200},"payment_received_at":{"type":"string","example":"2026-09-02T23:59:59+00:00","description":"Payment received at"},"liable":{"type":"boolean","description":"Liable of the transaction"},"split_rule":{"description":"If there was a transaction split, the split identifier will appear","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/EdubankSplit"}},"installment":{"type":"number","description":"Information regarding installment of the transaction","nullable":true}},"required":["create_at","expected_on","status","receivable_amount","main_seller_id","transaction_id","reference_id","payment_id","payment_type","payment_amount","payment_received_at","liable","split_rule","installment"]},"EdubankReceivablesResponseDto":{"type":"object","properties":{"page":{"type":"string","description":"Select the page","default":0},"limit":{"type":"string","description":"Limits the number of objects returned, which can be between 1 and 100","default":10},"sort":{"type":"string","description":"Determine how to sort the list by object creation date","enum":["ASC","DESC"],"default":"DESC"},"last_page":{"type":"number","description":"Last page"},"max_items":{"type":"number","description":"Max items"},"items":{"description":"List of all receivables","type":"array","items":{"$ref":"#/components/schemas/EdubankReceivables"}}},"required":["page","limit","sort","last_page","max_items","items"]},"GetPosSearchDto":{"type":"object","properties":{"id":{"type":"string","description":"POS id"},"code":{"type":"string","description":"POS code"},"status":{"type":"string","description":"Status"},"serial_number":{"type":"string","description":"POS serial number"},"terminal_model":{"type":"string","description":"POS model"},"manufacturer":{"type":"string","description":"POS manufacturer"},"seller_id":{"type":"string","description":"Active POS for seller_id"},"pin_capability":{"type":"string","description":"Shows that the POS is ready for use"},"contactless_enabled":{"type":"boolean","description":"Shows that the POS is ready for contactless payment"},"metadata":{"type":"object","description":"Metadata"}},"required":["id","code","status","serial_number","terminal_model","manufacturer","seller_id","pin_capability","contactless_enabled","metadata"]},"PostPosActivationDto":{"type":"object","properties":{"token":{"type":"string","description":"Activation token. The token must have 8 digits"}},"required":["token"]},"PostActivationResponseDto":{"type":"object","properties":{"type":{"type":"string","description":"activation"},"status":{"type":"string","description":"success"},"access_key":{"type":"string","description":"Access key"},"terminal":{"type":"string","description":"Terminal serial number"},"seller_name":{"type":"string","description":"Seller name"}},"required":["type","status"]},"AccountStatementItem":{"type":"object","properties":{"seller_name":{"type":"string","description":"Edubank seller name"},"seller_id":{"type":"string","description":"Edubank seller id","example":"117a97d225337dmf96bb0b883a1019sj"},"date":{"type":"string","example":"2026-09-02T23:59:59+00:00","description":"date"},"net_amount":{"type":"string","description":"net_amount"},"blocked_amount":{"type":"string","description":"blocked_amount"},"current_balance":{"type":"string","description":"current_balance"},"amount":{"type":"string","description":"amount"},"fee":{"type":"string","description":"fee"},"entry_type":{"type":"string","description":"entry_type"},"entry_description":{"type":"string","description":"entry_description"},"transaction_id":{"type":"string","description":"Edubank transaction id","example":"117a97d2253e4a22a7bb0b883a10242c"},"reference_id":{"type":"string","example":"my_ref_835","description":"Reference ID of your application VARCHAR(500)"},"payment_id":{"type":"string","description":"Edubank payment id","example":"d03918d2253e4a22a7bb0b88lap2039d"}},"required":["seller_name","seller_id","date","net_amount","blocked_amount","current_balance","amount","fee","entry_type","entry_description"]},"AccountStatementResponse":{"type":"object","properties":{"limit":{"type":"number"},"offset":{"type":"number"},"has_more":{"type":"boolean","default":false},"total":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"},"resource":{"type":"string","default":"account_statement"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AccountStatementItem"}}},"required":["limit","offset","has_more","total","total_pages","page","resource","items"]},"FutureTransferItem":{"type":"object","properties":{"expected_on":{"type":"string","example":"2026-10-02","description":"expected_on"},"amount":{"type":"string","description":"amount","example":"150.25"},"bank_account":{"type":"string","description":"bank_account","example":"EduBank - 0001 - 123456789"}},"required":["expected_on","amount","bank_account"]},"FutureTransferResponse":{"type":"object","properties":{"limit":{"type":"number"},"offset":{"type":"number"},"has_more":{"type":"boolean","default":false},"total":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"},"resource":{"type":"string","default":"future_transfer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FutureTransferItem"}}},"required":["limit","offset","has_more","total","total_pages","page","resource","items"]}}},"x-tagGroups":[{"name":"RESOURCES","tags":["Transactions","Receivables","Subscriptions","Cards","Buyers","Banking","POS","Health"]}]}