{"openapi":"3.0.0","paths":{"/auth/signin":{"post":{"description":"Generate an Access Token by providing your API ID and API Key in the request body. Use the Access Token to authenticate and log in to the application via the 'Authorize' section.","operationId":"LoginAuthRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"description":"Create an Access Token requires an API ID and Api Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticateRestRequest"}}}},"responses":{"200":{"description":"User authenticated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticateRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."}},"summary":"Create Access Token for Login","tags":["Authentication"]}},"/auth/refresh-token":{"post":{"description":"Refresh the user's access token by providing the old access token in the request header. A new access token will be generated upon successful authentication.","operationId":"RefreshTokenAuthRestController_execute","parameters":[{"name":"x-access-token","in":"header","description":"Send expired jwt access token with refresh token inside.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"200":{"description":"User authenticated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshTokenRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."}},"summary":"Refresh Access Token","tags":["Authentication"]}},"/pix/keys":{"get":{"description":"Retrieve a list of the user's pix keys, excluding canceled keys.","operationId":"GetAllPixKeyRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"200":{"description":"The pix keys returned successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetAllPixKeyRestResponse"}}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Pix Keys","tags":["Pix | Keys"]}},"/pix/keys/{id}/code":{"get":{"description":"Tag: api-paas-get-pix-keys-by-id-code
\n Description: Generate a new 5-digit code and send it by email or SMS to the user.\n This route works for keys in the PENDING or CLAIM_PENDING states.","operationId":"SendCodePixKeyRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Code sent successfully."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Send Confirmation Code","tags":["Pix | Keys"]},"post":{"description":"Tag: api-paas-post-pix-keys-verify-code-by-id
\n Description: Confirm the code received by the user for adding or claiming a key. This route works for keys in the PENDING or CLAIM_PENDING states.\n If the key state is:
\n \n Returns the key with a state of CONFIRMED or CLAIM_DENIED.","operationId":"VerifyCodePixKeyRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyCodePixKeyBody"}}}},"responses":{"200":{"description":"The pix key returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyCodePixKeyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"Key not found."}},"security":[{"bearer":[]}],"summary":"Confirm Pending Key Code","tags":["Pix | Keys"]},"delete":{"description":"Tag: api-paas-delete-pix-keys-by-id-code
\n Description: Cancel a process of a pix key. This route is applicable to keys in PENDING or CLAIM_PENDING state. If key state is:
\n \n Returns the key with a state of CANCELED or CLAIM_CLOSING.","operationId":"CancelCodePixKeyRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Key canceled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelCodePixKeyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Pix Key","tags":["Pix | Keys"]}},"/pix/keys/{id}":{"get":{"description":"Retrieve the state and detailed information of a pix key by specifying its ID. Canceled keys are not returned; instead, a 422 error will be sent.","operationId":"GetByIdPixKeyRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The pix key returned successfully. Returns null if key id is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetByIdPixKeyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Pix Key by ID","tags":["Pix | Keys"]}},"/pix/deposits/qr-codes/dynamic/instant-billing":{"post":{"description":"Generate a new instant-billing dynamic QR Code for the user.","operationId":"CreateQrCodeDynamicInstantBillingRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQrCodeDynamicInstantBillingBody"}}}},"responses":{"201":{"description":"The created dynamic QR Code returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQrCodeDynamicInstantBillingRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Instant-Billing Dynamic QR Code","tags":["Pix | Keys | Dynamic QR Code"]}},"/pix/deposits/qr-codes/dynamic/due-date":{"post":{"description":"Generate a new dynamic due date QR Code with a specific due date for the user.","operationId":"CreateQrCodeDynamicDueDateRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQrCodeDynamicDueDateBody"}}}},"responses":{"201":{"description":"The created dynamic due date QR Code returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQrCodeDynamicDueDateRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Dynamic Due Date QR Code","tags":["Pix | Keys | Dynamic QR Code"]}},"/pix/deposits/qr-codes/dynamic/{id}":{"get":{"description":"Retrieve a specific dynamic QR Code associated with the user using its unique identifier.","operationId":"GetQrCodeDynamicByIdRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Dynamic QR Code ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The dynamic QR Code returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQrCodeDynamicByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Dynamic QR Code by ID","tags":["Pix | Keys | Dynamic QR Code"]}},"/pix/deposits/qr-codes/static":{"get":{"description":"Retrieve all static QR Codes associated with the user.","operationId":"GetAllQrCodeStaticRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"The static QR Codes returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllQrCodeStaticRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Static QR Codes","tags":["Pix | Keys | Static QR Code"]},"post":{"description":"Generate a new static QR Code for the user.","operationId":"CreateQrCodeStaticRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQrCodeStaticBody"}}}},"responses":{"201":{"description":"The static QR Code returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQrCodeStaticRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Static QR Code","tags":["Pix | Keys | Static QR Code"]}},"/pix/deposits/qr-codes/static/async":{"post":{"description":"Generate a new static QR Code for the user async, so the user needs to use the GET path to get the result.","operationId":"CreateAsyncQrCodeStaticRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAsyncQrCodeStaticBody"}}}},"responses":{"201":{"description":"The static QR Code returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAsyncQrCodeStaticRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Async Static QR Code","tags":["Pix | Keys | Static QR Code"]}},"/pix/deposits/qr-codes/static/{id}":{"get":{"description":"Retrieve a specific static QR Code associated with the user by its unique identifier.","operationId":"GetByQrCodeStaticIdRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Static QR Code ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Static QR Code found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetByQrCodeStaticIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Static QR Code by ID","tags":["Pix | Keys | Static QR Code"]},"delete":{"description":"Remove a specific static QR Code associated with the user by its unique identifier.","operationId":"DeleteByQrCodeStaticIdRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Static QR Code ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Static QR Code deleted successfully."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the Pix QR Code static ID was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Static QR Code","tags":["Pix | Keys | Static QR Code"]}},"/v2/pix/keys":{"post":{"description":"Tag: api-paas-post-pix-keys
\n Description: Add a new key for the user. Allowed key types:
\n \n Returns the created key with a state of PENDING (for types PHONE or EMAIL) or CONFIRMED (for types CPF or EVP).
\n PS: The mobile app should call GET /pix/keys/id/code to send a code (e-mail or SMS) to the user.","operationId":"V2CreatePixKeyRestController_execute_v2","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CreatePixKeyBody"}}}},"responses":{"201":{"description":"The pix key returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CreatePixKeyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Pix Key","tags":["Pix | Keys"]}},"/pix/keys/{id}/portabilities/start":{"post":{"description":"Tag: api-paas-post-pix-keys-by-id-portabilities-start
\n Description: Initiate a portability claim start process. If key state is:
\n \n Returns the key with a state of PORTABILITY_OPENED.","operationId":"ApprovePortabilityClaimStartProcessRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Portability claim process started successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovePortabilityClaimStartProcessRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Approve Portability Start Process","tags":["Pix | Keys"]},"delete":{"description":"Tag: api-paas-delete-pix-keys-by-id-portabilities-start
\n Description: Cancel the portability start process. The portability process will not be started, and the key will remain with the third-party ISPB.\n If the key state is:
\n \n Returns the key with a state of CANCELED.","operationId":"CancelStartPortabilityProcessByIdPixKeyRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The pix key returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelStartPortabilityProcessByIdPixKeyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Portability Start Process","tags":["Pix | Keys"]}},"/pix/keys/{id}/portabilities/approve":{"post":{"description":"Tag: api-paas-post-pix-keys-by-id-portabilities-approve
\n Description: Initiate the portability claim process for a key by making the key available to third-party ISPB (Institutional Service Payment Bureau). If key state is:
\n \n Returns the key with a state of CANCELED.","operationId":"ApprovePortabilityClaimProcessRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The pix key returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovePortabilityClaimProcessRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Approve Portability Claim Process","tags":["Pix | Keys"]}},"/pix/keys/{id}/claims/start":{"delete":{"description":"Tag: api-paas-delete-pix-keys-by-id-claim-start
\n Description: Cancel the ownership start process. he ownership claim process will not be started, and the key will remain with the third-party ISPB.\n If key state is:
\n \n Returns the key with a state of CANCELED.","operationId":"CancelStartClaimProcessByIdPixKeyRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The pix key returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelStartClaimProcessByIdPixKeyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Ownership Claim Start Process","tags":["Pix | Keys"]},"post":{"description":"Tag: api-paas-post-pix-keys-by-id-claims-start
\n Description: Initiate a ownership claim process for a key. If key state is:
\n \n Returns the key with a state of OWNERSHIP_OPENED.","operationId":"ApproveOwnershipClaimStartProcessRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Ownership claim process started successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveOwnershipClaimStartProcessRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Approve Ownership Claim Start Process","tags":["Pix | Keys"]}},"/pix/keys/{id}/portabilities/cancel":{"delete":{"description":"Tag: api-paas-delete-pix-keys-by-id-portabilities-cancel
\n Description: Cancel a portability process that was initiated by this ZRO user. The portability process will be stopped, and the key will be canceled. If the key state is:
\n \n Returns the key with a state of PORTABILITY_CANCELING.","operationId":"CancelingPortabilityClaimProcessRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The pix key returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelingPortabilityClaimProcessRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Portability Claim Process (ZRO User)","tags":["Pix | Keys"]}},"/pix/keys/{id}/claims/cancel":{"delete":{"description":"Tag: api-paas-delete-pix-keys-by-id-claims-cancel
\n Description: Cancel an ownership claim process that was initiated by this ZRO user. The ownership process will be stopped, and the key will be canceled. If the key state is:
\n \n Returns the key with a state of OWNERSHIP_CANCELING.","operationId":"CancelingOwnershipClaimProcessRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The pix key returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelingOwnershipClaimProcessRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Ownership Claim Process (ZRO User)","tags":["Pix | Keys"]}},"/v2/pix/keys/{id}":{"delete":{"description":"Tag: api-paas-delete-pix-keys-by-id
\n Description: Delete a user's key by ID specified in the path. Sends a delete key request to DICT and changes the key state to DELETING.\n Returns the deleted key with a state of DELETING.","operationId":"V2DeleteByIdPixKeyRestController_execute_v2","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"The pix key returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2DeleteByIdPixKeyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Pix Key","tags":["Pix | Keys"]}},"/v2/pix/keys/{id}/dismiss":{"post":{"description":"Tag: api-paas-post-pix-keys-dismiss-by-id
\n Description: Set a key to not be shown anymore. The key state will change to CLAIM_PENDING, CANCELED or READY. If the key state is:
\n \n Returns the key with a state of CLAIM_PENDING, CANCELED or READY.","operationId":"V2DismissByIdPixKeyRestController_execute_v2","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix Key ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"The pix key returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2DismissByIdPixKeyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the key id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Dismiss Pix Key","tags":["Pix | Keys"]}},"/split-payments/pix/qr-codes/static":{"post":{"description":"Tag: api-paas-post-split-payments-pix-qr-codes-static
\n Description: Generate a new static QR Code with split payment configuration.","operationId":"CreateSplitPixQrCodeStaticRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSplitPixQrCodeStaticBody"}}}},"responses":{"201":{"description":"The split QR Code returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSplitPixQrCodeStaticRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Split PIX QR Code Static","tags":["Split Payments"]}},"/split-payments/pix/history":{"get":{"description":"Tag: api-paas-get-all-split-payments-pix-history
\n Description: Retrieve a list of split payment history records. Use optional filter parameters to refine your search.","operationId":"GetAllSplitPixPaymentHistoryRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"state","required":false,"in":"query","description":"Filter by split payment state.","schema":{"example":"READY","type":"string","enum":["PENDING","PROCESSING","READY","FAILED"]}},{"name":"deposit_end_to_end_id","required":false,"in":"query","description":"Filter by deposit end-to-end ID.","schema":{"example":"E1234567820240101120000000000001","type":"string"}},{"name":"split_end_to_end_id","required":false,"in":"query","description":"Filter by split end-to-end ID.","schema":{"example":"E1234567820240101120000000000002","type":"string"}},{"name":"deposit_id","required":false,"in":"query","description":"Filter by deposit ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"split_operation_id","required":false,"in":"query","description":"Filter by split operation ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"txid","required":false,"in":"query","description":"Filter by transaction ID (txId) from QR Code.","schema":{"example":"txid1234567890abcde","type":"string"}}],"responses":{"200":{"description":"The split payment history returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllSplitPixPaymentHistoryRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Split Payment History","tags":["Split Payments"]}},"/v2/pix/payments/decode":{"get":{"description":"Generate a new Decoded QR Code ID to facilitate pix payments by QR code. Provide the QR Code's information in the request body and execute to obtain its ID (decoded_qr_code_id), which is required for creating pix payments using a QR Code.","operationId":"V2CreateDecodedQrCodeRestController_execute_v2","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"emv","required":true,"in":"query","description":"QR Emv code.","schema":{"type":"string"}},{"name":"paymentDate","required":false,"in":"query","description":"Payment estimated date.","schema":{"format":"date","example":"2026-05-29","type":"string"}}],"responses":{"200":{"description":"QR code decoded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2DecodeQrCodeRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Decoded QR Code","tags":["Pix | Payments"]}},"/v2/pix/payment/decode/by-key":{"get":{"description":"Generate a new Decoded Pix Key ID to facilitate pix payments by pix key. Provide the pix key's information in the request body and execute to obtain its ID (decoded_pix_key_id), which is required for creating pix payments using a pix key.","operationId":"V2CreateDecodedPixKeyRestController_execute_v2","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"key","required":true,"in":"query","description":"Pix key.","schema":{"type":"string"}},{"name":"type","required":true,"in":"query","description":"Pix Key state:
\n ","schema":{"example":"EMAIL","type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"]}}],"responses":{"200":{"description":"Pix key decoded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDecodedPixKeyRestResponse$1"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Decoded Pix Key ID","tags":["Pix | Payments"]}},"/pix/payment/decode/by-account":{"post":{"description":"Generate a new Decoded Pix Account ID to enable pix payments by bank account. Enter the bank account's information in the request body below and execute to obtain its ID (decoded_pix_account_id), which is required for creating pix payments using a bank account.","operationId":"CreateDecodedPixAccountRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDecodedPixAccountBody"}}}},"responses":{"201":{"description":"Decoded account returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDecodedPixAccountRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Decoded Pix Account ID","tags":["Pix | Payments"]}},"/pix/payments/by-operation/{id}":{"delete":{"description":"Cancel a payment by its operation ID. This route works for payments scheduled. If the payment is scheduled:
\n \n Returns the payment with a state of CANCELED.","operationId":"CancelPaymentByOperationIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Payment operation ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Payment canceled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPixScheduledPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the payment id was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Payment by Operation ID","tags":["Pix | Payments"]}},"/pix/payments/by-qr-code/static/withdrawal":{"post":{"description":"Withdraw a payment using a static QR code.","operationId":"WithdrawalByQrCodeStaticPaymentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentByWithdrawalQrCodeStaticBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalByQrCodeStaticPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Withdraw Payment with Static QR Code","tags":["Pix | Payments"]}},"/pix/payments/by-qr-code/dynamic/withdrawal":{"post":{"description":"Withdraw a payment using a dynamic QR code.","operationId":"WithdrawalByQrCodeDynamicPaymentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentByWithdrawalQrCodeDynamicBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalByQrCodeDynamicPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Withdraw Payment with Dynamic QR Code","tags":["Pix | Payments"]}},"/pix/payments/by-qr-code/dynamic/due-date-billing":{"post":{"description":"Create a due date payment using a dynamic QR code.","operationId":"DuedateByQrCodeDynamicPaymentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentByDuedateQrCodeDynamicBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuedateByQrCodeDynamicPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Due Date Payment with Dynamic QR Code","tags":["Pix | Payments"]}},"/pix/payments/by-qr-code/dynamic/change":{"post":{"description":"Initiate a change a payment using a dynamic QR code.","operationId":"ChangeByQrCodeDynamicPaymentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentByChangeQrCodeDynamicBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeByQrCodeDynamicPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Change Payment with Dynamic QR Code","tags":["Pix | Payments"]}},"/pix/payments/by-qr-code/dynamic/instant-billing":{"post":{"description":"Initiate a payment using a dynamic QR code.","operationId":"CreateByQrCodeDynamicPaymentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentByQrCodeDynamicBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateByQrCodeDynamicPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Payment with Dynamic QR Code","tags":["Pix | Payments"]}},"/pix/payments/by-qr-code/static/instant-billing":{"post":{"description":"Initiate a payment using a static QR code.","operationId":"CreateByQrCodeStaticPaymentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentByQrCodeStaticBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateByQrCodeStaticPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Payment with Static QR Code","tags":["Pix | Payments"]}},"/v3/pix/payments/by-account/instant-billing":{"post":{"description":"Initiate a new pix payment using a bank account. Provide the required information and submit.","operationId":"V3CreateByAccountPaymentRestController_execute_v3","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3PaymentByAccountBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3CreateByAccountPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Pix Payment by Bank Account","tags":["Pix | Payments"]}},"/pix/payments/by-key/instant-billing":{"post":{"description":"Initiate a new pix payment using a pix key. First, create a Decoded Pix Key ID at the endpoint /pix/payment/decode/by-key. Then, use the decoded_pix_key_id to enter the pix payment's information in the request body and execute.","operationId":"CreateByPixKeyPaymentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentByPixKeyBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateByPixKeyPaymentRestResponse$1"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Pix Payment by Pix Key","tags":["Pix | Payments"]}},"/pix/payments/by-key/decode-instant-billing":{"post":{"description":"Initiate a new pix payment using a pix key. Enter the decode and pix payment's information in the request body and execute.","operationId":"DecodeAndCreateByPixKeyPaymentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecodeAndCreatePaymentByPixKeyBody"}}}},"responses":{"201":{"description":"Decoded Pix Key and Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecodeAndCreateByPixKeyPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Decode and Create Pix Payment by Pix Key","tags":["Pix | Payments"]}},"/pix/devolutions":{"post":{"description":"Initiate a new pix devolution by providing the required information in the request body and executing the request.","operationId":"CreatePixDevolutionRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixDevolutionBody"}}}},"responses":{"201":{"description":"The devolution returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixDevolutionRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Pix Devolution","tags":["Pix | Devolutions"]}},"/v4/pix/payments":{"get":{"description":"Retrieve a list of the user's pix payments. Use optional filter parameters to refine your search.","operationId":"V4GetAllPaymentRestController_execute_v4","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"states","required":false,"in":"query","description":"Payment State.","schema":{"example":["PENDING","CONFIRMED"],"type":"array","items":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"]}}},{"name":"payment_date_period_start","required":false,"in":"query","description":"Transaction period date start for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"payment_date_period_end","required":false,"in":"query","description":"Transaction period date end for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_period_start","required":false,"in":"query","description":"Created at period date start for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_period_end","required":false,"in":"query","description":"Created at period date end for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"end_to_end_id","required":false,"in":"query","description":"Payment end to end id","schema":{"type":"string"}}],"responses":{"200":{"description":"The payments returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V4GetAllPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Pix Payments","tags":["Pix | Payments"]}},"/v5/pix/deposits":{"get":{"description":"Get a list of user's pix deposits. You can include any of the filter parameters below to refine your search.","operationId":"V5GetAllPixDepositRestController_execute_v5","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"created_at_period_start","required":false,"in":"query","description":"Created at period date start for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_period_end","required":false,"in":"query","description":"Created at period date end for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"end_to_end_id","required":false,"in":"query","description":"PixDeposit end to end id","schema":{"type":"string"}},{"name":"txid","required":false,"in":"query","description":"PixDeposit tx identifier","schema":{"type":"string"}},{"name":"states","required":false,"in":"query","description":"PixDeposit State.","schema":{"example":["ERROR","RECEIVED"],"type":"array","items":{"type":"string","enum":["NEW","RECEIVED","WAITING","WAITING_ANTIFRAUD","ERROR","BLOCKED"]}}}],"responses":{"200":{"description":"The deposits returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V5GetAllPixDepositRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Pix Deposits","tags":["Pix | Deposits"]}},"/v6/pix/deposits":{"get":{"description":"Get a list of user's pix deposits. You can include any of the filter parameters below to refine your search.","operationId":"V6GetAllPixDepositRestController_execute_v6","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"created_at_period_start","required":false,"in":"query","description":"Created at period date start for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_period_end","required":false,"in":"query","description":"Created at period date end for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"end_to_end_id","required":false,"in":"query","description":"PixDeposit end to end id","schema":{"type":"string"}},{"name":"txid","required":false,"in":"query","description":"PixDeposit tx identifier","schema":{"type":"string"}},{"name":"states","required":false,"in":"query","description":"PixDeposit State.","schema":{"example":["ERROR","RECEIVED"],"type":"array","items":{"type":"string","enum":["NEW","RECEIVED","WAITING","WAITING_ANTIFRAUD","ERROR","BLOCKED"]}}}],"responses":{"200":{"description":"The deposits returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V6GetAllPixDepositRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Pix Deposits","tags":["Pix | Deposits"]}},"/v3/pix/devolutions":{"get":{"description":"Retrieve a list of pix devolutions for the user. Use optional filter parameters to refine your search.","operationId":"V3GetAllPixDevolutionRestController_execute_v3","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"created_at_period_start","required":false,"in":"query","description":"Created at period date start for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_period_end","required":false,"in":"query","description":"Created at period date end for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"end_to_end_id","required":false,"in":"query","description":"PixDevolution end to end id","schema":{"type":"string"}},{"name":"states","required":false,"in":"query","description":"PixDevolution State.","schema":{"example":["ERROR","CONFIRMED"],"type":"array","items":{"type":"string","enum":["PENDING","WAITING","WAITING_DELAYED","CONFIRMED","ERROR","FAILED","CANCELED"]}}}],"responses":{"200":{"description":"The devolutions returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GetAllPixDevolutionRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Pix Devolutions","tags":["Pix | Devolutions"]}},"/v3/pix/devolutions-received":{"get":{"description":"Retrieve a list of pix devolutions received by the user. Use optional filter parameters to refine your search.","operationId":"V3GetAllPixDevolutionReceivedRestController_execute_v3","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"created_at_period_start","required":false,"in":"query","description":"Created at period date start for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_period_end","required":false,"in":"query","description":"Created at period date end for any transaction.","schema":{"format":"date-time","type":"string"}},{"name":"end_to_end_id","required":false,"in":"query","description":"PixDevolutionReceived end to end id","schema":{"type":"string"}},{"name":"states","required":false,"in":"query","description":"PixDevolutionReceived State.","schema":{"example":["ERROR","READY"],"type":"array","items":{"type":"string","enum":["READY","ERROR"]}}}],"responses":{"200":{"description":"The devolutions received returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GetAllPixDevolutionReceivedRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Received Pix Devolutions","tags":["Pix | Devolutions"]}},"/v5/pix/payments/{id}":{"get":{"description":"Retrieve the state and details of a pix payment by providing its ID.","operationId":"V5GetPaymentByIdRestController_execute_v5","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Payment UUID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Payment received.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V5GetPaymentByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Pix Payment by ID","tags":["Pix | Payments"]}},"/v4/pix/devolutions/{id}":{"get":{"description":"Retrieve the state and details of a pix devolution by providing its ID. Uses wallet ID only.","operationId":"V4GetByPixDevolutionIdRestController_execute_v4","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Devolution ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The PIX devolution returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V4GetByPixDevolutionIdRestResponse"}}}},"400":{"description":"Invalid or missing parameters."},"401":{"description":"Wallet authentication failed."},"422":{"description":"Unable to process the provided parameters."}},"security":[{"bearer":[]}],"summary":"Get Pix Devolution by ID (V4)","tags":["Pix | Devolutions"]}},"/v3/pix/deposits/{id}":{"get":{"description":"Enter the pix deposit's ID below and execute to get its state and all information.","operationId":"V3GetPixDepositByIdRestController_execute_v3","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Deposit UUID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Deposit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GetPixDepositByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Pix Deposit by ID","tags":["Pix | Deposits"]}},"/v4/pix/deposits/{id}":{"get":{"description":"Enter the pix deposit's ID below and execute to get its state and all information.","operationId":"V4GetPixDepositByIdRestController_execute_v4","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Deposit UUID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Deposit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V4GetPixDepositByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Pix Deposit by ID","tags":["Pix | Deposits"]}},"/v2/pix/devolutions-received/{id}":{"get":{"description":"Retrieve the state and details of a received pix devolution by providing its ID.","operationId":"V2GetByIdPixDevolutionReceivedRestController_execute_v2","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Devolution Received ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The PIX devolution received returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetByPixDevolutionReceivedIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Received Pix Devolution by ID","tags":["Pix | Devolutions"]}},"/pix/trusted-contacts":{"post":{"description":"Create a new pix trusted contact. This endpoint is used to create a new pix trusted contact for the user.","operationId":"CreatePixTrustedContactRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixTrustedContactBody"}}}},"responses":{"201":{"description":"Pix trusted contact created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixTrustedContactRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Pix Trusted Contact","tags":["Pix | Payments"]},"get":{"description":"Retrieve a list of pix trusted contact for the user.","operationId":"GetAllPixTrustedContactByWalletRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"document","required":false,"in":"query","description":"Pix Trusted Contact document.","schema":{"example":"12345678900","type":"string"}}],"responses":{"200":{"description":"The trusted contact returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPixTrustedContactByWalletRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Pix Trusted Contact","tags":["Pix | Payments"]}},"/pix/trusted-contacts/{identifier}":{"get":{"description":"Retrieve a pix trusted contact by id for the user.","operationId":"GetPixTrustedContactByIdAndWalletRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"identifier","required":true,"in":"path","description":"Pix Trusted Contact identifier. For this operation, send the contact ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"The trusted contact returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPixTrustedContactByIdAndWalletRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Pix Trusted Contact by ID","tags":["Pix | Payments"]},"delete":{"description":"Description: Delete an pix trusted contact by its document.","operationId":"DeletePixTrustedContactRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"identifier","required":true,"in":"path","description":"Pix Trusted Contact identifier. For this operation, send the contact document.","schema":{"example":"12345678900","type":"string"}}],"responses":{"200":{"description":"Pix trusted contact deleted successfully."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete pix trusted contact","tags":["Pix | Payments"]}},"/pix/warning/deposits":{"get":{"description":"Tag: api-paas-get-pix-warning-deposits
\n Description: Retrieve a list of warning pix deposits for the authenticated user. Use optional filter parameters to refine your search.","operationId":"GetAllWarningPixDepositRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at","updated_at","state"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"transaction_tag","required":false,"in":"query","description":"Transaction tag.","schema":{"type":"string"}},{"name":"states","required":false,"in":"query","description":"Warning Pix Deposit states.","schema":{"example":["CREATED"],"type":"array","items":{"type":"string","enum":["CREATED","APPROVED","REJECTED","APPROVED_BY_USER"]}}},{"name":"created_at_period_start","required":false,"in":"query","description":"Created at start date period for warning transactions.","schema":{"format":"date","type":"string"}},{"name":"created_at_period_end","required":false,"in":"query","description":"Created at end date period for warning transactions.","schema":{"format":"date","type":"string"}}],"responses":{"200":{"description":"The warning pix deposits returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllWarningPixDepositRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Warning Pix Deposits","tags":["Pix | Deposits"]}},"/v2/otc/conversions":{"post":{"description":"To initiate a new currency conversion, first create a Quotation ID using the endpoint /v2/quotations/spot. Then, provide the Quotation ID in the request body below and execute the operation.","operationId":"V2CreateConversionRestController_execute_v2","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CreateConversionBody"}}}},"responses":{"201":{"description":"Conversion created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CreateConversionRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Conversion","tags":["Otc | Conversions"]}},"/v3/otc/conversions":{"get":{"description":"Retrieve a list of currency conversions associated with the specified user. Optional filter parameters can be used to refine your search.","operationId":"V3GetAllConversionRestController_execute_v3","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"operation_id","required":false,"in":"query","description":"Operation ID for conversion.","schema":{"type":"string"}},{"name":"currency_symbol","required":false,"in":"query","description":"Currency Symbol for conversion.","schema":{"type":"string"}},{"name":"quotation_id","required":false,"in":"query","description":"Quotation ID for conversion.","schema":{"type":"string"}},{"name":"conversion_type","required":false,"in":"query","description":"Conversion type.","schema":{"type":"string","enum":["buy","sell"]}},{"name":"created_at_start","required":false,"in":"query","description":"Created at start for any conversion.","schema":{"format":"date","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Created at end for any conversion.","schema":{"format":"date","type":"string"}}],"responses":{"200":{"description":"The conversions returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GetAllConversionRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Conversions","tags":["Otc | Conversions"]}},"/v2/otc/conversions/credit-balance":{"get":{"description":"Retrieve the user's liability (the sum of all negative balances in BRL across active currencies) and credit balance.","operationId":"V2GetConversionCreditByUserRestController_execute_v2","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"200":{"description":"Conversion credit success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetConversionCreditByUserRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Credit Balance and Liability","tags":["Otc | Conversions"]}},"/otc/conversions/{id}/quotations":{"get":{"description":"Retrieve the quotation related to a conversion by specifying its ID.","operationId":"GetQuotationByConversionIdRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Conversion UUID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Quotation returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQuotationByConversionIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Quotation by Conversion ID","tags":["Otc | Conversions"]}},"/otc/conversions/{id}":{"get":{"description":"Retrieve detailed information about a currency conversion by specifying its ID.","operationId":"GetConversionByIdRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Conversion UUID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Conversion returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConversionByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Conversion by ID","tags":["Otc | Conversions"]}},"/v2/quotations/spot":{"get":{"description":"Initiate a new SPOT quotation to enable currency conversions. After creating the quotation, retrieve its ID (quotation_id) to use for currency conversion requests.","operationId":"V2GetQuotationRestController_execute_v2","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"base_currency","required":true,"in":"query","description":"Quotation currency.","schema":{"example":"BTC","type":"string"}},{"name":"amount_currency","required":true,"in":"query","description":"Quotation currency quote.","schema":{"example":"BRL","type":"string"}},{"name":"amount","required":true,"in":"query","description":"Quotation amount in cents.","schema":{"example":1,"type":"number"}},{"name":"side","required":true,"in":"query","description":"Quotation side.","schema":{"example":"buy","type":"string","enum":["buy","sell"]}}],"responses":{"200":{"description":"Quotation returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetQuotationRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create SPOT Quotation","tags":["Quotations | Conversions"]}},"/operations/wallets":{"get":{"description":"Retrieve a list of the user's wallets. You can include any of the filter parameters below to refine your search.","operationId":"GetAllWalletRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"owner","required":false,"in":"query","description":"User wallet owner type.","schema":{"type":"string","enum":["USER","OTHER","ADMIN"]}}],"responses":{"200":{"description":"The wallets returned successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetAllWalletByUserRestResponse"}}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Wallets","tags":["Operations | Wallets"]},"post":{"description":"Initiate the creation of a new wallet with an optional name.","operationId":"CreateWalletRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWalletParams"}}}},"responses":{"201":{"description":"The wallet created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWalletRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Wallet","tags":["Operations | Wallets"]}},"/operations/wallets/{id}":{"get":{"description":"Retrieve detailed information about a wallet by specifying its ID.","operationId":"GetWalletByIdRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Wallet id.","schema":{"type":"string"}}],"responses":{"200":{"description":"The wallet returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWalletByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Wallet by ID","tags":["Operations | Wallets"]},"put":{"description":"Update the name of a wallet with a new one.","operationId":"UpdateWalletRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Wallet id.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWalletBody"}}}},"responses":{"200":{"description":"The wallet updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWalletRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update Wallet Name","tags":["Operations | Wallets"]},"delete":{"description":"Delete a wallet from the system.","operationId":"DeleteWalletRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Wallet id.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteWalletByIdBody"}}}},"responses":{"200":{"description":"The wallet deleted successfully."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Wallet","tags":["Operations | Wallets"]}},"/operations/p2p-transfers":{"post":{"description":"Initiate a peer-to-peer (P2P) fund transfer within your organization, allowing transfers between Master Account and Sub-account wallets. Specify the UUID of the wallet you are transferring funds from in the \"x-wallet-uuid\" header. If the \"x-wallet-uuid\" param is omitted, your default wallet will be used. Provide the destination wallet and transaction details in the request body and execute to complete the transaction.","operationId":"CreateP2PTransferRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateP2PTransferBody"}}}},"responses":{"201":{"description":"Transfer response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateP2PTransferRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create P2P Transfer","tags":["Operations | P2P Transfers"]}},"/operations/wallet-accounts":{"get":{"description":"Retrieve a list of wallet accounts belonging to a user. Optional filter parameters can be used to refine your search.","operationId":"GetAllWalletAccountRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["currencySymbol"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"currency_symbol","required":false,"in":"query","description":"WalletAccount currency symbol.","schema":{"type":"string"}}],"responses":{"200":{"description":"The wallet accounts returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllWalletAccountRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Wallet Accounts","tags":["Operations | Wallet Accounts"]}},"/operations/wallet-accounts/{id}":{"get":{"description":"Retrieve detailed information about a user's wallet account by specifying its ID.","operationId":"GetWalletAccountByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Wallet account id.","schema":{"type":"string"}}],"responses":{"200":{"description":"The wallet account returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWalletAccountByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Wallet Account by ID","tags":["Operations | Wallet Accounts"]}},"/operations/currencies":{"get":{"description":"Retrieve a list of all available and tradable currencies. Optional filter parameters can be used to refine your search.","operationId":"GetAllCurrencyRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["id"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"symbol","required":false,"in":"query","description":"Currency Symbol.","schema":{"type":"string"}}],"responses":{"200":{"description":"The currencies returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllCurrencyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Currencies","tags":["Operations | Currency"]}},"/operations":{"get":{"description":"Retrieve a list of the user's operations.","operationId":"GetAllOperationsRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 1000.","schema":{"maximum":1000,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"currency_symbol","required":false,"in":"query","description":"Operation currency symbol.","schema":{"type":"string"}},{"name":"transaction_tag","required":false,"in":"query","description":"Operation Transaction tag.","schema":{"type":"string"}},{"name":"created_at_start","required":false,"in":"query","description":"Operation Created at start.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Operation Created at end.","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"description":"The operations returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllOperationsRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Operations","tags":["Operations | Operation"]}},"/operations/{id}":{"get":{"description":"Retrieve a specific user's operation by its unique identifier.","operationId":"GetOperationByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Operation Uuid.","schema":{"type":"string"}}],"responses":{"200":{"description":"The operation returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOperationByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Operation by ID","tags":["Operations | Operation"]}},"/operations/{id}/receipt":{"get":{"description":"Retrieve a receipt by specifying its operation ID.","operationId":"GetOperationReceiptByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Operation id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Receipt found by operation id successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOperationReceiptByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Receipt by Operation ID","tags":["Operations | Operation"]}},"/operations/p2p-transfers/{id}":{"get":{"description":"Retrieve information about a specific P2P transfer by entering its ID and executing the request.","operationId":"GetP2PTransferByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Transfer UUID.","schema":{"type":"string"}}],"responses":{"200":{"description":"P2PTransfer received.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetP2PTransferByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get P2P Transfer by ID","tags":["Operations | P2P Transfers"]}},"/limits/wallets":{"patch":{"description":"Tag: api-paas-patch-operations-wallet-limits-by-wallet-id
\n Description: Update a specific wallet limit.","operationId":"UpdateWalletLimitRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWalletLimitRestBodyRequest"}}}},"responses":{"200":{"description":"The wallet limit updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWalletLimitRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update Wallet Limit","tags":["Operations | Wallet limits"]}},"/operations/{id}/receipt/generate":{"post":{"description":"Request receipt PDF generation by operation ID.","operationId":"GenerateOperationReceiptPdfByUserAndWalletAndIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Operation id.","schema":{"type":"string"}}],"responses":{"201":{"description":"Operation Receipt requested successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateOperationReceiptPdfByUserAndWalletAndIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Request Receipt PDF Generation by Operation ID","tags":["Operations | Operation"]}},"/operations/balance/pending":{"get":{"description":"Returns the sum of all debit operations in PENDING state for a specific wallet account.","operationId":"GetPendingSumByWalletAccountRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"200":{"description":"The pending balance sum was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPendingSumByWalletAccountRestResponse"}}}},"400":{"description":"Invalid request or parameters."},"401":{"description":"User authentication failed."},"422":{"description":"Validation error on one or more fields."}},"security":[{"bearer":[]}],"summary":"Get Pending Balance","tags":["Operations | Operation"]}},"/v2/banking/ted/received":{"get":{"description":"Tag: api-paas-get-banking-ted-received
\n Description: Retrieve a list of the user's TED (Transferência Eletrônica Disponível) received operations. Use optional filter parameters to refine your search.","operationId":"V2GetAllBankingTedReceivedRestController_execute_v2","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page Sort Attribute.","schema":{"type":"string","enum":["id","created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"owner_document","required":false,"in":"query","description":"Banking TED Received Owner Document.","schema":{"type":"string"}},{"name":"created_at_start","required":false,"in":"query","description":"Created at start for any Banking TED Received.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Created at end for any Banking TED Received.","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"description":"Banking TED Received.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetAllBankingTedReceivedRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List TED Received Operations","tags":["Banking"]}},"/v2/banking/ted/received/{id}":{"get":{"description":"Tag: api-paas-get-banking-ted-received-by-id
\n Description: Retrieve details of a TED (Transferência Eletrônica Disponível) Received by its unique identifier.","operationId":"V2GetBankingTedReceivedByIdRestController_execute_v2","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Banking TED Received ID.","schema":{"example":4598,"type":"number"}}],"responses":{"200":{"description":"Banking TED Received.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetBankingTedReceivedByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Banking TED Received by ID","tags":["Banking"]}},"/v2/banking/ted/received/by-operation/{operationId}":{"get":{"description":"Tag: api-paas-get-banking-ted-received-by-operation-id
\n Description: Retrieve details of a TED (Transferência Eletrônica Disponível) operation by its operation identifier.","operationId":"V2GetBankingTedReceivedByOperationIdRestController_execute_v2","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"operationId","required":true,"in":"path","description":"Banking TED Received Operation ID.","schema":{"example":"1b43322e-d6d5-4895-ac3f-a440cc63816a","type":"string"}}],"responses":{"200":{"description":"Banking TED Received.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetBankingTedReceivedByOperationIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get TED Received Operation by ID","tags":["Banking"]}},"/banking/ted/banks":{"get":{"description":"Retrieve a list of banks that support TED (Transferência Eletrônica Disponível) operations. Use optional filter parameters to refine your search.","operationId":"GetAllBankTedRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["id","code","ispb","name","active","created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"search","required":false,"in":"query","description":"Search filter. This filter is used to search for bank ted name and ispb.","schema":{"minLength":1,"maxLength":50,"type":"string"}}],"responses":{"200":{"description":"The banks returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllBankTedRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Banks Supporting TED Operations","tags":["Banking"]}},"/banking/ted":{"get":{"description":"Retrieve a list of the user's TED (Transferência Eletrônica Disponível) operations. Use optional filter parameters to refine your search.","operationId":"GetAllBankingTedRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["id","created_at","confirmed_at","failed_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"operation_id","required":false,"in":"query","description":"BankingTed operation created.","schema":{"type":"string"}},{"name":"state","required":false,"in":"query","description":"BankingTed state.","schema":{"type":"string","enum":["ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW","PENDING","WAITING","FAILED","FORWARDED","CONFIRMED"]}},{"name":"beneficiary_document","required":false,"in":"query","description":"BankingTed beneficiary document.","schema":{"type":"string"}},{"name":"created_at_start","required":false,"in":"query","description":"Created at start for any bankingTed.","schema":{"format":"date","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Created at end for any bankingTed.","schema":{"format":"date","type":"string"}},{"name":"confirmed_at_start","required":false,"in":"query","description":"Confirmed at start for any bankingTed.","schema":{"format":"date","type":"string"}},{"name":"confirmed_at_end","required":false,"in":"query","description":"Confirmed at end for any bankingTed.","schema":{"format":"date","type":"string"}},{"name":"failed_at_start","required":false,"in":"query","description":"Failed at start for any bankingTed.","schema":{"format":"date","type":"string"}},{"name":"failed_at_end","required":false,"in":"query","description":"Failed at end for any bankingTed.","schema":{"format":"date","type":"string"}}],"responses":{"200":{"description":"BankingTed received.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllBankingTedRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List TED Operations","tags":["Banking"]},"post":{"description":"Create a new TED (Transferência Eletrônica Disponível) operation by providing the required information in the request body and executing the operation.","operationId":"CreateBankingTedRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingTedBody"}}}},"responses":{"201":{"description":"BankingTeds created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingTedRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create TED Operation","tags":["Banking"]}},"/banking/ted/{id}":{"get":{"description":"Retrieve details of a TED (Transferência Eletrônica Disponível) operation by its unique identifier.","operationId":"GetBankingTedByIdRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"BankingTed ID.","schema":{"example":4598,"type":"number"}}],"responses":{"200":{"description":"BankingTed received.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankingTedByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get TED Operation by ID","tags":["Banking"]}},"/banking/banks":{"get":{"description":"Tag: api-paas-get-banking-banks
\n Description: Retrieve a list of banks. Use optional filter parameters to refine your search.","operationId":"GetAllBankRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["id","ispb","name","active","created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"search","required":false,"in":"query","description":"Search filter. This filter is used to search for bank name and ispb.","schema":{"minLength":1,"maxLength":50,"example":"My bank name","type":"string"}}],"responses":{"200":{"description":"The banks returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllBankRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Banks","tags":["Banking"]}},"/banking/billet-pix-deposits":{"post":{"description":"Tag: api-paas-post-banking-billet-pix-deposit
\n Description: Create a new bank billet for deposit by providing the required information in the request body and executing the operation.","operationId":"CreateBankingBilletPixDepositRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingBilletPixDepositBody"}}}},"responses":{"201":{"description":"Banking billet for deposit created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingBilletPixDepositRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Bank Billet for Deposit","tags":["Banking | Bank Billet | Pix Deposits"]},"get":{"description":"Tag: api-paas-get-banking-billet-pix-deposit
\n Description: Retrieve a list of bank billet deposits. Use optional filter parameters to refine your search.","operationId":"GetAllBankingBilletPixDepositRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"state","required":false,"in":"query","description":"State.","schema":{"type":"string","enum":["CREATED_PENDING","CREATED_WAITING","CREATED_CONFIRMED","CREATED_FAILED","RECEIVED"]}},{"name":"created_at_period_start","required":false,"in":"query","description":"Start date of the created at period in the format YYYY-MM-DD.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_period_end","required":false,"in":"query","description":"End date of the created at period in the format YYYY-MM-DD.","schema":{"format":"date-time","type":"string"}},{"name":"is_from_batch","required":false,"in":"query","description":"Whether the deposit is from a batch or not.","schema":{"example":true,"type":"boolean"}},{"name":"banking_billet_pix_deposit_batch_id","required":false,"in":"query","description":"Banking billet pix deposit batch ID.","schema":{"example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb","type":"string"}},{"name":"batch_name","required":false,"in":"query","description":"Banking billet pix deposit batch name.","schema":{"example":"Batch January 2025","type":"string"}}],"responses":{"200":{"description":"The deposits returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllBankingBilletPixDepositRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Bank Billet Deposits","tags":["Banking | Bank Billet | Pix Deposits"]}},"/banking/billet-pix-deposit/templates":{"post":{"description":"Tag: api-paas-post-banking-billet-pix-deposit-template
\n Description: Create a banking billet pix deposit template with logo and optional merchandise.","operationId":"CreateBankingBilletPixDepositTemplateRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingBilletPixDepositTemplateBody"}}}},"responses":{"201":{"description":"Banking billet pix deposit template created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingBilletPixDepositTemplateRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Banking Billet Pix Deposit Template","tags":["Banking | Bank Billet | Pix Deposit Template"]},"get":{"description":"Tag: api-paas-get-banking-billet-pix-deposit-template-by-wallet
\n Description: Get a banking billet pix deposit template by wallet.","operationId":"GetBankingBilletPixDepositTemplateByWalletRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"200":{"description":"Bank billet pix deposit template found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankingBilletPixDepositTemplateByWalletRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Banking Billet Pix Deposit Template By Wallet","tags":["Banking | Bank Billet | Pix Deposit Template"]}},"/banking/billet-pix-deposit/templates/upload":{"post":{"description":"Tag: api-paas-post-banking-billet-pix-deposit-template-upload-file
Description: Upload an image (logo or merchandise) to be used by the Pix deposit template via bank billet.","operationId":"UploadBankingBilletPixTemplateFileRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Allowed file formats: image/jpeg, image/jpg, image/png.","enum":["image/jpeg","image/jpg","image/png"]}}}}}},"responses":{"200":{"description":"File uploaded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadBankingBilletPixTemplateFileRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload image for Banking Billet Pix Deposit Template","tags":["Banking | Bank Billet | Pix Deposit Template"]}},"/banking/billet-pix-deposits/{id}":{"get":{"description":"Tag: api-paas-get-banking-billet-pix-deposit-by-id
\n Description: Get a bank billet pix deposit by ID.","operationId":"GetBankingBilletPixDepositByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Bank billet pix deposit ID.","schema":{"example":"123e4567-e89b-12d3-a456-426614174000","type":"string"}}],"responses":{"200":{"description":"Bank billet pix deposit found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankingBilletPixDepositByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the deposit ID was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Bank Billet Pix Deposit By ID","tags":["Banking | Bank Billet | Pix Deposits"]}},"/banking/billet-pix-deposits/pdf/{id}":{"get":{"description":"Tag: api-paas-get-banking-billet-pix-deposit-pdf
\n Description: Generates or updates the Banking Billet Pix Deposit PDF for the current wallet. Provide the deposit ID in the path and optionally set the personalize query to apply the wallet template. The response returns file metadata. Use storage/files/id/download to download the PDF.","operationId":"GetBankingBilletPixDepositPdfRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Bank billet pix deposit ID.","schema":{"example":"123e4567-e89b-12d3-a456-426614174000","type":"string"}},{"name":"personalize","required":false,"in":"query","description":"When true, tries to apply the wallet personalized template (default: false).","schema":{"example":true,"type":"boolean"}}],"responses":{"200":{"description":"Banking Billet Pix Deposit PDF generated or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankingBilletPixDepositPdfRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Generate or update the Banking Billet Pix Deposit PDF","tags":["Banking | Bank Billet | Pix Deposits"]}},"/banking/billet-payments/{id}":{"get":{"description":"Tag: api-paas-get-banking-billet-payment-by-id
\n Description: Get detailed information about a banking billet payment by its ID, including decoded billet data when available.","operationId":"GetBankingBilletPaymentByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Banking billet payment ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Banking billet payment found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankingBilletPaymentByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"Banking billet payment not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Banking Billet Payment by ID","tags":["Banking | Bank Billet | Payments"]}},"/banking/billet-pix-deposit-batches":{"post":{"description":"Tag: api-paas-post-banking-billet-pix-deposit-batch
\n Description: Create a new bank billet pix deposit batch by uploading a CSV file with the required information. The CSV must contain the following columns: payer_name, payer_document, description, amount, due_date. Optional columns: payer_email, interest_perc_value, fine_value, discount_value, fine_type, discount_type.","operationId":"CreateBankingBilletPixDepositBatchRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingBilletPixDepositBatchBody"}}}},"responses":{"201":{"description":"Banking billet pix deposit batch created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingBilletPixDepositBatchRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Bank Billet Pix Deposit Batch","tags":["Banking | Bank Billet | Pix Deposit Batch"]},"get":{"description":"Tag: api-paas-get-all-banking-billet-pix-deposit-batch
\n Description: Retrieve a list of bank billet deposit batches. Use optional filter parameters to refine your search.","operationId":"GetAllBankingBilletPixDepositBatchRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"status","required":false,"in":"query","description":"Status.","schema":{"type":"string","enum":["UNDER_ANALYSIS","VALIDATED","REJECTED","GENERATED","FAILED"]}},{"name":"batch_name","required":false,"in":"query","description":"Batch name.","schema":{"type":"string"}},{"name":"created_at_period_start","required":false,"in":"query","description":"Start date of the created at period in the format YYYY-MM-DD.","schema":{"format":"date","type":"string"}},{"name":"created_at_period_end","required":false,"in":"query","description":"End date of the created at period in the format YYYY-MM-DD.","schema":{"format":"date","type":"string"}}],"responses":{"200":{"description":"The billet batches returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllBankingBilletPixDepositBatchRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Bank Billet Deposit Batches","tags":["Banking | Bank Billet | Pix Deposit Batch"]}},"/banking/billet-pix-deposit-batches/{id}":{"delete":{"description":"Tag: api-paas-delete-banking-billet-pix-deposit-batch
\n Description: This action is only allowed when the banking billet pix deposit batch is REJECTED.","operationId":"DeleteBankingBilletPixDepositBatchRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Banking billet pix deposit batch ID.","schema":{"example":"5dbbb951-e19d-44a6-93f9-4b14f0495dfb","type":"string"}}],"responses":{"200":{"description":"Batch successfully deleted."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete a Bank Billet Pix Deposit Batch","tags":["Banking | Bank Billet | Pix Deposit Batch"]},"get":{"description":"Tag: api-paas-get-banking-billet-pix-deposit-batch-by-id
\n Description: Get a bank billet pix deposit batch by ID.","operationId":"GetBankingBilletPixDepositBatchByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Bank billet pix deposit batch ID.","schema":{"example":"123e4567-e89b-12d3-a456-426614174000","type":"string"}}],"responses":{"200":{"description":"Bank billet pix deposit batch found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankingBilletPixDepositBatchByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Bank Billet Pix Deposit Batch By ID","tags":["Banking | Bank Billet | Pix Deposit Batch"]},"put":{"description":"Tag: api-paas-update-banking-billet-pix-deposit-batch
\n Description: This action is only allowed on the same day the banking billet pix deposit batch is created.","operationId":"UpdateBankingBilletPixDepositBatchRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Banking billet pix deposit batch ID.","schema":{"example":"5dbbb951-e19d-44a6-93f9-4b14f0495dfb","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBankingBilletPixDepositBatchBodyParam"}}}},"responses":{"200":{"description":"Batch successfully updated."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update a Bank Billet Pix Deposit Batch","tags":["Banking | Bank Billet | Pix Deposit Batch"]}},"/banking/billet-pix-deposit-batches/{id}/update-file":{"post":{"description":"Tag: api-paas-banking-billet-pix-deposit-batch-update-csv-file
\n Description: Update the CSV file for a rejected banking billet pix deposit batch. The batch must have status REJECTED. This will delete the old CSV file, clear validation errors, and set the batch back to UNDER_ANALYSIS status. The CSV must contain the following columns: payer_name, payer_document, description, amount, due_date. Optional columns: payer_email, interest_perc_value, fine_value, fine_type, discount_value, discount_type.","operationId":"UpdateCsvFileBankingBilletPixDepositBatchRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Bank billet deposit batch ID.","schema":{"example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCsvFileBankingBilletPixDepositBatchBody"}}}},"responses":{"200":{"description":"Banking billet pix deposit batch CSV file updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCsvFileBankingBilletPixDepositBatchRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"Batch does not belong to user or status is not REJECTED."},"404":{"description":"Batch not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update CSV File for Bank Billet Pix Deposit Batch","tags":["Banking | Bank Billet | Pix Deposit Batch"]}},"/banking/billet-pix-deposits/send-by-email":{"post":{"description":"Tag: api-paas-send-by-email-banking-billet-pix-deposit
\n Description: Update the payer's email address and send the bank billet pix deposit by email with PDF attached.","operationId":"SendByEmailBankingBilletPixDepositRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendByEmailBankingBilletPixDepositBody"}}}},"responses":{"200":{"description":"Banking billet pix deposit email updated and sent successfully."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Send Bank Billet for Deposit by Email","tags":["Banking | Bank Billet | Pix Deposits"]}},"/banking/billet-pix-deposit-batch-items":{"post":{"description":"Tag: api-paas-post-banking-billet-pix-deposit-batch-item
\n Description: Create a new bank billet deposit batch item.","operationId":"CreateBankingBilletPixDepositBatchItemRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingBilletPixDepositBatchItemBody"}}}},"responses":{"201":{"description":"Banking billet deposit batch item created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankingBilletPixDepositBatchItemRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Bank Billet Deposit Batch Item","tags":["Banking | Bank Billet | Pix Deposit Batch Item"]},"get":{"description":"Tag: api-paas-get-all-banking-billet-pix-deposit-batch-item-by-batch-id
\n Description: Retrieve a list of bank billet deposit batch items by batch ID. Use optional filter parameters to refine your search.","operationId":"GetAllBankingBilletPixDepositBatchItemByBatchIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"banking_billet_pix_deposit_batch_id","required":true,"in":"query","description":"Batch ID.","schema":{"example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb","type":"string"}},{"name":"status","required":false,"in":"query","description":"Status.","schema":{"type":"string","enum":["BILLET_WAITING","BILLET_CREATED","BILLET_FAILED"]}},{"name":"created_at_period_start","required":false,"in":"query","description":"Start date of the created at period in the format YYYY-MM-DD.","schema":{"format":"date","type":"string"}},{"name":"created_at_period_end","required":false,"in":"query","description":"End date of the created at period in the format YYYY-MM-DD.","schema":{"format":"date","type":"string"}}],"responses":{"200":{"description":"The billet batch items returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllBankingBilletPixDepositBatchItemByBatchIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Bank Billet Deposit Batch Items","tags":["Banking | Bank Billet | Pix Deposit Batch Item"]}},"/banking/billet-pix-deposit-batch-items/{id}":{"get":{"description":"Tag: api-paas-get-banking-billet-pix-deposit-batch-item-by-id
\n Description: Get a bank billet deposit batch item by its ID.","operationId":"GetBankingBilletPixDepositBatchItemByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Batch item ID.","schema":{"example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb","type":"string"}}],"responses":{"200":{"description":"The billet batch item returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankingBilletPixDepositBatchItemByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Bank Billet Deposit Batch Item by ID","tags":["Banking | Bank Billet | Pix Deposit Batch Item"]},"put":{"description":"Tag: api-paas-update-banking-billet-pix-deposit-batch-item
\n Description: This action is only allowed on the same day the banking billet pix deposit batch is created.","operationId":"UpdateBankingBilletPixDepositBatchItemRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Batch item ID.","schema":{"example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBankingBilletPixDepositBatchItemBodyParam"}}}},"responses":{"200":{"description":"Item successfully updated."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update a Bank Billet Deposit Batch Item","tags":["Banking | Bank Billet | Pix Deposit Batch Item"]}},"/banking/billet-pix-deposit-batches/{id}/validation-errors":{"get":{"description":"Tag: api-paas-get-banking-billet-pix-deposit-batch-validation-errors
\n Description: Retrieve a list of bank billet deposit batch validation errors. Use optional filter parameters to refine your search.","operationId":"GetAllBankingBilletPixDepositBatchValidationErrorRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Bank billet deposit ID","schema":{"example":"246f89d0-f92d-4f08-83d1-55abf5d2bb73","type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["error_line"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"error_line","required":false,"in":"query","description":"Error line.","schema":{"type":"number"}},{"name":"error_field","required":false,"in":"query","description":"Error field.","schema":{"type":"string"}}],"responses":{"200":{"description":"The validation errors returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllBankingBilletPixDepositBatchValidationErrorRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Bank Billet Deposit Batch Validation Errors","tags":["Banking | Bank Billet | Pix Deposit Batch"]}},"/utils/user-withdraw-settings":{"get":{"description":"Retrieve a list of the user's withdraw settings.","operationId":"GetAllUserWithdrawSettingRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"The user withdraw settings returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllUserWithdrawSettingRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Withdraw Settings","tags":["Utils | User Withdraw Settings"]},"post":{"description":"Create a new withdraw setting for the user.","operationId":"CreateUserWithdrawSettingRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserWithdrawSettingBody"}}}},"responses":{"201":{"description":"User withdraw settings created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserWithdrawSettingRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Withdraw Setting","tags":["Utils | User Withdraw Settings"]}},"/utils/user-withdraw-setting/{id}":{"delete":{"description":"Delete a user's withdraw setting.","operationId":"DeleteUserWithdrawSettingRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"User withdraw setting ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The user withdraw setting was deleted successfully."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Withdraw Setting","tags":["Utils | User Withdraw Settings"]}},"/health":{"get":{"description":"Returns the service health status.","operationId":"HealthController_execute","parameters":[],"responses":{"200":{"description":"The Health Check is successful","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"ok"},"info":{"type":"object","example":{"database":{"status":"up"}},"additionalProperties":{"type":"object","required":["status"],"properties":{"status":{"type":"string"}},"additionalProperties":true},"nullable":true},"error":{"type":"object","example":{},"additionalProperties":{"type":"object","required":["status"],"properties":{"status":{"type":"string"}},"additionalProperties":true},"nullable":true},"details":{"type":"object","example":{"database":{"status":"up"}},"additionalProperties":{"type":"object","required":["status"],"properties":{"status":{"type":"string"}},"additionalProperties":true}}}}}}},"503":{"description":"The Health Check is not successful","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"error"},"info":{"type":"object","example":{"database":{"status":"up"}},"additionalProperties":{"type":"object","required":["status"],"properties":{"status":{"type":"string"}},"additionalProperties":true},"nullable":true},"error":{"type":"object","example":{"redis":{"status":"down","message":"Could not connect"}},"additionalProperties":{"type":"object","required":["status"],"properties":{"status":{"type":"string"}},"additionalProperties":true},"nullable":true},"details":{"type":"object","example":{"database":{"status":"up"},"redis":{"status":"down","message":"Could not connect"}},"additionalProperties":{"type":"object","required":["status"],"properties":{"status":{"type":"string"}},"additionalProperties":true}}}}}}}},"summary":"Health Check","tags":["Health"]}},"/v5/reports/pix-statement/exports":{"post":{"description":"Description: Initiate a request to retrieve a pix statement file for the specified date range. If no date range is provided, the current date will be used. Use the returned file_id with the 'storage/files/:id/url' endpoint to get a URL for downloading the pix statement in CSV, PDF or OFX format.","operationId":"V5GeneratePixStatementExportRestController_execute_v5","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V5GeneratePixStatementExportBody"}}}},"responses":{"201":{"description":"Pix statement generation initiated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V5GeneratePixStatementExportRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Generate Pix Statement Export File","tags":["Reports"]}},"/v2/reports/pix-statement":{"get":{"description":"Retrieve a list of Pix statement data for the user. When filtering by date, ensure that the date range is within the same month. If no date has been specified in the filters, the statement will be generated for the current month.","operationId":"V2GetAllReportPixStatementRestController_execute_v2","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"filter_type","required":false,"in":"query","description":"Filter Type:
\n ","schema":{"type":"string","enum":["beneficiary_document","owner_document","end_to_end_id","merchant_id","txid","priority_type"]}},{"name":"filter_text","required":false,"in":"query","description":"Filter text.","schema":{"type":"string"}},{"name":"page_state","required":false,"in":"query","description":"Previous page state.","schema":{"type":"string"}},{"name":"created_at_start","required":false,"in":"query","description":"Created at start.","schema":{"format":"date","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"End date for the statement (format: YYYY-MM-DD). Filters operations where transaction_created_at < this date (exclusive).","schema":{"format":"date","type":"string"}}],"responses":{"200":{"description":"The Pix statement data returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetAllReportPixStatementRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Pix Statement Data","tags":["Reports"]}},"/v4/reports/operation-statement":{"get":{"description":"Retrieve a list of operation statement data for the user. When filtering by date, ensure that the date range is within the same month. If no date has been specified in the filters, the statement will be generated for the current month.","operationId":"V4GetAllReportOperationStatementRestController_execute_v4","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"default":"transaction_created_at","type":"string","enum":["transaction_created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"filter_type","required":false,"in":"query","description":"Filter type.
\n ","schema":{"example":"topic","type":"string","enum":["currency_symbol","merchant_id","topic","value","transaction_type_tag","third_part_document"]}},{"name":"filter_text","required":false,"in":"query","description":"Filter Text.
\n ","schema":{"example":"PIX","type":"string"}},{"name":"page_state","required":false,"in":"query","description":"Previous page state.","schema":{"type":"string"}},{"name":"page_size","required":false,"in":"query","description":"Page size.","schema":{"type":"number"}},{"name":"created_at_start","required":false,"in":"query","description":"Transaction created at start GMT.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Transaction created at end GMT.","schema":{"format":"date-time","type":"string"}},{"name":"local_timezone_start","required":false,"in":"query","description":"Local timezone to validate start date.","schema":{"type":"number"}},{"name":"local_timezone_end","required":false,"in":"query","description":"Local timezone to validate end date.","schema":{"type":"number"}}],"responses":{"200":{"description":"The operation statement data returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V4GetAllReportOperationStatementRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Operation Statement Data","tags":["Reports"]}},"/v4/reports/operation-statement/exports":{"post":{"description":"Description: Initiate a request to retrieve a operation statement file for the current date. Use the returned file_id with the 'storage/files/:id/url' endpoint to get url for download the operation statement in CSV, PDF or OFX format.","operationId":"V4GenerateReportOperationStatementExportRestController_execute_v4","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V4GenerateReportOperationStatementExportBody"}}}},"responses":{"201":{"description":"Operation statement generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V4GenerateReportOperationStatementExportRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Generate Operation Statement Export File","tags":["Reports"]}},"/storage/files":{"get":{"description":"Retrieve a list of files.","operationId":"GetAllFilesRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"The Files returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllFilesRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Files related to user","tags":["Storage"]}},"/v2/storage/files/{id}/url":{"get":{"description":"Description: Retrieve a file URL for a specified ID. The generated URL automatically downloads the file. If you haven't generated a file yet, use the appropriate endpoint to do so.","operationId":"V2GetFileUrlByIdRestController_execute_v2","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"File ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"File URL and information returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetFileUrlByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get File URL by ID","tags":["Storage"]}},"/storage/upload":{"post":{"description":"Description: Retrieve a file URL to upload. When your upload finish, \n send the confirmation and you can download your file.","operationId":"UploadBySignedUrlFileRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadBySignedUrlFileBody"}}}},"responses":{"200":{"description":"File URL returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadBySignedUrlFileRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload file by url.","tags":["Storage"]}},"/storage/upload/{id}/confirm":{"post":{"description":"Confirm that the file was successfully uploaded using the signed URL.","operationId":"ConfirmUploadBySignedUrlFileRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"File ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"File upload confirmed successfully."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Confirm file upload by signed URL.","tags":["Storage"]}},"/users/banking/accounts":{"get":{"description":"Retrieve a user bank account.","operationId":"GetUserBankAccountByWalletRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"200":{"description":"The user bank account returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserBankAccountByWalletRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List User Bank Account","tags":["Users | User Bank Account"]}},"/pix/scheduled-payments/recurrence":{"post":{"description":"Tag: api-paas-post-pix-recurrence
\n Description: Initiate a new pix recurrence by providing the required information in the request body and executing the request.","operationId":"CreatePixRecurrenceRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixRecurrenceBody"}}}},"responses":{"201":{"description":"The recurrence returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixRecurrenceRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Pix Recurrence","tags":["Pix | Recurrence"]},"get":{"description":"Tag: api-paas-get-all-pix-recurrence
\n Description: Retrieve a list of the user's pix recurrences. Use optional filter parameters to refine your search.","operationId":"GetAllPixRecurrenceRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"The recurrences returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPixRecurrenceRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Pix recurrences","tags":["Pix | Recurrence"]}},"/pix/scheduled-payments/recurrence/{id}/deactivate":{"delete":{"description":"Tag: api-paas-deactivate-pix-recurrence-by-id
\n Description: Deactivate a pix recurrence.
","operationId":"DeactivatePixRecurrenceByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix recurrence ID.","schema":{"example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44","type":"string"}}],"responses":{"200":{"description":"The recurrence deactivated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivatePixRecurrenceByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Deactivate a pix recurrence","tags":["Pix | Recurrence"]}},"/pix/scheduled-payments/recurrence/{id}":{"get":{"description":"Tag: api-paas-get-pix-recurrence-by-id
\n Description: Retrieve the state and details of a pix recurrence by providing its ID.","operationId":"GetPixRecurrenceByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Recurrence ID.","schema":{"example":"d1952c4b-9348-41ab-99a3-05b11459aded","type":"string"}}],"responses":{"200":{"description":"Pix recurrence found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPixRecurrenceByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Pix Recurrence by ID","tags":["Pix | Recurrence"]}},"/pix/scheduled-payments":{"get":{"description":"Tag: api-paas-get-all-pix-scheduled-payments
\n Description: Retrieve a list of the user's pix scheduled payments. Use optional filter parameters to refine your search.","operationId":"GetAllPixScheduledPaymentRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"states","required":false,"in":"query","description":"Pix scheduled payment State.","schema":{"example":["PENDING","READY"],"type":"array","items":{"type":"string","enum":["PENDING","READY","CANCELED","FAILED"]}}}],"responses":{"200":{"description":"The pix scheduled payments returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPixScheduledPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List pix scheduled payments","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-authorizations":{"get":{"description":"Tag: api-paas-get-all-pix-automatic-authorizations
\n Description: List Automatic Pix Authorizations.","operationId":"GetAllPixAutomaticAuthorizationRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"example":"created_at","type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"status","required":false,"in":"query","description":"Authorization status attribute.","schema":{"example":["APPROVED"],"type":"array","items":{"type":"string","enum":["PENDING","WAITING_APPROVAL","WAITING_REJECTION","APPROVED","REJECTED","WAITING_CANCELLATION","CANCELED","FINISHED"]}}}],"responses":{"200":{"description":"Retrieved automatic pix authorizations successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPixAutomaticAuthorizationRestResponse$2"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Automatic Pix Authorizations","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-authorizations/{id}":{"get":{"description":"Tag: api-paas-get-by-id-pix-automatic-authorization
\n Description: Get Automatic Pix Authorization by ID.","operationId":"GetPixAutomaticAuthorizationByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Authorization ID.","schema":{"example":"d1952c4b-9348-41ab-99a3-05b11459aded","type":"string"}}],"responses":{"200":{"description":"Automatic pix authorization retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPixAutomaticAuthorizationRestResponse$1"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Automatic Pix Authorization by ID","tags":["Pix | Scheduled Payments"]},"put":{"description":"Tag: api-paas-change-max-value-pix-automatic-authorization
\n Description: Updates the pending automatic pix authorization to be able to receive payment schedules.","operationId":"UpdatePixAutomaticAuthorizationRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix automatic authorization id.","schema":{"example":"5dbbb951-e19d-44a6-93f9-4b14f0495dfb","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePixAutomaticAuthorizationBodyParam"}}}},"responses":{"200":{"description":"Authorization successfully updated."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update an Automatic Pix Authorization","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-payments":{"get":{"description":"Tag: api-paas-get-all-pix-automatic-payments
\n Description: Retrieve a list of the user's automatic pix payments. Use optional filter parameters to refine your search.","operationId":"GetAllPixAutomaticPaymentRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"example":"created_at","type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"status","required":false,"in":"query","description":"Payment status attribute.","schema":{"example":["CREATED"],"type":"array","items":{"type":"string","enum":["CREATED","WAITING_CANCELLATION","CANCELLATION_FAILED","CANCELED"]}}}],"responses":{"200":{"description":"Retrieved automatic pix payments successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPixAutomaticPaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Automatic Pix Payments","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-payments/{id}":{"get":{"description":"Tag: api-paas-get-by-id-pix-automatic-payment
\n Description: Retrieve the details of a pix automatic payment by providing its ID.","operationId":"GetPixAutomaticPaymentByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Payment ID.","schema":{"example":"d1952c4b-9348-41ab-99a3-05b11459aded","type":"string"}}],"responses":{"200":{"description":"Retrieved automatic pix payment successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPixAutomaticPaymentByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Automatic Pix Payment by ID","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-authorizations/approve-by-qrcode/{decoded_composite_qr_code_id}":{"post":{"description":"Tag: api-paas-approve-by-qrcode-pix-automatic-authorization
\n Description: Approves the pending automatic pix authorization by qr code to be able to receive payment schedules.","operationId":"ApprovePixAutomaticAuthorizationByQrCodeRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"decoded_composite_qr_code_id","required":true,"in":"path","description":"Decoded composite qr code id.","schema":{"example":"fb96cf13-4600-4d21-ad67-40fc05ac3a8d","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovePixAutomaticAuthorizationByQrCodeBodyParam"}}}},"responses":{"200":{"description":"Authorization successfully approved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovePixAutomaticAuthorizationByQrCodeRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Approve Automatic Pix Authorization by QR Code","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-authorizations/{id}/approve":{"post":{"description":"Tag: api-paas-approve-pix-automatic-authorization
\n Description: Approves the pending automatic pix authorization to be able to receive payment schedules.","operationId":"ApprovePixAutomaticAuthorizationRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Authorization unique id.","schema":{"example":"fb96cf13-4600-4d21-ad67-40fc05ac3a8d","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovePixAutomaticAuthorizationBodyParam"}}}},"responses":{"200":{"description":"Authorization successfully approved."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Approve an Automatic Pix Authorization","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-authorizations/{id}/reject":{"post":{"description":"Tag: api-paas-reject-pix-automatic-authorization
\n Description: Rejects the pending automatic pix authorization.","operationId":"RejectPixAutomaticAuthorizationRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Authorization unique id.","schema":{"example":"fb96cf13-4600-4d21-ad67-40fc05ac3a8d","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectPixAutomaticAuthorizationBodyParam"}}}},"responses":{"200":{"description":"Authorization successfully rejected."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Reject an Automatic Pix Authorization","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-payments/by-pix-payment/{pix_payment_id}":{"get":{"description":"Tag: api-paas-get-by-pix-payment-id-pix-automatic-payment
\n Description: Retrieve the details of a pix automatic payment by providing its pix payment ID.","operationId":"GetPixAutomaticPaymentByPixPaymentIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"pix_payment_id","required":true,"in":"path","description":"Pix payment ID.","schema":{"example":"d1952c4b-9348-41ab-99a3-05b11459aded","type":"string"}}],"responses":{"200":{"description":"Retrieved automatic pix payment successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPixAutomaticPaymentByPixPaymentIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Automatic Pix Payment by Pix Payment ID","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-authorizations/{id}/cancel":{"post":{"description":"Tag: api-paas-cancel-pix-automatic-authorization
\n Description: Cancels an automatic pix authorization and its scheduled payments.","operationId":"CancelPixAutomaticAuthorizationRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Authorization unique id.","schema":{"example":"fb96cf13-4600-4d21-ad67-40fc05ac3a8d","type":"string"}}],"responses":{"200":{"description":"Authorization successfully canceled."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Automatic Pix Authorization","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-payments/{id}/cancel":{"post":{"description":"Tag: api-paas-cancel-pix-automatic-payment
\n Description: Cancels an automatic pix payment and its associated scheduled payment.","operationId":"CancelPixAutomaticPaymentRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Pix automatic payment unique id.","schema":{"example":"fb96cf13-4600-4d21-ad67-40fc05ac3a8d","type":"string"}}],"responses":{"200":{"description":"Automatic pix payment successfully canceled."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Automatic Pix Payment","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-recurrences/{id}/cancel":{"post":{"description":"Tag: api-paas-cancel-pix-automatic-recurrence
\n Description: Cancels an automatic pix recurrence and its scheduled payments. Only recurrences with status APPROVED can be canceled.","operationId":"CancelPixAutomaticRecurrenceRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Recurrence unique id.","schema":{"example":"fb96cf13-4600-4d21-ad67-40fc05ac3a8d","type":"string"}}],"responses":{"200":{"description":"Recurrence successfully canceled."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancels an Automatic Pix Recurrence","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-recurrences/{id}":{"put":{"description":"Tag: api-paas-update-pix-automatic-recurrence
\n Description: Updates an automatic pix recurrence by canceling the current one and creating a new one with updated data. Only recurrences with status APPROVED can be updated.","operationId":"UpdatePixAutomaticRecurrenceRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Recurrence unique id.","schema":{"example":"fb96cf13-4600-4d21-ad67-40fc05ac3a8d","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePixAutomaticRecurrenceBodyParam"}}}},"responses":{"200":{"description":"Recurrence successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePixAutomaticRecurrenceRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If user person type is not Legal Person or does not own the recurrence."},"422":{"description":"If recurrence cannot be updated (already approved, canceled, etc.)."}},"security":[{"bearer":[]}],"summary":"Update an Automatic Pix Recurrence","tags":["Pix | Scheduled Payments"]},"get":{"description":"Tag: api-paas-get-by-id-pix-automatic-recurrence
\n Description: Retrieve the details of a pix automatic recurrence by providing its ID.","operationId":"GetPixAutomaticRecurrenceByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Recurrence ID.","schema":{"example":"d1952c4b-9348-41ab-99a3-05b11459aded","type":"string"}}],"responses":{"200":{"description":"Recurrence found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPixAutomaticRecurrenceByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Automatic Pix Recurrence by ID","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-recurrences":{"post":{"description":"Tag: api-paas-create-pix-automatic-recurrence
\n Description: Creates an automatic pix recurrence to be able to send payment schedules to the payer/debtor.","operationId":"CreatePixAutomaticRecurrenceRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixAutomaticRecurrenceBodyParam"}}}},"responses":{"200":{"description":"Recurrence successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixAutomaticRecurrenceRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If user person type is not Legal Person"},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create an Automatic Pix Recurrence","tags":["Pix | Scheduled Payments"]},"get":{"description":"Tag: api-paas-get-all-pix-automatic-recurrence
\n Description: Retrieve a list of the user's automatic pix recurrences. Use optional filter parameters to refine your search.","operationId":"GetAllPixAutomaticRecurrenceRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"example":"created_at","type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"status","required":false,"in":"query","description":"Recurrence status.","schema":{"example":["APPROVED"],"type":"array","items":{"type":"string","enum":["PENDING","CREATED","FAILED","APPROVED","REJECTED","CANCELED","EXPIRED","FINISHED"]}}},{"name":"owner_document","required":false,"in":"query","description":"Owner (payer) document (CPF or CNPJ)","schema":{"example":"01234567890","type":"string"}},{"name":"debtor_name","required":false,"in":"query","description":"Debtor name","schema":{"example":"John Doe","type":"string"}},{"name":"contract_number","required":false,"in":"query","description":"Contract number (reference code)","schema":{"example":"1234567","type":"string"}},{"name":"tags","required":false,"in":"query","description":"Recurrence tags","schema":{"type":"array","items":{"type":"string"}}},{"name":"created_at_start","required":false,"in":"query","description":"Recurrence created at start. Format: YYYY-MM-DD","schema":{"format":"date","example":"2026-05-29","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Recurrence created at end. Format: YYYY-MM-DD","schema":{"format":"date","example":"2026-05-29","type":"string"}},{"name":"frequency","required":false,"in":"query","description":"Recurrence frequency.","schema":{"example":"MONTHLY","type":"string","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"]}},{"name":"next_charge_due_date_start","required":false,"in":"query","description":"Next charge due date start. Format: YYYY-MM-DD","schema":{"format":"date","example":"2026-05-29","type":"string"}},{"name":"next_charge_due_date_end","required":false,"in":"query","description":"Next charge due date end. Format: YYYY-MM-DD","schema":{"format":"date","example":"2026-05-29","type":"string"}}],"responses":{"200":{"description":"The recurrences returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPixAutomaticRecurrenceRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List All Automatic Pix Recurrences","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-charges/{id}/cancel":{"post":{"description":"Tag: api-paas-cancel-pix-automatic-charge
\n Description: Cancels an automatic pix charge. Only charges with status CREATED can be canceled.","operationId":"CancelPixAutomaticChargeRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Charge unique id.","schema":{"example":"fb96cf13-4600-4d21-ad67-40fc05ac3a8d","type":"string"}}],"responses":{"200":{"description":"Charge successfully canceled."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancels an Automatic Pix Charge","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-charges":{"post":{"description":"Tag: api-paas-create-pix-automatic-charge
\n Description: Creates an automatic pix charge.","operationId":"CreatePixAutomaticChargeRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixAutomaticChargeBodyParam"}}}},"responses":{"200":{"description":"Charge successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixAutomaticChargeRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create an Automatic Pix Charge","tags":["Pix | Scheduled Payments"]},"get":{"description":"Tag: api-paas-get-all-pix-automatic-charge
\n Description: Retrieve a list of the user's automatic pix charges. Use optional filter parameters to refine your search.","operationId":"GetAllPixAutomaticChargeRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"example":"created_at","type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"status","required":false,"in":"query","description":"Status.","schema":{"example":"CREATED","type":"string","enum":["PENDING_WAITING","PENDING_CONFIRMED","CREATED","CREATED_FAILED","PAID","NOT_PAID","WAITING_CANCELLATION","CANCELED","CANCELED_FAILED"]}},{"name":"pix_automatic_recurrence_id","required":false,"in":"query","description":"Automatic pix recurrence ID.","schema":{"example":"1f85ecfa-a13b-4a59-bdc0-130d67f85122","type":"string"}},{"name":"owner_document","required":false,"in":"query","description":"Owner document (CPF or CNPJ).","schema":{"example":"12345678900","type":"string"}},{"name":"created_at_start","required":false,"in":"query","description":"Created at start. Format: YYYY-MM-DD","schema":{"format":"date","example":"2026-05-29","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Created at end. Format: YYYY-MM-DD","schema":{"format":"date","example":"2026-05-29","type":"string"}},{"name":"due_date_start","required":false,"in":"query","description":"Due date start. Format: YYYY-MM-DD","schema":{"format":"date","example":"2026-05-29","type":"string"}},{"name":"due_date_end","required":false,"in":"query","description":"Due date end. Format: YYYY-MM-DD","schema":{"format":"date","example":"2026-05-29","type":"string"}}],"responses":{"200":{"description":"The charges returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPixAutomaticChargeRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List All Automatic Pix Charges","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-charges/{id}":{"get":{"description":"Tag: api-paas-get-by-id-pix-automatic-charge
\n Description: Retrieve the details of a pix automatic charge by providing its ID.","operationId":"GetPixAutomaticChargeByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Charge ID.","schema":{"example":"d1952c4b-9348-41ab-99a3-05b11459aded","type":"string"}}],"responses":{"200":{"description":"Charge found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPixAutomaticChargeByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Automatic Pix Charge by ID","tags":["Pix | Scheduled Payments"]}},"/pix/scheduled-payments/automatic-receiver-limits":{"post":{"description":"Tag: api-paas-create-pix-automatic-receiver-limit
Description: Creates a daily limit for a specific receiver in automatic pix payments.","operationId":"CreatePixAutomaticReceiverLimitRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixAutomaticReceiverLimitBodyParam"}}}},"responses":{"201":{"description":"Receiver limit successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixAutomaticReceiverLimitRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Pix Automatic Receiver Limit","tags":["Pix | Automatic Receiver Limits"]},"get":{"description":"Tag: api-paas-get-all-by-wallet-pix-automatic-receiver-limit
Description: Gets all receiver limits for the authenticated wallet.","operationId":"GetAllPixAutomaticReceiverLimitByWalletRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"200":{"description":"Receiver limits found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPixAutomaticReceiverLimitByWalletRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get all Pix Automatic Receiver Limits by Wallet","tags":["Pix | Automatic Receiver Limits"]}},"/pix/scheduled-payments/automatic-receiver-limits/{id}":{"patch":{"description":"Tag: api-paas-update-pix-automatic-receiver-limit
Description: Updates the daily limit for a specific receiver in automatic pix payments.","operationId":"UpdatePixAutomaticReceiverLimitRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Receiver Limit ID.","schema":{"example":"d1952c4b-9348-41ab-99a3-05b11459aded","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePixAutomaticReceiverLimitBodyParam"}}}},"responses":{"200":{"description":"Receiver limit successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePixAutomaticReceiverLimitRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update Pix Automatic Receiver Limit","tags":["Pix | Automatic Receiver Limits"]},"get":{"description":"Tag: api-paas-get-by-id-pix-automatic-receiver-limit
Description: Gets a specific receiver limit by its ID.","operationId":"GetPixAutomaticReceiverLimitByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Receiver Limit ID.","schema":{"example":"d1952c4b-9348-41ab-99a3-05b11459aded","type":"string"}}],"responses":{"200":{"description":"Receiver limit found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPixAutomaticReceiverLimitByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Pix Automatic Receiver Limit by ID","tags":["Pix | Automatic Receiver Limits"]}},"/cards/virtual":{"post":{"description":"Tag: api-paas-post-virtual-card
\n Description: Create a new virtual card.","operationId":"CreateVirtualCardRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"201":{"description":"Virtual card created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVirtualCardRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Virtual Card","tags":["Card"]}},"/cards":{"get":{"description":"Tag: api-paas-get-all-cards
\n Description: List all cards.","operationId":"GetAllCardsRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"example":"created_at","type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Cards found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllCardsRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List all cards","tags":["Card"]}},"/cards/{id}/unblock":{"post":{"description":"Tag: api-paas-post-unblock-card
\n Description: Unblocks a customer's card. The customer must provide the PIN. The card can only be activated if the current status is \"blocked\" or \"password_locked\".","operationId":"UnblockCardRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card ID.","schema":{"example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44","type":"string"}}],"responses":{"200":{"description":"Card unblocked successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockCardRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Unblock Card","tags":["Card"]}},"/cards/{id}/block":{"post":{"description":"Tag: api-paas-post-block-card
\n Description: Blocks a customer's card. The customer must provide the PIN.","operationId":"BlockCardRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card ID.","schema":{"example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44","type":"string"}}],"responses":{"200":{"description":"Card blocked successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockCardRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Block Card","tags":["Card"]}},"/cards/{id}/details":{"patch":{"description":"Tag: api-paas-patch-card-details
\n Description: Retrieve card data. For virtual cards, return all information, including card number, CVV, expiration date, and the name printed on the card. For physical cards, return the masked card number data.","operationId":"CardDetailsRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card ID.","schema":{"example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44","type":"string"}}],"responses":{"200":{"description":"Retrieve card found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardDetailsRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Card details","tags":["Card"]}},"/cards/{id}":{"delete":{"description":"Tag: api-paas-delete-card
\n Description: Cancels a customer's card. The customer must provide the PIN.","operationId":"CancelCardRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card ID.","schema":{"example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44","type":"string"}}],"responses":{"200":{"description":"Card cancelled successfully..","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelCardRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Card","tags":["Card"]}},"/cards/physical":{"post":{"description":"Tag: api-paas-post-physical-card
\n Description: Create a new physical card.","operationId":"CreatePhysicalCardRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"description":"Body required.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePhysicalCardBody"}}}},"responses":{"201":{"description":"Physical card created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePhysicalCardRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Physical Card","tags":["Card"]}},"/cards/{id}/activate":{"post":{"description":"Tag: api-paas-post-activate-card
\n Description: Activates a customer's card. The customer must provide the PIN.","operationId":"ActivateCardRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card ID.","schema":{"example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44","type":"string"}}],"requestBody":{"required":true,"description":"Body required.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateCardBody"}}}},"responses":{"200":{"description":"Card activated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateCardRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Activate Card","tags":["Card"]}},"/cards/{id}/physical/new-via":{"post":{"description":"Tag: api-paas-post-new-physical-card-via
\n Description: Create a new version of a physical card.","operationId":"CreateNewPhysicalCardViaRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card ID.","schema":{"example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44","type":"string"}}],"responses":{"201":{"description":"Physical card created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNewPhysicalCardViaRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Issue a Replacement Physical Card","tags":["Card"]}},"/cards/{id}/password":{"patch":{"description":"Tag: api-paas-patch-change-card-password
\n Description: Change card password.","operationId":"ChangeCardPasswordRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card ID.","schema":{"example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44","type":"string"}}],"requestBody":{"required":true,"description":"Body required.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeCardPasswordBody"}}}},"responses":{"200":{"description":"Card password changed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeCardPasswordRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Change Card Password","tags":["Card"]}},"/cards/{id}/tracking":{"get":{"description":"Tag: api-paas-get-card-tracking
\n Description: Retrieve card tracking data.","operationId":"GetCardTrackingRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card ID.","schema":{"example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44","type":"string"}}],"responses":{"200":{"description":"Retrieve card tracking found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCardTrackingRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Card Tracking","tags":["Card"]}},"/card/onboarding/terms-of-use":{"get":{"description":"Tag: api-users-get-terms-of-use
\n Description: Get terms of use for the customer. The customer must be finished onboarding.","operationId":"GetTermsOfUseRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"200":{"description":"Get terms of use successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetTermsOfUseRestResponse"}}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Terms of Use","tags":["Card | Onboarding"]},"post":{"description":"Tag: api-users-post-accept-terms-of-use
\n Description: Accept terms of use for the customer. The customer must be finished onboarding.","operationId":"AcceptTermsOfUseRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptTermsOfUseBody"}}}},"responses":{"200":{"description":"Accept terms of use successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptTermsOfUseRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Accept Terms of Use","tags":["Card | Onboarding"]}},"/card/onboarding/{id}/documents":{"post":{"description":"Tag: api-paas-post-upload-document
\n Description: Upload card onboarding document.
","operationId":"UploadCardOnboardingDocumentRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card Onboarding ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"document_type":{"type":"string","description":"Document type\n Possible values: selfie, rg_front, rg_verse, cnh_front, cnh_verse, cnh_digital, passport, signature_card, rne_front, rne_verse.","enum":["selfie","rg_front","rg_verse","cnh_front","cnh_verse","cnh_digital","passport","signature_card","rne_front","rne_verse"]},"file":{"type":"string","format":"binary","description":"Allowed file formats: application/pdf, image/jpeg, image/jpg.","enum":["application/pdf","image/jpeg","image/jpg"]}}}}}},"responses":{"200":{"description":"Upload card onboarding document successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadCardOnboardingDocumentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload card onboarding document","tags":["Card | Onboarding"]}},"/card/onboarding/{id}":{"get":{"description":"Tag: api-users-get-card-onboarding-by-id
\n Description: Get card onboarding by ID.
","operationId":"GetCardOnboardingByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Card Onboarding ID.","schema":{"example":"12345678-1234-5678-1234-567812345678","type":"string"}}],"responses":{"200":{"description":"Get card onboarding by ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCardOnboardingByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Card Onboarding By ID","tags":["Card | Onboarding"]}},"/card/onboarding":{"post":{"description":"Tag: api-paas-post-card-onboarding
\n Description: Create card onboarding. The customer must have finished the onboarding.","operationId":"CreateCardOnboardingRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"responses":{"200":{"description":"Card Onboarding created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCardOnboardingResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create card onboarding","tags":["Card | Onboarding"]}},"/open-finance/participants":{"get":{"description":"Retrieve a list of all Open Finance participants.","operationId":"GetAllOpenFinanceParticipantsRestController_execute","parameters":[{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"type":"string","enum":["id","friendlyName","createdAt"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"friendly_name","required":false,"in":"query","description":"Filter by friendly name (partial match).","schema":{"example":"Z.ro global","type":"string"}}],"responses":{"200":{"description":"The participants returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllOpenFinanceParticipantsRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Open Finance Participants","tags":["Open Finance | Participants"]}},"/open-finance/payment-consent/by-keys":{"post":{"description":"Create a new Open Finance payment consent by pix key.","operationId":"CreateOpenFinancePaymentConsentByPixKeyRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenFinancePaymentConsentByPixKeyBody"}}}},"responses":{"201":{"description":"The payment consent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenFinancePaymentConsentByPixKeyRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Open Finance Payment Consent by Pix Key","tags":["Open Finance | Payment Consents"]}},"/open-finance/payment-consent/by-accounts":{"post":{"description":"Create a new Open Finance payment consent by pix account.","operationId":"CreateOpenFinancePaymentConsentByPixAccountRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenFinancePaymentConsentByPixAccountBody"}}}},"responses":{"201":{"description":"The payment consent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenFinancePaymentConsentByPixAccountRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Open Finance Payment Consent by Pix Account","tags":["Open Finance | Payment Consents"]}},"/open-finance/payment-consent/by-qr-codes/dynamic":{"post":{"description":"Create a new Open Finance payment consent by qr code dynamic.","operationId":"CreateOpenFinancePaymentConsentByQrCodeDynamicRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenFinancePaymentConsentByQrCodeDynamicBody"}}}},"responses":{"201":{"description":"The payment consent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenFinancePaymentConsentByQrCodeDynamicRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Open Finance Payment Consent by QR Code Dynamic","tags":["Open Finance | Payment Consents"]}},"/open-finance/payment-consent/by-qr-codes/static":{"post":{"description":"Create a new Open Finance payment consent by qr code static.","operationId":"CreateOpenFinancePaymentConsentByQrCodeStaticRestController_execute","parameters":[{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenFinancePaymentConsentByQrCodeStaticBody"}}}},"responses":{"201":{"description":"The payment consent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenFinancePaymentConsentByQrCodeStaticRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Open Finance Payment Consent by QR Code Static","tags":["Open Finance | Payment Consents"]}},"/open-finance/payment-consent/{id}":{"get":{"description":"Get an open finance payment consent by id.","operationId":"GetOpenFinancePaymentConsentByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Payment consent UUID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Payment consent returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOpenFinancePaymentConsentByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Open Finance Payment Consent by ID","tags":["Open Finance | Payment Consents"]}},"/open-finance/payments":{"get":{"description":"Get all open finance payments with filters.","operationId":"GetAllOpenFinancePaymentsRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"example":"created_at","type":"string","enum":["id","created_at","amount","payment_date","status"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"status","required":false,"in":"query","description":"Payment status.","schema":{"type":"string","enum":["PENDING","WAITING","WAITING_ANALYSIS","COMPLETED","FAILED","REJECTED","SCHEDULED","PENDING_CANCEL","CANCELLED","ERROR"]}},{"name":"created_at_start","required":false,"in":"query","description":"Filter by created at start.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Filter by created at end.","schema":{"format":"date-time","type":"string"}},{"name":"participant_id","required":false,"in":"query","description":"Participant UUID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Payments returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllOpenFinancePaymentsRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get All Open Finance Payments","tags":["Open Finance | Payments"]}},"/open-finance/payment-consent/{id}/authorize-without-redirect":{"post":{"description":"Authorize a new Open Finance payment consent without redirect.","operationId":"AuthorizeWithoutRedirectOpenFinancePaymentConsentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Open Finance payment consent id.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizeWithoutRedirectOpenFinancePaymentConsentBody"}}}},"responses":{"200":{"description":"Payment consent authorized without redirect successfully."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Authorize Open Finance Payment Consent Without Redirect.","tags":["Open Finance | Payment Consents"]}},"/open-finance/payments/{id}":{"get":{"description":"Get an open finance payment by id.","operationId":"GetOpenFinancePaymentByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Payment UUID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Payment returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOpenFinancePaymentByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Open Finance Payment by ID","tags":["Open Finance | Payments"]},"patch":{"description":"Cancel a Open Finance scheduled or pending payment by ID.","operationId":"CancelOpenFinancePaymentRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Open Finance payment ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOpenFinancePaymentBody"}}}},"responses":{"200":{"description":"The payment canceled successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOpenFinancePaymentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Cancel Open Finance Scheduled or Pending Payment","tags":["Open Finance | Payments"]}},"/open-finance/enrollments/{id}":{"get":{"description":"Get an open finance enrollment by id.","operationId":"GetEnrollmentByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Enrollment UUID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Enrollment retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Open Finance Enrollment by ID","tags":["Open Finance | Enrollment"]}},"/open-finance/enrollments/{enrollment_id}/device/{id}/credentials":{"get":{"description":"Get an open finance device enrollment credential by id.","operationId":"GetDeviceEnrollmentCredentialByIdRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Device enrollment id.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"enrollment_id","required":true,"in":"path","description":"Enrollment id.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Device enrollment credential retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeviceEnrollmentCredentialByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Open Finance Device Enrollment Credential by ID","tags":["Open Finance | Enrollment"]}},"/open-finance/enrollments":{"get":{"description":"Get all enrollments with filters.","operationId":"GetAllEnrollmentRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"size","required":false,"in":"query","description":"Page size. Max size is 100.","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"example":"created_at","type":"string","enum":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"status","required":false,"in":"query","description":"Enrollment status.","schema":{"example":["PENDING","ERROR"],"type":"array","items":{"type":"string","enum":["PENDING","ERROR","FAILED","AWAITING_DEVICE_RISK_SIGNALS","AWAITING_ACCOUNT_OWNER_VALIDATION","AWAITING_ENROLLMENT","AWAITING_DEVICE_REGISTRATION","PENDING_REVOKE","AUTHORIZED","REVOKED","REJECTED"]}}},{"name":"permissions","required":false,"in":"query","description":"Enrollment Permissions.","schema":{"example":["PAYMENTS_INITIATE","RECURRING_PAYMENTS_INITIATE"],"type":"array","items":{"type":"string","enum":["PAYMENTS_INITIATE","RECURRING_PAYMENTS_INITIATE"]}}},{"name":"logged_user_document","required":false,"in":"query","description":"Filter by logged user document.","schema":{"example":"12345678910","type":"string"}},{"name":"logged_business_entity_document","required":false,"in":"query","description":"Filter by logged business entity document.","schema":{"example":"12345678910234","type":"string"}},{"name":"participant_id","required":false,"in":"query","description":"Participant UUID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"created_at_start","required":false,"in":"query","description":"Filter by created at start.","schema":{"format":"date","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Filter by created at end.","schema":{"format":"date","type":"string"}}],"responses":{"200":{"description":"Enrollments returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllEnrollmentsRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get All Enrollments","tags":["Open Finance | Enrollment"]},"post":{"description":"Create a new Open Finance enrollment. ","operationId":"CreateEnrollmentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEnrollmentBody"}}}},"responses":{"201":{"description":"The enrollment created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEnrollmentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Open Finance Enrollment","tags":["Open Finance | Enrollment"]}},"/open-finance/enrollments/{id}/revoke":{"patch":{"description":"Revoke an Open Finance enrollment.","operationId":"RevokeEnrollmentRestController_execute","parameters":[{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Enrollment ID.","schema":{"example":"13cc7a64-610a-4102-8712-eba9ea293cdb","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeEnrollmentBody"}}}},"responses":{"200":{"description":"The enrollment revoked successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeEnrollmentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Revoke Open Finance Enrollment","tags":["Open Finance | Enrollment"]}},"/open-finance/enrollments/{id}/device/signin":{"post":{"description":"Create a new Open Finance device enrollment sign in.","operationId":"CreateDeviceEnrollmentSignInRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Enrollment id.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceEnrollmentSignInBody"}}}},"responses":{"201":{"description":"The device enrollment sign in created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEnrollmentDeviceSignInRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Open Finance Device Enrollment Sign In","tags":["Open Finance | Enrollment"]}},"/open-finance/enrollments/{id}/device/credentials":{"post":{"description":"Create a new Open Finance device enrollment credentials.","operationId":"CreateDeviceEnrollmentCredentialsRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Enrollment id.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceEnrollmentCredentialsBody"}}}},"responses":{"201":{"description":"The device enrollment credentials created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEnrollmentDeviceCredentialRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Open Finance Device Enrollment Credentials","tags":["Open Finance | Enrollment"]}},"/open-finance/enrollments/{id}/device/risk-signal":{"post":{"description":"Create a new Open Finance device enrollment risk signal.","operationId":"CreateDeviceEnrollmentRiskSignalRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-transaction-uuid","in":"header","description":"The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.","required":true,"schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"id","required":true,"in":"path","description":"Open Finance enrollment id.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceEnrollmentRiskSignalBody"}}}},"responses":{"200":{"description":"Device enrollment risk signal created successfully."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Open Finance Device Enrollment Risk Signal.","tags":["Open Finance | Enrollment"]}},"/open-finance/enrollments/{enrollment_id}/device/{id}":{"post":{"description":"Create a new Open Finance device enrollment. Must be called after the device permission is created.","operationId":"CreateDeviceEnrollmentRestController_execute","parameters":[{"name":"x-include-replay-protection-schema","in":"header","description":"The replay-protection-schema allows the user to choose between 3 options:
\n ","schema":{"type":"string"}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"nonce","in":"header","description":"The nonce ID is a UUID (v4) used to uniquely identify the \n request. All requests must have an identifier.\n ","required":true,"schema":{"type":"string"}},{"name":"x-product-uuid","in":"header","description":"UUID (v4) of the product that the request should use. Send \n it explicitly when the authenticated user has more than one product or \n when the integration must select a specific product. If omitted and the \n endpoint does not require it, the API uses the authenticated user's \n default product.\n ","required":false,"schema":{"type":"string"}},{"name":"x-product-target-user-uuid","in":"header","description":"UUID (v4) of the user on whose behalf the request should \n run within the selected product. If omitted, the request runs as the \n authenticated user. Requires x-product-uuid.\n ","required":false,"schema":{"type":"string"}},{"name":"x-lang","in":"header","description":"Indicates the preferred language. Defaults to Brazilian \n Portuguese if unspecified.\n ","required":false,"schema":{"type":"string","enum":["pt-BR","en-US"]}},{"name":"enrollment_id","required":true,"in":"path","description":"Enrollment id.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"id","required":true,"in":"path","description":"Device enrollment id.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceEnrollmentBody"}}}},"responses":{"201":{"description":"The device enrollment created. Successfully!.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEnrollmentDeviceRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Open Finance Device Enrollment","tags":["Open Finance | Enrollment"]}}},"info":{"title":"Zro Global Paas API","description":"Zro Global Paas API","version":"1.84.0","contact":{"name":"Z.ro Global","url":"https://www.zro.global","email":"tecnologia@zro.global"},"license":{"name":"All rights reserved","url":"https://www.zro.global"}},"tags":[{"name":"Authentication"},{"name":"Pix | Keys"},{"name":"Pix | Keys | Dynamic QR Code"},{"name":"Pix | Keys | Static QR Code"},{"name":"Split Payments"},{"name":"Pix | Payments"},{"name":"Pix | Devolutions"},{"name":"Pix | Deposits"},{"name":"Otc | Conversions"},{"name":"Quotations | Conversions"},{"name":"Operations | Wallets"},{"name":"Operations | P2P Transfers"},{"name":"Operations | Wallet Accounts"},{"name":"Operations | Currency"},{"name":"Operations | Operation"},{"name":"Operations | Wallet limits"},{"name":"Banking"},{"name":"Banking | Bank Billet | Pix Deposits"},{"name":"Banking | Bank Billet | Pix Deposit Template"},{"name":"Banking | Bank Billet | Payments"},{"name":"Banking | Bank Billet | Pix Deposit Batch"},{"name":"Banking | Bank Billet | Pix Deposit Batch Item"},{"name":"Utils | User Withdraw Settings"},{"name":"Health"},{"name":"Reports"},{"name":"Storage"},{"name":"Users | User Bank Account"},{"name":"Pix | Recurrence"},{"name":"Pix | Scheduled Payments"},{"name":"Pix | Automatic Receiver Limits"},{"name":"Card"},{"name":"Card | Onboarding"},{"name":"Open Finance | Participants"},{"name":"Open Finance | Payment Consents"},{"name":"Open Finance | Payments"},{"name":"Open Finance | Enrollment"}],"servers":[{"url":"/","description":"Current API host"}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"AuthenticateRestRequest":{"type":"object","properties":{"api_id":{"type":"string","description":"User defined apiId.","example":"2af31bf2-e676-4e81-8dde-dfd671124e97"},"api_key":{"type":"string","description":"User defined apiKey.","example":"superpassword"}},"required":["api_id","api_key"]},"AuthenticateRestResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"JWT access token. Token used to access all protected endpoints."}},"required":["access_token"]},"RefreshTokenRestResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"JWT access token. Token used to access all protected endpoints."}},"required":["access_token"]},"VerifyCodePixKeyBody":{"type":"object","properties":{"code":{"type":"string","description":"Verification code.","example":"00000"}},"required":["code"]},"VerifyCodePixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.488Z"}},"required":["id","key","type","state","created_at"]},"GetAllPixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"state_description":{"type":"string","description":"Pix key state translated.","example":"Pronta para uso"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.489Z"}},"required":["id","key","type","state","state_description","created_at"]},"GetByIdPixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.490Z"},"failed_message":{"type":"string","description":"Pix Key failed message."}},"required":["id","key","type","state","created_at","failed_message"]},"CreateQrCodeDynamicInstantBillingBody":{"type":"object","properties":{"key":{"type":"string","description":"PIX Key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"document_value":{"type":"number","description":"Value in R$ cents","example":2300},"expiration_date":{"type":"string","description":"Expiration date to pay dynamic QR Code.","example":"2026-05-29","format":"date"},"summary":{"type":"string","description":"User friendly dynamic QR Code identifier.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"Dynamic QR Code to receive payment."},"payer_request":{"type":"string","description":"Payer request.","example":"Send receipt to my email."}},"required":["key","document_value","description"]},"CreateQrCodeDynamicInstantBillingRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Dynamic QR Code ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key_id":{"type":"string","description":"Associated key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","READY","ERROR","PAID"],"description":"Dynamic QR Code state.","example":"PENDING"},"summary":{"type":"string","description":"User defined payment ID.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"The party payment."},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay dynamic QR Code."},"created_at":{"format":"date-time","type":"string","description":"Dynamic QR Code created at.","example":"2026-05-29T19:41:08.588Z"}},"required":["id","key_id","state","description","created_at"]},"CreateQrCodeDynamicDueDateBody":{"type":"object","properties":{"key":{"type":"string","description":"PIX Key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"document_value":{"type":"number","description":"Value in R$ cents","example":2300},"due_date":{"type":"string","description":"Document due date.","example":"2026-05-29","format":"date"},"expiration_date":{"type":"string","description":"Expiration date to pay dynamic QR Code.","example":"2026-05-29","format":"date"},"summary":{"type":"string","description":"User friendly dynamic QR Code identifier.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"payer_city":{"type":"string","description":"Payer city (IBGE city code).","example":"2611606"},"payer_person_type":{"type":"string","description":"Person type:
\n ","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"LEGAL_PERSON"},"payer_document":{"type":"string","description":"Payer document number.","example":"78762893041"},"payer_name":{"type":"string","description":"Payer name.","example":"Jonh Doe"},"payer_email":{"type":"string","description":"Payer email.","example":"nobody@zrobank.biz"},"payer_phone":{"type":"string","description":"Payer phone.","example":"5581987654321"},"payer_address":{"type":"string","description":"Payer address.","example":"Main Street 1, 9."},"payer_request":{"type":"string","description":"Payer request.","example":"Send receipt to my email."}},"required":["key","document_value","due_date","description","payer_person_type","payer_document","payer_name"]},"CreateQrCodeDynamicDueDateRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Dynamic QR Code ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key_id":{"type":"string","description":"Associated key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","READY","ERROR","PAID"],"description":"Dynamic QR Code state.","example":"PENDING"},"summary":{"type":"string","description":"User defined payment ID.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"The party payment."},"due_date":{"format":"date-time","type":"string","description":"Due date to pay dynamic QR Code."},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay dynamic QR Code."},"created_at":{"format":"date-time","type":"string","description":"Dynamic QR Code created at.","example":"2026-05-29T19:41:08.589Z"}},"required":["id","key_id","state","description","created_at"]},"GetQrCodeDynamicByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Dynamic QR Code ID.","example":"abf6c3c6-f54b-4fbf-83ee-75ecf5f36c66"},"txid":{"type":"string","description":"Dynamic QR Code txID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"emv":{"type":"string","description":"EMV code.","example":"00020101021226910014br.gov.bcb.pix2569bankaddress.com.br/pix/v2/cob/8b358702141e4162bd68eedfe7fb45f4520400005303986540523.005802BR5924USER"},"expiration_date":{"format":"date-time","type":"string","description":"Dynamic QR Code expiration date.","example":"2026-05-29T19:41:08.589Z"},"key_id":{"type":"string","description":"Associated key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"description":{"type":"string","description":"User defined dynamic QR Code description.","example":"Dynamic QR Code to receive payment."},"state":{"type":"string","enum":["PENDING","READY","ERROR","PAID"],"description":"Dynamic QR Code state.","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Dynamic QR Code created at.","example":"2026-05-29T19:41:08.589Z"}},"required":["id","txid","emv","expiration_date","key_id","description","state","created_at"]},"GetAllQrCodeStaticRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Static QR Code ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"PIX txID.","example":"f6e2e08429b94935a0595473b"},"emv":{"type":"string","description":"EMV code.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key_id":{"type":"string","description":"Associated key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"summary":{"type":"string","description":"User defined payment ID.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"The party payment."},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay static QR Code. Max date is 3 months ahead.","example":"2026-05-29T19:41:08.586Z"},"payable_many_times":{"type":"boolean","description":"If it is true, static QR Code can be paid many times. When it is false, expiration date is required.","example":true},"state":{"type":"string","enum":["PENDING","READY","DELETING","DELETED","ERROR"],"description":"Static QR Code state.","example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Static QR Code created at.","example":"2026-05-29T19:41:08.586Z"}},"required":["id","txid","key_id","state","created_at"]},"GetAllQrCodeStaticRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Static QR Code data.","type":"array","items":{"$ref":"#/components/schemas/GetAllQrCodeStaticRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"CreateQrCodeStaticBody":{"type":"object","properties":{"key":{"type":"string","description":"PIX Key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"PIX txID.","example":"f6e2e08429b94935a0595473b"},"value":{"type":"number","description":"Value in R$ cents.","example":2300},"summary":{"type":"string","description":"User friendly static QR Code identifier.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay static QR Code. Max date is 3 months ahead.","example":"2026-05-29T19:41:08.490Z"},"payable_many_times":{"type":"boolean","description":"If it is true, static QR Code can be paid many times. When it is false, expiration date is required.","example":true},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["key"]},"CreateQrCodeStaticRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Static QR Code ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"PIX txID.","example":"f6e2e08429b94935a0595473b"},"emv":{"type":"string","description":"EMV code.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key_id":{"type":"string","description":"Associated key UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"summary":{"type":"string","description":"User defined payment ID.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay qrCode. Max date is 3 months ahead.","example":"2026-05-29T19:41:08.490Z"},"payable_many_times":{"type":"boolean","description":"If it is true, QrCode can be paid many times. When it is false, expiration date is required.","example":true},"state":{"type":"string","enum":["PENDING","READY","DELETING","DELETED","ERROR"],"description":"Static QR Code state.","example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Static QR Code created at.","example":"2026-05-29T19:41:08.491Z"}},"required":["id","txid","key_id","state","created_at"]},"CreateAsyncQrCodeStaticBody":{"type":"object","properties":{"key":{"type":"string","description":"PIX Key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"PIX txID.","example":"f6e2e08429b94935a0595473b"},"emv":{"type":"string","description":"EMV code.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"value":{"type":"number","description":"Value in R$ cents.","example":2300},"summary":{"type":"string","description":"User friendly static QR Code identifier.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay static QR Code. Max date is 3 months ahead.","example":"2026-05-29T19:41:08.492Z"},"payable_many_times":{"type":"boolean","description":"If it is true, static QR Code can be paid many times. When it is false, expiration date is required.","example":true},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["key","txid","emv"]},"CreateAsyncQrCodeStaticRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Static QR Code ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"PIX txID.","example":"f6e2e08429b94935a0595473b"},"emv":{"type":"string","description":"EMV code.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"PIX Key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"summary":{"type":"string","description":"User defined payment ID.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay qrCode. Max date is 3 months ahead.","example":"2026-05-29T19:41:08.492Z"},"payable_many_times":{"type":"boolean","description":"If it is true, QrCode can be paid many times. When it is false, expiration date is required.","example":true},"state":{"type":"string","enum":["PENDING","READY","DELETING","DELETED","ERROR"],"description":"Static QR Code state.","example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Static QR Code created at.","example":"2026-05-29T19:41:08.493Z"}},"required":["id","txid","emv","key","state"]},"GetByQrCodeStaticIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Static QR Code ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"PIX txID.","example":"f6e2e08429b94935a0595473b"},"emv":{"type":"string","description":"EMV code.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key_id":{"type":"string","description":"Associated key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"summary":{"type":"string","description":"User defined payment ID.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"The party payment."},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay static QR Code. Max date is 3 months ahead.","example":"2026-05-29T19:41:08.587Z"},"payable_many_times":{"type":"boolean","description":"If it is true, static QR Code can be paid many times. When it is false, expiration date is required.","example":true},"state":{"type":"string","enum":["PENDING","READY","DELETING","DELETED","ERROR"],"description":"Static QR Code state.","example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Static QR Code created at.","example":"2026-05-29T19:41:08.587Z"}},"required":["id","txid","key_id","state","created_at"]},"V2CreatePixKeyBody":{"type":"object","properties":{"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"}},"required":["type"]},"V2CreatePixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix Key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key Created At.","example":"2026-05-29T19:41:08.590Z"}},"required":["id","key","type","state","created_at"]},"ApprovePortabilityClaimStartProcessRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.590Z"}},"required":["id","key","type","state","created_at"]},"ApprovePortabilityClaimProcessRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.590Z"}},"required":["id","key","type","state","created_at"]},"CancelCodePixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.591Z"}},"required":["id","key","type","state","created_at"]},"CancelStartClaimProcessByIdPixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.591Z"}},"required":["id","key","type","state","created_at"]},"CancelStartPortabilityProcessByIdPixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.591Z"}},"required":["id","key","type","state","created_at"]},"CancelingPortabilityClaimProcessRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.592Z"}},"required":["id","key","type","state","created_at"]},"ApproveOwnershipClaimStartProcessRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.592Z"}},"required":["id","key","type","state","created_at"]},"CancelingOwnershipClaimProcessRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.592Z"}},"required":["id","key","type","state","created_at"]},"V2DeleteByIdPixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.592Z"}},"required":["id","key","type","state","created_at"]},"V2DismissByIdPixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix Key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"key":{"type":"string","description":"Pix key.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"state":{"type":"string","enum":["PENDING","CONFIRMED","NOT_CONFIRMED","ADD_KEY_READY","READY","CANCELED","ERROR","DELETING","DELETED","DELETED_ERROR","PORTABILITY_PENDING","PORTABILITY_OPENED","PORTABILITY_STARTED","PORTABILITY_READY","PORTABILITY_CONFIRMED","PORTABILITY_CANCELING","PORTABILITY_CANCELED","PORTABILITY_REQUEST_PENDING","PORTABILITY_REQUEST_CANCEL_OPENED","PORTABILITY_REQUEST_CANCEL_STARTED","PORTABILITY_REQUEST_CONFIRM_OPENED","PORTABILITY_REQUEST_CONFIRM_STARTED","PORTABILITY_REQUEST_AUTO_CONFIRMED","OWNERSHIP_PENDING","OWNERSHIP_OPENED","OWNERSHIP_STARTED","OWNERSHIP_CONFIRMED","OWNERSHIP_READY","OWNERSHIP_CANCELING","OWNERSHIP_CANCELED","OWNERSHIP_WAITING","OWNERSHIP_CONFLICT","CLAIM_NOT_CONFIRMED","CLAIM_PENDING","CLAIM_CLOSING","CLAIM_DENIED","CLAIM_CLOSED","CLAIM_READY"],"description":"Pix Key state:
\n ","example":"READY"},"created_at":{"format":"date-time","type":"string","description":"Pix Key created at.","example":"2026-05-29T19:41:08.686Z"}},"required":["id","key","type","state","created_at"]},"SplitAccountBody":{"type":"object","properties":{"person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Person type (NATURAL_PERSON or LEGAL_PERSON).","example":"NATURAL_PERSON"},"name":{"type":"string","description":"Name of the account holder.","example":"Maria da Silva"},"document":{"type":"string","description":"CPF or CNPJ of the account holder.","example":"12345678909"},"bank_ispb":{"type":"string","description":"Bank ISPB code.","example":"12345678"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"account_number":{"type":"string","description":"Account number.","example":"12345678"},"account_type":{"type":"string","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"description":"Account type.","example":"CACC"},"split_value":{"type":"number","description":"Split value. For PERCENTUAL: percentage (0-100). For ABSOLUTE: value in cents.","example":30}},"required":["person_type","name","document","bank_ispb","branch","account_number","account_type","split_value"]},"SplitBody":{"type":"object","properties":{"split_type":{"type":"string","enum":["PERCENTUAL","ABSOLUTE"],"description":"Split type (PERCENTUAL or ABSOLUTE).","example":"PERCENTUAL"},"accounts":{"description":"Array of accounts to receive split payments.","type":"array","items":{"$ref":"#/components/schemas/SplitAccountBody"}}},"required":["split_type","accounts"]},"CreateSplitPixQrCodeStaticBody":{"type":"object","properties":{"key_id":{"type":"string","description":"Associated key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"value":{"type":"number","description":"Value in R$ cents.","example":10000},"summary":{"type":"string","description":"User friendly static QR Code identifier.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay static QR Code. Max date is 3 months ahead.","example":"2026-05-29T19:41:08.996Z"},"payable_many_times":{"type":"boolean","description":"If it is true, static QR Code can be paid many times. When it is false, expiration date is required.","example":true},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"},"split":{"description":"Split configuration.","allOf":[{"$ref":"#/components/schemas/SplitBody"}]}},"required":["key_id","value","split"]},"CreateSplitPixQrCodeStaticRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Split QR Code ID.","example":"9a1c2d3e-4f56-4789-8abc-def012345678"},"key_id":{"type":"string","description":"Associated key ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","READY","ERROR"],"description":"Split QR Code state.","example":"PENDING"},"summary":{"type":"string","description":"User defined payment ID.","example":"party-payment"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date to pay static QR Code. When it is false, expiration date is required.","example":"2026-05-29T19:41:08.996Z"},"created_at":{"format":"date-time","type":"string","description":"Split QR Code created at.","example":"2026-05-29T19:41:08.996Z"}},"required":["id","key_id","state","created_at"]},"GetAllSplitPixPaymentHistoryRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Split payment history ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"deposit_id":{"type":"string","description":"Original deposit ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"deposit_end_to_end_id":{"type":"string","description":"Deposit end-to-end ID.","example":"E1234567820240101120000000000001"},"split_end_to_end_id":{"type":"string","description":"Split payment end-to-end ID.","example":"E1234567820240101120000000000002"},"split_operation_id":{"type":"string","description":"Split operation ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"Transaction ID from QR Code.","example":"txid1234567890abcde"},"payer_name":{"type":"string","description":"Payer name.","example":"John Doe"},"payer_person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Payer person type.","example":"LEGAL_PERSON"},"payer_document":{"type":"string","description":"Payer document (CPF/CNPJ).","example":"***456789**"},"payer_branch":{"type":"string","description":"Payer branch.","example":"0001"},"payer_account_number":{"type":"string","description":"Payer account number.","example":"12345678"},"payer_account_type":{"type":"string","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"description":"Payer account type.","example":"CACC"},"payer_bank_ispb":{"type":"string","description":"Payer bank ISPB.","example":"26264220"},"recipient_person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Recipient person type.","example":"NATURAL_PERSON"},"recipient_name":{"type":"string","description":"Recipient name.","example":"Jane Doe"},"recipient_document":{"type":"string","description":"Recipient document (CPF/CNPJ).","example":"***456789**"},"recipient_bank_ispb":{"type":"string","description":"Recipient bank ISPB.","example":"26264220"},"recipient_branch":{"type":"string","description":"Recipient branch.","example":"0001"},"recipient_account_number":{"type":"string","description":"Recipient account number.","example":"87654321"},"recipient_account_type":{"type":"string","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"description":"Recipient account type.","example":"CACC"},"total_deposit_amount":{"type":"number","description":"Total deposit amount in R$ cents.","example":10000},"split_amount":{"type":"number","description":"Split amount in R$ cents.","example":5000},"split_type":{"type":"string","enum":["PERCENTUAL","ABSOLUTE"],"description":"Split type.","example":"PERCENTUAL"},"split_value":{"type":"number","description":"Split value (percentage or absolute cents).","example":50},"state":{"type":"string","enum":["PENDING","PROCESSING","READY","FAILED"],"description":"Split payment state.","example":"READY"},"failed_message":{"type":"string","description":"Error returned when split payment failed.","example":"Could not process your request. Please try again.","nullable":true},"failed_code":{"type":"string","description":"Code error returned when split payment failed.","example":"NOT_ENOUGH_AVAILABLE_LIMIT","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Split pix payments history creation date.","example":"2026-05-29T19:41:08.997Z"},"updated_at":{"format":"date-time","type":"string","description":"Split pix payments history last update date.","example":"2026-05-29T19:41:08.997Z"}},"required":["id","deposit_id","deposit_end_to_end_id","txid","recipient_person_type","recipient_name","recipient_document","recipient_bank_ispb","recipient_branch","recipient_account_number","recipient_account_type","total_deposit_amount","split_amount","split_type","split_value","state","created_at","updated_at"]},"GetAllSplitPixPaymentHistoryRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Split payment history data.","type":"array","items":{"$ref":"#/components/schemas/GetAllSplitPixPaymentHistoryRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"DecodeQrCodeItemRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique decoded UUID.","example":"d5e0bec8-8695-4557-b0dd-021788cd83ef"},"key":{"type":"string","description":"Payment link's key."},"txid":{"type":"string","description":"Payment txid identifier."},"document_value":{"type":"number","description":"Document value.","example":1299},"recipient_name":{"type":"string","description":"Recipient name."},"recipient_person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Recipient person type.","example":"LEGAL_PERSON"},"recipient_document":{"type":"string","description":"Recipient document.","example":"***456789**"},"recipient_bank_name":{"type":"string","description":"Recipient bank name."},"recipient_bank_ispb":{"type":"string","description":"Recipient bank ispb."},"payment_value":{"type":"number","description":"Payment value.","example":1299},"expiration_date":{"format":"date-time","type":"string","description":"Expiration date.","example":"2026-05-29T19:41:08.398Z"},"payer_person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Payer person type value.","example":"LEGAL_PERSON"},"payer_document":{"type":"string","description":"Payer document.","example":"***456789**"},"payer_name":{"type":"string","description":"Payer name."},"due_date":{"format":"date-time","type":"string","description":"Due date.","example":"2026-05-29T19:41:08.398Z"},"interest_value":{"type":"number","description":"Interest value.","example":1299},"fine_value":{"type":"number","description":"Fine value.","example":1299},"deduction_value":{"type":"number","description":"Deduction value.","example":1299},"discount_value":{"type":"number","description":"Discount value.","example":1299},"state":{"type":"string","enum":["ERROR","PENDING","READY","CANCELED"],"description":"QR code state.","example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T19:41:08.398Z"},"change_value":{"type":"number","description":"Change value.","example":1299},"additional_infos":{"description":"Additional infos object. It is used on QRCODE DYNAMIC.","example":["{\"name\":\"Juros\",\"value\":\"10%\"}"],"type":"array","items":{"type":"string"}},"additional_info":{"type":"string","description":"Additional info. It is used on QRCODE STATIC."},"type":{"type":"string","enum":["QR_CODE_STATIC_INSTANT_PAYMENT","QR_CODE_STATIC_WITHDRAWAL","QR_CODE_DYNAMIC_DUE_DATE","QR_CODE_DYNAMIC_WITHDRAWAL","QR_CODE_DYNAMIC_CHANGE","QR_CODE_DYNAMIC_INSTANT_PAYMENT","QR_CODE_COMPOSITE_PAYMENT"],"description":"QR code type.","example":"QR_CODE_STATIC_WITHDRAWAL"},"payment_type":{"type":"string","enum":["ACCOUNT","KEY","QR_CODE","QR_CODE_STATIC_INSTANT","QR_CODE_STATIC_WITHDRAWAL","QR_CODE_DYNAMIC_DUE_DATE","QR_CODE_DYNAMIC_WITHDRAWAL","QR_CODE_DYNAMIC_CHANGE","QR_CODE_DYNAMIC_INSTANT","REFUND","AUTOMATIC_PAYMENT","OPEN_FINANCE"],"description":"Payment Type.","example":"QR_CODE_DYNAMIC_INSTANT"},"allow_update":{"type":"boolean","description":"Is document value updating allowed?","example":true},"withdraw_value":{"type":"number","description":"Withdrawal value.","example":1299}},"required":["id","key","txid","document_value","recipient_name","recipient_person_type","recipient_document","recipient_bank_name","recipient_bank_ispb","state","created_at","type","payment_type"]},"DecodedQrCompositeHistoryItem":{"type":"object","properties":{}},"DecodeCompositeQrCodeItemRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique decoded composite qr code UUID.","example":"d5e0bec8-8695-4557-b0dd-021788cd83ef"},"journey":{"type":"string","enum":["JOURNEY_1","JOURNEY_2","JOURNEY_3","JOURNEY_4"],"description":"Composite qr code journey.","example":"JOURNEY_2"},"recurrence_id":{"type":"string","description":"Composite qr code journey.","example":"d5e0bec8-8695-4557-b0dd-021788cd83ef"},"frequency":{"type":"string","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"description":"Recurrence frequency.","example":"WEEKLY"},"start_date":{"type":"string","description":"Recurrence start date.","example":"2026-05-29","format":"date"},"end_date":{"type":"string","description":"Recurrence end date.","example":"2026-05-29","format":"date"},"value":{"type":"number","description":"Recurrence value.","example":1000},"floor_max_value":{"type":"number","description":"Recurrence floor max value.","example":1000},"beneficiary_ispb":{"type":"string","description":"Recurrence beneficiary ISPB.","example":"31432132"},"beneficiary_document":{"type":"string","description":"Recurrence beneficiary document.","example":"12345678901"},"beneficiary_name":{"type":"string","description":"Recurrence beneficiary name.","example":"John Doe"},"debtor_document":{"type":"string","description":"Recipient debtor document.","example":"12345678901"},"debtor_name":{"type":"string","description":"Recurrence debtor name.","example":"John Doe"},"debtor_person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Recurrence debtor person type.","example":"NATURAL_PERSON"},"contract_number":{"type":"string","description":"Recurrence contract number.","example":"1235434534"},"contract_description":{"type":"string","description":"Recurrence contract description.","example":"Recurrence payment for any company."},"state":{"type":"string","enum":["ERROR","PENDING","READY","CANCELED"],"description":"Composite QR code state.","example":"PENDING"},"retry":{"type":"string","enum":["NOT_ALLOWED","ALLOWED"],"description":"Recurrency retry.","example":"ALLOWED"},"history":{"description":"Recurrence history.","type":"array","items":{"$ref":"#/components/schemas/DecodedQrCompositeHistoryItem"}},"receiver_psp_url":{"type":"string","description":"Recurrence receiver psp url.","example":"test.com/TEST/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8="},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T19:41:08.398Z"}},"required":["id","journey","recurrence_id","frequency","start_date","beneficiary_ispb","beneficiary_document","beneficiary_name","debtor_document","debtor_name","debtor_person_type","contract_number","state","retry","created_at"]},"V2DecodeQrCodeRestResponse":{"type":"object","properties":{"qr_code":{"description":"Qr code response.","allOf":[{"$ref":"#/components/schemas/DecodeQrCodeItemRestResponse"}]},"composite_qr_code":{"description":"Composite qr code response.","allOf":[{"$ref":"#/components/schemas/DecodeCompositeQrCodeItemRestResponse"}]}}},"CreateDecodedPixKeyRestResponse$1":{"type":"object","properties":{"id":{"type":"string","description":"Unique decoded pix key UUID.","example":"d5e0bec8-8695-4557-b0dd-021788cd83ef"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"LEGAL_PERSON"},"key":{"type":"string","description":"Pix key."},"document":{"type":"string","description":"Owner document number."},"name":{"type":"string","description":"Owner name."},"trade_name":{"type":"string","description":"Company's trade name."},"end_to_end_id":{"type":"string"},"ispb":{"type":"string","description":"Bank ISPB."},"bank_name":{"type":"string","description":"Bank name."}},"required":["id","type","person_type","key","document","name","end_to_end_id","ispb","bank_name"]},"CreateDecodedPixAccountBody":{"type":"object","properties":{"person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Person type:
\n ","example":"NATURAL_PERSON"},"document":{"type":"string","description":"Person's document (CPF or CNPJ).","example":"00000000000"},"bank_ispb":{"type":"string","description":"Bank ISPB code (8 digits)"},"branch":{"type":"string","description":"Account branch (4 digits)."},"account_number":{"type":"string","description":"Account number (between 2 and 20 digits)."},"account_type":{"type":"string","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"description":"Account type:
\n ","example":"CACC"}},"required":["person_type","document","bank_ispb","branch","account_number"]},"CreateDecodedPixAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix decoded account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Person full name or company tax name.","example":"Zro Pagamentos S.A."},"trade_name":{"type":"string","description":"Company trade name.","example":"Zro Global"}},"required":["id","name"]},"CancelPixScheduledPaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"description":"Payment account type.","example":"CACC"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"CANCELED"},"created_at":{"format":"date-time","type":"string","description":"Payment created at.","example":"2026-05-29T19:41:08.392Z"},"canceled_at":{"format":"date-time","type":"string","description":"Payment canceled at.","example":"2026-05-29T19:41:08.392Z"},"payment_date":{"format":"date-time","type":"string","description":"Payment date.","example":"2026-05-29T19:41:08.392Z"}},"required":["id","type","state","created_at","canceled_at","payment_date"]},"PaymentByWithdrawalQrCodeStaticBody":{"type":"object","properties":{"decoded_qr_code_id":{"type":"string","description":"Decoded qr code ID.","example":"abb8e578-6540-4104-8fa9-90a854ab0d1c"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["decoded_qr_code_id"]},"WithdrawalByQrCodeStaticPaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. This will not be returned if the payment was scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"format":"date-time","type":"string","description":"Schedule a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"description":{"type":"string","description":"User defined payment description.","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.393Z"}},"required":["id","state","value","created_at"]},"PaymentByWithdrawalQrCodeDynamicBody":{"type":"object","properties":{"decoded_qr_code_id":{"type":"string","description":"Decoded qr code ID.","example":"abb8e578-6540-4104-8fa9-90a854ab0d1c"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["decoded_qr_code_id"]},"WithdrawalByQrCodeDynamicPaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. This will not be returned if the payment was scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"format":"date-time","type":"string","description":"Schedule a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"description":{"type":"string","description":"User defined payment description.","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.394Z"}},"required":["id","state","value","created_at"]},"PaymentByDuedateQrCodeDynamicBody":{"type":"object","properties":{"decoded_qr_code_id":{"type":"string","description":"Decoded qr code ID.","example":"abb8e578-6540-4104-8fa9-90a854ab0d1c"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["decoded_qr_code_id"]},"DuedateByQrCodeDynamicPaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. This will not be returned if the payment was scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"format":"date-time","type":"string","description":"Duedate a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"description":{"type":"string","description":"User defined payment description.","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.394Z"}},"required":["id","state","value","created_at"]},"PaymentByChangeQrCodeDynamicBody":{"type":"object","properties":{"decoded_qr_code_id":{"type":"string","description":"Decoded qr code ID.","example":"abb8e578-6540-4104-8fa9-90a854ab0d1c"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["decoded_qr_code_id"]},"ChangeByQrCodeDynamicPaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. This will not be returned if the payment was scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"change_operation_id":{"type":"string","description":"Change Operation UUID. This will not be returned if the payment was scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"format":"date-time","type":"string","description":"Schedule a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"description":{"type":"string","description":"User defined payment description.","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.395Z"}},"required":["id","state","value","created_at"]},"PaymentByQrCodeDynamicBody":{"type":"object","properties":{"decoded_qr_code_id":{"type":"string","description":"Decoded qr code ID.","example":"abb8e578-6540-4104-8fa9-90a854ab0d1c"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"type":"string","description":"Payment date.","format":"date","example":"2026-05-29"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["decoded_qr_code_id"]},"CreateByQrCodeDynamicPaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. This will not be returned if the payment was scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"format":"date-time","type":"string","description":"Schedule a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.396Z"}},"required":["id","state","value","created_at"]},"PaymentByQrCodeStaticBody":{"type":"object","properties":{"decoded_qr_code_id":{"type":"string","description":"Decoded qr code ID.","example":"abb8e578-6540-4104-8fa9-90a854ab0d1c"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"type":"string","description":"Payment date.","format":"date","example":"2026-05-29"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["decoded_qr_code_id"]},"CreateByQrCodeStaticPaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. This will not be returned if the payment was scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"format":"date-time","type":"string","description":"Schedule a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.393Z"}},"required":["id","state","value","created_at"]},"V3PaymentByAccountBody":{"type":"object","properties":{"person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Person type:
\n ","example":"NATURAL_PERSON"},"document":{"type":"string","description":"Person's document (CPF or CNPJ).","example":"00000000000"},"name":{"type":"string","description":"Person's name or Company name.","example":"John Doe"},"bank_ispb":{"type":"string","description":"Beneficiary’s bank ISPB. Unlike the 3-digit bank code, the ISPB is an 8-digit internal code of the brazilian financial system used for transactions between banks and fintechs. Click here to check the ISPB of the institutions participating in Pix.","example":"26264220"},"branch":{"type":"string","description":"Account branch (4 digits)."},"account_number":{"type":"string","description":"Account number (between 1 and 20 digits)."},"account_type":{"type":"string","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"description":"Account type:
\n ","example":"CACC"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"type":"string","description":"Payment date.","format":"date","example":"2026-05-29"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["person_type","document","name","bank_ispb","branch","account_number","account_type","value"]},"V3CreateByAccountPaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. Used to get receipt and track the transaction. This will not be returned if the payment has been scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"format":"date-time","type":"string","description":"Schedule a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"description":{"type":"string","description":"User defined payment description.","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.220Z"}},"required":["id","state","value","created_at"]},"CreatePaymentByPixKeyBody":{"type":"object","properties":{"decoded_pix_key_id":{"type":"string","description":"Decoded pix key ID.","example":"abb8e578-6540-4104-8fa9-90a854ab0d1c"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"type":"string","description":"Payment date.","format":"date","example":"2026-05-29"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["decoded_pix_key_id","value"]},"CreateByPixKeyPaymentRestResponse$1":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. Used to get receipt and track the transaction. This will not be returned if the payment has been scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"format":"date-time","type":"string","description":"Schedule a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"description":{"type":"string","description":"User defined payment description.","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.287Z"}},"required":["id","state","value","created_at"]},"DecodeAndCreatePaymentByPixKeyBody":{"type":"object","properties":{"key":{"type":"string","description":"Pix key."},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"type":"string","description":"Payment date.","format":"date","example":"2026-05-29"},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"},"document_allowed":{"type":"string","description":"User defined allowed document.","example":"06112135086"},"bank_allowlist":{"description":"User defined bank allowlist.","example":["0011223344"],"type":"array","items":{"type":"string"}},"bank_blocklist":{"description":"User defined bank blocklist.","example":["0011223344"],"type":"array","items":{"type":"string"}}},"required":["key","type","value"]},"CreateDecodedPixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique decoded pix key UUID.","example":"d5e0bec8-8695-4557-b0dd-021788cd83ef"},"type":{"type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"description":"Pix Key state:
\n ","example":"EMAIL"},"person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"LEGAL_PERSON"},"key":{"type":"string","description":"Pix key."},"document":{"type":"string","description":"Owner document number."},"name":{"type":"string","description":"Owner name."},"trade_name":{"type":"string","description":"Company's trade name."},"end_to_end_id":{"type":"string"},"ispb":{"type":"string","description":"Bank ISPB."},"bank_name":{"type":"string","description":"Bank name."}},"required":["id","type","person_type","key","document","name","end_to_end_id","ispb","bank_name"]},"CreateByPixKeyPaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. Used to get receipt and track the transaction. This will not be returned if the payment has been scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"value":{"type":"number","description":"Value in R$ cents.","example":1299},"payment_date":{"format":"date-time","type":"string","description":"Schedule a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"description":{"type":"string","description":"User defined payment description.","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.306Z"}},"required":["id","state","value","created_at"]},"DecodeAndCreateByPixKeyPaymentRestResponse":{"type":"object","properties":{"decoded_pix_key":{"description":"Decoded Pix Key response.","allOf":[{"$ref":"#/components/schemas/CreateDecodedPixKeyRestResponse"}]},"payment":{"description":"Payment response. If Decoded does not exist, this will be returned null.","allOf":[{"$ref":"#/components/schemas/CreateByPixKeyPaymentRestResponse"}]},"failed_code":{"type":"string","enum":["DOCUMENT_NOT_ALLOWED","BANK_NOT_ALLOWLIST","BANK_IN_BLACKLIST"],"description":"Reason that decoded pix key is invalid. Check this field to know if decoded and payment are valid."}}},"CreatePixDevolutionBody":{"type":"object","properties":{"operation_id":{"type":"string","description":"Charge back the operation ID listed on the credit statement.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Value in R$ cents. Should be less or equal then credit transacation.","example":2300,"minimum":1},"description":{"type":"string","description":"User defined payment description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["operation_id","amount"]},"CreatePixDevolutionRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Devolution ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Value in R$ cents.","example":1299},"description":{"type":"string","description":"User defined devolution description.","example":"User defined description"},"state":{"type":"string","enum":["PENDING","WAITING","WAITING_DELAYED","CONFIRMED","ERROR","FAILED","CANCELED"],"description":"Devolution state.","example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Devolution created at.","example":"2026-05-29T19:41:08.221Z"}},"required":["id","amount","state","created_at"]},"V4GetAllPaymentRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. Used to get receipt and track the transaction. This will not be returned if the payment has been scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","description":"Transaction type.","enum":["DEVOLUTION_COMPLETED","DEVOLUTION_RECEIVED","DEPOSIT_RECEIVED","PAYMENT_COMPLETED","WALLET_ACCOUNT_BALANCE_UPDATED"]},"state":{"type":"string","description":"Payment state.","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"]},"end_to_end_id":{"type":"string","description":"End to end id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Value in R$ cents.","example":1299},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"owner_document":{"type":"string","description":"The payment owner document."},"owner_bank_name":{"type":"string","description":"The payment owner bank name."},"owner_bank_ispb":{"type":"string","description":"The payment owner bank ispb."},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"beneficiary_bank_ispb":{"type":"string","description":"The payment beneficiary bank ispb."},"created_at":{"format":"date-time","type":"string","description":"Date of created payment.","example":"2026-05-29T19:41:08.294Z"}},"required":["id","type","state","end_to_end_id","amount","owner_person_type","owner_bank_name","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V4GetAllPaymentRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Payments data.","type":"array","items":{"$ref":"#/components/schemas/V4GetAllPaymentRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V5GetAllPixDepositRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Deposit ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","description":"Transaction type.","enum":["DEVOLUTION_COMPLETED","DEVOLUTION_RECEIVED","DEPOSIT_RECEIVED","PAYMENT_COMPLETED"]},"state":{"type":"string","enum":["NEW","RECEIVED","WAITING","WAITING_ANTIFRAUD","ERROR","BLOCKED"],"description":"Deposit state.","example":"RECEIVED"},"end_to_end_id":{"type":"string","description":"End to end id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Deposit R$ in cents.","example":1299},"available_amount":{"type":"number","description":"Deposit available amount.","example":1299},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person document type.","enum":["CPF","CNPJ"]},"owner_document":{"type":"string","description":"The payment owner document."},"owner_bank_name":{"type":"string","description":"The payment owner bank name."},"owner_bank_ispb":{"type":"string","description":"The payment owner bank ispb."},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_account_number":{"type":"string","description":"The payment beneficiary account number.","example":"12376786"},"beneficiary_branch_number":{"type":"string","description":"The payment beneficiary account branch number.","example":"12376786"},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person document type.","enum":["CPF","CNPJ"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"beneficiary_bank_ispb":{"type":"string","description":"The payment beneficiary bank ispb."},"created_at":{"format":"date-time","type":"string","description":"Deposit created at.","example":"2026-05-29T19:41:08.296Z"}},"required":["id","operation_id","type","state","end_to_end_id","amount","available_amount","owner_person_type","owner_bank_name","beneficiary_account_number","beneficiary_branch_number","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V5GetAllPixDepositRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"PixDeposits data.","type":"array","items":{"$ref":"#/components/schemas/V5GetAllPixDepositRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V6GetAllPixDepositRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Deposit ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","description":"Transaction type.","enum":["DEVOLUTION_COMPLETED","DEVOLUTION_RECEIVED","DEPOSIT_RECEIVED","PAYMENT_COMPLETED"]},"state":{"type":"string","enum":["NEW","RECEIVED","WAITING","WAITING_ANTIFRAUD","ERROR","BLOCKED"],"description":"Deposit state.","example":"RECEIVED"},"end_to_end_id":{"type":"string","description":"End to end id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Deposit R$ in cents.","example":1299},"available_amount":{"type":"number","description":"Deposit available amount.","example":1299},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person document type.","enum":["CPF","CNPJ"]},"owner_document":{"type":"string","description":"The payment owner document."},"owner_bank_name":{"type":"string","description":"The payment owner bank name."},"owner_bank_ispb":{"type":"string","description":"The payment owner bank ispb."},"owner_account_number":{"type":"string","description":"The payment owner account number."},"owner_branch_number":{"type":"string","description":"The payment owner branch number."},"owner_account_type":{"type":"string","description":"The payment owner account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"]},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_account_number":{"type":"string","description":"The payment beneficiary account number.","example":"12376786"},"beneficiary_branch_number":{"type":"string","description":"The payment beneficiary account branch number.","example":"12376786"},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person document type.","enum":["CPF","CNPJ"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"beneficiary_bank_ispb":{"type":"string","description":"The payment beneficiary bank ispb."},"created_at":{"format":"date-time","type":"string","description":"Deposit created at.","example":"2026-05-29T19:41:08.297Z"}},"required":["id","operation_id","type","state","end_to_end_id","amount","available_amount","owner_person_type","owner_bank_name","beneficiary_account_number","beneficiary_branch_number","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V6GetAllPixDepositRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"PixDeposits data.","type":"array","items":{"$ref":"#/components/schemas/V6GetAllPixDepositRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V3GetAllPixDevolutionRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Devolution ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"description":{"type":"string","description":"User defined devolution description.","example":"The party devolution."},"failed_message":{"type":"string","description":"Error returned when devolution is reverted.","example":"Não foi possível processar o seu pedido. Por favor tente novamente.","nullable":true},"operation_id":{"type":"string","description":"Operation UUID. Used to get receipt and track the transaction.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","description":"Transaction type.","enum":["DEVOLUTION_COMPLETED","DEVOLUTION_RECEIVED","DEPOSIT_RECEIVED","PAYMENT_COMPLETED","WALLET_ACCOUNT_BALANCE_UPDATED"]},"end_to_end_id":{"type":"string","description":"End to End ID."},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Value in R$ cents.","example":1299},"state":{"type":"string","enum":["PENDING","WAITING","WAITING_DELAYED","CONFIRMED","ERROR","FAILED","CANCELED"],"description":"Devolution state.","example":"CONFIRMED"},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person type.","enum":["CPF","CNPJ"]},"owner_document":{"type":"string","description":"The payment owner document."},"owner_bank_name":{"type":"string","description":"The payment owner bank name."},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person type.","enum":["CPF","CNPJ"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"created_at":{"format":"date-time","type":"string","description":"Devolution created at.","example":"2026-05-29T19:41:08.298Z"}},"required":["id","operation_id","type","amount","state","owner_person_type","owner_bank_name","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V3GetAllPixDevolutionRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"PixDevolutions data.","type":"array","items":{"$ref":"#/components/schemas/V3GetAllPixDevolutionRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V3GetAllPixDevolutionReceivedRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Devolution ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"description":{"type":"string","description":"User defined devolution description.","example":"The party devolution received."},"state":{"type":"string","enum":["READY","ERROR"],"description":"Devolution state.","example":"READY"},"operation_id":{"type":"string","description":"Operation UUID. Used to get receipt and track the transaction.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","description":"Transaction type.","enum":["DEVOLUTION_COMPLETED","DEVOLUTION_RECEIVED","DEPOSIT_RECEIVED","PAYMENT_COMPLETED","WALLET_ACCOUNT_BALANCE_UPDATED"]},"end_to_end_id":{"type":"string","description":"End to End ID."},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Value in R$ cents.","example":1299},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person type.","enum":["CPF","CNPJ"]},"owner_document":{"type":"string","description":"The payment owner document."},"owner_bank_name":{"type":"string","description":"The payment owner bank name."},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person type.","enum":["CPF","CNPJ"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"created_at":{"format":"date-time","type":"string","description":"Devolution received created at.","example":"2026-05-29T19:41:08.299Z"}},"required":["id","state","operation_id","type","amount","owner_person_type","owner_bank_name","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V3GetAllPixDevolutionReceivedRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"PixDevolutionReceiveds data.","type":"array","items":{"$ref":"#/components/schemas/V3GetAllPixDevolutionReceivedRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V5GetPaymentByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. Used to get receipt and track the transaction. This will not be returned if the payment has been scheduled.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"description":"Payment state.","example":"PENDING"},"end_to_end_id":{"type":"string","description":"End to end id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Value in R$ cents.","example":1299},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"owner_document":{"type":"string","description":"The payment owner document."},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"beneficiary_bank_ispb":{"type":"string","description":"The payment beneficiary bank ispb."},"payment_date":{"format":"date-time","type":"string","description":"Schedule a day to execute payment. Use null to send payment right now.","example":null,"nullable":true},"description":{"type":"string","description":"User defined payment description.","nullable":true},"failed_code":{"type":"string","description":"Error code returned when payment is reverted.","example":"AG03","nullable":true},"failed_message":{"type":"string","description":"Error description returned when payment is reverted.","example":"Pagamento rejeitado pelo PSP do recebedor","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T19:41:08.303Z"},"merchant_id":{"type":"string","description":"Merchant ID. This will be returned if the payment has been processed by a merchant.","example":"1234567890"}},"required":["id","state","end_to_end_id","amount","owner_person_type","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V4GetByPixDevolutionIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Devolution ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"description":{"type":"string","description":"User defined devolution description.","example":"The party devolution."},"failed_message":{"type":"string","description":"Error returned when devolution is reverted.","example":"Não foi possível processar o seu pedido. Por favor tente novamente.","nullable":true},"operation_id":{"type":"string","description":"Operation UUID. Used to get receipt and track the transaction.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"end_to_end_id":{"type":"string","description":"End to End ID."},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Value in R$ cents.","example":1299},"state":{"type":"string","enum":["PENDING","WAITING","WAITING_DELAYED","CONFIRMED","ERROR","FAILED","CANCELED"],"description":"Devolution state.","example":"CONFIRMED"},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person type.","enum":["CPF","CNPJ"]},"owner_document":{"type":"string","description":"The payment owner document."},"owner_bank_name":{"type":"string","description":"The payment owner bank name."},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person type.","enum":["CPF","CNPJ"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"created_at":{"format":"date-time","type":"string","description":"Devolution created at.","example":"2026-05-29T19:41:08.399Z"}},"required":["id","operation_id","amount","state","owner_person_type","owner_bank_name","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V3GetPixDepositByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Deposit ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["NEW","RECEIVED","WAITING","WAITING_ANTIFRAUD","ERROR","BLOCKED"],"description":"Deposit state.","example":"RECEIVED"},"end_to_end_id":{"type":"string","description":"End to end id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Deposit R$ in cents.","example":1299},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person document type.","enum":["CPF","CNPJ"]},"owner_document":{"type":"string","description":"The payment owner document."},"owner_bank_name":{"type":"string","description":"The payment owner bank name."},"owner_bank_ispb":{"type":"string","description":"The payment owner bank ispb."},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_account_number":{"type":"string","description":"The payment beneficiary account number.","example":"12376786"},"beneficiary_branch_number":{"type":"string","description":"The payment beneficiary account branch number.","example":"12376786"},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person document type.","enum":["CPF","CNPJ"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"beneficiary_bank_ispb":{"type":"string","description":"The payment beneficiary bank ispb."},"created_at":{"format":"date-time","type":"string","description":"Deposit created at.","example":"2026-05-29T19:41:08.302Z"}},"required":["id","operation_id","state","end_to_end_id","amount","owner_person_type","owner_bank_name","beneficiary_account_number","beneficiary_branch_number","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V4GetPixDepositByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Deposit ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["NEW","RECEIVED","WAITING","WAITING_ANTIFRAUD","ERROR","BLOCKED"],"description":"Deposit state.","example":"RECEIVED"},"end_to_end_id":{"type":"string","description":"End to end id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Deposit R$ in cents.","example":1299},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person document type.","enum":["CPF","CNPJ"]},"owner_document":{"type":"string","description":"The payment owner document."},"owner_bank_name":{"type":"string","description":"The payment owner bank name."},"owner_bank_ispb":{"type":"string","description":"The payment owner bank ispb."},"owner_account_number":{"type":"string","description":"The payment owner account number."},"owner_branch_number":{"type":"string","description":"The payment owner branch number."},"owner_account_type":{"type":"object","description":"The payment owner account type."},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_account_number":{"type":"string","description":"The payment beneficiary account number.","example":"12376786"},"beneficiary_branch_number":{"type":"string","description":"The payment beneficiary account branch number.","example":"12376786"},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person document type.","enum":["CPF","CNPJ"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"beneficiary_bank_ispb":{"type":"string","description":"The payment beneficiary bank ispb."},"created_at":{"format":"date-time","type":"string","description":"Deposit created at.","example":"2026-05-29T19:41:08.302Z"}},"required":["id","operation_id","state","end_to_end_id","amount","owner_person_type","owner_bank_name","beneficiary_account_number","beneficiary_branch_number","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V2GetByPixDevolutionReceivedIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Devolution ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"description":{"type":"string","description":"User defined devolution description.","example":"The party devolution received."},"state":{"type":"string","enum":["READY","ERROR"],"description":"Devolution state.","example":"READY"},"operation_id":{"type":"string","description":"Operation UUID. Used to get receipt and track the transaction.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"original_id":{"type":"string","description":"Original Payment ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"original_end_to_end_id":{"type":"string","description":"Original Payment End to End ID."},"end_to_end_id":{"type":"string","description":"End to End ID."},"txid":{"type":"string","description":"Payment txid identifier.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount":{"type":"number","description":"Value in R$ cents.","example":1299},"owner_name":{"type":"string","description":"The payment owner name."},"owner_person_type":{"type":"string","description":"The payment owner person type.","enum":["CPF","CNPJ"]},"owner_document":{"type":"string","description":"The payment owner document."},"owner_bank_name":{"type":"string","description":"The payment owner bank name."},"beneficiary_name":{"type":"string","description":"The payment beneficiary name."},"beneficiary_person_type":{"type":"string","description":"The payment beneficiary person type.","enum":["CPF","CNPJ"]},"beneficiary_document":{"type":"string","description":"The payment beneficiary document."},"beneficiary_bank_name":{"type":"string","description":"The payment beneficiary bank name."},"created_at":{"format":"date-time","type":"string","description":"Devolution received created at.","example":"2026-05-29T19:41:08.302Z"}},"required":["id","state","operation_id","amount","owner_person_type","owner_bank_name","beneficiary_person_type","beneficiary_bank_name","created_at"]},"CreatePixTrustedContactBody":{"type":"object","properties":{"name":{"type":"string","description":"Pix trusted contact name.","example":"John Doe"},"document":{"type":"string","description":"Pix trusted contact CPF or company CNPJ (only numbers)","example":"12345678900"},"person_type":{"type":"string","description":"Pix trusted contact person type:
\n ","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"branch_number":{"type":"string","description":"Pix trusted contact branch number.","example":"0001"},"account_number":{"type":"string","description":"Pix trusted contact account number.","example":"12345678"},"account_type":{"type":"string","description":"Pix trusted contact account type.","example":"CACC","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"]},"bank_ispb":{"type":"string","description":"Pix trusted contact bank ISPB.","example":"12345678"},"bank_name":{"type":"string","description":"Pix trusted contact bank name.","example":"Any Bank"}},"required":["name","document","person_type","branch_number","account_number","account_type","bank_ispb","bank_name"]},"CreatePixTrustedContactRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix trusted contact ID.","example":"56007975-3e29-4b57-b5b9-d32d331fd820"},"created_at":{"format":"date-time","type":"string","description":"Pix trusted contact created date.","example":"2026-05-29T19:41:08.400Z"}},"required":["id"]},"GetPixTrustedContactByIdAndWalletRestResponse":{"type":"object","properties":{"name":{"type":"string","description":"Pix Trusted Contact name.","example":"John Doe"},"document":{"type":"string","description":"Pix Trusted Contact document.","example":"12345678900"},"person_type":{"type":"string","description":"Pix Trusted Contact person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"account_number":{"type":"string","description":"Pix Trusted Contact account number.","example":"12345678"},"account_type":{"type":"string","description":"Pix Trusted Contact account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"branch_number":{"type":"string","description":"Pix Trusted Contact branch number.","example":"0001"},"bank_name":{"type":"string","description":"Pix Trusted Contact bank name.","example":"Any Bank"},"bank_ispb":{"type":"string","description":"Pix Trusted Contact bank ISPB.","example":"12345678"},"created_at":{"format":"date-time","type":"string","description":"Pix Trusted Contact created at.","example":"2026-05-29T19:41:08.400Z"},"updated_at":{"format":"date-time","type":"string","description":"Pix Trusted Contact updated at.","example":"2026-05-29T19:41:08.400Z"}},"required":["name","document","person_type","account_number","account_type","branch_number","bank_name","bank_ispb","created_at","updated_at"]},"GetAllPixTrustedContactByWalletRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Pix Trusted Contact ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Pix Trusted Contact name.","example":"John Doe"},"document":{"type":"string","description":"Pix Trusted Contact document.","example":"12345678900"},"person_type":{"type":"string","description":"Pix Trusted Contact person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"account_number":{"type":"string","description":"Pix Trusted Contact account number.","example":"12345678"},"account_type":{"type":"string","description":"Pix Trusted Contact account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"branch_number":{"type":"string","description":"Pix Trusted Contact branch number.","example":"0001"},"bank_name":{"type":"string","description":"Pix Trusted Contact bank name.","example":"Any Bank"},"bank_ispb":{"type":"string","description":"Pix Trusted Contact bank ISPB.","example":"12345678"},"created_at":{"format":"date-time","type":"string","description":"Pix Trusted Contact created at.","example":"2026-05-29T19:41:08.401Z"},"updated_at":{"format":"date-time","type":"string","description":"Pix Trusted Contact updated at.","example":"2026-05-29T19:41:08.401Z"}}},"GetAllPixTrustedContactByWalletRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"PixTrustedContact data.","type":"array","items":{"$ref":"#/components/schemas/GetAllPixTrustedContactByWalletRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetAllWarningPixDepositRestResponseItem":{"type":"object","properties":{"id":{"type":"string","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"transaction_tag":{"type":"string","description":"Transaction tag.","example":"PIXREC"},"state":{"type":"string","enum":["CREATED","APPROVED","REJECTED","APPROVED_BY_USER"],"description":"Warning pix deposit state.","example":"CREATED"},"rejected_reason":{"type":"string","description":"Warning pix deposit rejected reason.","example":null,"nullable":true},"amount":{"type":"number","description":"Pix deposit amount.","example":10000,"nullable":true},"third_part_name":{"type":"string","description":"Pix deposit payer name.","example":"João Silva","nullable":true},"failed_checks":{"description":"List of failed validation checks that triggered the warning.","example":["is_duplicated","is_suspect_cpf"],"nullable":true,"type":"array","items":{"type":"string"}},"created_at":{"format":"date-time","type":"string","description":"Date of created Warning Pix Deposit.","example":"2026-05-29T19:41:08.402Z"},"updated_at":{"format":"date-time","type":"string","description":"Date of updated Warning Pix Deposit.","example":"2026-05-29T19:41:08.402Z"}},"required":["id","operation_id","transaction_tag","state","created_at","updated_at"]},"GetAllWarningPixDepositRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Warning Pix Deposits data.","type":"array","items":{"$ref":"#/components/schemas/GetAllWarningPixDepositRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V2CreateConversionBody":{"type":"object","properties":{"quotation_id":{"type":"string","description":"Quotation ID to convert.","example":"abb8e578-6540-4104-8fa9-90a854ab0d1c"}},"required":["quotation_id"]},"V2CreateConversionRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Conversion ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation ID conversion.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"created_at":{"format":"date-time","type":"string","description":"Conversion created at.","example":"2026-05-29T19:41:08.002Z"}},"required":["id","operation_id","created_at"]},"V3GetAllConversionRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Conversion UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. Used to track the conversion.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"quotation_id":{"type":"string","description":"Quotation UUID. Used to track the quotation for this conversion.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"price":{"type":"number","description":"Conversion price."},"side":{"type":"string","enum":["buy","sell"],"description":"Conversion side.","example":"buy"},"quote_amount":{"type":"number","description":"Conversion quote amount."},"quote_currency_symbol":{"type":"string","description":"Conversion quote currency symbol.","example":"BRL"},"quote_currency_decimal":{"type":"number","description":"Conversion quote currency decimal.","example":2},"quote_currency_title":{"type":"string","description":"Conversion quote currency title.","example":"Real"},"base_amount":{"type":"number","description":"Conversion base amount."},"base_currency_symbol":{"type":"string","description":"Conversion base currency symbol.","example":"BTC"},"base_currency_decimal":{"type":"number","description":"Conversion base currency decimal.","example":8},"base_currency_title":{"type":"string","description":"Conversion base currency title.","example":"Real"},"created_at":{"format":"date-time","type":"string","description":"Conversion created at.","example":"2026-05-29T19:41:08.005Z"}},"required":["id","operation_id","price","side","quote_amount","quote_currency_symbol","quote_currency_decimal","quote_currency_title","base_amount","base_currency_symbol","base_currency_decimal","base_currency_title"]},"V3GetAllConversionRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Conversion data.","type":"array","items":{"$ref":"#/components/schemas/V3GetAllConversionRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V2GetConversionCreditByUserRestResponse":{"type":"object","properties":{"liability":{"type":"number","description":"Libability (Sum of all negative balances of all active currencies).","example":-1000},"credit_balance":{"type":"number","description":"Credit balance for user.","example":10000}},"required":["liability","credit_balance"]},"GetQuotationByConversionIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Quotation ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"price_buy":{"type":"number","description":"Quotation price buy."},"price_sell":{"type":"number","description":"Quotation price sell."},"side":{"type":"string","enum":["buy","sell"],"description":"Quotation side.","example":"buy"},"quote_amount_buy":{"type":"number","description":"Quotation quote amount buy."},"quote_amount_sell":{"type":"number","description":"Quotation quote amount sell."},"quote_currency_symbol":{"type":"string","description":"Quotation quote currency symbol.","example":"BRL"},"quote_currency_decimal":{"type":"number","description":"Quotation quote currency decimal.","example":2},"quote_currency_title":{"type":"string","description":"Quotation quote currency title.","example":"Real"},"base_amount_buy":{"type":"number","description":"Quotation base amount buy."},"base_amount_sell":{"type":"number","description":"Quotation base amount sell."},"base_currency_symbol":{"type":"string","description":"Quotation base currency symbol.","example":"BTC"},"base_currency_decimal":{"type":"number","description":"Quotation base currency decimal.","example":8},"base_currency_title":{"type":"string","description":"Quotation base currency title.","example":"Real"},"created_at":{"format":"date-time","type":"string","description":"Quotation created at.","example":"2026-05-29T19:41:08.005Z"}},"required":["id","price_buy","price_sell","side","quote_amount_buy","quote_amount_sell","quote_currency_symbol","quote_currency_decimal","quote_currency_title","base_amount_buy","base_amount_sell","base_currency_symbol","base_currency_decimal","base_currency_title"]},"GetConversionByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Conversion UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Operation UUID. Used to track the conversion.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"quotation_id":{"type":"string","description":"Quotation UUID. Used to track the quotation for this conversion.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"price":{"type":"number","description":"Conversion price."},"side":{"type":"string","enum":["buy","sell"],"description":"Conversion side.","example":"buy"},"quote_amount":{"type":"number","description":"Conversion quote amount."},"quote_currency_symbol":{"type":"string","description":"Conversion quote currency symbol.","example":"BRL"},"quote_currency_decimal":{"type":"number","description":"Conversion quote currency decimal.","example":2},"quote_currency_title":{"type":"string","description":"Conversion quote currency title.","example":"Real"},"base_amount":{"type":"number","description":"Conversion base amount."},"base_currency_symbol":{"type":"string","description":"Conversion base currency symbol.","example":"BTC"},"base_currency_decimal":{"type":"number","description":"Conversion base currency decimal.","example":8},"base_currency_title":{"type":"string","description":"Conversion base currency title.","example":"Real"},"created_at":{"format":"date-time","type":"string","description":"Conversion created at.","example":"2026-05-29T19:41:08.006Z"}},"required":["id","operation_id","price","side","quote_amount","quote_currency_symbol","quote_currency_decimal","quote_currency_title","base_amount","base_currency_symbol","base_currency_decimal","base_currency_title"]},"V2GetQuotationRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Quotation ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"price_buy":{"type":"number","description":"Quotation price buy in cents."},"price_sell":{"type":"number","description":"Quotation price sell in cents."},"side":{"type":"string","enum":["buy","sell"],"description":"Quotation side.","example":"buy"},"quote_amount_buy":{"type":"number","description":"Quotation quote amount buy."},"quote_amount_sell":{"type":"number","description":"Quotation quote amount sell."},"quote_currency_symbol":{"type":"string","description":"Quotation quote currency symbol.","example":"BRL"},"quote_currency_decimal":{"type":"number","description":"Quotation quote currency decimal.","example":2},"quote_currency_title":{"type":"string","description":"Quotation quote currency title.","example":"Real"},"base_amount_buy":{"type":"number","description":"Quotation base amount buy."},"base_amount_sell":{"type":"number","description":"Quotation base amount sell."},"base_currency_symbol":{"type":"string","description":"Quotation base currency symbol.","example":"BTC"},"base_currency_decimal":{"type":"number","description":"Quotation base currency decimal.","example":8},"base_currency_title":{"type":"string","description":"Quotation base currency title.","example":"Real"},"ttl":{"format":"date-time","type":"string","description":"Quotation TTL date.","example":"2026-05-29T19:41:08.487Z"}},"required":["id","price_buy","price_sell","side","quote_amount_buy","quote_amount_sell","quote_currency_symbol","quote_currency_decimal","quote_currency_title","base_amount_buy","base_amount_sell","base_currency_symbol","base_currency_decimal","base_currency_title","ttl"]},"GetAllWalletByUserRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"BTC"},"default":{"type":"boolean","description":"Wallet default flag.","example":false},"state":{"type":"string","description":"Wallet state.","enum":["pending","active","deactivate","blocked"],"example":"active"},"permission_types":{"description":"Wallet permission type that defines what the user can do.","example":["CLIENT"],"type":"array","items":{"type":"string"}},"owner_id":{"type":"string","description":"Wallet owner id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"owner_name":{"type":"string","description":"Wallet owner name.","example":"James Bond"},"created_at":{"format":"date-time","type":"string","description":"Wallet created at.","example":"2026-05-29T19:41:08.802Z"}},"required":["id","name","default","state","permission_types","owner_id","owner_name","created_at"]},"GetWalletByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"BTC"},"default":{"type":"boolean","description":"Wallet default flag.","example":false},"state":{"type":"string","description":"Wallet state.","enum":["pending","active","deactivate","blocked"],"example":"active"},"permission_types":{"description":"Wallet permission type that defines what the user can do.","example":["CLIENT"],"type":"array","items":{"type":"string"}},"owner_id":{"type":"string","description":"Wallet owner id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"owner_name":{"type":"string","description":"Wallet owner name.","example":"James Bond"},"created_at":{"format":"date-time","type":"string","description":"Wallet created at.","example":"2026-05-29T19:41:08.802Z"}},"required":["id","name","default","state","permission_types","owner_id","owner_name","created_at"]},"CreateP2PTransferBody":{"type":"object","properties":{"destination_wallet_id":{"type":"string","description":"Destination wallet UUID."},"amount_currency":{"type":"string","description":"Transfer currency amount symbol.","example":"BRL"},"amount":{"type":"number","description":"Transfer amount in cents.","example":1299},"fee":{"type":"number","description":"Transfer fee in cents.","example":19},"description":{"type":"string","description":"Transfer description.","example":"User defined description"},"merchant_id":{"type":"string","description":"User defined payment merchant ID.","example":"User defined merchant ID"}},"required":["amount_currency","amount"]},"CreateP2PTransferRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Transfer UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Transfer Operation UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount_currency":{"type":"string","description":"Transfer currency amount.","example":"BRL"},"amount":{"type":"number","description":"Transfer amount in cents.","example":1299},"fee":{"type":"number","description":"Transfer fee in cents.","example":10},"description":{"type":"string","description":"Transfer description.","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Transfer created at.","example":"2026-05-29T19:41:08.212Z"}},"required":["id","operation_id","amount_currency","amount","fee","created_at"]},"CreateWalletParams":{"type":"object","properties":{"name":{"type":"string","description":"Wallet name.","example":"Default wallet"}}},"CreateWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"Default wallet"},"default":{"type":"boolean","description":"Wallet default flag.","example":false},"state":{"type":"string","description":"Wallet state.","enum":["pending","active","deactivate","blocked"],"example":"active"},"created_at":{"format":"date-time","type":"string","description":"Wallet created at.","example":"2026-05-29T19:41:08.213Z"}},"required":["id","name","default","state","created_at"]},"UpdateWalletBody":{"type":"object","properties":{"name":{"type":"string","description":"Wallet name.","example":"Default wallet"}},"required":["name"]},"UpdateWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"Default wallet"},"default":{"type":"boolean","description":"Wallet default flag.","example":false},"state":{"type":"string","description":"Wallet state.","enum":["pending","active","deactivate","blocked"],"example":"active"},"created_at":{"format":"date-time","type":"string","description":"Wallet created at.","example":"2026-05-29T19:41:08.213Z"}},"required":["id","name","default","state","created_at"]},"DeleteWalletByIdBody":{"type":"object","properties":{"wallet_backup_id":{"type":"string","description":"Second wallet id. If the wallet you want to delete has balance, you need to insert a second wallet id to transfer the balance amount before deleting it."}}},"GetAllWalletAccountRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Wallet account id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"balance":{"type":"number","description":"Value in cents.","example":10000},"pending_amount":{"type":"number","description":"Value in cents.","example":5000},"currency_id":{"type":"number","description":"The currency id.","example":21},"currency_title":{"type":"string","description":"The currency title."},"currency_decimal":{"type":"number","description":"The currency decimal.","example":8},"currency_symbol":{"type":"string","description":"The currency symbol.","example":"BRL"},"currency_symbol_align":{"type":"string","description":"The currency symbol align.","enum":["left","right"],"example":"right"}},"required":["id","balance","currency_id","currency_decimal","currency_symbol","currency_symbol_align"]},"GetAllWalletAccountRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"WalletAccounts data.","type":"array","items":{"$ref":"#/components/schemas/GetAllWalletAccountRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetWalletAccountByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet Account uuid.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"balance":{"type":"number","description":"Value in cents.","example":10000},"pending_amount":{"type":"number","description":"Value in cents.","example":5000},"state":{"type":"string","description":"Wallet account state.","enum":["pending","active","deactivate"],"example":"active"},"account_number":{"type":"string","description":"Wallet account number."},"branch_number":{"type":"string","description":"Wallet account branch number."},"wallet_id":{"type":"string","description":"Wallet account wallet id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"currency_id":{"type":"number","description":"Wallet account currency id.","example":27},"currency_title":{"type":"string","description":"The currency title.","example":"Bitcoin"},"currency_decimal":{"type":"number","description":"The currency decimal.","example":8},"currency_symbol":{"type":"string","description":"The currency symbol.","example":"BRL"},"currency_symbol_align":{"type":"string","description":"The currency symbol align.","enum":["left","right"],"example":"right"}},"required":["id","balance","state","wallet_id","currency_id","currency_decimal","currency_symbol","currency_symbol_align"]},"GetAllCurrencyRestResponseItem":{"type":"object","properties":{"id":{"type":"number","description":"Currency ID."},"title":{"type":"string","description":"Currency title."},"symbol":{"type":"string","description":"Currency symbol."},"symbol_align":{"type":"string","enum":["left","right"],"description":"Currency symbol align position."},"decimal":{"type":"number","description":"Currency decimal value."},"tag":{"type":"string","description":"Currency tag."},"state":{"type":"string","enum":["active","deactivate"],"description":"Currency state."}},"required":["id","title","symbol","symbol_align","decimal","tag","state"]},"GetAllCurrencyRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Currencies data.","type":"array","items":{"$ref":"#/components/schemas/GetAllCurrencyRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetAllOperationsRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Operation id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"fee":{"type":"number","description":"Operation fee in cents.","example":0},"state":{"type":"string","description":"Operation state.","enum":["accepted","declined","undone","pending","reverted","waiting_accept","waiting_revert","waiting_ledger","waiting_credit","waiting_debit","waiting_accept_credit"],"example":"accepted"},"description":{"type":"string","description":"Operation description."},"value":{"type":"number","description":"Operation value in cents.","example":1880000},"created_at":{"format":"date-time","type":"string","description":"Operation created at.","example":"2026-05-29T19:41:08.214Z"},"reverted_at":{"format":"date-time","type":"string","description":"Operation reverted at.","example":"2026-05-29T19:41:08.214Z"},"currency_id":{"type":"number","description":"Currency Id.","example":2},"currency_symbol":{"type":"string","description":"Currency symbol.","example":"R$"},"transaction_id":{"type":"number","description":"Transaction id.","example":2},"transaction_tag":{"type":"string","description":"Transaction tag.","example":"BRL"},"owner_wallet_uuid":{"type":"string","description":"Operation owner wallet.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"beneficiary_wallet_uuid":{"type":"string","description":"Operation beneficiary wallet uuid.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_ref_id":{"type":"string","description":"Operation ref id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"chargeback_id":{"type":"string","description":"Operation chargeback id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"}},"required":["id","state","description","created_at","currency_id","currency_symbol","transaction_id","transaction_tag"]},"GetAllOperationsRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Operations data.","type":"array","items":{"$ref":"#/components/schemas/GetAllOperationsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetOperationByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Operation id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"fee":{"type":"number","description":"Operation fee in cents.","example":0},"state":{"type":"string","description":"Operation state.","enum":["accepted","declined","undone","pending","reverted","waiting_accept","waiting_revert","waiting_ledger","waiting_credit","waiting_debit","waiting_accept_credit"],"example":"accepted"},"description":{"type":"string","description":"Operation description."},"value":{"type":"number","description":"Operation value in cents.","example":1880000},"created_at":{"format":"date-time","type":"string","description":"Operation created at.","example":"2026-05-29T19:41:08.214Z"},"reverted_at":{"format":"date-time","type":"string","description":"Operation reverted at.","example":"2026-05-29T19:41:08.214Z"},"currency_id":{"type":"number","description":"Currency Id.","example":2},"currency_symbol":{"type":"string","description":"Currency symbol.","example":"R$"},"transaction_id":{"type":"number","description":"Transaction id.","example":2},"transaction_tag":{"type":"string","description":"Transaction tag.","example":"BRL"},"owner_wallet_uuid":{"type":"string","description":"Operation owner wallet.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"beneficiary_wallet_uuid":{"type":"string","description":"Operation beneficiary wallet uuid.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_ref_id":{"type":"string","description":"Operation ref id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"chargeback_id":{"type":"string","description":"Operation chargeback id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"}},"required":["id","state","description","created_at","currency_id","currency_symbol","transaction_id","transaction_tag"]},"GetOperationReceiptByIdRestResponse":{"type":"object","properties":{"payment_data":{"type":"object","description":"Payment data (Id, value, date, etc)."},"payment_title":{"type":"string","description":"Payment title.","example":"Pix key scheduled successfully."},"operation_id":{"type":"string","description":"Related operation id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_scheduled":{"type":"boolean","description":"If payment state is scheduled.","example":true},"active_devolution":{"type":"boolean","description":"If payment state can be returned.","example":false}},"required":["payment_data","payment_title","operation_id","is_scheduled","active_devolution"]},"GetP2PTransferByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Transfer UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"operation_id":{"type":"string","description":"Transfer Operation UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"amount_currency":{"type":"string","description":"Transfer currency amount.","example":"BRL"},"amount":{"type":"number","description":"Transfer amount in cents.","example":1299},"fee":{"type":"number","description":"Transfer fee in cents.","example":10},"description":{"type":"string","description":"Transfer description.","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Transfer created at.","example":"2026-05-29T19:41:08.217Z"}},"required":["id","operation_id","amount_currency","amount","fee","created_at"]},"UpdateWalletLimitRestBodyRequest":{"type":"object","properties":{"daily_limit":{"type":"number","description":"Wallet daily limit","example":1000},"nightly_limit":{"type":"number","description":"Wallet nightly limit","example":1000},"monthly_limit":{"type":"number","description":"Wallet monthly limit","example":1000},"yearly_limit":{"type":"number","description":"Wallet yearly limit","example":1000},"max_amount":{"type":"number","description":"Wallet max amount","example":1000},"min_amount":{"type":"number","description":"Wallet min amount","example":1000},"max_amount_nightly":{"type":"number","description":"Wallet max amount nightly","example":1000},"min_amount_nightly":{"type":"number","description":"Wallet min amount nightly","example":1000},"user_max_amount":{"type":"number","description":"Wallet user max amount","example":1000},"user_min_amount":{"type":"number","description":"Wallet user min amount","example":1000},"user_max_amount_nightly":{"type":"number","description":"Wallet user max amount nightly","example":1000},"user_min_amount_nightly":{"type":"number","description":"Wallet user min amount nightly","example":1000},"user_nightly_limit":{"type":"number","description":"Wallet user nightly limit","example":1000},"user_daily_limit":{"type":"number","description":"Wallet user daily limit","example":1000},"user_monthly_limit":{"type":"number","description":"Wallet user monthly limit","example":1000},"user_yearly_limit":{"type":"number","description":"Wallet user yearly limit","example":1000},"night_time_start":{"type":"string","description":"Wallet night time start","example":"00:00"},"night_time_end":{"type":"string","description":"Wallet night time end","example":"06:00"}},"required":["daily_limit","nightly_limit","monthly_limit","yearly_limit"]},"UpdateWalletLimitRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet limit id.","example":"2d4b3b3d-3b3d-4b3d-3b3d-4b3d3b3d3b3d"}},"required":["id"]},"GenerateOperationReceiptPdfByUserAndWalletAndIdRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"Generated file ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_state":{"type":"string","description":"Generated file state.","enum":["PENDING","WAITING_UPLOAD","READY","ERROR","ABORTED"],"example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"File created at.","example":"2026-05-29T19:41:08.216Z"}},"required":["file_id","file_state","created_at"]},"GetPendingSumByWalletAccountRestResponse":{"type":"object","properties":{"pending_balance":{"type":"number","description":"Sum of pending balance in cents.","example":123000}},"required":["pending_balance"]},"V2V2GetAllBankingTedReceivedRestResponseItem":{"type":"object","properties":{"id":{"type":"number","description":"Banking TED Received ID.","example":4598},"operation_id":{"type":"string","description":"Banking TED Received Operation.","example":"1b43322e-d6d5-4895-ac3f-a440cc63816a"},"amount":{"type":"number","description":"Banking TED Received Amount.","example":4598},"owner_name":{"type":"string","description":"Banking TED Received Owner Name.","example":"João"},"owner_document":{"type":"string","description":"Banking TED Received Owner Document.","example":"12345678901"},"owner_account_type":{"type":"string","description":"Banking TED Received Owner Account Type.","example":"CC"},"owner_bank_account":{"type":"string","description":"Banking TED Received Owner Bank Account.","example":"12345"},"owner_bank_branch":{"type":"string","description":"Banking TED Received Owner Bank Branch.","example":"12345"},"owner_bank_code":{"type":"string","description":"3-digit code used to identify financial institutions, primarily utilized by customers and end users when entering information for transfers. It is different from the ISPB, which is an internal 8-digit code in the Brazilian financial system used for transactions between banks and fintechs.","example":"237"},"owner_bank_name":{"type":"string","description":"Banking TED Received Owner Bank Name.","example":"Banco Bradesco S.A."},"created_at":{"format":"date-time","type":"string","description":"Banking TED Received Created At.","example":"2022-01-01T00:00:00.000Z"}},"required":["id","operation_id","amount"]},"V2GetAllBankingTedReceivedRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"BankingTedsReceived Data.","type":"array","items":{"$ref":"#/components/schemas/V2V2GetAllBankingTedReceivedRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V2GetBankingTedReceivedByIdRestResponse":{"type":"object","properties":{"id":{"type":"number","description":"Banking TED Received ID.","example":4598},"operation_id":{"type":"string","description":"Banking TED Received Operation ID.","example":"1b43322e-d6d5-4895-ac3f-a440cc63816a"},"amount":{"type":"number","description":"Banking TED Received Amount.","example":4598},"owner_name":{"type":"string","description":"Banking TED Received Owner Name.","example":"João"},"owner_document":{"type":"string","description":"Banking TED Received Owner Document.","example":"12345678901"},"owner_account_type":{"type":"string","description":"Banking TED Received Owner Account Type.","example":"CC"},"owner_bank_account":{"type":"string","description":"Banking TED Received Owner Bank Account.","example":"12345"},"owner_bank_branch":{"type":"string","description":"Banking TED Received Owner Bank Branch.","example":"12345"},"owner_bank_code":{"type":"string","description":"3-digit code used to identify financial institutions, primarily utilized by customers and end users when entering information for transfers. It is different from the ISPB, which is an internal 8-digit code in the Brazilian financial system used for transactions between banks and fintechs.","example":"237"},"owner_bank_name":{"type":"string","description":"Banking TED Received Owner Bank Name.","example":"Banco Bradesco S.A."},"created_at":{"format":"date-time","type":"string","description":"Banking TED Received Created At.","example":"2022-01-01T00:00:00.000Z"}},"required":["id","operation_id","amount"]},"V2GetBankingTedReceivedByOperationIdRestResponse":{"type":"object","properties":{"id":{"type":"number","description":"Banking TED Received ID.","example":4598},"operation_id":{"type":"string","description":"Banking TED Received Operation.","example":"1b43322e-d6d5-4895-ac3f-a440cc63816a"},"amount":{"type":"number","description":"Banking TED Received Amount.","example":4598},"owner_name":{"type":"string","description":"Banking TED Received Owner Name.","example":"João"},"owner_document":{"type":"string","description":"Banking TED Received Owner Document.","example":"12345678901"},"owner_account_type":{"type":"string","description":"Banking TED Received Owner Account Type.","example":"CC"},"owner_bank_account":{"type":"string","description":"Banking TED Received Owner Bank Account.","example":"12345"},"owner_bank_branch":{"type":"string","description":"Banking TED Received Owner Bank Branch.","example":"12345"},"owner_bank_code":{"type":"string","description":"3-digit code used to identify financial institutions, primarily utilized by customers and end users when entering information for transfers. It is different from the ISPB, which is an internal 8-digit code in the Brazilian financial system used for transactions between banks and fintechs.","example":"237"},"owner_bank_name":{"type":"string","description":"Banking TED Received Owner Bank Name.","example":"Banco Bradesco S.A."},"created_at":{"format":"date-time","type":"string","description":"Banking TED Received Created At.","example":"2026-05-29T19:41:07.898Z"}},"required":["id","operation_id","amount"]},"GetAllBankTedRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Bank ted ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"code":{"type":"string","description":"Bank ted code.","example":"237"},"ispb":{"type":"string","description":"Bank ted ispb.","example":"7219"},"name":{"type":"string","description":"Bank ted name.","example":"Bank ted Name S.A."},"full_name":{"type":"string","description":"Bank ted full name.","example":"Bank ted Name of Money."},"created_at":{"format":"date-time","type":"string","description":"Bank ted created at.","example":"2026-05-29T19:41:07.888Z"}},"required":["id","code","ispb","name","full_name","created_at"]},"GetAllBankTedRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"BankTeds data.","type":"array","items":{"$ref":"#/components/schemas/GetAllBankTedRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetAllBankingTedRestResponseItem":{"type":"object","properties":{"id":{"type":"number","description":"BankingTed ID.","example":4598},"state":{"type":"string","description":"BankingTed state.","enum":["ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW","PENDING","WAITING","FAILED","FORWARDED","CONFIRMED"],"example":"CONFIRMED"},"amount":{"type":"number","description":"BankingTed amount.","example":15050},"operation_id":{"type":"string","description":"BankingTed operation created.","example":"1b43322e-d6d5-4895-ac3f-a440cc63816a"},"beneficiary_bank_name":{"type":"string","description":"BankingTed beneficiary bank name.","example":"Banco Bradesco S.A."},"beneficiary_bank_code":{"type":"string","description":"3-digit code used to identify financial institutions, primarily utilized by customers and end users when entering information for transfers. It is different from the ISPB, which is an internal 8-digit code in the Brazilian financial system used for transactions between banks and fintechs.","example":"237"},"beneficiary_name":{"type":"string","description":"BankingTed beneficiary name.","example":"Name Test"},"beneficiary_type":{"type":"string","description":"BankingTed beneficiary type.","example":"fisico"},"beneficiary_document":{"type":"string","description":"BankingTed beneficiary document.","example":"99999999910"},"beneficiary_agency":{"type":"string","description":"BankingTed beneficiary agency.","example":"0001"},"beneficiary_account":{"type":"string","description":"BankingTed beneficiary account.","example":"111111"},"beneficiary_account_digit":{"type":"string","description":"BankingTed beneficiary account digit.","example":"10"},"beneficiary_account_type":{"type":"string","description":"BankingTed beneficiary account type.","example":"CACC","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"]},"transaction_id":{"type":"string","description":"BankingTed transaction gateway ID.","example":"1b43322e-d6d5-4895-ac3f-a440cc63816a"},"confirmed_at":{"format":"date-time","type":"string","description":"BankingTed confirmed date.","example":"2026-05-29T19:41:07.894Z"},"failed_at":{"format":"date-time","type":"string","description":"BankingTed failed date.","example":"2026-05-29T19:41:07.894Z"},"created_at":{"format":"date-time","type":"string","description":"BankingTed created date.","example":"2026-05-29T19:41:07.894Z"}},"required":["id","operation_id","beneficiary_name","beneficiary_type","beneficiary_document","beneficiary_agency","beneficiary_account","beneficiary_account_digit","beneficiary_account_type"]},"GetAllBankingTedRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"bankingTeds data.","type":"array","items":{"$ref":"#/components/schemas/GetAllBankingTedRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetBankingTedByIdRestResponse":{"type":"object","properties":{"id":{"type":"number","description":"BankingTed ID.","example":4598},"state":{"type":"string","description":"BankingTed state.","enum":["ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW","PENDING","WAITING","FAILED","FORWARDED","CONFIRMED"],"example":"CONFIRMED"},"amount":{"type":"number","description":"BankingTed amount.","example":15050},"operation_id":{"type":"string","description":"BankingTed operation created.","example":"1b43322e-d6d5-4895-ac3f-a440cc63816a"},"beneficiary_bank_name":{"type":"string","description":"BankingTed beneficiary bank name.","example":"Banco Bradesco S.A."},"beneficiary_bank_code":{"type":"string","description":"3-digit code used to identify financial institutions, primarily utilized by customers and end users when entering information for transfers. It is different from the ISPB, which is an internal 8-digit code in the Brazilian financial system used for transactions between banks and fintechs.","example":"237"},"beneficiary_name":{"type":"string","description":"BankingTed beneficiary name.","example":"Name Test"},"beneficiary_type":{"type":"string","description":"BankingTed beneficiary type.","example":"fisico"},"beneficiary_document":{"type":"string","description":"BankingTed beneficiary document.","example":"99999999910"},"beneficiary_agency":{"type":"string","description":"BankingTed beneficiary agency.","example":"0001"},"beneficiary_account":{"type":"string","description":"BankingTed beneficiary account.","example":"111111"},"beneficiary_account_digit":{"type":"string","description":"BankingTed beneficiary account digit.","example":"10"},"beneficiary_account_type":{"type":"string","description":"BankingTed beneficiary account type.","example":"CC","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"]},"transaction_id":{"type":"string","description":"BankingTed transaction gateway ID.","example":"1b43322e-d6d5-4895-ac3f-a440cc63816a"},"confirmed_at":{"format":"date-time","type":"string","description":"BankingTed confirmed date.","example":"2026-05-29T19:41:07.890Z"},"failed_at":{"format":"date-time","type":"string","description":"BankingTed failed date.","example":"2026-05-29T19:41:07.890Z"},"created_at":{"format":"date-time","type":"string","description":"BankingTed created date.","example":"2026-05-29T19:41:07.890Z"}},"required":["id","operation_id","beneficiary_name","beneficiary_type","beneficiary_document","beneficiary_agency","beneficiary_account","beneficiary_account_digit","beneficiary_account_type"]},"CreateBankingTedBody":{"type":"object","properties":{"amount":{"type":"number","description":"BankingTed amount.","example":10000},"beneficiary_bank_name":{"type":"string","description":"BankingTed beneficiary bank name.","example":"Banco Bradesco S.A."},"beneficiary_bank_code":{"type":"string","description":"3-digit code used to identify financial institutions, primarily utilized by customers and end users when entering information for transfers. It is different from the ISPB, which is an internal 8-digit code in the Brazilian financial system used for transactions between banks and fintechs.","example":"237"},"beneficiary_name":{"type":"string","description":"BankingTed beneficiary name.","example":"Name Test"},"beneficiary_type":{"type":"string","description":"BankingTed beneficiary type.","example":"fisico"},"beneficiary_document":{"type":"string","description":"BankingTed beneficiary document.","example":"90933356005"},"beneficiary_agency":{"type":"string","description":"BankingTed beneficiary agency.","example":"0001"},"beneficiary_account":{"type":"string","description":"BankingTed beneficiary account.","example":"111111"},"beneficiary_account_digit":{"type":"string","description":"BankingTed beneficiary account digit.","example":"10"},"beneficiary_account_type":{"type":"string","description":"BankingTed beneficiary account type.","example":"CC","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"]}},"required":["amount","beneficiary_name","beneficiary_type","beneficiary_document","beneficiary_agency","beneficiary_account","beneficiary_account_digit","beneficiary_account_type"]},"CreateBankingTedRestResponse":{"type":"object","properties":{"id":{"type":"number","description":"BankingTed ID.","example":6790},"operation_id":{"type":"string","description":"Operation ID bankingTed.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"created_at":{"format":"date-time","type":"string","description":"BankingTed Created at.","example":"2026-05-29T19:41:07.891Z"}},"required":["id","operation_id","created_at"]},"GetAllBankRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Bank ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"ispb":{"type":"string","description":"Bank ispb.","example":"7219"},"name":{"type":"string","description":"Bank name.","example":"Bank Name S.A."},"full_name":{"type":"string","description":"Bank full name.","example":"Bank Name of Money."},"created_at":{"format":"date-time","type":"string","description":"Bank created at.","example":"2026-05-29T19:41:07.898Z"}},"required":["id","ispb","name","full_name","created_at"]},"GetAllBankRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Banks data.","type":"array","items":{"$ref":"#/components/schemas/GetAllBankRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"CreateBankingBilletPixAutomaticRecurrenceBodyParam":{"type":"object","properties":{"frequency":{"type":"string","description":"Frequency.","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"MONTHLY"},"start_date":{"type":"string","description":"Date of the first payment of the automatic pix recurrence.","example":"2026-05-29","format":"date"},"end_date":{"type":"string","description":"Date for when the automatic pix recurrence will be ended.","example":"2027-05-29","format":"date"},"value":{"type":"number","description":"Recurrence fixed value for the charges in Brazilian Real (R$) cents.","example":1000},"floor_max_value":{"type":"number","description":"Maximum floor value in Brazilian Real (R$) cents. Must not be provided if (fixed) value is provided.","example":1000},"owner_ispb":{"type":"string","description":"Owner (payer) Bank ISPB.","example":"11111111","minLength":1,"maxLength":8},"debtor_document":{"type":"string","description":"Debtor document (CPF or CNPJ).","example":"83003535005"},"debtor_name":{"type":"string","description":"Debtor name.","example":"John Doe"},"contract_number":{"type":"string","description":"Contract number or reference code.","example":"ABC123"},"contract_description":{"type":"string","description":"Contract description.","example":"Super plan"},"tags":{"description":"Tags (max: 5).","example":["discount 15%"],"type":"array","items":{"type":"string"}}},"required":["frequency","start_date","owner_ispb","debtor_document","debtor_name","contract_number"]},"CreateBankingBilletPixDepositBody":{"type":"object","properties":{"amount":{"type":"number","description":"Amount specified in Brazilian Real (R$) cents."},"interest_perc_value":{"type":"number","description":"Interest value specified in percentage by month.","example":1.01},"fine_value":{"type":"number","description":"Fine value (in (R$) amount or percentage).","example":2.02},"fine_type":{"type":"string","description":"Fine type.","example":"AMOUNT","enum":["AMOUNT","PERCENTAGE"]},"discount_value":{"type":"number","description":"Discount value (in (R$) amount or percentage).","example":10.01},"discount_type":{"type":"string","description":"Discount type.","example":"AMOUNT","enum":["AMOUNT","PERCENTAGE"]},"due_date":{"type":"string","description":"Due date. Format: YYYY-MM-DD.","example":"2026-06-07","format":"date"},"pix_key":{"type":"string","description":"Pix key.","example":"c6537646-a972-4531-97a3-18002de8219e"},"description":{"type":"string","description":"Description.","example":"Description"},"payer_document":{"type":"string","description":"Payer's document (CPF or CNPJ) (required when pix_automatic_recurrence is provided).","example":"12345678909"},"payer_name":{"type":"string","description":"Payer's name (required when pix_automatic_recurrence is provided).","example":"John Doe"},"payer_email":{"type":"string","description":"Payer email.","example":"nobody@zrobank.com.br"},"payer_emails":{"description":"List of payer emails (up to 5). When provided, takes precedence over payer_email.","example":["payer1@example.com","payer2@example.com"],"type":"array","items":{"type":"string"}},"personalized":{"type":"boolean","description":"Whether the billet PDF will be personalized or not.","example":true},"pix_automatic_recurrence":{"description":"Pix automatic recurrence.","allOf":[{"$ref":"#/components/schemas/CreateBankingBilletPixAutomaticRecurrenceBodyParam"}]}},"required":["amount","due_date","pix_key","description","personalized"]},"CreateBankingBilletPixDepositRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet deposit ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"operation_id":{"type":"string","description":"Bank billet deposit operation ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"state":{"type":"string","enum":["CREATED_PENDING","CREATED_WAITING","CREATED_CONFIRMED","CREATED_FAILED","RECEIVED"],"description":"Bank billet deposit state.","example":"CREATED_PENDING"},"amount":{"type":"number","description":"Amount specified in Brazilian Real (R$) cents.","example":1299},"interest_perc_value":{"type":"number","description":"Interest value specified in percentage.","example":1.01},"fine_value":{"type":"number","description":"Fine value (converted to R$ cents).","example":202},"discount_value":{"type":"number","description":"Discount value (converted to R$ cents).","example":1001},"due_date":{"format":"date-time","type":"string","description":"Due date.","example":"2026-05-29T19:41:07.987Z"},"limit_due_date":{"format":"date-time","type":"string","description":"Limit due date.","example":"2026-05-29T19:41:07.987Z"},"barcode":{"type":"string","description":"Barcode.","example":"00000000000000000000000000000000000000000000"},"typeable_line":{"type":"string","description":"Typeable line.","example":"00000000000000000000000000000000000000000000000"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.987Z"},"personalized":{"type":"boolean","description":"Whether the billet PDF is personalized or not.","example":true}},"required":["id","operation_id","state","amount","due_date","limit_due_date","barcode","typeable_line","created_at","personalized"]},"GetAllBankingBilletPixDepositRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet deposit ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"operation_id":{"type":"string","description":"Bank billet deposit operation ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"state":{"type":"string","enum":["CREATED_PENDING","CREATED_WAITING","CREATED_CONFIRMED","CREATED_FAILED","RECEIVED"],"description":"Bank billet deposit state.","example":"CREATED_PENDING"},"amount":{"type":"number","description":"Amount specified in Brazilian Real (R$) cents.","example":1299},"interest_perc_value":{"type":"number","description":"Bank billet pix deposit interest value in percentage.","example":1.01},"fine_value":{"type":"number","description":"Bank billet pix deposit fine (converted to integer amount).","example":202},"discount_value":{"type":"number","description":"Bank billet pix deposit discount value (converted to integer amount).","example":1001},"due_date":{"format":"date-time","type":"string","description":"Due date.","example":"2026-05-29T19:41:07.988Z"},"limit_due_date":{"format":"date-time","type":"string","description":"Limit due date.","example":"2026-05-29T19:41:07.988Z"},"barcode":{"type":"string","description":"Barcode.","example":"00000000000000000000000000000000000000000000"},"typeable_line":{"type":"string","description":"Typeable line.","example":"00000000000000000000000000000000000000000000000"},"key":{"type":"string","description":"Pix key.","example":"cd71aa2d-757e-4ccc-aeef-1d2c1e00b49b"},"key_id":{"type":"string","description":"Pix key id.","example":"cd71aa2d-757e-4ccc-aeef-1d2c1e00b49b"},"emv":{"type":"string","description":"Emv.","example":"00020101021226910014br.gov.bcb.pix2569bankaddress.com.br/pix/v2/cob/8b358702141e4162bd68eedfe7fb45f4520400005303986540523.005802BR5924USER"},"transaction_tag":{"type":"string","description":"Transaction tag.","example":"PIXREC"},"file_id":{"type":"string","description":"Bank billet pix deposit file ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"personalized":{"type":"boolean","description":"Whether the billet PDF is personalized or not.","example":true},"banking_billet_pix_deposit_batch_id":{"type":"string","description":"Banking billet pix deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"banking_billet_pix_deposit_batch_name":{"type":"string","description":"Banking billet pix deposit batch name.","example":"Batch January 2025"},"email_status":{"type":"string","enum":["SCHEDULED","SENT","FAILED","WAITING_TO_SEND"],"description":"Email status.","example":"SCHEDULED"},"payer_name":{"type":"string","description":"Payer name."},"payer_document":{"type":"string","description":"Payer document (CPF/CNPJ)."},"payer_email":{"type":"string","description":"Payer email."},"payer_emails":{"description":"List of payer emails (up to 5).","type":"array","items":{"type":"string"}},"description":{"type":"string","description":"Description."},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.988Z"},"confirmed_at":{"format":"date-time","type":"string","description":"Confirmation date.","example":"2026-05-29T19:41:07.988Z"}},"required":["id","operation_id","state","amount","due_date","limit_due_date","barcode","typeable_line","description","created_at"]},"GetAllBankingBilletPixDepositRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Bank billet pix deposit data.","type":"array","items":{"$ref":"#/components/schemas/GetAllBankingBilletPixDepositRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"CreateBankingBilletPixDepositTemplateBody":{"type":"object","properties":{"logo_file_id":{"type":"string","description":"Logo file ID.","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"merchandise_file_id":{"type":"string","description":"Merchandise file ID (optional).","example":"f47ac10b-58cc-4372-a567-0e02b2c3d480"},"color":{"type":"string","description":"Template color.","example":"#FFFFFF"},"merchandise_url":{"type":"string","description":"Merchandise URL (optional).","example":"https://example.com/merchandise"},"button_title_label":{"type":"string","description":"Button title label (optional).","example":"Pagar agora"}},"required":["logo_file_id","color"]},"CreateBankingBilletPixDepositTemplateRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Banking billet pix deposit template ID."},"user_id":{"type":"string","description":"User ID owner of the template."},"wallet_id":{"type":"string","description":"Wallet ID related to the template."},"template_name":{"type":"string","description":"Template name."},"props":{"type":"object","description":"Template properties."},"created_at":{"format":"date-time","type":"string","description":"Creation date."},"updated_at":{"format":"date-time","type":"string","description":"Update date."},"deleted_at":{"format":"date-time","type":"string","description":"Deletion date."}},"required":["id","user_id","wallet_id","template_name","props","created_at","updated_at"]},"GetBankingBilletPixDepositTemplateByWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Banking billet pix deposit template ID."},"user_id":{"type":"string","description":"User ID owner of the template."},"wallet_id":{"type":"string","description":"Wallet ID related to the template."},"template_name":{"type":"string","description":"Template name."},"props":{"type":"object","description":"Template properties."},"created_at":{"format":"date-time","type":"string","description":"Creation date."},"updated_at":{"format":"date-time","type":"string","description":"Update date."},"deleted_at":{"format":"date-time","type":"string","description":"Deletion date."}},"required":["id","user_id","wallet_id","template_name","props","created_at","updated_at"]},"UploadBankingBilletPixTemplateFileRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"File ID."},"file_name":{"type":"string","description":"Uploaded file name."},"created_at":{"format":"date-time","type":"string","description":"Creation date."}},"required":["id","file_name","created_at"]},"GetBankingBilletPixDepositByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet pix deposit ID."},"state":{"type":"string","enum":["CREATED_PENDING","CREATED_WAITING","CREATED_CONFIRMED","CREATED_FAILED","RECEIVED"]},"amount":{"type":"number","description":"Bank billet pix deposit amount in cents."},"interest_perc_value":{"type":"number","description":"Bank billet pix deposit interest value in percentage.","example":1.01},"fine_value":{"type":"number","description":"Bank billet pix deposit fine value (converted to integer amount).","example":202},"discount_value":{"type":"number","description":"Bank billet pix deposit discount value (converted to integer amount).","example":1001},"due_date":{"format":"date-time","type":"string","description":"Due date."},"limit_due_date":{"format":"date-time","type":"string","description":"Limit due date."},"barcode":{"type":"string","description":"Barcode."},"typeable_line":{"type":"string","description":"Typeable line."},"operation_id":{"type":"string","description":"Operation ID."},"file_id":{"type":"string","description":"banking billet pix deposit PDF file id"},"transaction_tag":{"type":"string","description":"Transaction tag."},"personalized":{"type":"boolean","description":"Whether the billet PDF is personalized or not."},"banking_billet_pix_deposit_batch_id":{"type":"string","description":"Banking billet pix deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"banking_billet_pix_deposit_batch_name":{"type":"string","description":"Banking billet pix deposit batch name.","example":"Batch January 2025"},"email_status":{"type":"string","enum":["SCHEDULED","SENT","FAILED","WAITING_TO_SEND"],"description":"Email status.","example":"SCHEDULED"},"payer_name":{"type":"string","description":"Payer name."},"payer_document":{"type":"string","description":"Payer document (CPF/CNPJ)."},"payer_email":{"type":"string","description":"Payer email."},"payer_emails":{"description":"List of payer emails (up to 5).","type":"array","items":{"type":"string"}},"description":{"type":"string","description":"Description."},"created_at":{"format":"date-time","type":"string","description":"Created at."},"confirmed_at":{"format":"date-time","type":"string","description":"Confirmed at."},"pix_key":{"type":"string","description":"Pix key."},"emv":{"type":"string","description":"EMV code."}},"required":["id","state","amount","due_date","limit_due_date","barcode","typeable_line","operation_id","description","created_at"]},"GetBankingBilletPixDepositPdfRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet pix deposit ID."},"file_name":{"type":"string","description":"Bank billet pix deposit file name."},"created_at":{"format":"date-time","type":"string","description":"Bank billet pix deposit created at."}},"required":["id"]},"GetBankingBilletPaymentByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Banking billet payment ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"status":{"type":"string","enum":["PENDING","WAITING","WAITING_CMP","CONFIRMED","FAILED","CANCELED"],"description":"Banking billet payment status.","example":"CONFIRMED"},"amount":{"type":"number","description":"Amount specified in Brazilian Real (R$) cents.","example":1299},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.990Z"},"confirmed_at":{"format":"date-time","type":"string","description":"Confirmation date.","example":"2026-05-29T19:41:07.990Z"},"operation_id":{"type":"string","description":"Operation ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"typeable_line":{"type":"string","description":"Typeable line of the banking billet.","example":"26090420781062989442839400000004199810000002050"},"barcode":{"type":"string","description":"Barcode of the banking billet.","example":"55900000000000000000000000000000000011578328"},"due_date":{"format":"date-time","type":"string","description":"Due date of the banking billet.","example":"2026-05-29T19:41:07.990Z"},"nominal_value":{"type":"number","description":"Nominal value of the banking billet in Brazilian Real (R$) cents.","example":2000},"beneficiary_bank_name":{"type":"string","description":"Beneficiary bank name.","example":"Banco do Brasil S.A."},"beneficiary_bank_ispb":{"type":"string","description":"Beneficiary bank ISPB.","example":"00000000"},"beneficiary_full_name":{"type":"string","description":"Beneficiary full name.","example":"João da Silva"},"beneficiary_document":{"type":"string","description":"Beneficiary document.","example":"11111111111"}},"required":["id","status","amount","created_at"]},"CreateBankingBilletPixDepositBatchBody":{"type":"object","properties":{"batch_name":{"type":"string","description":"Batch name.","example":"Batch January 2025"},"pix_key":{"type":"string","description":"Pix key.","example":"c6537646-a972-4531-97a3-18002de8219e"},"personalized":{"type":"boolean","description":"Whether the billet PDF will be personalized or not.","example":true},"email_send_date":{"type":"string","description":"Email send date. Format: YYYY-MM-DD.","example":"2026-05-31","format":"date"},"file_id":{"type":"string","description":"CSV file ID","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"}},"required":["batch_name","pix_key","personalized","file_id"]},"CreateBankingBilletPixDepositBatchRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"batch_name":{"type":"string","description":"Batch name.","example":"Batch January 2025"},"status":{"type":"string","enum":["UNDER_ANALYSIS","VALIDATED","REJECTED","GENERATED","FAILED"],"description":"Bank billet deposit batch status.","example":"UNDER_ANALYSIS"},"personalized":{"type":"boolean","description":"Whether the billet PDF is personalized or not.","example":true},"pix_key":{"type":"string","description":"Pix key.","example":"c6537646-a972-4531-97a3-18002de8219e"},"file_id":{"type":"string","description":"File ID of uploaded CSV.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"email_send_date":{"type":"string","description":"Email send date.","example":"2025-02-01","format":"date"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.994Z"}},"required":["id","batch_name","status","personalized","pix_key","file_id","created_at"]},"GetAllBankingBilletPixDepositBatchRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"pix_key_id":{"type":"string","description":"Pix key ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"batch_name":{"type":"string","description":"Batch name.","example":"January/26"},"status":{"type":"string","enum":["UNDER_ANALYSIS","VALIDATED","REJECTED","GENERATED","FAILED"],"description":"Status.","example":"GENERATED"},"email_send_date":{"type":"string","description":"Date on which the bank billets will be sent by email.","example":"2026-05-31","format":"date"},"personalized":{"type":"boolean","description":"Whether the banking billets will be created using a template or not.","example":true},"file_id":{"type":"string","description":"File ID (CSV).","example":"64983ca9-6f13-4988-af37-c65fb31f5c65"},"items_count":{"type":"number","description":"Quantity of items (banking billets) of the batch","example":100},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.995Z"},"updated_at":{"format":"date-time","type":"string","description":"Update date.","example":"2026-05-29T19:41:07.995Z"}},"required":["id","pix_key_id","batch_name","status","personalized","created_at","updated_at"]},"GetAllBankingBilletPixDepositBatchRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Bank billet pix deposit batch data.","type":"array","items":{"$ref":"#/components/schemas/GetAllBankingBilletPixDepositBatchRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetBankingBilletPixDepositBatchByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"pix_key_id":{"type":"string","description":"Pix key ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"batch_name":{"type":"string","description":"Batch name.","example":"January/26"},"status":{"type":"string","enum":["UNDER_ANALYSIS","VALIDATED","REJECTED","GENERATED","FAILED"],"description":"Status.","example":"GENERATED"},"email_send_date":{"type":"string","description":"Date on which the bank billets will be sent by email.","example":"2026-05-31","format":"date"},"personalized":{"type":"boolean","description":"Whether the banking billets will be created using a template or not.","example":true},"file_id":{"type":"string","description":"File ID (CSV).","example":"64983ca9-6f13-4988-af37-c65fb31f5c65"},"items_count":{"type":"number","description":"Quantity of items (banking billets) of the batch","example":100},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.995Z"},"updated_at":{"format":"date-time","type":"string","description":"Update date.","example":"2026-05-29T19:41:07.995Z"}},"required":["id","pix_key_id","batch_name","status","personalized","created_at","updated_at"]},"UpdateCsvFileBankingBilletPixDepositBatchBody":{"type":"object","properties":{"file_id":{"type":"string","description":"CSV file ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"}},"required":["file_id"]},"UpdateCsvFileBankingBilletPixDepositBatchRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"batch_name":{"type":"string","description":"Batch name.","example":"Batch January 2025"},"status":{"type":"string","enum":["UNDER_ANALYSIS","VALIDATED","REJECTED","GENERATED","FAILED"],"description":"Bank billet deposit batch status.","example":"UNDER_ANALYSIS"},"personalized":{"type":"boolean","description":"Whether the billet PDF is personalized or not.","example":true},"file_id":{"type":"string","description":"File ID of uploaded CSV.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"email_send_date":{"type":"string","description":"Email send date.","example":"2025-02-01","format":"date"},"updated_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.995Z"}},"required":["id","batch_name","status","personalized","file_id","updated_at"]},"UpdateBankingBilletPixDepositBatchBodyParam":{"type":"object","properties":{"batch_name":{"type":"string","description":"Batch name.","example":"January/26"},"email_send_date":{"type":"string","description":"Email send date. Format: YYYY-MM-DD.","example":"2026-05-31","format":"date"},"personalized":{"type":"boolean","description":"Whether the billet PDF will be personalized or not.","example":true}}},"SendByEmailBankingBilletPixDepositBody":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet pix deposit ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"payer_email":{"type":"string","description":"New payer's email address (single). Ignored when payer_emails is provided.","example":"payer@example.com"},"payer_emails":{"description":"List of payer emails (up to 5). Takes precedence over payer_email.","example":["payer1@example.com","payer2@example.com"],"type":"array","items":{"type":"string"}}},"required":["id"]},"CreateBatchItemPixAutomaticRecurrenceBodyParam":{"type":"object","properties":{"frequency":{"type":"string","description":"Frequency.","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"MONTHLY"},"start_date":{"type":"string","description":"Date of the first payment of the automatic pix recurrence.","example":"2026-05-29","format":"date"},"end_date":{"type":"string","description":"Date for when the automatic pix recurrence will be ended.","example":"2027-05-29","format":"date"},"value":{"type":"number","description":"Recurrence fixed value for the charges in Brazilian Real (R$) cents.","example":1000},"floor_max_value":{"type":"number","description":"Maximum floor value in Brazilian Real (R$) cents. Must not be provided if (fixed) value is provided.","example":1000},"owner_ispb":{"type":"string","description":"Owner (payer) Bank ISPB.","example":"11111111","minLength":1,"maxLength":8},"debtor_document":{"type":"string","description":"Debtor document (CPF or CNPJ).","example":"83003535005"},"debtor_name":{"type":"string","description":"Debtor name.","example":"John Doe"},"contract_number":{"type":"string","description":"Contract number or reference code.","example":"ABC123"},"contract_description":{"type":"string","description":"Contract description.","example":"Super plan"},"tags":{"description":"Tags (max: 5).","example":["discount 15%"],"type":"array","items":{"type":"string"}}},"required":["frequency","start_date","owner_ispb","debtor_document","debtor_name","contract_number"]},"CreateBankingBilletPixDepositBatchItemBody":{"type":"object","properties":{"banking_billet_pix_deposit_batch_id":{"type":"string","description":"Banking billet deposit batch ID","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"payer_name":{"type":"string","description":"Payer name.","example":"John Doe"},"payer_document":{"type":"string","description":"Payer document.","example":"24378444062"},"payer_email":{"type":"string","description":"Payer email.","example":"example@example.com"},"description":{"type":"string","description":"Description.","example":"Payment for services"},"amount":{"type":"number","description":"Amount specified in Brazilian Real (R$) cents.","example":1299},"interest_perc_value":{"type":"number","description":"Interest value specified in percentage by month.","example":1.01},"fine_value":{"type":"number","description":"Fine value (in (R$) amount or percentage).","example":2.02},"fine_type":{"type":"string","description":"Fine type.","example":"AMOUNT","enum":["AMOUNT","PERCENTAGE"]},"discount_value":{"type":"number","description":"Discount value (in (R$) amount or percentage).","example":10.01},"discount_type":{"type":"string","description":"Discount type.","example":"AMOUNT","enum":["AMOUNT","PERCENTAGE"]},"due_date":{"type":"string","description":"Due date. Format: YYYY-MM-DD.","example":"2026-06-07","format":"date"},"pix_automatic_recurrence":{"description":"Pix automatic recurrence.","allOf":[{"$ref":"#/components/schemas/CreateBatchItemPixAutomaticRecurrenceBodyParam"}]}},"required":["banking_billet_pix_deposit_batch_id","description","amount","due_date"]},"CreateBankingBilletPixDepositBatchItemRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet deposit batch item ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"banking_billet_pix_deposit_batch_id":{"type":"string","description":"Bank billet deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"status":{"type":"string","enum":["BILLET_WAITING","BILLET_CREATED","BILLET_FAILED"],"description":"Bank billet deposit batch item status.","example":"BILLET_WAITING"},"payer_name":{"type":"string","description":"Payer name.","example":"John Doe"},"payer_document":{"type":"string","description":"Payer document.","example":"12345678900"},"payer_email":{"type":"string","description":"Payer email.","example":"example@example.com"},"description":{"type":"string","description":"Description.","example":"Payment for services"},"amount":{"type":"number","description":"Amount specified in Brazilian Real (R$) cents.","example":1299},"interest_perc_value":{"type":"number","description":"Interest value specified in percentage.","example":1.01},"fine_value":{"type":"number","description":"Fine value (converted to R$ cents).","example":202},"discount_value":{"type":"number","description":"Discount value (converted to R$ cents).","example":1001},"due_date":{"format":"date-time","type":"string","description":"Due date.","example":"2026-05-29T19:41:07.998Z"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.998Z"}},"required":["id","banking_billet_pix_deposit_batch_id","status","payer_name","payer_document","description","amount","due_date","created_at"]},"GetAllBankingBilletPixDepositBatchItemByBatchIdRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet deposit batch item ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"payer_name":{"type":"string","description":"Payer name."},"payer_document":{"type":"string","description":"Payer document (CPF/CNPJ).","example":"12345678901"},"payer_email":{"type":"string","description":"Payer email."},"description":{"type":"string","description":"Description.","example":"Payment for service"},"amount":{"type":"number","description":"Amount in cents","example":10000},"interest_perc_value":{"type":"number","description":"Interest percentage value.","example":2.5},"fine_value":{"type":"number","description":"Fine value in cents.","example":500},"discount_value":{"type":"number","description":"Discount value in cents.","example":1000},"status":{"type":"string","enum":["BILLET_WAITING","BILLET_CREATED","BILLET_FAILED"],"description":"Status.","example":"BILLET_WAITING"},"email_status":{"type":"string","enum":["SCHEDULED","SENT","FAILED"],"description":"Email status.","example":"SCHEDULED"},"due_date":{"type":"string","description":"Due date.","example":"2026-06-05","format":"date"},"banking_billet_pix_deposit_batch_id":{"type":"string","description":"Bank billet deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.999Z"},"updated_at":{"format":"date-time","type":"string","description":"Update date.","example":"2026-05-29T19:41:07.999Z"}},"required":["id","payer_name","payer_document","description","amount","status","due_date","banking_billet_pix_deposit_batch_id","created_at","updated_at"]},"GetAllBankingBilletPixDepositBatchItemByBatchIdRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Bank billet pix deposit batch items data.","type":"array","items":{"$ref":"#/components/schemas/GetAllBankingBilletPixDepositBatchItemByBatchIdRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetBankingBilletPixDepositBatchItemByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Bank billet deposit batch item ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"payer_name":{"type":"string","description":"Payer name."},"payer_document":{"type":"string","description":"Payer document (CPF/CNPJ).","example":"12345678901"},"payer_email":{"type":"string","description":"Payer email."},"description":{"type":"string","description":"Description.","example":"Payment for service"},"amount":{"type":"number","description":"Amount","example":10000},"interest_perc_value":{"type":"number","description":"Interest percentage value.","example":2.5},"fine_value":{"type":"number","description":"Fine value in cents.","example":500},"discount_value":{"type":"number","description":"Discount value in cents.","example":1000},"status":{"type":"string","enum":["BILLET_WAITING","BILLET_CREATED","BILLET_FAILED"],"description":"Status.","example":"BILLET_WAITING"},"email_status":{"type":"string","enum":["SCHEDULED","SENT","FAILED"],"description":"Email status.","example":"SCHEDULED"},"due_date":{"type":"string","description":"Due date.","example":"2026-06-05","format":"date"},"banking_billet_pix_deposit_batch_id":{"type":"string","description":"Bank billet deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"banking_billet_pix_deposit_id":{"type":"string","description":"Banking billet pix deposit ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"barcode":{"type":"string","description":"Barcode.","example":"00190500954014481606906809350314337370000000100"},"emv":{"type":"string","description":"EMV code.","example":"00020126360014BR.GOV.BCB.PIX0114+5511999999999520400005303986540610.005802BR5909Person Name6009Sao Paulo62070503***6304"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:07.999Z"},"updated_at":{"format":"date-time","type":"string","description":"Update date.","example":"2026-05-29T19:41:07.999Z"}},"required":["id","payer_name","payer_document","description","amount","status","due_date","banking_billet_pix_deposit_batch_id","created_at","updated_at"]},"UpdateBankingBilletPixDepositBatchItemBodyParam":{"type":"object","properties":{"payer_email":{"type":"string","description":"Payer email.","example":"example@example.com"}}},"GetAllBankingBilletPixDepositBatchValidationErrorRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Validation error ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"banking_billet_pix_deposit_batch_id":{"type":"string","description":"Bank billet deposit batch ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"},"error_line":{"type":"number","description":"Error line.","example":10},"error_field":{"type":"string","description":"Error field.","example":"due_date"},"data":{"type":"string","description":"Invalid data sent.","example":"2025/10/22"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T19:41:08.000Z"}},"required":["id","banking_billet_pix_deposit_batch_id","error_line","error_field","created_at"]},"GetAllBankingBilletPixDepositBatchValidationErrorRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Validation error data.","type":"array","items":{"$ref":"#/components/schemas/GetAllBankingBilletPixDepositBatchValidationErrorRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetAllUserWithdrawSettingRestResponseItem":{"type":"object","properties":{"id":{"type":"string","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["ACTIVE","DEACTIVE"],"description":"Withdraw state.","example":"DEACTIVE"},"type":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","BALANCE"],"description":"Withdraw type","example":"DAILY"},"balance":{"type":"number","description":"Balance in R$ cents.","example":1299},"wallet_owner_branch":{"type":"string","description":"Wallet owner branch.","example":"0001"},"wallet_owner_account_number":{"type":"string","description":"Wallet owner account number.","example":"12345678"},"day":{"type":"number","description":"Schedule a day to execute the withdraw. Returns value only for DAILY type","example":null,"nullable":true},"week_day":{"type":"object","description":"Schedule a day to execute the withdraw. Returns value only for WEEKLY type","example":null,"nullable":true},"time":{"type":"string","description":"Scheduled time for the automatic daily withdrawal in HH:mm format (UTC-3 timezone).","example":"14:30","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Date of created withdraw.","example":"2026-05-29T19:41:08.791Z"}},"required":["id","state","type","balance"]},"GetAllUserWithdrawSettingRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"User withdraw setting data.","type":"array","items":{"$ref":"#/components/schemas/GetAllUserWithdrawSettingRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"DailyUserWithdrawSettingDto":{"type":"object","properties":{"balance":{"type":"number","description":"Withdraw settings balance in cents, minimum 100.","example":1000000},"total_available_balance":{"type":"boolean","description":"Total available balance for withdraw (if withdraw settings type is DAILY, WEEKLY or MONTHLY).","example":true,"default":false},"time":{"type":"string","description":"Scheduled time for the automatic daily withdrawal in HH:mm format (UTC-3 timezone). If not provided, the withdrawal will run at the default daily schedule.","example":"14:30"}}},"WeeklyUserWithdrawSettingDto":{"type":"object","properties":{"balance":{"type":"number","description":"Withdraw settings balance in cents, minimum 100.","example":1000000},"total_available_balance":{"type":"boolean","description":"Total available balance for withdraw (if withdraw settings type is DAILY, WEEKLY or MONTHLY).","example":true,"default":false},"week_day":{"type":"string","description":"Week day of withdraw (if withdraw settings type is WEEKLY).","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}}},"MonthlyUserWithdrawSettingDto":{"type":"object","properties":{"balance":{"type":"number","description":"Withdraw settings balance in cents, minimum 100.","example":1000000},"total_available_balance":{"type":"boolean","description":"Total available balance for withdraw (if withdraw settings type is DAILY, WEEKLY or MONTHLY).","example":true,"default":false},"day":{"type":"number","description":"Month day of withdraw (if withdraw settings type is MONTHLY).","example":10}}},"BalanceUserWithdrawSettingDto":{"type":"object","properties":{"balance":{"type":"number","description":"Withdraw settings balance in cents, minimum 100.","example":1000000}}},"CreateUserWithdrawSettingBody":{"type":"object","properties":{"transaction_type_tag":{"type":"string","description":"Transaction type tag.","example":"PIXSEND"},"pix_key_type":{"type":"string","description":"Pix key type.","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"],"example":"CNPJ"},"pix_key":{"type":"string","description":"Pix key.","example":"10213526000103"},"pix_key_document":{"type":"string","description":"Pix key document related (CPF or CNPJ).","example":"00000000000"},"type":{"type":"string","description":"Withdraw settings type.","enum":["DAILY","WEEKLY","MONTHLY","BALANCE"]},"data":{"description":"Withdraw configuration data (based on type)","oneOf":[{"$ref":"#/components/schemas/DailyUserWithdrawSettingDto"},{"$ref":"#/components/schemas/WeeklyUserWithdrawSettingDto"},{"$ref":"#/components/schemas/MonthlyUserWithdrawSettingDto"},{"$ref":"#/components/schemas/BalanceUserWithdrawSettingDto"}]}},"required":["transaction_type_tag","pix_key_type","pix_key","type","data"]},"CreateUserWithdrawSettingRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"User withdraw settings id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","description":"User withdraw settings state.","enum":["ACTIVE","DEACTIVE"],"example":"ACTIVE"},"type":{"type":"string","description":"Withdraw settings type.","enum":["DAILY","WEEKLY","MONTHLY","BALANCE"]},"balance":{"type":"number","description":"Withdraw settings balance.","example":1000000},"total_available_balance":{"type":"boolean","description":"Total available balance for withdraw (if withdraw settings type is DAILY, WEEKLY or MONTHLY).","example":true},"day":{"type":"number","description":"Month day of withdraw (if withdraw settings type is MONTHLY).","example":10},"week_day":{"type":"string","description":"Week day of withdraw (if withdraw settings type is WEEKLY).","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"time":{"type":"string","description":"Automatic withdraw time in HH:mm format (timezone UTC-3 - Brasilia).","example":"14:30"},"wallet_id":{"type":"string","description":"User wallet id.","example":"3267dfe0-73ee-4421-80e7-0c3a5372fa13"},"transaction_type_tag":{"type":"string","description":"Transaction type tag.","example":"PIXSEND"},"pix_key_type":{"type":"string","description":"Pix key type.","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"]},"pix_key":{"type":"string","description":"Pix key."},"pix_key_document":{"type":"string","description":"Pix key document related (CPF or CNPJ).","example":"00000000000"},"created_at":{"format":"date-time","type":"string","description":"Date of created withdraw.","example":"2026-05-29T19:41:08.792Z"}},"required":["id","state","type","balance","wallet_id","transaction_type_tag","pix_key_type","pix_key","created_at"]},"V5GeneratePixStatementExportBody":{"type":"object","properties":{"created_at_start":{"type":"string","description":"Start date for the statement (format: YYYY-MM-DD). Filters operations where transaction_created_at >= this date (inclusive).","example":"2024-01-01","format":"date"},"created_at_end":{"type":"string","description":"End date for the statement (format: YYYY-MM-DD). Filters operations where transaction_created_at < this date (exclusive).","example":"2024-01-01","format":"date"},"type_extension":{"type":"string","description":"Type of the report.","default":"CSV","enum":["CSV","XML","OFX","PDF"]}}},"V5GeneratePixStatementExportRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"Generated file ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","description":"File state.","enum":["PENDING","WAITING_UPLOAD","READY","ERROR","ABORTED"],"example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"File created at.","example":"2026-05-29T19:41:08.799Z"}},"required":["file_id","state","created_at"]},"GetAllReportPixStatementRestResponseItem":{"type":"object","properties":{"beneficiary_bank_name":{"type":"string","description":"Payment beneficiary bank name.","example":"Bank Name S.A."},"beneficiary_branch":{"type":"string","description":"Payment beneficiary branch (bank agency).","example":"0001"},"beneficiary_document":{"type":"string","description":"Payment beneficiary document (cpf or cnpj).","example":"87908771017"},"beneficiary_name":{"type":"string","description":"Payment beneficiary name.","example":"Fulano de Tal"},"beneficiary_person_type":{"type":"string","description":"Payment beneficiary person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"LEGAL_PERSON"},"beneficiary_account_number":{"type":"string","description":"Payment beneficiary account number.","example":"12376786"},"beneficiary_account_type":{"type":"string","description":"Payment beneficiary account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"beneficiary_bank_ispb":{"type":"string","description":"Payment beneficiary bank ispb.","example":"26264220"},"wallet_id":{"type":"string","description":"User wallet id.","example":"3267dfe0-73ee-4421-80e7-0c3a5372fa13"},"description":{"type":"string","description":"Payment description."},"end_to_end_id":{"type":"string","description":"Payment end to end id.","example":"36f81858-f3ed-4ee5-8e6f-5f834129f6ec"},"key":{"type":"string","description":"Payment key.","example":"bdb98227-3e02-4fa2-8e71-bfb8e4b4310a"},"operation_type":{"type":"string","enum":["C","D"],"description":"Operations type.","example":"C"},"owner_account_number":{"type":"string","description":"Payment owner account number.","example":"33338888"},"owner_branch":{"type":"string","description":"Payment owner branch.","example":"0001"},"owner_document":{"type":"string","description":"Payment owner document (cpf or cnpj).","example":"14102415726"},"owner_full_name":{"type":"string","description":"Payment owner full name.","example":"Joao da Silva"},"owner_person_type":{"type":"string","description":"Payment owner person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"LEGAL_PERSON"},"payment_confirmed_at":{"format":"date-time","type":"string","description":"Payment confirmed at.","example":"2026-05-29T19:41:08.798Z"},"payment_canceled_at":{"format":"date-time","type":"string","description":"Payment canceled at.","example":"2026-05-29T19:41:08.798Z"},"payment_date":{"format":"date-time","type":"string","description":"Payment date.","example":"2026-05-29T19:41:08.798Z"},"payment_type":{"type":"string","description":"Payment type.","enum":["ACCOUNT","KEY","QR_CODE","QR_CODE_STATIC_INSTANT","QR_CODE_STATIC_WITHDRAWAL","QR_CODE_DYNAMIC_DUE_DATE","QR_CODE_DYNAMIC_WITHDRAWAL","QR_CODE_DYNAMIC_CHANGE","QR_CODE_DYNAMIC_INSTANT","REFUND","AUTOMATIC_PAYMENT","OPEN_FINANCE"],"example":"ACCOUNT"},"priority_type":{"type":"string","description":"Priority type."},"state":{"type":"string","description":"Payment state.","enum":["PENDING","PENDING_GATEWAY","SCHEDULED","WAITING","WAITING_INTERNAL","WAITING_DELAYED","CONFIRMED","FAILED","CANCELED","ANTIFRAUD_ANALYSIS","ANTIFRAUD_ANALYSIS_REVIEW"],"example":"CONFIRMED"},"operation_created_at":{"format":"date-time","type":"string","description":"Operation created at.","example":"2026-05-29T19:41:08.798Z"},"transaction_id":{"type":"string","description":"Transaction ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"transaction_type_tag":{"type":"string","description":"Operation transaction type tag.","enum":["P2PBT","WITHDRAW","PIXCHANGE","PIXDEVREC","PIXDEVSEND","PIXREC","PIXREFUND","PIXREFUNDDEV","PIXSEND","PIXSENDAUTOMATIC","PIXSENDSELF","TED","CONV","BTCSEND","BTCRECEIVE","BBP","BBD","DEPORECEIVE","TEDRECEIVE","DEBITTRANSACTION","DEBITCBK","TEDFAILURE","TEDUNDO","TEDRECCBK","DEPRECCBK","DOCRECEIVE","PIXRECEIVE","WITHDRAWCBK","CASHBACK","CASHBACKCBK","FORFEITURE","DBTCARDCRED","ACTCLOSURE","REFREWARD","EXTRACREDIT","SALECREDCARD","SALEDEBTCARD","PIXWITHDRAWAL","ADMCRYPTOSEND","ADMCRYPTOREC","P2PBTCTP","P2PBTCTC","P2PTP","P2PTC","CBK","P2MTP","SP","TEDTRANSFERSELF","TEDDEVREC","PIXSENDRESTRICTED","CASHREC","BANKTRANSFERREC","BANKTRANSFERSEND_ARG","BANKTRANSFERDEV_ARG","BANKTRANSFERSEND_CHL","BANKTRANSFERDEV_CHL","BANKTRANSFERSEND_PER","BANKTRANSFERDEV_PER","DEBITCARDREC","CREDITCARDREC","CREDITDEBITCARDREC","YAPEWALLETREC","YAPEWALLETDEV","QRREC","PIXREFUNDCBK"],"example":"PIXREC"},"transaction_updated_at":{"format":"date-time","type":"string","description":"Transaction updated at.","example":"2026-05-29T19:41:08.798Z"},"txid":{"type":"string","description":"Payment tx Id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"merchant_id":{"type":"string","description":"Merchant ID.","example":"Merchant unique defined"},"value":{"type":"number","description":"Payment value.","example":10000}},"required":["wallet_id","operation_type","state","operation_created_at","transaction_id","transaction_type_tag","value"]},"V2GetAllReportPixStatementRestResponse":{"type":"object","properties":{"data":{"description":"Pix statement data.","type":"array","items":{"$ref":"#/components/schemas/GetAllReportPixStatementRestResponseItem"}},"has_next_page":{"type":"boolean","description":"Has next page."},"page_state":{"type":"string","description":"Page state."}},"required":["data","has_next_page"]},"V4GetAllReportOperationStatementRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Operation ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"fee":{"type":"number","description":"Fee.","example":1},"value":{"type":"number","description":"Value.","example":1},"updated_balance":{"type":"number","description":"Updated balance.","example":1},"previous_balance":{"type":"number","description":"Previous balance.","example":1},"description":{"type":"string","description":"Description.","example":"Get statement"},"created_at":{"format":"date-time","type":"string","description":"Operation creation date.","example":"2026-05-29T19:41:08.800Z"},"updated_at":{"format":"date-time","type":"string","description":"Operation updated date.","example":"2026-05-29T19:41:08.800Z"},"transaction_id":{"type":"string","description":"Transaction Id (Statement ID). Ledger ID when the balance changed.","example":"2026-05-29T19:41:08.800Z"},"transaction_created_at":{"format":"date-time","type":"string","description":"Transaction created date (Statement created date). The time when the balance changed.","example":"2026-05-29T19:41:08.800Z"},"transaction_created_at_unixtime":{"type":"number","description":"Transaction created date (Statement created date). The time is in microseconds.","example":1759337318878533},"currency_id":{"type":"number","description":"Currency ID.","example":1},"currency_symbol":{"type":"string","description":"Currency symbol.","example":"BRL"},"transaction_type_id":{"type":"number","description":"Transaction type ID.","example":1},"transaction_type_tag":{"type":"string","description":"Transaction type tag.","enum":["P2PBT","WITHDRAW","PIXCHANGE","PIXDEVREC","PIXDEVSEND","PIXREC","PIXREFUND","PIXREFUNDDEV","PIXSEND","PIXSENDAUTOMATIC","PIXSENDSELF","TED","CONV","BTCSEND","BTCRECEIVE","BBP","BBD","DEPORECEIVE","TEDRECEIVE","DEBITTRANSACTION","DEBITCBK","TEDFAILURE","TEDUNDO","TEDRECCBK","DEPRECCBK","DOCRECEIVE","PIXRECEIVE","WITHDRAWCBK","CASHBACK","CASHBACKCBK","FORFEITURE","DBTCARDCRED","ACTCLOSURE","REFREWARD","EXTRACREDIT","SALECREDCARD","SALEDEBTCARD","PIXWITHDRAWAL","ADMCRYPTOSEND","ADMCRYPTOREC","P2PBTCTP","P2PBTCTC","P2PTP","P2PTC","CBK","P2MTP","SP","TEDTRANSFERSELF","TEDDEVREC","PIXSENDRESTRICTED","CASHREC","BANKTRANSFERREC","BANKTRANSFERSEND_ARG","BANKTRANSFERDEV_ARG","BANKTRANSFERSEND_CHL","BANKTRANSFERDEV_CHL","BANKTRANSFERSEND_PER","BANKTRANSFERDEV_PER","DEBITCARDREC","CREDITCARDREC","CREDITDEBITCARDREC","YAPEWALLETREC","YAPEWALLETDEV","QRREC","PIXREFUNDCBK"],"example":"PIXSEND"},"transaction_type":{"type":"string","description":"Transaction type.","enum":["C","D"],"example":"D"},"owner_wallet_account_uuid":{"type":"string","description":"Owner wallet account ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"beneficiary_wallet_account_uuid":{"type":"string","description":"Beneficiary wallet account ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"operation_ref_id":{"type":"string","description":"Operation reference ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"chargeback_id":{"type":"string","description":"Chargeback ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"merchant_id":{"type":"string","description":"Merchant ID.","example":"Merchant unique defined"}},"required":["id","value","created_at","updated_at","transaction_id","transaction_created_at","currency_id","currency_symbol","transaction_type_id","transaction_type_tag","transaction_type"]},"V4GetAllReportOperationStatementRestResponse":{"type":"object","properties":{"data":{"description":"Report operation statement data.","type":"array","items":{"$ref":"#/components/schemas/V4GetAllReportOperationStatementRestResponseItem"}},"has_next_page":{"type":"boolean","description":"Has next page."},"page_state":{"type":"string","description":"Page state."}},"required":["data","has_next_page"]},"V4GenerateReportOperationStatementExportBody":{"type":"object","properties":{"sort":{"type":"string","description":"Page sort attribute.","default":"transaction_created_at","enum":["transaction_created_at"]},"order":{"type":"string","description":"Page order.","default":"desc","enum":["asc","desc"]},"user_configs":{"type":"array","description":"User configuration options to apply in the export.","example":["show_third_part_cpf_in_export"],"items":{"type":"string","enum":["show_third_part_cpf","show_third_part_cpf_in_export","show_decoded_pix_key_document","show_third_part_account_number","show_third_part_account_type","show_third_part_account_number_in_export","show_third_part_branch_number","show_beneficiary_account_number_and_type","show_beneficiary_branch_number","request_merchant_id_required","bet_segmentation"]}},"filter_type":{"type":"string","enum":["currency_symbol","merchant_id","topic","value","transaction_type_tag","third_part_document"],"description":"Filter type.
\n ","example":"topic"},"filter_text":{"type":"string","description":"Filter Text.
\n ","example":"PIX"},"created_at_start":{"format":"date-time","type":"string","example":"2026-05-29T19:41:08.799Z","description":"Transaction created at start. Filters transactions where transaction_created_at >= this date."},"created_at_end":{"format":"date-time","type":"string","example":"2026-05-29T19:41:08.800Z","description":"Transaction created at end. Filters transactions where transaction_created_at < this date (exclusive)."},"local_timezone_start":{"type":"number","description":"Local timezone to validate start date.","example":-3},"local_timezone_end":{"type":"number","description":"Local timezone to validate end date.","example":-3},"type_extension":{"type":"string","description":"Type of the report.","default":"CSV","enum":["CSV","XML","OFX","PDF"]}}},"V4GenerateReportOperationStatementExportRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"Generated file ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_state":{"type":"string","description":"Generated file state.","enum":["PENDING","WAITING_UPLOAD","READY","ERROR","ABORTED"],"example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"File created at.","example":"2026-05-29T19:41:08.800Z"}},"required":["file_id","file_state","created_at"]},"GetAllFilesRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_name":{"type":"string","description":"File name.","example":"f6e2e084-29b9-4935-a059-5473b13033aa-report-operation.csv"},"folder_name":{"type":"string","description":"File folder.","example":"Teste."},"type":{"type":"string","description":"File type.","enum":["DAILY_BALANCE_SUMMARY","DAILY_BALANCE_SUMMARY_DETAILED","REPORT_STATEMENTS","REPORT_PIX_STATEMENTS","REPORT_PIX_STATEMENTS_PRODUCT","REPORT_OPERATION_STATEMENTS","REPORT_OPERATION_STATEMENTS_PRODUCT","REPORT_TRANSACTION_SUMMARY_PRODUCT","REPORT_INTERNATIONAL_STATEMENTS","CARD_CLEARING","BANKING_BILLET_DEPOSIT","ONBOARDING_DOCUMENTS","LEGAL_PERSON_ONBOARDING_DOCUMENTS","CARD_ONBOARDING_DOCUMENTS","COMPANY_DOCUMENTS","REPORT_ENDR","OTHERS","OPERATION_RECEIPT","QUOTE_RECEIPT","PIX_REFUND_FILES","BANKING_BILLET_PIX_DEPOSIT_BATCH_FILE","PIX_FUND_RECOVERY_REQUEST_FILES","CROSSBORDER_CLIENT_DOCUMENT","CROSSBORDER_CLIENT_ACCOUNT_DOCUMENT","CROSSBORDER_CLIENT_WALLET_DOCUMENT","CROSSBORDER_QUOTE_DOCUMENT","CROSSBORDER_COUNTERPARTY_DOCUMENT","CROSSBORDER_COUNTERPARTY_WALLET_DOCUMENT","REPORT_QUOTE_STATEMENTS"],"example":"REPORT_OPERATION_STATEMENTS"},"created_at":{"format":"date-time","type":"string","description":"File created at.","example":"2026-05-29T19:41:08.801Z"},"updated_at":{"format":"date-time","type":"string","description":"File updated at.","example":"2026-05-29T19:41:08.801Z"}},"required":["id","file_name","folder_name","created_at","updated_at"]},"GetAllFilesRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Files data.","type":"array","items":{"$ref":"#/components/schemas/GetAllFilesRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V2GetFileUrlByIdRestResponse":{"type":"object","properties":{"url":{"type":"string","description":"URL File.","example":"https://s3.amazonaws.com/bucket/folder/file.csv"},"size":{"type":"number","description":"Size File. This format is in bytes. Ex: 307504 Byte => 300 KB => 0.3 MB","example":307504},"state":{"type":"string","description":"File state.","example":"PENDING","enum":["PENDING","WAITING_UPLOAD","READY","ERROR","ABORTED"]}},"required":["url","size","state"]},"UploadBySignedUrlFileBody":{"type":"object","properties":{"file_date":{"type":"string","description":"The reference file date. Format: YYYY-MM-DD.","example":"2026-05-29","format":"date"},"file_name":{"type":"string","description":"The name of the file with extension.","example":"document.csv"},"folder_name":{"type":"string","description":"Folder name. The requested value will be concatenated with the identifier of the user making the request.","example":"banking/batch"},"file_type":{"type":"string","description":"File type.","enum":["DAILY_BALANCE_SUMMARY","DAILY_BALANCE_SUMMARY_DETAILED","REPORT_STATEMENTS","REPORT_PIX_STATEMENTS","REPORT_PIX_STATEMENTS_PRODUCT","REPORT_OPERATION_STATEMENTS","REPORT_OPERATION_STATEMENTS_PRODUCT","REPORT_TRANSACTION_SUMMARY_PRODUCT","REPORT_INTERNATIONAL_STATEMENTS","CARD_CLEARING","BANKING_BILLET_DEPOSIT","ONBOARDING_DOCUMENTS","LEGAL_PERSON_ONBOARDING_DOCUMENTS","CARD_ONBOARDING_DOCUMENTS","COMPANY_DOCUMENTS","REPORT_ENDR","OTHERS","OPERATION_RECEIPT","QUOTE_RECEIPT","PIX_REFUND_FILES","BANKING_BILLET_PIX_DEPOSIT_BATCH_FILE","PIX_FUND_RECOVERY_REQUEST_FILES","CROSSBORDER_CLIENT_DOCUMENT","CROSSBORDER_CLIENT_ACCOUNT_DOCUMENT","CROSSBORDER_CLIENT_WALLET_DOCUMENT","CROSSBORDER_QUOTE_DOCUMENT","CROSSBORDER_COUNTERPARTY_DOCUMENT","CROSSBORDER_COUNTERPARTY_WALLET_DOCUMENT","REPORT_QUOTE_STATEMENTS"],"example":"REPORT_ENDR"},"gateway_name":{"type":"string","description":"The destination gateway for this file.","enum":["AWS_S3","AWS_S3_ARCHIVE","AWS_S3_DOCUMENT","AWS_S3_STATIC_FILES","FILE_STORAGE"],"example":"AWS_S3"}},"required":["file_date","file_name","folder_name","file_type","gateway_name"]},"UploadBySignedUrlFileRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID"},"url":{"type":"string","description":"File URL","example":"https://s3.amazonaws.com/bucket/folder/file.csv"}},"required":["file_id","url"]},"GetUserBankAccountByWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"User bank account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User UUID.","example":"caff7d9f-b554-4978-b87d-717a4115a7a8"},"user_document":{"type":"string","description":"User document.","example":"84411010003"},"onboarding_id":{"type":"string","description":"Onboarding UUID.","example":"79ffc231-d5b5-4e84-9384-4b9ce5d36a9c"},"account_number":{"type":"string","description":"Account number.","example":"123456"},"branch_number":{"type":"string","description":"Branch number.","example":"0001"},"active":{"type":"boolean","description":"User bank account is active.","example":true},"default":{"type":"boolean","description":"User bank account default flag.","example":false},"created_at":{"format":"date-time","type":"string","description":"User bank account created at.","example":"2026-05-29T19:41:08.803Z"}},"required":["id","user_id","user_document","onboarding_id","account_number","branch_number","active","default","created_at"]},"CreatePixRecurrenceBody":{"type":"object","properties":{"frequency":{"type":"string","description":"Pix recurrence frequency.","enum":["WEEKLY","MONTHLY"],"example":"MONTHLY"},"day_of_the_week":{"type":"string","description":"Day of the week in case of weekly frequency.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"MONDAY","nullable":true},"day_of_the_month":{"type":"number","description":"Day of the month in case of monthly frequency.","example":1},"end_date":{"type":"string","description":"End date of the recurrence.","example":"2026-05-29","format":"date"},"payment_id":{"type":"string","description":"First payment id.","example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44"},"first_payment_date":{"type":"string","description":"First payment date.","example":"2026-05-29","format":"date"}},"required":["frequency","end_date","payment_id","first_payment_date"]},"CreatePixRecurrenceRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Recurrence ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","enum":["ACTIVE","DEACTIVATED"],"description":"Recurrence state.","example":"ACTIVE"},"created_at":{"format":"date-time","type":"string","description":"Recurrence created at.","example":"2026-05-29T19:41:08.886Z"}},"required":["id","state","created_at"]},"DeactivatePixRecurrenceByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Pix recurrence ID.","example":"0a5c6a43-d7d4-4635-9075-c9a5aaf24a44"}},"required":["id"]},"GetPixRecurrenceByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Recurrence ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"value":{"type":"number","description":"Recurrence value.","example":100},"beneficiary_name":{"type":"string","description":"Recurrence beneficiary name.","example":"John Doe."},"state":{"type":"string","description":"Recurrence state.","enum":["ACTIVE","DEACTIVATED"],"example":"ACTIVE"},"frequency":{"type":"string","description":"Recurrence frequency.","enum":["WEEKLY","MONTHLY"],"example":"MONTHLY"},"day_of_the_week":{"type":"string","description":"Recurrence day of the week.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"FRIDAY"},"day_of_the_month":{"type":"number","description":"Recurrence day of the month.","example":10},"end_date":{"format":"date-time","type":"string","description":"Recurrence end date.","example":"2026-05-29T19:41:08.887Z"},"first_payment_date":{"format":"date-time","type":"string","description":"Recurrence first payment date.","example":"2026-05-29T19:41:08.887Z"},"last_payment_date":{"format":"date-time","type":"string","description":"Recurrence last payment date.","example":"2026-05-29T19:41:08.887Z"},"created_at":{"format":"date-time","type":"string","description":"Recurrence creation date.","example":"2026-05-29T19:41:08.887Z"},"updated_at":{"format":"date-time","type":"string","description":"Recurrence update date.","example":"2026-05-29T19:41:08.887Z"}},"required":["id","value","beneficiary_name","state","frequency"]},"GetAllPixRecurrenceRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Recurrence ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"value":{"type":"number","description":"Recurrence value.","example":100},"beneficiary_name":{"type":"string","description":"Recurrence beneficiary name.","example":"John Doe."},"state":{"type":"string","description":"Recurrence state.","enum":["ACTIVE","DEACTIVATED"],"example":"ACTIVE"},"frequency":{"type":"string","description":"Recurrence frequency.","enum":["WEEKLY","MONTHLY"],"example":"MONTHLY"},"day_of_the_week":{"type":"string","description":"Recurrence day of the week.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"FRIDAY"},"day_of_the_month":{"type":"number","description":"Recurrence day of the month.","example":10},"end_date":{"format":"date-time","type":"string","description":"Recurrence end date.","example":"2026-05-29T19:41:08.887Z"},"first_payment_date":{"format":"date-time","type":"string","description":"Recurrence first payment date.","example":"2026-05-29T19:41:08.887Z"},"last_payment_date":{"format":"date-time","type":"string","description":"Recurrence last payment date.","example":"2026-05-29T19:41:08.887Z"},"created_at":{"format":"date-time","type":"string","description":"Recurrence creation date.","example":"2026-05-29T19:41:08.887Z"},"updated_at":{"format":"date-time","type":"string","description":"Recurrence update date.","example":"2026-05-29T19:41:08.887Z"}},"required":["id","value","beneficiary_name","state","frequency"]},"GetAllPixRecurrenceRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Pix recurrence data","type":"array","items":{"$ref":"#/components/schemas/GetAllPixRecurrenceRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetAllPixScheduledPaymentRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Pix scheduled payment ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"value":{"type":"number","description":"Pix scheduled payment value.","example":100},"beneficiary_name":{"type":"string","description":"Pix scheduled payment beneficiary name.","example":"John Doe."},"state":{"type":"string","description":"Pix scheduled payment state.","enum":["PENDING","READY","CANCELED","FAILED"],"example":"PENDING"},"type":{"type":"string","description":"Pix scheduled payment state.","enum":["PIX_RECURRING_PAYMENT","PIX_AUTOMATIC_PAYMENT","OTHER"],"example":"PIX_RECURRING_PAYMENT"},"pix_payment_id":{"type":"string","description":"Pix payment id.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"operation_id":{"type":"string","description":"Operation id.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"payment_date":{"format":"date-time","type":"string","description":"Pix scheduled payment payment date.","example":"2026-05-29T19:41:08.888Z"},"created_at":{"format":"date-time","type":"string","description":"Pix scheduled payment creation date.","example":"2026-05-29T19:41:08.888Z"},"updated_at":{"format":"date-time","type":"string","description":"Pix scheduled payment update date.","example":"2026-05-29T19:41:08.888Z"}},"required":["id","value","beneficiary_name","state","type","pix_payment_id","operation_id"]},"GetAllPixScheduledPaymentRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Pix scheduled payment data","type":"array","items":{"$ref":"#/components/schemas/GetAllPixScheduledPaymentRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetAllPixAutomaticAuthorizationRestResponseItem$1":{"type":"object","properties":{"id":{"type":"string","description":"Authorization ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"journey":{"type":"string","enum":["JOURNEY_1","JOURNEY_2","JOURNEY_3","JOURNEY_4"],"description":"Authorization journey.","example":"JOURNEY_1"},"frequency":{"type":"string","description":"Authorization frequency.","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"MONTHLY"},"start_date":{"type":"string","description":"Authorization start date","example":"2026-05-29","format":"YYYY-MM-DD"},"end_date":{"type":"string","description":"Authorization end date","example":"2026-05-29","format":"YYYY-MM-DD"},"value":{"type":"number","description":"Authorization value","example":100},"floor_max_value":{"type":"number","description":"Authorization floor max value","example":50},"beneficiary_ispb":{"type":"string","description":"Authorization beneficiary ISPB","example":"7219"},"beneficiary_document":{"type":"string","description":"Authorization beneficiary document","example":"01234567890"},"beneficiary_name":{"type":"string","description":"Authorization beneficiary name","example":"John Doe"},"owner_document":{"type":"string","description":"Authorization owner (payer) document","example":"02345678912"},"debtor_document":{"type":"string","description":"Authorization debtor document","example":"03456789013"},"debtor_name":{"type":"string","description":"Authorization debtor name","example":"John Wick"},"contract_number":{"type":"string","description":"Authorization contract number","example":"123456-7"},"contract_description":{"type":"string","description":"Authorization contract description","example":"Gym monthly subscription"},"request_expiration_date":{"format":"date-time","type":"string","description":"Authorization request expiration date","example":"2026-05-29T19:41:08.889Z"},"status":{"type":"string","description":"Authorization status","enum":["PENDING","WAITING_APPROVAL","WAITING_REJECTION","APPROVED","REJECTED","WAITING_CANCELLATION","CANCELED","FINISHED"],"example":"APPROVED"},"state":{"type":"string","description":"Authorization state","enum":["PENDING_CONFIRMED","WAITING_APPROVAL_CONFIRMED","WAITING_REJECTION_CONFIRMED","APPROVED_CONFIRMED","REJECTED_CONFIRMED","APPROVED_FAILED","REJECTED_FAILED","WAITING_CANCELLATION_CONFIRMED","CANCELED_CONFIRMED","CANCELED_FAILED","FINISHED_CONFIRMED","UPDATED_CONFIRMED","UPDATED_FAILED"],"example":"PENDING_CONFIRMED"},"payment_max_value":{"type":"number","description":"Authorization payment max value (defined by payer)","example":80},"created_at":{"format":"date-time","type":"string","description":"Authorization creation date.","example":"2026-05-29T19:41:08.889Z"},"updated_at":{"format":"date-time","type":"string","description":"Authorization update date.","example":"2026-05-29T19:41:08.889Z"}},"required":["id","journey","frequency","start_date","beneficiary_ispb","beneficiary_document","beneficiary_name","owner_document","contract_number","contract_description","request_expiration_date","status"]},"GetAllPixAutomaticAuthorizationRestResponse$2":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Automatic pix authorization data","type":"array","items":{"$ref":"#/components/schemas/GetAllPixAutomaticAuthorizationRestResponseItem$1"}}},"required":["page","page_size","page_total","total","data"]},"GetAllPixAutomaticAuthorizationRestResponse$1":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Automatic pix authorization data","type":"array","items":{"$ref":"#/components/schemas/GetAllPixAutomaticAuthorizationRestResponseItem$1"}}},"required":["page","page_size","page_total","total","data"]},"GetAllPixAutomaticAuthorizationRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Authorization ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"journey":{"type":"string","enum":["JOURNEY_1","JOURNEY_2","JOURNEY_3","JOURNEY_4"],"description":"Authorization journey.","example":"JOURNEY_1"},"frequency":{"type":"string","description":"Authorization frequency.","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"MONTHLY"},"start_date":{"type":"string","description":"Authorization start date","example":"2026-05-29","format":"YYYY-MM-DD"},"end_date":{"type":"string","description":"Authorization end date","example":"2026-05-29","format":"YYYY-MM-DD"},"value":{"type":"number","description":"Authorization value","example":100},"floor_max_value":{"type":"number","description":"Authorization floor max value","example":50},"beneficiary_ispb":{"type":"string","description":"Authorization beneficiary ISPB","example":"7219"},"beneficiary_document":{"type":"string","description":"Authorization beneficiary document","example":"01234567890"},"beneficiary_name":{"type":"string","description":"Authorization beneficiary name","example":"John Doe"},"owner_document":{"type":"string","description":"Authorization owner (payer) document","example":"02345678912"},"debtor_document":{"type":"string","description":"Authorization debtor document","example":"03456789013"},"debtor_name":{"type":"string","description":"Authorization debtor name","example":"John Wick"},"contract_number":{"type":"string","description":"Authorization contract number","example":"123456-7"},"contract_description":{"type":"string","description":"Authorization contract description","example":"Gym monthly subscription"},"request_expiration_date":{"format":"date-time","type":"string","description":"Authorization request expiration date","example":"2026-05-29T19:41:08.890Z"},"status":{"type":"string","description":"Authorization status","enum":["PENDING","WAITING_APPROVAL","WAITING_REJECTION","APPROVED","REJECTED","WAITING_CANCELLATION","CANCELED","FINISHED"],"example":"APPROVED"},"state":{"type":"string","description":"Authorization state","enum":["PENDING_CONFIRMED","WAITING_APPROVAL_CONFIRMED","WAITING_REJECTION_CONFIRMED","APPROVED_CONFIRMED","REJECTED_CONFIRMED","APPROVED_FAILED","REJECTED_FAILED","WAITING_CANCELLATION_CONFIRMED","CANCELED_CONFIRMED","CANCELED_FAILED","FINISHED_CONFIRMED","UPDATED_CONFIRMED","UPDATED_FAILED"],"example":"PENDING_CONFIRMED"},"payment_max_value":{"type":"number","description":"Authorization payment max value (defined by payer)","example":80},"created_at":{"format":"date-time","type":"string","description":"Authorization creation date.","example":"2026-05-29T19:41:08.890Z"},"updated_at":{"format":"date-time","type":"string","description":"Authorization update date.","example":"2026-05-29T19:41:08.890Z"}},"required":["id","journey","frequency","start_date","beneficiary_ispb","beneficiary_document","beneficiary_name","owner_document","contract_number","contract_description","request_expiration_date","status"]},"GetAllPixAutomaticPaymentRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Payment ID","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"pix_automatic_authorization":{"description":"Authorization","allOf":[{"$ref":"#/components/schemas/GetAllPixAutomaticAuthorizationRestResponseItem"}]},"due_date":{"type":"string","description":"Payment due date","example":"2026-04-15","format":"YYYY-MM-DD"},"value":{"type":"number","description":"Payment value","example":100},"scheduling_purpose":{"type":"string","description":"Payment scheduling purpose","enum":["SCHEDULING","NEW_ATTEMPT","RESEND"],"example":"SCHEDULING"},"status":{"type":"string","description":"Payment status","enum":["CREATED","WAITING_CANCELLATION","CANCELLATION_FAILED","CANCELED"],"example":"CREATED"},"created_at":{"format":"date-time","type":"string","description":"Payment creation date.","example":"2026-05-29T19:41:08.890Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment update date.","example":"2026-05-29T19:41:08.890Z"}},"required":["id","pix_automatic_authorization","due_date","value","scheduling_purpose","status"]},"GetAllPixAutomaticPaymentRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Automatic pix payment data","type":"array","items":{"$ref":"#/components/schemas/GetAllPixAutomaticPaymentRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetPixAutomaticAuthorizationByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Authorization ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"journey":{"type":"string","enum":["JOURNEY_1","JOURNEY_2","JOURNEY_3","JOURNEY_4"],"description":"Authorization journey","example":"JOURNEY_1"},"frequency":{"type":"string","description":"Authorization frequency","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"MONTHLY"},"start_date":{"type":"string","description":"Authorization start date","example":"2025-04-15","format":"YYYY-MM-DD"},"end_date":{"type":"string","description":"Authorization end date","example":"2026-04-15","format":"YYYY-MM-DD"},"value":{"type":"number","description":"Authorization value","example":100},"floor_max_value":{"type":"number","description":"Authorization floor max value","example":50},"beneficiary_ispb":{"type":"string","description":"Authorization beneficiary ISPB","example":"7219"},"beneficiary_document":{"type":"string","description":"Authorization beneficiary document","example":"01234567890"},"beneficiary_name":{"type":"string","description":"Authorization beneficiary name","example":"John Doe"},"owner_document":{"type":"string","description":"Authorization owner (payer) document","example":"02345678912"},"debtor_document":{"type":"string","description":"Authorization debtor document","example":"03456789013"},"debtor_name":{"type":"string","description":"Authorization debtor name","example":"John Wick"},"contract_number":{"type":"string","description":"Authorization contract number","example":"123456-7"},"contract_description":{"type":"string","description":"Authorization contract description","example":"Gym monthly subscription"},"request_expiration_date":{"format":"date-time","type":"string","description":"Authorization request expiration date","example":"2026-05-29T19:41:08.890Z"},"status":{"type":"string","description":"Authorization status","enum":["PENDING","WAITING_APPROVAL","WAITING_REJECTION","APPROVED","REJECTED","WAITING_CANCELLATION","CANCELED","FINISHED"],"example":"APPROVED"},"state":{"type":"string","description":"Authorization state","enum":["PENDING_CONFIRMED","WAITING_APPROVAL_CONFIRMED","WAITING_REJECTION_CONFIRMED","APPROVED_CONFIRMED","REJECTED_CONFIRMED","APPROVED_FAILED","REJECTED_FAILED","WAITING_CANCELLATION_CONFIRMED","CANCELED_CONFIRMED","CANCELED_FAILED","FINISHED_CONFIRMED","UPDATED_CONFIRMED","UPDATED_FAILED"],"example":"PENDING_CONFIRMED"},"payment_max_value":{"type":"number","description":"Authorization payment max value (defined by payer)","example":80},"created_at":{"format":"date-time","type":"string","description":"Authorization creation date.","example":"2026-05-29T19:41:08.890Z"},"updated_at":{"format":"date-time","type":"string","description":"Authorization update date.","example":"2026-05-29T19:41:08.891Z"}},"required":["id","journey","frequency","start_date","beneficiary_ispb","beneficiary_document","beneficiary_name","owner_document","contract_number","request_expiration_date","status","created_at","updated_at"]},"GetPixAutomaticPaymentByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment ID","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"pix_automatic_authorization":{"description":"Authorization","allOf":[{"$ref":"#/components/schemas/GetPixAutomaticAuthorizationByIdRestResponse"}]},"due_date":{"type":"string","description":"Payment due date","example":"2026-04-15","format":"YYYY-MM-DD"},"value":{"type":"number","description":"Payment value","example":100},"scheduling_purpose":{"type":"string","description":"Payment scheduling purpose","enum":["SCHEDULING","NEW_ATTEMPT","RESEND"],"example":"SCHEDULING"},"status":{"type":"string","description":"Payment status","enum":["CREATED","WAITING_CANCELLATION","CANCELLATION_FAILED","CANCELED"],"example":"CREATED"},"created_at":{"format":"date-time","type":"string","description":"Payment creation date.","example":"2026-05-29T19:41:08.891Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment update date.","example":"2026-05-29T19:41:08.891Z"}},"required":["id","pix_automatic_authorization","due_date","value","scheduling_purpose","status"]},"ApprovePixAutomaticAuthorizationByQrCodeBodyParam":{"type":"object","properties":{"payment_max_value":{"type":"number","description":"Payment maximum value.","example":1000}},"required":["payment_max_value"]},"ApprovePixAutomaticAuthorizationByQrCodeRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Authorization ID.","example":"a3b5c7d9-1234-5678-90ab-cdef12345678"},"payment_id":{"type":"string","description":"Payment ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"}},"required":["id"]},"ApprovePixAutomaticAuthorizationBodyParam":{"type":"object","properties":{"payment_max_value":{"type":"number","description":"Payment maximum value.","example":1000}},"required":["payment_max_value"]},"RejectPixAutomaticAuthorizationBodyParam":{"type":"object","properties":{"rejection_reason":{"type":"string","enum":["UNRECOGNIZED_RECEIVER","NOT_INTERESTED"],"description":"Rejection reason.","example":"NOT_INTERESTED"}},"required":["rejection_reason"]},"UpdatePixAutomaticAuthorizationBodyParam":{"type":"object","properties":{"payment_max_value":{"type":"number","description":"Payment maximum value.","example":1000}},"required":["payment_max_value"]},"GetPixAutomaticPaymentByPixPaymentIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment ID","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"pix_automatic_authorization":{"description":"Authorization","allOf":[{"$ref":"#/components/schemas/GetPixAutomaticAuthorizationByIdRestResponse"}]},"due_date":{"type":"string","description":"Payment due date","example":"2026-04-15","format":"YYYY-MM-DD"},"value":{"type":"number","description":"Payment value","example":100},"scheduling_purpose":{"type":"string","description":"Payment scheduling purpose","enum":["SCHEDULING","NEW_ATTEMPT","RESEND"],"example":"SCHEDULING"},"status":{"type":"string","description":"Payment status","enum":["CREATED","WAITING_CANCELLATION","CANCELLATION_FAILED","CANCELED"],"example":"CREATED"},"created_at":{"format":"date-time","type":"string","description":"Payment creation date.","example":"2026-05-29T19:41:08.891Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment update date.","example":"2026-05-29T19:41:08.891Z"}},"required":["id","pix_automatic_authorization","due_date","value","scheduling_purpose","status"]},"UpdatePixAutomaticRecurrenceBodyParam":{"type":"object","properties":{"value":{"type":"number","description":"Value for the charges in Brazilian Real (R$) cents.","example":1000},"floor_max_value":{"type":"number","description":"Floor max value for the charges in Brazilian Real (R$) cents.","example":1000},"request_expiration_date":{"type":"string","description":"Request expiration date. Max 30 days from now.","example":"2026-06-05","format":"date"},"frequency":{"type":"string","description":"Frequency.","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"MONTHLY"},"start_date":{"type":"string","description":"Date of the first payment of the automatic pix recurrence.","example":"2026-06-05","format":"date"},"end_date":{"type":"string","description":"Date for when the automatic pix recurrence will be ended.","example":"2027-05-29","format":"date"},"contract_number":{"type":"string","description":"Contract/reference number. Alphanumeric code to reference the recurrence.","example":"COD123456","maxLength":35},"contract_description":{"type":"string","description":"Contract/recurrence description.","example":"Monthly subscription","maxLength":35},"tags":{"description":"Tags to help identify the recurrence.","example":["subscription","premium"],"maxItems":5,"type":"array","items":{"type":"string"}}}},"UpdatePixAutomaticRecurrenceRestResponse":{"type":"object","properties":{"old_id":{"type":"string","description":"Old recurrence ID (canceled).","example":"fb96cf13-4600-4d21-ad67-40fc05ac3a8d"},"old_recurrence_status":{"type":"string","description":"Old recurrence status.","enum":["PENDING","CREATED","FAILED","APPROVED","REJECTED","CANCELED","EXPIRED","FINISHED"],"example":"CANCELED"},"id":{"type":"string","description":"New recurrence ID.","example":"a3f12345-6789-4abc-def0-123456789abc"},"status":{"type":"string","description":"New recurrence status.","enum":["PENDING","CREATED","FAILED","APPROVED","REJECTED","CANCELED","EXPIRED","FINISHED"],"example":"PENDING"},"state":{"type":"string","description":"New recurrence state.","enum":["PENDING_CONFIRMED","CREATED_CONFIRMED","CREATED_FAILED","APPROVED_CONFIRMED","REJECTED_CONFIRMED","CANCELED_CONFIRMED","CANCELED_FAILED","EXPIRED_CONFIRMED","FINISHED_CONFIRMED"],"example":"PENDING_CONFIRMED"},"updated_at":{"format":"date-time","type":"string","description":"Update timestamp.","example":"2026-05-29T19:41:08.892Z"}},"required":["old_id","old_recurrence_status","id","status","state","updated_at"]},"CreatePixAutomaticRecurrenceBodyParam":{"type":"object","properties":{"journey":{"type":"string","description":"Automatic pix journey.\n JOURNEY_1: An automatic pix recurrence will be created and a notification to the payer will be sent.\n JOURNEY_2: A composite QRCode will be generated to be shared with the payer to approve the automatic pix recurrence.\n JOURNEY_3: A composite dynamic QRCode will be generated to be shared with the payer to approve the automatic pix recurrence and pay an immediate charge.\n JOURNEY_4: A composite dynamic QRCode will be generated to be shared with the payer to pay or schedule the payment of the charge and approve (optional) the automatic pix recurrence.\n JOURNEY_4_STATIC: A composite static QRCode will be generated to be shared with the payer to pay or schedule the payment of the charge and approve (optional) the automatic pix recurrence.","enum":["JOURNEY_1","JOURNEY_2","JOURNEY_3","JOURNEY_4","JOURNEY_4_STATIC"],"example":"JOURNEY_1"},"frequency":{"type":"string","description":"Frequency.","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"MONTHLY"},"start_date":{"type":"string","description":"Date of the first payment of the automatic pix recurrence.","example":"2026-05-29","format":"date"},"end_date":{"type":"string","description":"Date for when the automatic pix recurrence will be ended.","example":"2027-05-29","format":"date"},"value":{"type":"number","description":"Recurrence fixed value for the charges in Brazilian Real (R$) cents.","example":1000},"floor_max_value":{"type":"number","description":"Maximum floor value in Brazilian Real (R$) cents. Must not be provided if (fixed) value is provided.","example":1000},"owner_ispb":{"type":"string","description":"Owner (payer) Bank ISPB (required for all journeys except journey 4 static).","example":"11111111","minLength":1,"maxLength":8},"owner_name":{"type":"string","description":"Owner (payer) name (required if journey 3 or 4 (dynamic)).","example":"John Doe"},"owner_document":{"type":"string","description":"Owner (payer) document (CPF or CNPJ) (required for all journeys except journey 4 static).","example":"83003535005"},"owner_bank_branch":{"type":"string","description":"Owner (payer) Bank branch (required if journey 1).","minLength":1,"maxLength":5,"example":"12345"},"owner_bank_account":{"type":"string","description":"Owner (payer) Bank account number (required if journey 1).","example":"123456"},"debtor_document":{"type":"string","description":"Debtor document (CPF or CNPJ) (required if journey 2, 3 or 4 dynamic).","example":"83003535005"},"debtor_name":{"type":"string","description":"Debtor name (required if journey 2, 3 or 4 dynamic).","example":"John Doe"},"contract_number":{"type":"string","description":"Contract number or reference code.","example":"ABC123"},"contract_description":{"type":"string","description":"Contract description.","example":"Super plan"},"tags":{"description":"Tags (max: 5).","example":["discount 15%"],"type":"array","items":{"type":"string"}},"request_expiration_date":{"type":"string","description":"Expiration date (required if journey 1).","example":"2026-05-29","format":"date"},"pix_key_id":{"type":"string","description":"Pix key ID (required if journey 3 or 4 (dynamic and static)).","example":"d5e93fb5-5db0-4501-bf53-92fa38b8958e"},"charge_value":{"type":"number","description":"Charge value (required if journey 3 or 4 dynamic (also available for journey 4 static)).","example":1000},"charge_due_date":{"type":"string","description":"Charge due date (required if journey 4 dynamic).","example":"2026-05-29","format":"date"},"interest_perc_value":{"type":"number","description":"Interest value specified in percentage by month. Available only for journey 4 dynamic.","example":1.01},"fine_value":{"type":"number","description":"Fine value (in (R$) amount or percentage). Available only for journey 4 dynamic.","example":2.02},"fine_type":{"type":"string","description":"Fine type. Available only for journey 4 dynamic.","example":"AMOUNT","enum":["AMOUNT","PERCENTAGE"]},"discount_value":{"type":"number","description":"Discount value (in (R$) amount or percentage). Available only for journey 4 dynamic.","example":10.01},"discount_type":{"type":"string","description":"Discount type. Available only for journey 4 dynamic.","example":"AMOUNT","enum":["AMOUNT","PERCENTAGE"]}},"required":["journey","frequency","start_date","debtor_document","contract_number"]},"CreatePixAutomaticRecurrenceRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Recurrence ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"status":{"type":"string","description":"Recurrence status.","example":"PENDING","enum":["PENDING","CREATED","FAILED","APPROVED","REJECTED","CANCELED","EXPIRED","FINISHED"]},"state":{"type":"string","description":"Recurrence state.","example":"PENDING_CONFIRMED","enum":["PENDING_CONFIRMED","CREATED_CONFIRMED","CREATED_FAILED","APPROVED_CONFIRMED","REJECTED_CONFIRMED","CANCELED_CONFIRMED","CANCELED_FAILED","EXPIRED_CONFIRMED","FINISHED_CONFIRMED"]}},"required":["id","status","state"]},"GetAllPixAutomaticRecurrenceRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Recurrence ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"status":{"type":"string","description":"Recurrence status","enum":["PENDING","CREATED","FAILED","APPROVED","REJECTED","CANCELED","EXPIRED","FINISHED"],"example":"APPROVED"},"state":{"type":"string","description":"Recurrence state","enum":["PENDING_CONFIRMED","CREATED_CONFIRMED","CREATED_FAILED","APPROVED_CONFIRMED","REJECTED_CONFIRMED","CANCELED_CONFIRMED","CANCELED_FAILED","EXPIRED_CONFIRMED","FINISHED_CONFIRMED"],"example":"APPROVED_CONFIRMED"},"journey":{"type":"string","enum":["JOURNEY_1","JOURNEY_2","JOURNEY_3","JOURNEY_4","JOURNEY_4_STATIC"],"description":"Recurrence journey","example":"JOURNEY_1"},"frequency":{"type":"string","description":"Recurrence frequency","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"MONTHLY"},"start_date":{"format":"YYYY-MM-DD","type":"string","description":"Recurrence start date","example":"2025-04-15"},"end_date":{"format":"YYYY-MM-DD","type":"string","description":"Recurrence end date","example":"2026-04-15"},"value":{"type":"number","description":"Recurrence value","example":100},"floor_max_value":{"type":"number","description":"Recurrence floor max value","example":50},"beneficiary_ispb":{"type":"string","description":"Recurrence beneficiary ISPB","example":"7219"},"beneficiary_document":{"type":"string","description":"Recurrence beneficiary document","example":"01234567890"},"beneficiary_name":{"type":"string","description":"Recurrence beneficiary name","example":"John Doe"},"owner_ispb":{"type":"string","description":"Recurrence owner (payer) ISPB","example":"7219"},"owner_name":{"type":"string","description":"Recurrence owner (payer) name","example":"John Doe"},"owner_person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Recurrence owner (payer) person type","example":"NATURAL_PERSON"},"owner_document":{"type":"string","description":"Recurrence owner (payer) document","example":"02345678912"},"owner_bank_branch":{"type":"string","description":"Recurrence owner (payer) bank branch","example":"0001"},"owner_bank_account":{"type":"string","description":"Recurrence owner (payer) bank account","example":"12345678"},"debtor_person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Recurrence debtor person type","example":"NATURAL_PERSON"},"debtor_document":{"type":"string","description":"Recurrence debtor document","example":"03456789013"},"debtor_name":{"type":"string","description":"Recurrence debtor name","example":"John Wick"},"contract_number":{"type":"string","description":"Recurrence contract number","example":"123456-7"},"contract_description":{"type":"string","description":"Recurrence contract description","example":"Gym monthly subscription"},"tags":{"description":"Recurrence tags","example":["gym","subscription"],"type":"array","items":{"type":"string"}},"request_expiration_date":{"format":"date-time","type":"string","description":"Recurrence request expiration date","example":"2026-05-29T19:41:08.895Z"},"cancellation_reason":{"type":"string","enum":["ACCOUNT_CANCELED","RECEIVER_COMPANY_CLOSURE","OWNER_DEATH","CONFIRMATION_ERROR","FRAUD_SUSPICION","RECURRENCE_ALREADY_CONFIRMED","RECEIVER_REQUEST","PAYER_REQUEST","RECEIVER_PSP_REQUEST"],"description":"Recurrence cancellation reason","example":"RECEIVER_REQUEST"},"next_charge_due_date":{"type":"string","description":"Recurrence next charge due date","example":"2026-05-29","format":"date"},"next_charge_value":{"type":"number","description":"Recurrence next charge value","example":100},"created_at":{"format":"date-time","type":"string","description":"Recurrence creation date.","example":"2026-05-29T19:41:08.895Z"},"updated_at":{"format":"date-time","type":"string","description":"Recurrence update date.","example":"2026-05-29T19:41:08.895Z"}},"required":["id","status","journey","frequency","start_date","beneficiary_ispb","beneficiary_document","beneficiary_name","contract_number","created_at","updated_at"]},"GetAllPixAutomaticRecurrenceRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Automatic pix recurrence data","type":"array","items":{"$ref":"#/components/schemas/GetAllPixAutomaticRecurrenceRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetPixAutomaticRecurrenceByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Recurrence ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"status":{"type":"string","description":"Recurrence status","enum":["PENDING","CREATED","FAILED","APPROVED","REJECTED","CANCELED","EXPIRED","FINISHED"],"example":"APPROVED"},"state":{"type":"string","description":"Recurrence state","enum":["PENDING_CONFIRMED","CREATED_CONFIRMED","CREATED_FAILED","APPROVED_CONFIRMED","REJECTED_CONFIRMED","CANCELED_CONFIRMED","CANCELED_FAILED","EXPIRED_CONFIRMED","FINISHED_CONFIRMED"],"example":"APPROVED_CONFIRMED"},"journey":{"type":"string","enum":["JOURNEY_1","JOURNEY_2","JOURNEY_3","JOURNEY_4","JOURNEY_4_STATIC"],"description":"Recurrence journey","example":"JOURNEY_1"},"frequency":{"type":"string","description":"Recurrence frequency","enum":["WEEKLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"MONTHLY"},"start_date":{"format":"YYYY-MM-DD","type":"string","description":"Recurrence start date","example":"2025-04-15"},"end_date":{"format":"YYYY-MM-DD","type":"string","description":"Recurrence end date","example":"2026-04-15"},"value":{"type":"number","description":"Recurrence value","example":100},"floor_max_value":{"type":"number","description":"Recurrence floor max value","example":50},"beneficiary_ispb":{"type":"string","description":"Recurrence beneficiary ISPB","example":"7219"},"beneficiary_document":{"type":"string","description":"Recurrence beneficiary document","example":"01234567890"},"beneficiary_name":{"type":"string","description":"Recurrence beneficiary name","example":"John Doe"},"owner_ispb":{"type":"string","description":"Recurrence owner (payer) ISPB","example":"7219"},"owner_name":{"type":"string","description":"Recurrence owner (payer) name","example":"John Doe"},"owner_person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Recurrence owner (payer) person type","example":"NATURAL_PERSON"},"owner_document":{"type":"string","description":"Recurrence owner (payer) document","example":"02345678912"},"owner_bank_branch":{"type":"string","description":"Recurrence owner (payer) bank branch","example":"0001"},"owner_bank_account":{"type":"string","description":"Recurrence owner (payer) bank account","example":"12345678"},"debtor_person_type":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Recurrence debtor person type","example":"NATURAL_PERSON"},"debtor_document":{"type":"string","description":"Recurrence debtor document","example":"03456789013"},"debtor_name":{"type":"string","description":"Recurrence debtor name","example":"John Wick"},"contract_number":{"type":"string","description":"Recurrence contract number","example":"123456-7"},"contract_description":{"type":"string","description":"Recurrence contract description","example":"Gym monthly subscription"},"tags":{"description":"Recurrence tags","example":["gym","subscription"],"type":"array","items":{"type":"string"}},"request_expiration_date":{"format":"date-time","type":"string","description":"Recurrence request expiration date","example":"2026-05-29T19:41:08.895Z"},"cancellation_reason":{"type":"string","enum":["ACCOUNT_CANCELED","RECEIVER_COMPANY_CLOSURE","OWNER_DEATH","CONFIRMATION_ERROR","FRAUD_SUSPICION","RECURRENCE_ALREADY_CONFIRMED","RECEIVER_REQUEST","PAYER_REQUEST","RECEIVER_PSP_REQUEST"],"description":"Recurrence cancellation reason","example":"RECEIVER_REQUEST"},"next_charge_due_date":{"type":"string","description":"Recurrence next charge due date","example":"2026-05-29","format":"date"},"next_charge_value":{"type":"number","description":"Recurrence next charge value","example":100},"charge_due_date":{"type":"string","description":"Charge due date","example":"2026-05-29","format":"date"},"charge_value":{"type":"number","description":"Charge value","example":100},"qr_code_emv":{"type":"string","description":"Recurrence QR Code EMV.","example":"SkQuUElYLlFSQ29kZS5EaW5hbWljbw==……"},"created_at":{"format":"date-time","type":"string","description":"Recurrence creation date.","example":"2026-05-29T19:41:08.896Z"},"updated_at":{"format":"date-time","type":"string","description":"Recurrence update date.","example":"2026-05-29T19:41:08.896Z"}},"required":["id","status","journey","frequency","start_date","beneficiary_ispb","beneficiary_document","beneficiary_name","contract_number","created_at","updated_at"]},"CreatePixAutomaticChargeBodyParam":{"type":"object","properties":{"value":{"type":"number","description":"Value.","example":1000},"due_date":{"type":"string","description":"Due date","example":"2026-05-29","format":"date"},"pix_automatic_recurrence_id":{"type":"string","description":"Pix Automatic Recurrence ID","example":"5c59a31a-76d6-4a2c-9b66-6d8a054d2880"}},"required":["value","due_date","pix_automatic_recurrence_id"]},"CreatePixAutomaticChargeRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Charge ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"status":{"type":"string","description":"Charge status","example":"PENDING_WAITING","enum":["PENDING_WAITING","PENDING_CONFIRMED","CREATED","CREATED_FAILED","PAID","NOT_PAID","WAITING_CANCELLATION","CANCELED","CANCELED_FAILED"]}},"required":["id","status"]},"GetAllPixAutomaticChargeRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Charge ID","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"pix_automatic_recurrence":{"description":"Automatic pix recurrence","allOf":[{"$ref":"#/components/schemas/GetAllPixAutomaticRecurrenceRestResponseItem"}]},"status":{"type":"string","description":"Charge status","enum":["PENDING_WAITING","PENDING_CONFIRMED","CREATED","CREATED_FAILED","PAID","NOT_PAID","WAITING_CANCELLATION","CANCELED","CANCELED_FAILED"],"example":"CREATED"},"scheduling_purpose":{"type":"string","description":"Scheduling purpose","enum":["SCHEDULING","NEW_ATTEMPT","RESEND"],"example":"SCHEDULING"},"due_date":{"type":"string","description":"Due date","example":"2026-05-29","format":"YYYY-MM-DD"},"value":{"type":"number","description":"Value","example":100},"cancellation_reason":{"type":"string","description":"Cancellation reason","enum":["ACCOUNT_CLOSED","ACCOUNT_BLOCKED","RECURRENCE_CANCELED","SETTLEMENT_FAILURE","OTHER_REASON_BY_PARTICIPANT","REQUESTED_BY_PAYER","REQUESTED_BY_RECEIVER"],"example":"REQUESTED_BY_RECEIVER"},"created_at":{"format":"date-time","type":"string","description":"Charge creation date.","example":"2026-05-29T19:41:08.897Z"},"updated_at":{"format":"date-time","type":"string","description":"Charge update date.","example":"2026-05-29T19:41:08.897Z"}},"required":["id","pix_automatic_recurrence","status","scheduling_purpose","due_date","value","created_at","updated_at"]},"GetAllPixAutomaticChargeRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Automatic pix charge data","type":"array","items":{"$ref":"#/components/schemas/GetAllPixAutomaticChargeRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetPixAutomaticChargeByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Charge ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"status":{"type":"string","description":"Charge status","enum":["PENDING_WAITING","PENDING_CONFIRMED","CREATED","CREATED_FAILED","PAID","NOT_PAID","WAITING_CANCELLATION","CANCELED","CANCELED_FAILED"],"example":"CREATED"},"pix_automatic_recurrence_id":{"type":"string","description":"Pix Automatic Recurrence ID","example":"595d2a52-eb0f-4b4a-954c-2379cc0f4179"},"scheduling_purpose":{"type":"string","description":"Scheduling purpose","enum":["SCHEDULING","NEW_ATTEMPT","RESEND"],"example":"SCHEDULING"},"due_date":{"type":"string","description":"Due date","example":"2026-05-29","format":"YYYY-MM-DD"},"value":{"type":"number","description":"Value","example":100},"cancellation_reason":{"type":"string","description":"Cancellation reason","enum":["ACCOUNT_CLOSED","ACCOUNT_BLOCKED","RECURRENCE_CANCELED","SETTLEMENT_FAILURE","OTHER_REASON_BY_PARTICIPANT","REQUESTED_BY_PAYER","REQUESTED_BY_RECEIVER"],"example":"REQUESTED_BY_RECEIVER"},"created_at":{"format":"date-time","type":"string","description":"Charge creation date.","example":"2026-05-29T19:41:08.897Z"},"updated_at":{"format":"date-time","type":"string","description":"Charge update date.","example":"2026-05-29T19:41:08.897Z"}},"required":["id","status","pix_automatic_recurrence_id","scheduling_purpose","due_date","value","created_at","updated_at"]},"CreatePixAutomaticReceiverLimitBodyParam":{"type":"object","properties":{"receiver_document":{"type":"string","description":"Receiver document (CNPJ).","example":"21941873000179"},"receiver_name":{"type":"string","description":"Receiver name.","example":"John Doe Company"},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":100000}},"required":["receiver_document","receiver_name","daily_limit"]},"CreatePixAutomaticReceiverLimitRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Receiver Limit ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"receiver_document":{"type":"string","description":"Receiver document.","example":"12345678901"},"receiver_name":{"type":"string","description":"Receiver name.","example":"John Doe Company"},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":100000},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T19:41:08.898Z"}},"required":["id","wallet_id","receiver_document","receiver_name","daily_limit","created_at"]},"UpdatePixAutomaticReceiverLimitBodyParam":{"type":"object","properties":{"daily_limit":{"type":"number","description":"Daily limit in cents.","example":100000}},"required":["daily_limit"]},"UpdatePixAutomaticReceiverLimitRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Receiver Limit ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"receiver_document":{"type":"string","description":"Receiver document.","example":"21941873000179"},"receiver_name":{"type":"string","description":"Receiver name.","example":"John Doe Company"},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":100000},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T19:41:08.898Z"}},"required":["id","wallet_id","receiver_document","receiver_name","daily_limit","updated_at"]},"GetPixAutomaticReceiverLimitByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Receiver Limit ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"receiver_document":{"type":"string","description":"Receiver document.","example":"21941873000179"},"receiver_name":{"type":"string","description":"Receiver name.","example":"John Doe Company"},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":100000},"daily_used":{"type":"number","description":"Daily used amount in cents.","example":35000},"daily_available":{"type":"number","description":"Daily available amount in cents.","example":65000},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T19:41:08.898Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T19:41:08.898Z"}},"required":["id","wallet_id","receiver_document","receiver_name","daily_limit","daily_used","daily_available","created_at","updated_at"]},"GetAllPixAutomaticReceiverLimitByWalletRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Receiver Limit ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"d1952c4b-9348-41ab-99a3-05b11459aded"},"receiver_document":{"type":"string","description":"Receiver document.","example":"21941873000179"},"receiver_name":{"type":"string","description":"Receiver name.","example":"Empresa XPTO"},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":100000},"daily_used":{"type":"number","description":"Daily used amount in cents.","example":35000},"daily_available":{"type":"number","description":"Daily available amount in cents.","example":65000},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T19:41:08.898Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T19:41:08.898Z"}},"required":["id","wallet_id","receiver_document","receiver_name","daily_limit","daily_used","daily_available","created_at","updated_at"]},"GetAllPixAutomaticReceiverLimitByWalletRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Receiver limits list.","type":"array","items":{"$ref":"#/components/schemas/GetAllPixAutomaticReceiverLimitByWalletRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"CreateVirtualCardRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":true},"status":{"type":"string","description":"Card Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"blocked"}},"required":["id","is_virtual","status"]},"GetAllCardsRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":true},"card_name":{"type":"string","description":"Card Name.","example":"*****"},"status":{"type":"string","description":"Card Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"activated"},"last_four_number":{"type":"string","description":"Last Four Numbers of Card.","example":"**** **** **** 1234"},"activated_at":{"format":"date-time","type":"string","description":"Card activation date.","example":"2026-05-29T19:41:08.899Z"},"created_at":{"format":"date-time","type":"string","description":"Card creation date.","example":"2026-05-29T19:41:08.899Z"}},"required":["id","is_virtual","card_name","status","activated_at","created_at"]},"GetAllCardsRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Cards data.","type":"array","items":{"$ref":"#/components/schemas/GetAllCardsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"UnblockCardRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":true},"status":{"type":"string","description":"Card Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"blocked"},"created_at":{"format":"date-time","type":"string","description":"Card creation date.","example":"2026-05-29T19:41:08.900Z"}},"required":["id","is_virtual","status","created_at"]},"BlockCardRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":true},"status":{"type":"string","description":"Card Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"blocked"},"created_at":{"format":"date-time","type":"string","description":"Card creation date.","example":"2026-05-29T19:41:08.899Z"}},"required":["id","is_virtual","status","created_at"]},"CardDetailsRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":true},"status":{"type":"string","description":"Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"blocked"},"number":{"type":"string","description":"Card Number.","example":"1111222233334444"},"card_name":{"type":"string","description":"Card Name.","example":"JOHN DOE"},"expiry":{"type":"string","description":"Expiry Date.","example":"2026-05-29T19:41:08.899Z"},"cvv":{"type":"string","description":"CVV.","example":"123"},"activated_at":{"format":"date-time","type":"string","description":"Card Activation Date.","example":"2026-05-29T19:41:08.899Z"}},"required":["id","is_virtual","status","number","card_name","expiry","cvv","activated_at"]},"CancelCardRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":true},"status":{"type":"string","description":"Card Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"blocked"},"created_at":{"format":"date-time","type":"string","description":"Card creation date.","example":"2026-05-29T19:41:08.900Z"}},"required":["id","is_virtual","status","created_at"]},"CreatePhysicalCardBody":{"type":"object","properties":{"password":{"type":"string","description":"Card Password.","example":"0000"}},"required":["password"]},"CreatePhysicalCardRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":false},"status":{"type":"string","description":"Card Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"pending"}},"required":["id","is_virtual","status"]},"ActivateCardBody":{"type":"object","properties":{"activation_code":{"type":"string","description":"Activation Code.","example":"0000"}},"required":["activation_code"]},"ActivateCardRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":true},"status":{"type":"string","description":"Card Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"blocked"},"created_at":{"format":"date-time","type":"string","description":"Card creation date.","example":"2026-05-29T19:41:08.900Z"}},"required":["id","is_virtual","status","created_at"]},"CreateNewPhysicalCardViaRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":false},"status":{"type":"string","description":"Card Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"pending"}},"required":["id","is_virtual","status"]},"ChangeCardPasswordBody":{"type":"object","properties":{"current_password":{"type":"string","description":"Current Card Password.","example":"0000"},"new_password":{"type":"string","description":"New Card Password.","example":"0000"}},"required":["current_password","new_password"]},"ChangeCardPasswordRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"is_virtual":{"type":"boolean","description":"Is Virtual Card.","example":true},"status":{"type":"string","description":"Card Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"blocked"},"created_at":{"format":"date-time","type":"string","description":"Card creation date.","example":"2026-05-29T19:41:08.900Z"}},"required":["id","is_virtual","status","created_at"]},"GetCardTrackingRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"virtual":{"type":"boolean","description":"Is Virtual Card.","example":true},"status":{"type":"string","description":"Status.","enum":["password_locked","activated","pending","blocked","cancelled","preventive_blocked"],"example":"blocked"},"tracking_status":{"type":"string","description":"Tracking Status.","enum":["created","embossing","forwarded","received"],"example":"created"}},"required":["id","virtual","status","tracking_status"]},"GetTermsOfUseRestResponse":{"type":"object","properties":{"type":{"type":"string","description":"Document type.","example":"PRIVACY_POLICY","enum":["PRIVACY_POLICY","TERMS_OF_USE"]},"document_url":{"type":"string","description":"Document URL.","example":"https://example.com/terms-of-use.pdf"}},"required":["type","document_url"]},"DocumentTypeItemBody":{"type":"object","properties":{"document_url":{"type":"string","description":"Document URL.","example":"https://example.com/document.pdf"},"type":{"type":"string","description":"Document type.","enum":["PRIVACY_POLICY","TERMS_OF_USE"],"example":"TERMS_OF_USE"}},"required":["document_url","type"]},"AcceptTermsOfUseBody":{"type":"object","properties":{"fingerprint":{"type":"string","description":"Fingerprint.","example":"ZXhhbXBsZS1zdHJpbmctdG8tZW5jb2Rl"},"documents":{"description":"Documents.","example":[{"document_url":"https://example.com/document.pdf","type":"TERMS_OF_USE"}],"type":"array","items":{"$ref":"#/components/schemas/DocumentTypeItemBody"}}},"required":["fingerprint","documents"]},"AcceptTermsOfUseRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card Onboarding ID.","example":"12345678-1234-5678-1234-567812345678"},"user_id":{"type":"string","description":"User ID.","example":"12345678-1234-5678-1234-567812345678"},"onboarding_id":{"type":"string","description":"Onboarding ID.","example":"12345678-1234-5678-1234-567812345678"},"status":{"type":"string","description":"Card Onboarding Status.","enum":["pending","terms_of_use_accepted","waiting_creation","created","waiting_documents","rejected","finished","expired"],"example":"pending"},"created_at":{"format":"date-time","type":"string","description":"Card Onboarding Created At.","example":"2026-05-29T19:41:08.901Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Updated At.","example":"2026-05-29T19:41:08.901Z"}},"required":["id","user_id","onboarding_id","status","created_at","updated_at"]},"UploadCardOnboardingDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card Onboarding ID.","example":"12345678-1234-5678-1234-567812345678"},"user_id":{"type":"string","description":"User ID.","example":"12345678-1234-5678-1234-567812345678"},"status":{"type":"string","description":"Card Onboarding Status.","enum":["pending","terms_of_use_accepted","waiting_creation","created","waiting_documents","rejected","finished","expired"],"example":"waiting_documents"},"created_at":{"format":"date-time","type":"string","description":"Card Onboarding Created At.","example":"2026-05-29T19:41:08.898Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Updated At.","example":"2026-05-29T19:41:08.898Z"}},"required":["id","user_id","status","created_at","updated_at"]},"CardOnboardingAddressInfoResponse":{"type":"object","properties":{"id":{"type":"number","description":"User address ID.","example":1234},"zip_code":{"type":"string","description":"User address zip code.","example":"96075858"},"street":{"type":"string","description":"User address street.","example":"Alameda"},"number":{"type":"number","description":"User address number.","example":10},"neighborhood":{"type":"string","description":"User address neighborhood.","example":"Alphaville"},"city":{"type":"string","description":"User address neighborhood.","example":"São Paulo"},"federative_unit":{"type":"string","description":"User address federative unit.","example":"SP"},"country":{"type":"string","description":"User address country.","example":"Brasil"},"complement":{"type":"string","description":"User address complement.","example":"flat 1201"}},"required":["id","zip_code","street","number","city","federative_unit","country"]},"CardOnboardingDocumentInfoResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card Onboarding Document ID.","example":"12345678-1234-5678-1234-567812345678"},"card_onboarding_id":{"type":"string","description":"Card Onboarding ID.","example":"12345678-1234-5678-1234-567812345678"},"file_id":{"type":"string","description":"File ID.","example":"12345678-1234-5678-1234-567812345678"},"type":{"type":"string","description":"Card Onboarding Document Type.","enum":["selfie","rg_front","rg_verse","cnh_front","cnh_verse","cnh_digital","passport","signature_card","rne_front","rne_verse"],"example":"rg_front"},"created_at":{"format":"date-time","type":"string","description":"Card Onboarding Document Created At.","example":"2026-05-29T19:41:08.898Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Document Updated At.","example":"2026-05-29T19:41:08.899Z"}},"required":["id","card_onboarding_id","file_id","type","created_at","updated_at"]},"GetCardOnboardingByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card Onboarding ID.","example":"12345678-1234-5678-1234-567812345678"},"user_id":{"type":"string","description":"User ID.","example":"12345678-1234-5678-1234-567812345678"},"birth_date":{"format":"date-time","type":"string","description":"Bith Date.","example":"2026-05-29T19:41:08.899Z"},"document":{"type":"string","description":"Document (CPF).","example":"12345678901"},"mother_name":{"type":"string","description":"Mother Name.","example":"Test Mother"},"name":{"type":"string","description":"Name.","example":"Test User"},"pep":{"type":"boolean","description":"Is PEP.","example":true},"pep_since":{"type":"string","description":"Is PEP Since.","example":"2023-01-01","format":"date"},"status":{"type":"string","description":"Card Onboarding Status.","enum":["pending","terms_of_use_accepted","waiting_creation","created","waiting_documents","rejected","finished","expired"],"example":"finished"},"address":{"description":"User address information.","allOf":[{"$ref":"#/components/schemas/CardOnboardingAddressInfoResponse"}]},"documents":{"description":"User card onboarding documents.","type":"array","items":{"$ref":"#/components/schemas/CardOnboardingDocumentInfoResponse"}},"created_at":{"format":"date-time","type":"string","description":"Card Onboarding Created At.","example":"2026-05-29T19:41:08.899Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Updated At.","example":"2026-05-29T19:41:08.899Z"}},"required":["id","user_id","birth_date","document","mother_name","name","pep","pep_since","status","address","created_at","updated_at"]},"CreateCardOnboardingResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card Onboarding ID.","example":"12345678-1234-5678-1234-567812345678"},"status":{"type":"string","description":"Card Onboarding Status.","enum":["pending","terms_of_use_accepted","waiting_creation","created","waiting_documents","rejected","finished","expired"],"example":"waiting_creation"},"created_at":{"format":"date-time","type":"string","description":"Card Onboarding Created At.","example":"2026-05-29T19:41:08.901Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Updated At.","example":"2026-05-29T19:41:08.901Z"}},"required":["id","status","created_at","updated_at"]},"GetAllOpenFinanceParticipantsRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Open Finance participant id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"friendly_name":{"type":"string","description":"Open Finance participant friendly name.","example":"Open Finance Participant"},"friendly_logo_uri":{"type":"string","description":"Open Finance participant friendly logo URI.","example":"https://example.com/logo.png"}},"required":["id","friendly_name"]},"GetAllOpenFinanceParticipantsRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Open Finance participants data.","type":"array","items":{"$ref":"#/components/schemas/GetAllOpenFinanceParticipantsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"CreateOpenFinancePaymentConsentByPixKeyBody":{"type":"object","properties":{"amount":{"type":"number","description":"Open Finance payment consent amount.","example":100},"participant_id":{"type":"string","description":"Open Finance participant ID. For redirect flow.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"enrollment_id":{"type":"string","description":"Open Finance enrollment ID. For without redirect flow.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"logged_user_document":{"type":"string","description":"Client logged user document. In case of the user is a business entity, it is the document of the business entity representative.","example":"40995401039"},"logged_business_entity_document":{"type":"string","description":"Client logged user document when the user is a business entity.","example":"85959525000101"},"logged_user_bank_ispb":{"type":"string","description":"client logged user bank ISPB.","example":"1234567890"},"logged_user_branch_number":{"type":"string","description":"client logged user branch number.","example":"0001"},"logged_user_bank_account_number":{"type":"string","description":"client logged user bank account number.","example":"1234567890"},"logged_user_bank_account_type":{"type":"string","description":"client logged user bank account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"decoded_pix_key_id":{"type":"string","description":"Decoded pix key id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_redirect_url":{"type":"string","description":"Client redirect URL for Open Finance flow.","example":"https://example.com/callback"},"payment_date":{"type":"string","description":"Payment date.","format":"date","example":"2026-05-29"}},"required":["amount","participant_id","logged_user_document","decoded_pix_key_id","client_redirect_url"]},"CreateOpenFinancePaymentConsentByPixKeyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment consent id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Payment consent status.","enum":["PENDING","WAITING","WAITING_AUTHORIZATION","AUTHORIZED","CONSUMED","REJECTED","REVOKED","EXPIRED","ERROR","FAILED"],"example":"PENDING"},"expiration_date_time":{"format":"date-time","type":"string","description":"Payment consent expiration date time.","example":"2026-05-29T19:41:08.987Z"},"created_at":{"format":"date-time","type":"string","description":"Payment consent created at.","example":"2026-05-29T19:41:08.987Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T19:41:08.987Z"}},"required":["id","status","created_at","updated_at"]},"CreateOpenFinancePaymentConsentByPixAccountBody":{"type":"object","properties":{"amount":{"type":"number","description":"Open Finance payment consent amount.","example":100},"participant_id":{"type":"string","description":"Open Finance participant ID. For redirect flow.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"enrollment_id":{"type":"string","description":"Open Finance enrollment ID. For without redirect flow.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"logged_user_document":{"type":"string","description":"Client logged user document. In case of the user is a business entity, it is the document of the business entity representative.","example":"40995401039"},"logged_business_entity_document":{"type":"string","description":"Client logged user document when the user is a business entity.","example":"85959525000101"},"logged_user_bank_ispb":{"type":"string","description":"client logged user bank ISPB.","example":"1234567890"},"logged_user_branch_number":{"type":"string","description":"client logged user branch number.","example":"0001"},"logged_user_bank_account_number":{"type":"string","description":"client logged user bank account number.","example":"1234567890"},"logged_user_bank_account_type":{"type":"string","description":"client logged user bank account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"decoded_pix_account_id":{"type":"string","description":"Decoded pix account id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_redirect_url":{"type":"string","description":"Client redirect URL for Open Finance flow.","example":"https://example.com/callback"},"payment_date":{"type":"string","description":"Payment date.","format":"date","example":"2026-05-29"}},"required":["amount","participant_id","logged_user_document","decoded_pix_account_id","client_redirect_url"]},"CreateOpenFinancePaymentConsentByPixAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment consent id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Payment consent status.","enum":["PENDING","WAITING","WAITING_AUTHORIZATION","AUTHORIZED","CONSUMED","REJECTED","REVOKED","EXPIRED","ERROR","FAILED"],"example":"PENDING"},"expiration_date_time":{"format":"date-time","type":"string","description":"Payment consent expiration date time.","example":"2026-05-29T19:41:08.988Z"},"created_at":{"format":"date-time","type":"string","description":"Payment consent created at.","example":"2026-05-29T19:41:08.988Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T19:41:08.988Z"}},"required":["id","status","created_at","updated_at"]},"CreateOpenFinancePaymentConsentByQrCodeDynamicBody":{"type":"object","properties":{"amount":{"type":"number","description":"Open Finance payment consent amount.","example":100},"participant_id":{"type":"string","description":"Open Finance participant ID. For redirect flow.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"enrollment_id":{"type":"string","description":"Open Finance enrollment ID. For without redirect flow.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"logged_user_document":{"type":"string","description":"Client logged user document. In case of the user is a business entity, it is the document of the business entity representative.","example":"40995401039"},"logged_business_entity_document":{"type":"string","description":"Client logged user document when the user is a business entity.","example":"85959525000101"},"logged_user_bank_ispb":{"type":"string","description":"client logged user bank ISPB.","example":"1234567890"},"logged_user_branch_number":{"type":"string","description":"client logged user branch number.","example":"0001"},"logged_user_bank_account_number":{"type":"string","description":"client logged user bank account number.","example":"1234567890"},"logged_user_bank_account_type":{"type":"string","description":"client logged user bank account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"decoded_qr_code_id":{"type":"string","description":"Decoded qr code id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_redirect_url":{"type":"string","description":"Client redirect URL for Open Finance flow.","example":"https://example.com/callback"},"payment_date":{"type":"string","description":"Payment date.","format":"date","example":"2026-05-29"}},"required":["participant_id","logged_user_document","decoded_qr_code_id","client_redirect_url"]},"CreateOpenFinancePaymentConsentByQrCodeDynamicRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment consent id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Payment consent status.","enum":["PENDING","WAITING","WAITING_AUTHORIZATION","AUTHORIZED","CONSUMED","REJECTED","REVOKED","EXPIRED","ERROR","FAILED"],"example":"PENDING"},"expiration_date_time":{"format":"date-time","type":"string","description":"Payment consent expiration date time.","example":"2026-05-29T19:41:08.988Z"},"created_at":{"format":"date-time","type":"string","description":"Payment consent created at.","example":"2026-05-29T19:41:08.988Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T19:41:08.988Z"}},"required":["id","status","created_at","updated_at"]},"CreateOpenFinancePaymentConsentByQrCodeStaticBody":{"type":"object","properties":{"amount":{"type":"number","description":"Open Finance payment consent amount.","example":100},"participant_id":{"type":"string","description":"Open Finance participant ID. For redirect flow.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"enrollment_id":{"type":"string","description":"Open Finance enrollment ID. For without redirect flow.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"logged_user_document":{"type":"string","description":"Client logged user document. In case of the user is a business entity, it is the document of the business entity representative.","example":"40995401039"},"logged_business_entity_document":{"type":"string","description":"Client logged user document when the user is a business entity.","example":"85959525000101"},"logged_user_bank_ispb":{"type":"string","description":"client logged user bank ISPB.","example":"1234567890"},"logged_user_branch_number":{"type":"string","description":"client logged user branch number.","example":"0001"},"logged_user_bank_account_number":{"type":"string","description":"client logged user bank account number.","example":"1234567890"},"logged_user_bank_account_type":{"type":"string","description":"client logged user bank account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"decoded_qr_code_id":{"type":"string","description":"Decoded qr code id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_redirect_url":{"type":"string","description":"Client redirect URL for Open Finance flow.","example":"https://example.com/callback"},"payment_date":{"type":"string","description":"Payment date.","format":"date","example":"2026-05-29"}},"required":["participant_id","logged_user_document","decoded_qr_code_id","client_redirect_url"]},"CreateOpenFinancePaymentConsentByQrCodeStaticRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment consent id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Payment consent status.","enum":["PENDING","WAITING","WAITING_AUTHORIZATION","AUTHORIZED","CONSUMED","REJECTED","REVOKED","EXPIRED","ERROR","FAILED"],"example":"PENDING"},"expiration_date_time":{"format":"date-time","type":"string","description":"Payment consent expiration date time.","example":"2026-05-29T19:41:08.989Z"},"created_at":{"format":"date-time","type":"string","description":"Payment consent created at.","example":"2026-05-29T19:41:08.989Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T19:41:08.989Z"}},"required":["id","status","created_at","updated_at"]},"GetOpenFinancePaymentConsentByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment consent UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"enrollment_id":{"type":"string","description":"Payment consent enrollment ID. When payment consent is without redirect flow.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Payment consent status.","enum":["PENDING","WAITING","WAITING_AUTHORIZATION","AUTHORIZED","CONSUMED","REJECTED","REVOKED","EXPIRED","ERROR","FAILED"],"example":"PENDING"},"amount":{"type":"number","description":"Payment amount.","example":100},"payment_type":{"type":"string","description":"Payment type.","enum":["ACCOUNT","KEY","QR_CODE","QR_CODE_STATIC_INSTANT","QR_CODE_STATIC_WITHDRAWAL","QR_CODE_DYNAMIC_DUE_DATE","QR_CODE_DYNAMIC_WITHDRAWAL","QR_CODE_DYNAMIC_CHANGE","QR_CODE_DYNAMIC_INSTANT","REFUND","AUTOMATIC_PAYMENT","OPEN_FINANCE"],"example":"KEY"},"logged_user_bank_ispb":{"type":"string","description":"Client logged user bank ISPB.","example":"1234567890"},"logged_user_branch_number":{"type":"string","description":"Client logged user branch number.","example":"0001"},"logged_user_account_number":{"type":"string","description":"Client logged user account number.","example":"1234567890"},"logged_user_account_type":{"type":"string","description":"Client logged user account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"expiration_date_time":{"format":"date-time","type":"string","description":"Payment consent expiration date time.","example":"2026-05-29T19:41:08.989Z"},"authorized_date":{"format":"date-time","type":"string","description":"Payment consent authorized date.","example":"2026-05-29T19:41:08.989Z"},"rejected_date":{"format":"date-time","type":"string","description":"Payment consent rejected date.","example":"2026-05-29T19:41:08.989Z"},"revoked_date":{"format":"date-time","type":"string","description":"Payment consent revoked date.","example":"2026-05-29T19:41:08.989Z"},"expired_date":{"format":"date-time","type":"string","description":"Payment consent expired date.","example":"2026-05-29T19:41:08.989Z"},"redirect_uri":{"type":"string","description":"Payment consent redirect URI.","example":"https://auth.bank.com/authorize?client_id=abc123&request_uri=urn:123"},"created_at":{"format":"date-time","type":"string","description":"Payment consent created at.","example":"2026-05-29T19:41:08.989Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T19:41:08.989Z"}},"required":["id","status","amount","payment_type","created_at","updated_at"]},"AuthorizeWithoutRedirectOpenFinancePaymentConsentBody":{"type":"object","properties":{"enrollment_id":{"type":"string","description":"Open Finance enrollment ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"account_tenure":{"type":"string","description":"Client logged user account tenure in days.","example":"2026-05-29","format":"date"},"device_id":{"type":"string","description":"Client logged user device ID.","example":"00aa11bb22cc33dd"},"os_version":{"type":"string","description":"Client logged user OS version.","example":"14"},"elapsed_time_since_boot":{"type":"number","description":"Client logged user elapsed time since boot in milliseconds.","example":1000},"is_rooted_device":{"type":"boolean","description":"Client logged user is rooted device.","example":true},"user_time_zone_offset":{"type":"string","description":"Client logged user user time zone offset.","example":"-03:00"},"language":{"type":"string","description":"Client logged user language ISO 639-1 code.","example":"pt"},"screen_width":{"type":"number","description":"Client logged user device screen width in pixels.","example":1920},"screen_height":{"type":"number","description":"Client logged user device screen height in pixels.","example":1080},"screen_brightness":{"type":"number","description":"Client logged user screen brightness in percentage. Examples: 0.5 for fractional format and 50 for percentage format.","example":0.5},"device_latitude":{"type":"number","description":"Client logged user device latitude.","example":-23.5505},"device_longitude":{"type":"number","description":"Client logged user device longitude.","example":-46.6333},"device_geolocation_type":{"type":"string","description":"Client logged user device geolocation type.","example":"COARSE","enum":["COARSE","FINE","INFERRED"]},"is_call_in_progress":{"type":"boolean","description":"Client logged user device is call in progress.","example":true},"is_dev_mode_enabled":{"type":"boolean","description":"Client logged user device is dev mode enabled.","example":true},"is_mock_gps":{"type":"boolean","description":"Client logged user device is mock GPS enabled.","example":true},"is_emulated":{"type":"boolean","description":"Client logged user device is emulated.","example":true},"is_monkey_runner":{"type":"boolean","description":"Client logged user device is monkey runner enabled.","example":true},"is_charging":{"type":"boolean","description":"Client logged user device is charging.","example":true},"antenna_information":{"type":"string","description":"Client logged user device antenna information.","example":" CellIdentityLte:{ mCi=2******60 mPci=274 mTac=5***1 }..."},"is_usb_connected":{"type":"boolean","description":"Client logged user device is USB connected.","example":true},"device_app_integrity_verdict":{"type":"string","description":"Client logged user device app integrity verdict.","example":"PLAY_RECOGNIZED"},"device_integrity_verdict":{"type":"string","description":"Client logged user device integrity verdict.","example":"[\"MEETS_DEVICE_INTEGRITY\"]"},"device_credential_id":{"type":"string","description":"Device enrollment credential ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"device_credential_raw_id":{"type":"string","description":"Device enrollment credential raw ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"device_credential_type":{"type":"string","description":"Device enrollment credential type.","example":"public-key"},"device_credential_client_data_json":{"type":"string","description":"Information about the APP that generated the credential. Must be a base64url encoded string.","example":"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxl"},"device_credential_authenticator_data":{"type":"string","description":"Information about the data structure of authenticator. Must be a base64url encoded string.","example":"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxl"},"device_credential_signature":{"type":"string","description":"Device enrollment credential signature. Must be a base64 encoded string.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"device_credential_user_handle":{"type":"string","description":"Device enrollment credential user handle. Must be a base64 encoded string.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_extension_results":{"type":"object","description":"Client extension results.","example":{"additionalProp1":{}}}},"required":["enrollment_id","account_tenure","device_id","os_version","user_time_zone_offset","language","screen_width","screen_height","device_credential_id","device_credential_raw_id","device_credential_type","device_credential_client_data_json","device_credential_authenticator_data","device_credential_signature"]},"GetOpenFinancePaymentByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Payment status.","enum":["PENDING","WAITING","WAITING_ANALYSIS","COMPLETED","FAILED","REJECTED","SCHEDULED","PENDING_CANCEL","CANCELLED","ERROR"],"example":"PENDING"},"amount":{"type":"number","description":"Payment amount in cents.","example":10000},"end_to_end_id":{"type":"string","description":"End to end ID.","example":"E00038166201907261559y6j6"},"rejection_reason_code":{"type":"string","description":"Rejection reason code.","example":"AB03"},"rejection_reason_detail":{"type":"string","description":"Rejection reason detail.","example":"Líquido insuficiente."},"created_at":{"format":"date-time","type":"string","description":"Payment created at.","example":"2026-05-29T19:41:08.990Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment updated at.","example":"2026-05-29T19:41:08.990Z"}},"required":["id","status","amount","created_at","updated_at"]},"CancelOpenFinancePaymentBody":{"type":"object","properties":{"canceled_by_document":{"type":"string","description":"Canceled by document.","example":"40995401039"}},"required":["canceled_by_document"]},"CancelOpenFinancePaymentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Payment status.","enum":["PENDING","WAITING","WAITING_ANALYSIS","COMPLETED","FAILED","REJECTED","SCHEDULED","PENDING_CANCEL","CANCELLED","ERROR"],"example":"PENDING_CANCEL"},"created_at":{"format":"date-time","type":"string","description":"Payment created at.","example":"2026-05-29T19:41:08.995Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment updated at.","example":"2026-05-29T19:41:08.995Z"}},"required":["id","status","created_at","updated_at"]},"GetAllOpenFinancePaymentsRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Payment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"open_finance_participant_id":{"type":"string","description":"Participant UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"payment_consent_id":{"type":"string","description":"Payment consent UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Payment status.","enum":["PENDING","WAITING","WAITING_ANALYSIS","COMPLETED","FAILED","REJECTED","SCHEDULED","PENDING_CANCEL","CANCELLED","ERROR"],"example":"PENDING"},"amount":{"type":"number","description":"Payment amount in cents.","example":10000},"payment_date":{"format":"date-time","type":"string","description":"Payment date.","example":"2026-05-29T19:41:08.990Z"},"payment_type":{"type":"string","description":"Payment type.","enum":["ACCOUNT","KEY","QR_CODE","QR_CODE_STATIC_INSTANT","QR_CODE_STATIC_WITHDRAWAL","QR_CODE_DYNAMIC_DUE_DATE","QR_CODE_DYNAMIC_WITHDRAWAL","QR_CODE_DYNAMIC_CHANGE","QR_CODE_DYNAMIC_INSTANT","REFUND","AUTOMATIC_PAYMENT","OPEN_FINANCE"],"example":"KEY"},"end_to_end_id":{"type":"string","description":"End to end ID.","example":"E00038166201907261559y6j6"},"rejection_reason_code":{"type":"string","description":"Rejection reason code.","example":"AB03"},"rejection_reason_detail":{"type":"string","description":"Rejection reason detail.","example":"Líquido insuficiente."},"failed_code":{"type":"string","description":"Failed code.","example":"ERROR_CODE"},"failed_message":{"type":"string","description":"Failed message.","example":"Error processing payment"},"third_part_creditor_name":{"type":"string","description":"Third part creditor name."},"third_part_creditor_document":{"type":"string","description":"Third part creditor document."},"third_part_creditor_person_type":{"type":"string","description":"Third part creditor person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"third_part_payment_creditor_account_ispb":{"type":"string","description":"Third part payment creditor account ISPB."},"third_part_payment_creditor_account_number":{"type":"string","description":"Third part payment creditor account number."},"third_part_payment_creditor_branch":{"type":"string","description":"Third part payment creditor branch."},"third_part_payment_creditor_account_type":{"type":"string","description":"Third part payment creditor account type."},"third_part_payment_pix_key":{"type":"string","description":"Third part payment pix key."},"third_part_payment_emv":{"type":"string","description":"Third part payment EMV."},"third_part_logged_user_document":{"type":"string","description":"Third part logged user document."},"third_part_logged_user_document_type":{"type":"string","description":"Third part logged user document type.","enum":["CPF","CNPJ"]},"third_part_business_entity_document":{"type":"string","description":"Third part business entity document."},"third_part_business_entity_document_type":{"type":"string","description":"Third part business entity document type.","enum":["CPF","CNPJ"]},"third_part_debtor_account_ispb":{"type":"string","description":"Third part debtor account ISPB.","example":"1234567890"},"third_part_debtor_account_number":{"type":"string","description":"Third part debtor account number.","example":"1234567890"},"third_part_debtor_account_type":{"type":"string","description":"Third part debtor account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"third_part_debtor_account_branch":{"type":"string","description":"Third part debtor account branch.","example":"0001"},"canceled_by_document":{"type":"string","description":"Canceled by document.","example":"1234567890"},"canceled_by_document_type":{"type":"string","description":"Canceled by document type.","enum":["CPF","CNPJ"],"example":"CPF"},"cancel_reason":{"type":"string","description":"Cancel reason.","enum":["PENDING_CANCELED","SCHEDULED_CANCELED","CANCELLED_BY_MULTIPLE_COMPETENCES"],"example":"PENDING_CANCELED"},"canceled_from":{"type":"string","description":"Canceled from.","enum":["INITIATOR","HOLDER"],"example":"INITIATOR"},"canceled_at":{"format":"date-time","type":"string","description":"Canceled at.","example":"2026-05-29T19:41:08.991Z"},"created_at":{"format":"date-time","type":"string","description":"Payment created at.","example":"2026-05-29T19:41:08.991Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment updated at.","example":"2026-05-29T19:41:08.991Z"}},"required":["id","user_id","open_finance_participant_id","payment_consent_id","status","amount","payment_date","payment_type","third_part_creditor_name","third_part_creditor_document","third_part_creditor_person_type","third_part_payment_creditor_account_ispb","third_part_payment_creditor_account_number","third_part_payment_creditor_branch","third_part_payment_creditor_account_type","third_part_logged_user_document","third_part_logged_user_document_type","created_at","updated_at"]},"GetAllOpenFinancePaymentsRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Payments data.","type":"array","items":{"$ref":"#/components/schemas/GetAllOpenFinancePaymentsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetEnrollmentByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Enrollment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Enrollment status.","enum":["PENDING","ERROR","FAILED","AWAITING_DEVICE_RISK_SIGNALS","AWAITING_ACCOUNT_OWNER_VALIDATION","AWAITING_ENROLLMENT","AWAITING_DEVICE_REGISTRATION","PENDING_REVOKE","AUTHORIZED","REVOKED","REJECTED"],"example":"PENDING"},"name":{"type":"string","description":"Enrollment name.","example":"Payments account"},"logged_user_document":{"type":"string","description":"Client logged user document.","example":"1234567890"},"logged_user_document_type":{"type":"string","description":"Client logged user document type.","enum":["CPF","CNPJ"],"example":"CPF"},"logged_business_entity_document":{"type":"string","description":"Client logged business entity document.","example":"12345678910234"},"logged_business_entity_document_type":{"type":"string","description":"Client logged business entity document type.","enum":["CPF","CNPJ"],"example":"CNPJ"},"permissions":{"type":"array","description":"Enrollment permissions.","example":["PAYMENTS_INITIATE"],"items":{"type":"string","enum":["PAYMENTS_INITIATE","RECURRING_PAYMENTS_INITIATE"]}},"logged_user_bank_ispb":{"type":"string","description":"Client logged user bank ISPB.","example":"1234567890"},"logged_user_branch_number":{"type":"string","description":"Client logged user branch number.","example":"0001"},"logged_user_account_number":{"type":"string","description":"Client logged user account number.","example":"1234567890"},"logged_user_account_type":{"type":"string","description":"Client logged user account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"transaction_limit":{"type":"number","description":"Enrollment transaction limit.","example":1000},"daily_limit":{"type":"number","description":"Enrollment daily limit.","example":1000},"expiration_date":{"format":"date-time","type":"string","description":"Enrollment expiration date.","example":"2026-05-29T19:41:08.991Z"},"participant_id":{"type":"string","description":"Open Finance participant id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"participant_friendly_name":{"type":"string","description":"Open Finance participant friendly name.","example":"Open Finance Participant"},"participant_friendly_logo_uri":{"type":"string","description":"Open Finance participant friendly logo URI.","example":"https://example.com/logo.png"},"is_linked":{"type":"boolean","description":"Enrollment is linked to an optimized journey.","example":true},"link_id":{"type":"string","description":"Enrollment link id to an optimized journey. Required if is_linked is true.","example":"urn:bancoex:C1DD331237"},"canceled_by_document":{"type":"string","description":"Enrollment canceled by document.","example":"1234567890"},"canceled_by_document_type":{"type":"string","description":"Enrollment canceled by document type.","enum":["CPF","CNPJ"],"example":"CPF"},"cancel_reason":{"type":"string","description":"Enrollment canceled reason.","enum":["REJECTED_BY_DIFFERENT_ACCOUNT_HOLDER","REJECTED_BY_EXPIRED_RISK_SIGNALS","REJECTED_BY_EXPIRED_ACCOUNT_HOLDER_VALIDATION","REJECTED_BY_EXPIRED_ENROLLMENT","REJECTED_BY_MAXIMUM_CHALLENGES_REACHED","REJECTED_MANUALLY","REJECTED_BY_INCOMPATIBLE_DEVICE","REJECTED_BY_INFRASTRUCTURE_FAILURE","REJECTED_BY_HYBRID_FLOW_FAILURE","REJECTED_BY_FIDO_FAILURE","REJECTED_BY_INTERNAL_SECURITY","REJECTED_BY_OTHER_REASON","REVOKED_MANUALLY","REVOKED_BY_EXPIRED_VALIDITY","REVOKED_BY_INFRASTRUCTURE_FAILURE","REVOKED_BY_INTERNAL_SECURITY","REVOKED_BY_OTHER_REASON"],"example":"REJECTED_MANUALLY"},"cancel_description":{"type":"string","description":"Enrollment canceled description."},"canceled_from":{"type":"string","description":"Enrollment canceled from.","enum":["INITIATOR","HOLDER"],"example":"INITIATOR"},"canceled_at":{"format":"date-time","type":"string","description":"Enrollment canceled at.","example":"2026-05-29T19:41:08.992Z"},"redirect_uri":{"type":"string","description":"Enrollment redirect link.","example":"https://client.bank.com/redirect?client_id=abc123&request_uri=urn:123"},"created_at":{"format":"date-time","type":"string","description":"Enrollment created at.","example":"2026-05-29T19:41:08.992Z"},"updated_at":{"format":"date-time","type":"string","description":"Enrollment updated at.","example":"2026-05-29T19:41:08.992Z"}},"required":["id","status","logged_user_document","logged_user_document_type","permissions","participant_id","participant_friendly_name","created_at","updated_at"]},"DeviceEnrollmentPublicKeyCredentialParamRest":{"type":"object","properties":{"alg":{"type":"number","description":"Credential algorithm.","example":-257},"type":{"type":"string","description":"Credential type.","example":"public-key"}},"required":["alg","type"]},"DeviceEnrollmentBaseCredentialRest":{"type":"object","properties":{"id":{"type":"string","description":"Credential ID.","example":"00aa11bb22cc33dd"},"type":{"type":"string","description":"Credential type.","example":"public-key"}},"required":["id","type"]},"GetDeviceEnrollmentCredentialByIdRestResponse":{"type":"object","properties":{"enrollment_id":{"type":"string","description":"Enrollment id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"rp_id":{"type":"string","description":"Device enrollment credential RP ID.","example":"dev.zroglobal.test"},"rp_name":{"type":"string","description":"Device enrollment credential RP name.","example":"ZRO Global Test"},"user_id":{"type":"string","description":"Device enrollment credential user ID.","example":"1234567890"},"user_name":{"type":"string","description":"Device enrollment credential user name.","example":"John Doe"},"user_display_name":{"type":"string","description":"Device enrollment credential user display name.","example":"John Doe"},"challenge":{"type":"string","description":"Device enrollment credential challenge in base64url format.","example":"ODFaQmdvSDY4MlVzaXc"},"pub_key_cred_params":{"description":"Device enrollment credential FIDO public key credentials params.","example":[{"alg":-257,"type":"public-key"}],"type":"array","items":{"$ref":"#/components/schemas/DeviceEnrollmentPublicKeyCredentialParamRest"}},"timeout":{"type":"number","description":"Device enrollment credential timeout.","example":30000},"exclude_credentials":{"description":"Device enrollment credential exclude credentials.","example":[{"id":"00aa11bb22cc33dd","type":"public-key"}],"type":"array","items":{"$ref":"#/components/schemas/DeviceEnrollmentBaseCredentialRest"}},"allow_credentials":{"description":"Device enrollment credential allow credentials.","example":[{"id":"00aa11bb22cc33dd","type":"public-key"}],"type":"array","items":{"$ref":"#/components/schemas/DeviceEnrollmentBaseCredentialRest"}},"user_verification":{"type":"string","description":"Device enrollment credential user verification.","example":"required"},"authenticator_attachment":{"type":"string","description":"Device enrollment credential authenticator attachment.","example":"platform"},"require_resident_key":{"type":"boolean","description":"Device enrollment credential require resident key.","example":true},"resident_key":{"type":"string","description":"Device enrollment credential resident key.","example":"required"},"attestation":{"type":"string","description":"Device enrollment credential attestation. Supported values: none, indirect, direct, enterprise.","example":"none"},"attestation_formats":{"description":"Device enrollment credential attestation formats. Supported values: packed, tpm, android-key, android-safetynet, fido-u2f, apple, none.","example":["packed","tpm","android-key","android-safetynet","fido-u2f","apple","none"],"type":"array","items":{"type":"string"}},"extensions":{"type":"object","description":"Device enrollment credential extensions.","example":{"appid":"true"}},"request_date":{"format":"date-time","type":"string","description":"Device enrollment credential request date.","example":"2026-05-29T19:41:08.995Z"}},"required":["enrollment_id","challenge","request_date"]},"GetAllEnrollmentsRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Enrollment UUID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Enrollment status.","enum":["PENDING","ERROR","FAILED","AWAITING_DEVICE_RISK_SIGNALS","AWAITING_ACCOUNT_OWNER_VALIDATION","AWAITING_ENROLLMENT","AWAITING_DEVICE_REGISTRATION","PENDING_REVOKE","AUTHORIZED","REVOKED","REJECTED"],"example":"PENDING"},"name":{"type":"string","description":"Enrollment name.","example":"Payments account"},"logged_user_document":{"type":"string","description":"Client logged user document.","example":"1234567890"},"logged_user_document_type":{"type":"string","description":"Client logged user document type.","enum":["CPF","CNPJ"],"example":"CPF"},"logged_business_entity_document":{"type":"string","description":"Client logged business entity document.","example":"12345678910234"},"logged_business_entity_document_type":{"type":"string","description":"Client logged business entity document type.","enum":["CPF","CNPJ"],"example":"CNPJ"},"permissions":{"type":"array","description":"Enrollment permissions.","example":["PAYMENTS_INITIATE"],"items":{"type":"string","enum":["PAYMENTS_INITIATE","RECURRING_PAYMENTS_INITIATE"]}},"logged_user_bank_ispb":{"type":"string","description":"Client logged user bank ISPB.","example":"1234567890"},"logged_user_branch_number":{"type":"string","description":"Client logged user branch number.","example":"0001"},"logged_user_account_number":{"type":"string","description":"Client logged user account number.","example":"1234567890"},"logged_user_account_type":{"type":"string","description":"Client logged user account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"transaction_limit":{"type":"number","description":"Enrollment transaction limit.","example":1000},"daily_limit":{"type":"number","description":"Enrollment daily limit.","example":1000},"expiration_date":{"format":"date-time","type":"string","description":"Enrollment expiration date.","example":"2026-05-29T19:41:08.994Z"},"participant_id":{"type":"string","description":"Open Finance participant id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"participant_friendly_name":{"type":"string","description":"Open Finance participant friendly name.","example":"Open Finance Participant"},"participant_friendly_logo_uri":{"type":"string","description":"Open Finance participant friendly logo URI.","example":"https://example.com/logo.png"},"is_linked":{"type":"boolean","description":"Enrollment is linked to an optimized journey.","example":true},"link_id":{"type":"string","description":"Enrollment link id to an optimized journey. Required if is_linked is true.","example":"urn:bancoex:C1DD331237"},"canceled_by_document":{"type":"string","description":"Enrollment canceled by document.","example":"1234567890"},"canceled_by_document_type":{"type":"string","description":"Enrollment canceled by document type.","enum":["CPF","CNPJ"],"example":"CPF"},"cancel_reason":{"type":"string","description":"Enrollment canceled reason.","enum":["REJECTED_BY_DIFFERENT_ACCOUNT_HOLDER","REJECTED_BY_EXPIRED_RISK_SIGNALS","REJECTED_BY_EXPIRED_ACCOUNT_HOLDER_VALIDATION","REJECTED_BY_EXPIRED_ENROLLMENT","REJECTED_BY_MAXIMUM_CHALLENGES_REACHED","REJECTED_MANUALLY","REJECTED_BY_INCOMPATIBLE_DEVICE","REJECTED_BY_INFRASTRUCTURE_FAILURE","REJECTED_BY_HYBRID_FLOW_FAILURE","REJECTED_BY_FIDO_FAILURE","REJECTED_BY_INTERNAL_SECURITY","REJECTED_BY_OTHER_REASON","REVOKED_MANUALLY","REVOKED_BY_EXPIRED_VALIDITY","REVOKED_BY_INFRASTRUCTURE_FAILURE","REVOKED_BY_INTERNAL_SECURITY","REVOKED_BY_OTHER_REASON"],"example":"REJECTED_MANUALLY"},"cancel_description":{"type":"string","description":"Enrollment canceled description."},"canceled_from":{"type":"string","description":"Enrollment canceled from.","enum":["INITIATOR","HOLDER"],"example":"INITIATOR"},"canceled_at":{"format":"date-time","type":"string","description":"Enrollment canceled at.","example":"2026-05-29T19:41:08.994Z"},"redirect_uri":{"type":"string","description":"Enrollment redirect link.","example":"https://client.bank.com/redirect?client_id=abc123&request_uri=urn:123"},"created_at":{"format":"date-time","type":"string","description":"Enrollment created at.","example":"2026-05-29T19:41:08.994Z"},"updated_at":{"format":"date-time","type":"string","description":"Enrollment updated at.","example":"2026-05-29T19:41:08.994Z"}},"required":["id","status","logged_user_document","logged_user_document_type","permissions","participant_id","participant_friendly_name","created_at","updated_at"]},"GetAllEnrollmentsRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Page number.","example":1},"page_size":{"type":"number","description":"Page size.","example":20},"page_total":{"type":"number","description":"Page total.","example":20},"total":{"type":"number","description":"Total of elements.","example":100},"data":{"description":"Enrollments data.","type":"array","items":{"$ref":"#/components/schemas/GetAllEnrollmentsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"RevokeEnrollmentBody":{"type":"object","properties":{"logged_user_document":{"type":"string","description":"Document of the user who is revoke the enrollment.","example":"40995401039"},"additional_information":{"type":"string","description":"Additional information for revoke the enrollment.","example":"The user canceled the enrollment because they did not want to use the service."}},"required":["logged_user_document"]},"RevokeEnrollmentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Revoked enrollment id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Enrollment status.","enum":["PENDING","ERROR","FAILED","AWAITING_DEVICE_RISK_SIGNALS","AWAITING_ACCOUNT_OWNER_VALIDATION","AWAITING_ENROLLMENT","AWAITING_DEVICE_REGISTRATION","PENDING_REVOKE","AUTHORIZED","REVOKED","REJECTED"],"example":"PENDING_REVOKE"},"created_at":{"format":"date-time","type":"string","description":"Enrollment created at.","example":"2026-05-29T19:41:08.992Z"},"updated_at":{"format":"date-time","type":"string","description":"Enrollment updated at.","example":"2026-05-29T19:41:08.992Z"}},"required":["id","status","created_at","updated_at"]},"CreateDeviceEnrollmentSignInBody":{"type":"object","properties":{"platform":{"type":"string","description":"Platform of the device.","example":"CROSS_PLATFORM","enum":["ANDROID","IOS","BROWSER","CROSS_PLATFORM"]},"consent_id":{"type":"string","description":"Consent id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"}},"required":["platform","consent_id"]},"CreateEnrollmentDeviceSignInRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Device enrollment id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"enrollment_id":{"type":"string","description":"Enrollment id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"consent_id":{"type":"string","description":"Consent id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Device enrollment status.","enum":["WAITING_RISK_SIGNAL","WAITING_CREDENTIALS_CREATION","WAITING_CREATION","WAITING_SIGN_IN","SIGNED_IN","CREATED","ERROR","FAILED"],"example":"WAITING_SIGN_IN"},"created_at":{"format":"date-time","type":"string","description":"Device enrollment created at.","example":"2026-05-29T19:41:08.996Z"}},"required":["id","enrollment_id","consent_id","status","created_at"]},"CreateDeviceEnrollmentCredentialsBody":{"type":"object","properties":{"platform":{"type":"string","description":"Platform of the device.","example":"CROSS_PLATFORM","enum":["ANDROID","IOS","BROWSER","CROSS_PLATFORM"]}},"required":["platform"]},"CreateEnrollmentDeviceCredentialRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Device enrollment id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"enrollment_id":{"type":"string","description":"Enrollment id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Device enrollment status.","enum":["WAITING_RISK_SIGNAL","WAITING_CREDENTIALS_CREATION","WAITING_CREATION","WAITING_SIGN_IN","SIGNED_IN","CREATED","ERROR","FAILED"],"example":"WAITING_CREDENTIALS_CREATION"},"created_at":{"format":"date-time","type":"string","description":"Device enrollment created at.","example":"2026-05-29T19:41:08.994Z"}},"required":["id","enrollment_id","status","created_at"]},"CreateDeviceEnrollmentRiskSignalBody":{"type":"object","properties":{"account_tenure":{"type":"string","description":"Client logged user account tenure date.","example":"2026-05-29","format":"date"},"device_id":{"type":"string","description":"Client logged user device ID.","example":"00aa11bb22cc33dd"},"os_version":{"type":"string","description":"Client logged user OS version.","example":"14"},"elapsed_time_since_boot":{"type":"number","description":"Client logged user elapsed time since boot in milliseconds.","example":1000},"is_rooted_device":{"type":"boolean","description":"Client logged user is rooted device.","example":true},"user_time_zone_offset":{"type":"string","description":"Client logged user user time zone offset.","example":"-03:00"},"language":{"type":"string","description":"Client logged user language ISO 639-1 code.","example":"pt"},"screen_width":{"type":"number","description":"Client logged user device screen width in pixels.","example":1920},"screen_height":{"type":"number","description":"Client logged user device screen height in pixels.","example":1080},"screen_brightness":{"type":"number","description":"Client logged user screen brightness in percentage. Examples: 0.5 for fractional format and 50 for percentage format.","example":0.5},"device_latitude":{"type":"number","description":"Client logged user device latitude.","example":-23.5505},"device_longitude":{"type":"number","description":"Client logged user device longitude.","example":-46.6333},"device_geolocation_type":{"type":"string","description":"Client logged user device geolocation type.","example":"COARSE","enum":["COARSE","FINE","INFERRED"]},"is_call_in_progress":{"type":"boolean","description":"Client logged user device is call in progress.","example":true},"is_dev_mode_enabled":{"type":"boolean","description":"Client logged user device is dev mode enabled.","example":true},"is_mock_gps":{"type":"boolean","description":"Client logged user device is mock GPS enabled.","example":true},"is_emulated":{"type":"boolean","description":"Client logged user device is emulated.","example":true},"is_monkey_runner":{"type":"boolean","description":"Client logged user device is monkey runner enabled.","example":true},"is_charging":{"type":"boolean","description":"Client logged user device is charging.","example":true},"antenna_information":{"type":"string","description":"Client logged user device antenna information.","example":" CellIdentityLte:{ mCi=2******60 mPci=274 mTac=5***1 }..."},"is_usb_connected":{"type":"boolean","description":"Client logged user device is USB connected.","example":true},"device_app_integrity_verdict":{"type":"string","description":"Client logged user device app integrity verdict.","example":"PLAY_RECOGNIZED"},"device_integrity_verdict":{"type":"string","description":"Client logged user device integrity verdict.","example":"[\"MEETS_DEVICE_INTEGRITY\"]"}},"required":["account_tenure","device_id","os_version","user_time_zone_offset","language","screen_width","screen_height"]},"CreateDeviceEnrollmentBody":{"type":"object","properties":{"device_credential_id":{"type":"string","description":"Includes information about the application that generated the credential. Must be sent to the holder in base64 format.","example":"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxl"},"device_credential_raw_id":{"type":"string","description":"Device credential raw ID. Must match the device_credential_id property.","example":"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxl"},"device_credential_client_data_json":{"type":"string","description":"Information about the APP that generated the credential. Must be a base64url encoded string.","example":"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxl"},"device_credential_attestation_object":{"type":"string","description":"Information about the public key of the credential. Must be a base64url encoded string.","example":"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxl"},"device_credential_authenticator_attachment":{"type":"string","description":"Device credential authenticator attachment.","example":"platform"},"device_credential_type":{"type":"string","description":"Device credential type.","example":"public-key"},"client_extension_results":{"type":"object","description":"Client extension results.","example":{"additionalProp1":{}}}},"required":["device_credential_id","device_credential_raw_id","device_credential_client_data_json","device_credential_attestation_object"]},"CreateEnrollmentDeviceRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Device enrollment id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"enrollment_id":{"type":"string","description":"Enrollment id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Device enrollment status.","enum":["WAITING_RISK_SIGNAL","WAITING_CREDENTIALS_CREATION","WAITING_CREATION","WAITING_SIGN_IN","SIGNED_IN","CREATED","ERROR","FAILED"],"example":"WAITING_CREDENTIALS_CREATION"},"created_at":{"format":"date-time","type":"string","description":"Device enrollment created at.","example":"2026-05-29T19:41:08.994Z"}},"required":["id","enrollment_id","status","created_at"]},"CreateEnrollmentBody":{"type":"object","properties":{"client_redirect_url":{"type":"string","description":"Client redirect URL.","example":"https://example.com/client-redirect"},"participant_id":{"type":"string","description":"Open Finance participant id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"logged_user_document":{"type":"string","description":"Client logged user document. In case of the user is a business entity, it is the document of the business entity representative.","example":"40995401039"},"logged_business_entity_document":{"type":"string","description":"Client logged user document when the user is a business entity.","example":"85959525000101"},"permissions":{"type":"array","description":"Enrollment permissions.\n
PAYMENTS_INITIATE: Permission to initiate payments\n
RECURRING_PAYMENTS_INITIATE: Permission to initiate recurring payments","example":["PAYMENTS_INITIATE","RECURRING_PAYMENTS_INITIATE"],"items":{"type":"string","enum":["PAYMENTS_INITIATE","RECURRING_PAYMENTS_INITIATE"]}},"name":{"type":"string","description":"Enrollment name.","example":"Payments account"},"logged_user_bank_ispb":{"type":"string","description":"client logged user bank ISPB.","example":"1234567890"},"logged_user_branch_number":{"type":"string","description":"client logged user branch number.","example":"0001"},"logged_user_bank_account_number":{"type":"string","description":"client logged user bank account number.","example":"1234567890"},"logged_user_bank_account_type":{"type":"string","description":"client logged user bank account type.","enum":["CACC","CASH","CHAR","CISH","COMM","CPAC","LLSV","LOAN","MGLD","MOMA","NREX","ODFT","ONDP","OTHR","SACC","SLRY","SVGS","TAXE","TRAN","TRAS","CC","PG","CD","CG","CI","PP","PI"],"example":"CACC"},"is_linked":{"type":"boolean","description":"Enrollment is linked to a optmized journey.","example":true},"link_id":{"type":"string","description":"Enrollment link id to a optmized journey. Required if is_linked is true.","example":"urn:bancoex:C1DD331237"}},"required":["client_redirect_url","participant_id","logged_user_document","permissions"]},"CreateEnrollmentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Enrollment id.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Enrollment status.","enum":["PENDING","ERROR","FAILED","AWAITING_DEVICE_RISK_SIGNALS","AWAITING_ACCOUNT_OWNER_VALIDATION","AWAITING_ENROLLMENT","AWAITING_DEVICE_REGISTRATION","PENDING_REVOKE","AUTHORIZED","REVOKED","REJECTED"],"example":"PENDING"},"expiration_date_time":{"format":"date-time","type":"string","description":"Enrollment expiration date time.","example":"2026-05-29T19:41:08.991Z"},"created_at":{"format":"date-time","type":"string","description":"Enrollment created at.","example":"2026-05-29T19:41:08.991Z"}},"required":["id","status","created_at"]}}}}