{"openapi":"3.0.0","paths":{"/v1/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":"V1LoginAuthRestController_execute_v1","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/V1AuthenticateRestRequest"}}}},"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"]}},"/v1/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":"V1RefreshTokenAuthRestController_execute_v1","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"]}},"/v1/pix/keys":{"get":{"description":"Retrieve a list of the user's pix keys, excluding canceled keys.","operationId":"V1GetAllPixKeyRestController_execute_v1","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"}}}}},"401":{"description":"User authentication failed."}},"security":[{"bearer":[]}],"summary":"List Pix Keys","tags":["Pix | Keys"]}},"/v1/pix/keys/{id}/code":{"get":{"description":"Tag: api-baas-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":"V1SendCodePixKeyRestController_execute_v1","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-baas-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":"V1VerifyCodePixKeyRestController_execute_v1","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-baas-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_v1","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"]}},"/v1/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":"V1GetByIdPixKeyRestController_execute_v1","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"]}},"/v1/pix/payments/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":"V1CreateDecodedPixKeyRestController_execute_v1","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":true,"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"]}},"/v1/pix/deposits/qr-codes/dynamic/instant-billing":{"post":{"description":"Generate a new instant-billing dynamic QR Code for the user.","operationId":"V1CreateQrCodeDynamicInstantBillingRestController_execute_v1","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"]}},"/v1/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":"V1CreateQrCodeDynamicDueDateRestController_execute_v1","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"]}},"/v1/pix/deposits/qr-codes/dynamic/{id}":{"get":{"description":"Retrieve a specific dynamic QR Code associated with the user using its unique identifier.","operationId":"V1GetQrCodeDynamicByIdRestController_execute_v1","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"]}},"/v1/pix/deposits/qr-codes/static":{"post":{"description":"Generate a new static QR Code for the user.","operationId":"V1CreateQrCodeStaticRestController_execute_v1","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"]},"get":{"description":"Retrieve all static QR Codes associated with the user.","operationId":"V1GetAllQrCodeStaticRestController_execute_v1","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"]}},"/v1/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":"V1CreateAsyncQrCodeStaticRestController_execute_v1","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"]}},"/v1/pix/deposits/qr-codes/static/{id}":{"get":{"description":"Retrieve a specific static QR Code associated with the user by its unique identifier.","operationId":"V1GetByQrCodeStaticIdRestController_execute_v1","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"]},"delete":{"description":"Remove a specific static QR Code associated with the user by its unique identifier.","operationId":"V1DeleteByQrCodeStaticIdRestController_execute_v1","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"]}},"/v2/pix/keys":{"post":{"description":"Tag: api-baas-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"]}},"/v1/pix/keys/{id}/portabilities/start":{"post":{"description":"Tag: api-baas-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_v1","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-baas-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_v1","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"]}},"/v1/pix/keys/{id}/portabilities/approve":{"post":{"description":"Tag: api-baas-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_v1","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"]}},"/v1/pix/keys/{id}/claims/start":{"delete":{"description":"Tag: api-baas-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_v1","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-baas-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_v1","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"]}},"/v1/pix/keys/{id}/portabilities/cancel":{"delete":{"description":"Tag: api-baas-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_v1","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"]}},"/v1/pix/keys/{id}/claims/cancel":{"delete":{"description":"Tag: api-baas-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_v1","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-baas-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-baas-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"]}},"/v1/split-payments/pix/qr-codes/static":{"post":{"description":"Tag: api-baas-post-split-payments-pix-qr-codes-static
\n Description: Generate a new static QR Code with split payment configuration.","operationId":"CreateSplitPixQrCodeStaticRestController_execute_v1","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"]}},"/v1/split-payments/pix/history":{"get":{"description":"Tag: api-baas-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_v1","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/by-qr-code":{"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":true,"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"]}},"/v1/pix/payments/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":"V1CreateDecodedPixAccountRestController_execute_v1","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"]}},"/v2/pix/payments/by-account/instant-billing":{"post":{"description":"Initiate a new pix payment using a bank account. First, create a Decoded Pix Account ID at the endpoint /pix/payment/decode/by-account. Then, use the decoded_pix_account_id to enter the pix payment's information in the request body and execute.","operationId":"V2CreateByAccountPaymentRestController_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":"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/V2CreatePaymentByPixAccountBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CreateByAccountPaymentRestResponse"}}}},"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"]}},"/v1/pix/payments/by-account/decode-instant-billing":{"post":{"description":"Initiate a new pix payment using a bank account. Enter the decode and pix payment's information in the request body and execute.","operationId":"V1DecodeAndCreateByAccountPaymentRestController_execute_v1","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/DecodeAndCreatePaymentByAccountBody"}}}},"responses":{"201":{"description":"Payment accomplished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecodeAndCreateByAccountPaymentRestResponse"}}}},"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 Bank Account","tags":["Pix | Payments"]}},"/v1/pix/payments/by-qr-code/static/withdrawal":{"post":{"description":"Withdraw a payment using a static QR code.","operationId":"V1WithdrawalByQrCodeStaticPaymentRestController_execute_v1","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"]}},"/v1/pix/payments/by-qr-code/dynamic/withdrawal":{"post":{"description":"Withdraw a payment using a dynamic QR code.","operationId":"V1WithdrawalByQrCodeDynamicPaymentRestController_execute_v1","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"]}},"/v1/pix/payments/by-qr-code/dynamic/due-date-billing":{"post":{"description":"Create a due date payment using a dynamic QR code.","operationId":"V1DuedateByQrCodeDynamicPaymentRestController_execute_v1","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"]}},"/v1/pix/payments/by-qr-code/dynamic/change":{"post":{"description":"Initiate a change a payment using a dynamic QR code.","operationId":"V1ChangeByQrCodeDynamicPaymentRestController_execute_v1","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"]}},"/v1/pix/payments/by-qr-code/dynamic/instant-billing":{"post":{"description":"Initiate a payment using a dynamic QR code.","operationId":"V1CreateByQrCodeDynamicPaymentRestController_execute_v1","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"]}},"/v1/pix/payments/by-qr-code/static/instant-billing":{"post":{"description":"Initiate a payment using a static QR code.","operationId":"V1CreateByQrCodeStaticPaymentRestController_execute_v1","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"]}},"/v1/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":"V1CreateByPixKeyPaymentRestController_execute_v1","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"]}},"/v1/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":"V1DecodeAndCreateByPixKeyPaymentRestController_execute_v1","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":true,"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"]}},"/v1/pix/devolutions":{"post":{"description":"Initiate a new pix devolution by providing the required information in the request body and executing the request.","operationId":"V1CreatePixDevolutionRestController_execute_v1","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"]},"get":{"description":"Retrieve a list of pix devolutions for the user. Use optional filter parameters to refine your search.","operationId":"V1GetAllPixDevolutionRestController_execute_v1","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/GetAllPixDevolutionRestResponse"}}}},"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"]}},"/v1/pix/payments/by-operation/{id}":{"delete":{"description":"Cancel a payment by its operation ID. This route works for payments in the SCHEDULED state. If the payment state is:
\n \n Returns the payment with a state of CANCELED.","operationId":"V1CancelPaymentByOperationIdRestController_execute_v1","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/CancelPaymentRestResponse"}}}},"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"]}},"/v1/pix/payments":{"get":{"description":"Retrieve a list of the user's pix payments. Use optional filter parameters to refine your search.","operationId":"V1GetAllPaymentRestController_execute_v1","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":["SCHEDULED","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/GetAllPaymentRestResponse"}}}},"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"]}},"/v2/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":"V2GetAllPixDepositRestController_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":"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/V2GetAllPixDepositRestResponse"}}}},"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"]}},"/v1/pix/devolutions-received":{"get":{"description":"Retrieve a list of pix devolutions received by the user. Use optional filter parameters to refine your search.","operationId":"V1GetAllPixDevolutionReceivedRestController_execute_v1","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/GetAllPixDevolutionReceivedRestResponse"}}}},"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"]}},"/v1/pix/payments/{id}":{"get":{"description":"Retrieve the state and details of a pix payment by providing its ID.","operationId":"V1GetPaymentByIdRestController_execute_v1","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/GetPaymentByIdRestResponse"}}}},"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"]}},"/v2/pix/devolutions/{id}":{"get":{"description":"Retrieve the state and details of a pix devolution by providing its ID.","operationId":"V2GetByPixDevolutionIdRestController_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 ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"The PIX devolution returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetByPixDevolutionIdRestResponse"}}}},"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 Devolution by ID","tags":["Pix | Devolutions"]}},"/v1/pix/deposits/{id}":{"get":{"description":"Enter the pix deposit's ID below and execute to get its state and all information.","operationId":"V1GetPixDepositByIdRestController_execute_v1","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/GetPixDepositByIdRestResponse"}}}},"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"]}},"/v1/pix/devolutions-received/{id}":{"get":{"description":"Retrieve the state and details of a received pix devolution by providing its ID.","operationId":"V1GetByIdPixDevolutionReceivedRestController_execute_v1","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/GetByPixDevolutionReceivedIdRestResponse"}}}},"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"]}},"/v1/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":"V1CreatePixTrustedContactRestController_execute_v1","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/V1CreatePixTrustedContactBody"}}}},"responses":{"201":{"description":"Pix trusted contact created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreatePixTrustedContactRestResponse"}}}},"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":"V1GetAllPixTrustedContactByWalletRestController_execute_v1","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"]}},"/v1/pix/trusted-contacts/{identifier}":{"get":{"description":"Retrieve a pix trusted contact by id for the user.","operationId":"V1GetPixTrustedContactByIdAndWalletRestController_execute_v1","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":"V1DeletePixTrustedContactRestController_execute_v1","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":"12345678901","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"]}},"/v1/pix/warning/deposits":{"get":{"description":"Get a list of user's warning pix deposits. You can include any of the filter parameters below to refine your search.","operationId":"V1GetAllWarningPixDepositRestController_execute_v1","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"]}},"/v1/pix/payments/person-bucket/available-tokens":{"get":{"description":"Returns the total available tokens across all slots of the person rate limiting bucket. Can be used to check if a user is able to perform more Pix decode operations before being blocked.","operationId":"V1GetPersonBucketAvailableTokenRestController_execute_v1","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":"key_type","required":true,"in":"query","description":"Pix Key state:
\n ","schema":{"example":"EMAIL","type":"string","enum":["CNPJ","CPF","PHONE","EMAIL","EVP"]}}],"responses":{"200":{"description":"Person bucket available tokens retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPersonBucketAvailableTokenRestResponse"}}}},"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":"Get Person Bucket Available Tokens","tags":["Pix | Payments"]}},"/v1/pix/account-config":{"post":{"description":"Owner-only endpoint that creates a PixAccountConfig of the informed name (always ACTIVE) for the selected accounts. Set apply_to_all=true to reach every wallet/pix account of every target user under the owner product, or send an explicit items array to target specific wallet+pix_account pairs. Existing configs are left untouched (use the update endpoint to change their state).","operationId":"V1CreatePixAccountConfigRestController_execute_v1","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":true,"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/CreatePixAccountConfigBody"}}}},"responses":{"201":{"description":"Pix account config created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePixAccountConfigRestResponse"}}}},"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 a Pix account config (block) for accounts.","tags":["Pix | Account config"]}},"/v1/otc/conversions":{"post":{"description":"To initiate a new currency conversion, first create a Quotation ID using the endpoint /v1/quotations/spot. Then, provide the Quotation ID in the request body below and execute the operation.","operationId":"V1CreateConversionRestController_execute_v1","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/CreateConversionBody"}}}},"responses":{"201":{"description":"Conversion created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversionRestResponse"}}}},"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"]},"get":{"description":"Retrieve a list of currency conversions associated with the specified user. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllConversionRestController_execute_v1","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/GetAllConversionRestResponse"}}}},"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"]}},"/v1/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":"V1GetConversionCreditByUserRestController_execute_v1","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/V1GetConversionCreditByUserRestResponse"}}}},"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"]}},"/v1/otc/conversions/{id}/quotations":{"get":{"description":"Retrieve the quotation related to a conversion by specifying its ID.","operationId":"V1GetQuotationByConversionIdRestController_execute_v1","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"]}},"/v1/otc/conversions/{id}":{"get":{"description":"Retrieve detailed information about a currency conversion by specifying its ID.","operationId":"V1GetConversionByIdRestController_execute_v1","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"]}},"/v1/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":"V1GetQuotationRestController_execute_v1","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/GetQuotationRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create SPOT Quotation","tags":["Quotations | Conversions"]}},"/v1/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":"V1GetAllWalletRestController_execute_v1","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":"V1CreateWalletRestController_execute_v1","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"]}},"/v1/operations/wallets/{id}":{"get":{"description":"Retrieve detailed information about a wallet by specifying its ID.","operationId":"V1GetWalletByIdRestController_execute_v1","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":"V1UpdateWalletRestController_execute_v1","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":"V1DeleteWalletRestController_execute_v1","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"]}},"/v1/permissions/permission-type":{"post":{"description":"Tag: api-baas-post-permissions-type
\n Description: To create a new permission type.","operationId":"CreatePermissionTypeRestController_execute_v1","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/CreatePermissionTypeBody"}}}},"responses":{"201":{"description":"The permission type has been created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePermissionTypeRestResponse"}}}},"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 a New Permission Type","tags":["Permissions | Permission Types"]}},"/v1/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":"V1CreateP2PTransferRestController_execute_v1","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"]}},"/v1/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":"V1GetAllWalletAccountRestController_execute_v1","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"]}},"/v1/operations/wallet-accounts/{id}":{"get":{"description":"Retrieve detailed information about a user's wallet account by specifying its ID.","operationId":"V1GetWalletAccountByIdRestController_execute_v1","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"]}},"/v1/operations/currencies":{"get":{"description":"Retrieve a list of all available and tradable currencies. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllCurrencyRestController_execute_v1","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"]}},"/v1/operations":{"get":{"description":"Retrieve a list of the user's operations.","operationId":"V1GetAllOperationsRestController_execute_v1","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":"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"]}},"/v1/operations/{id}":{"get":{"description":"Retrieve a specific user's operation by its unique identifier.","operationId":"V1GetOperationByIdRestController_execute_v1","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"]}},"/v1/operations/{id}/receipt":{"get":{"description":"Retrieve a receipt by specifying its operation ID.","operationId":"V1GetOperationReceiptByIdRestController_execute_v1","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"]}},"/v1/operations/p2p-transfers/{id}":{"get":{"description":"Retrieve information about a specific P2P transfer by entering its ID and executing the request.","operationId":"V1GetP2PTransferByIdRestController_execute_v1","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"]}},"/v1/operations/{id}/receipt/generate":{"post":{"description":"Request receipt PDF generation by operation ID.","operationId":"V1GenerateOperationReceiptPdfByUserAndWalletAndIdRestController_execute_v1","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"]}},"/v1/operations/balance/pending":{"get":{"description":"Returns the sum of all debit operations in PENDING state for a specific wallet account.","operationId":"GetPendingSumByWalletAccountRestController_execute_v1","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"]}},"/v1/operations/balance/daily-summary-detailed":{"get":{"description":"Tag: api-baas-get-operations-balance-daily-summary-detailed
\n Description: Retrieve the daily balance summary for the authenticated user for a specific date or date range.
\n Note: If the start date is not specified, the first day of the month will be used. If the end date is not specified, the current day will be used.
\n Response Format: Returns an array of daily balance summaries, even if only one day is requested.","operationId":"V1GetDailySummaryDetailedRestController_execute_v1","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":{"default":"movement_date","type":"string","enum":["movement_date"]}},{"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":"Wallet currency tag.","schema":{"example":"BRL","type":"string"}},{"name":"movement_date_start","required":false,"in":"query","description":"Movement date start for the daily summary (YYYY-MM-DD).","schema":{"format":"date","example":"2025-10-01","type":"string"}},{"name":"movement_date_end","required":false,"in":"query","description":"Movement date end for the daily summary (YYYY-MM-DD).","schema":{"format":"date","example":"2025-10-09","type":"string"}}],"responses":{"200":{"description":"The daily balance summary detailed (or summaries) returned successfully. Returns a paginated response with GetDailySummaryDetailedRestResponse objects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDailySummaryDetailedRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."}},"security":[{"bearer":[]}],"summary":"Get Daily Balance Summary Detailed","tags":["Operations | Balance"]}},"/v1/operations/balance/daily-summary-detailed/export":{"post":{"description":"Description: Initiate a request to retrieve a daily balance summary detailed file for the specified date range. Use the returned file_id with the 'storage/files/:id/url' endpoint to get url for download the daily balance summary detailed in CSV, PDF or XML format.","operationId":"V1GenerateDailySummaryDetailedExportRestController_execute_v1","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/GenerateDailySummaryDetailedExportBody"}}}},"responses":{"200":{"description":"Daily balance summary detailed generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateDailySummaryDetailedExportRestResponse"}}}},"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 Daily Balance Summary Detailed Export File","tags":["Operations | Balance"]}},"/v1/banking/ted/received":{"get":{"description":"Tag: api-baas-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":"V1GetAllBankingTedReceivedRestController_execute_v1","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/GetAllBankingTedReceivedRestResponse"}}}},"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"]}},"/v1/banking/ted/received/{id}":{"get":{"description":"Tag: api-baas-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":"V1GetBankingTedReceivedByIdRestController_execute_v1","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/GetBankingTedReceivedByIdRestResponse"}}}},"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"]}},"/v1/banking/ted/received/by-operation/{id}":{"get":{"description":"Tag: api-baas-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":"V1GetBankingTedReceivedByOperationIdRestController_execute_v1","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 Operation ID.","schema":{"example":"1b43322e-d6d5-4895-ac3f-a440cc63816a","type":"string"}}],"responses":{"200":{"description":"Banking TED Received.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankingTedReceivedByOperationIdRestResponse"}}}},"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"]}},"/v1/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":"V1GetAllBankTedRestController_execute_v1","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"]}},"/v1/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":"V1GetAllBankingTedRestController_execute_v1","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":"V1CreateBankingTedRestController_execute_v1","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"]}},"/v1/banking/ted/{id}":{"get":{"description":"Retrieve details of a TED (Transferência Eletrônica Disponível) operation by its unique identifier.","operationId":"V1GetBankingTedByIdRestController_execute_v1","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"]}},"/v1/banking/banks":{"get":{"description":"Tag: api-baas-get-banking-banks
\n Description: Retrieve a list of banks. Use optional filter parameters to refine your search.","operationId":"V1GetAllBankRestController_execute_v1","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"]}},"/v1/banking/billet-pix-deposits":{"post":{"description":"Tag: api-baas-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":"V1CreateBankingBilletPixDepositRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Create Bank Billet for Deposit","tags":["Banking | Bank Billet | Pix Deposits"]},"get":{"description":"Tag: api-baas-get-banking-billet-pix-deposit
\n Description: Retrieve a list of bank billet deposits. Use optional filter parameters to refine your search.","operationId":"V1GetAllBankingBilletPixDepositRestController_execute_v1","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"]}},"/v1/banking/billet-pix-deposit/templates":{"post":{"description":"Tag: api-baas-post-banking-billet-pix-deposit-template
\n Description: Create a banking billet pix deposit template with logo and optional merchandise.","operationId":"V1CreateBankingBilletPixDepositTemplateRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Create Banking Billet Pix Deposit Template","tags":["Banking | Bank Billet | Pix Deposit Template"]},"get":{"description":"Tag: api-baas-get-banking-billet-pix-deposit-template-by-wallet
\n Description: Get a banking billet pix deposit template by wallet.","operationId":"V1GetBankingBilletPixDepositTemplateByWalletRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Get Banking Billet Pix Deposit Template By Wallet","tags":["Banking | Bank Billet | Pix Deposit Template"]}},"/v1/banking/billet-pix-deposit/templates/upload":{"post":{"description":"Tag: api-baas-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":"V1UploadBankingBilletPixTemplateFileRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Upload image for Banking Billet Pix Deposit Template","tags":["Banking | Bank Billet | Pix Deposit Template"]}},"/v1/banking/billet-pix-deposits/{id}":{"get":{"description":"Tag: api-baas-get-banking-billet-pix-deposit-by-id
\n Description: Get a bank billet pix deposit by ID.","operationId":"V1GetBankingBilletPixDepositByIdRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Get Bank Billet Pix Deposit By ID","tags":["Banking | Bank Billet | Pix Deposits"]}},"/v1/banking/billet-pix-deposits/pdf/{id}":{"get":{"description":"Tag: api-baas-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":"V1GetBankingBilletPixDepositPdfRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Generate or update the Banking Billet Pix Deposit PDF","tags":["Banking | Bank Billet | Pix Deposits"]}},"/v1/banking/billet-pix-deposits/send-by-email":{"post":{"description":"Tag: api-baas-post-banking-billet-pix-deposit-send-by-email
\n Description: Update the payer's email address and send the bank billet pix deposit by email with PDF attached.","operationId":"V1SendByEmailBankingBilletPixDepositRestController_execute_v1","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/V1SendByEmailBankingBilletPixDepositBody"}}}},"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."}},"security":[{"bearer":[]}],"summary":"Send Bank Billet for Deposit by Email","tags":["Banking | Bank Billet | Pix Deposits"]}},"/v1/banking/billet-payments/{id}":{"get":{"description":"Tag: api-baas-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":"V1GetBankingBilletPaymentByIdRestController_execute_v1","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/V1GetBankingBilletPaymentByIdRestResponse"}}}},"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"]}},"/v1/banking/billet-pix-deposit-batches":{"post":{"description":"Tag: api-baas-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":"V1CreateBankingBilletPixDepositBatchRestController_execute_v1","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/V1CreateBankingBilletPixDepositBatchBody"}}}},"responses":{"201":{"description":"Banking billet pix deposit batch created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateBankingBilletPixDepositBatchRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."}},"security":[{"bearer":[]}],"summary":"Create Bank Billet Pix Deposit Batch","tags":["Banking | Bank Billet | Pix Deposit Batch"]},"get":{"description":"Tag: api-baas-get-banking-billet-pix-deposit-batch
\n Description: Retrieve a list of bank billet deposit batches. Use optional filter parameters to refine your search.","operationId":"V1GetAllBankingBilletPixDepositBatchRestController_execute_v1","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/V1GetAllBankingBilletPixDepositBatchRestResponse"}}}},"400":{"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"]}},"/v1/banking/billet-pix-deposit-batches/{id}":{"get":{"description":"Tag: api-baas-get-banking-billet-pix-deposit-batch-by-id
\n Description: Get a bank billet pix deposit batch by ID.","operationId":"V1GetBankingBilletPixDepositBatchByIdRestController_execute_v1","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/V1GetBankingBilletPixDepositBatchByIdRestResponse"}}}},"400":{"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-baas-put-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":"V1UpdateBankingBilletPixDepositBatchRestController_execute_v1","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/V1UpdateBankingBilletPixDepositBatchBodyParam"}}}},"responses":{"200":{"description":"Batch successfully updated."},"400":{"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"]},"delete":{"description":"Tag: api-baas-delete-banking-billet-pix-deposit-batch
\n Description: This action is only allowed when the banking billet pix deposit batch is REJECTED.","operationId":"V1DeleteBankingBilletPixDepositBatchRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Delete a Bank Billet Pix Deposit Batch","tags":["Banking | Bank Billet | Pix Deposit Batch"]}},"/v1/banking/billet-pix-deposit-batches/{id}/update-file":{"post":{"description":"Tag: api-baas-post-banking-billet-pix-deposit-batch-csv
\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":"V1UpdateCsvFileBankingBilletPixDepositBatchRestController_execute_v1","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/V1UpdateCsvFileBankingBilletPixDepositBatchBody"}}}},"responses":{"200":{"description":"Banking billet pix deposit batch CSV file updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateCsvFileBankingBilletPixDepositBatchRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"403":{"description":"Batch does not belong to user or status is not REJECTED."},"404":{"description":"Batch not found."}},"security":[{"bearer":[]}],"summary":"Update CSV File for Bank Billet Pix Deposit Batch","tags":["Banking | Bank Billet | Pix Deposit Batch"]}},"/v1/banking/billet-pix-deposit-batches/{id}/validation-errors":{"get":{"description":"Tag: api-baas-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":"V1GetAllBankingBilletPixDepositBatchValidationErrorRestController_execute_v1","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/V1GetAllBankingBilletPixDepositBatchValidationErrorRestResponse"}}}},"400":{"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"]}},"/v1/banking/billet-pix-deposit-batch-items":{"post":{"description":"Tag: api-baas-post-banking-billet-pix-deposit-batch-item
\n Description: Create a new bank billet deposit batch item.","operationId":"V1CreateBankingBilletPixDepositBatchItemRestController_execute_v1","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/V1CreateBankingBilletPixDepositBatchItemBody"}}}},"responses":{"201":{"description":"Banking billet deposit batch item created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateBankingBilletPixDepositBatchItemRestResponse"}}}},"400":{"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-baas-get-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":"V1GetAllBankingBilletPixDepositBatchItemByBatchIdRestController_execute_v1","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/V1GetAllBankingBilletPixDepositBatchItemByBatchIdRestResponse"}}}},"400":{"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"]}},"/v1/banking/billet-pix-deposit-batch-items/{id}":{"get":{"description":"Tag: api-baas-get-banking-billet-pix-deposit-batch-item-by-id
\n Description: Get a bank billet deposit batch item by its ID.","operationId":"V1GetBankingBilletPixDepositBatchItemByIdRestController_execute_v1","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/V1GetBankingBilletPixDepositBatchItemByIdRestResponse"}}}},"400":{"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-baas-put-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":"V1UpdateBankingBilletPixDepositBatchItemRestController_execute_v1","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/V1UpdateBankingBilletPixDepositBatchItemBodyParam"}}}},"responses":{"200":{"description":"Item successfully updated."},"400":{"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"]}},"/v1/utils/user-withdraw-settings":{"get":{"description":"Retrieve a list of the user's withdraw settings.","operationId":"V1GetAllUserWithdrawSettingRestController_execute_v1","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":"V1CreateUserWithdrawSettingRestController_execute_v1","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"]}},"/v1/utils/user-withdraw-setting/{id}":{"delete":{"description":"Delete a user's withdraw setting.","operationId":"V1DeleteUserWithdrawSettingRestController_execute_v1","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"]}},"/v3/reports/pix-statement/exports":{"post":{"description":"Description: Initiate a request to retrieve a pix statement file for the current date. Use the returned file_id with the 'storage/files/:id/url' endpoint to get url for download the pix statement in CSV, PDF or OFX format.","operationId":"V3GeneratePixStatementExportRestController_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"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GeneratePixStatementExportBody"}}}},"responses":{"201":{"description":"Pix statement generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GeneratePixStatementExportRestResponse"}}}},"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/GetAllReportPixStatementRestResponse"}}}},"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"]}},"/v2/reports/operation-statement-product/exports":{"post":{"description":"Description: Same as v1, but the CSV includes additional columns: txid, original_end_to_end_id, end_to_end_id, and original_id. Use the returned file_id with the 'storage/files/:id/url' endpoint to download the file.","operationId":"V2GenerateReportOperationStatementProductExportRestController_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":true,"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/V2GenerateReportOperationStatementProductExportBody"}}}},"responses":{"201":{"description":"Operation statement product export generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GenerateReportOperationStatementProductExportRestResponse"}}}},"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 Product Export File (v2)","tags":["Reports"]}},"/v3/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":"V3GetAllReportOperationStatementRestController_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":"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/V3GetAllReportOperationStatementRestResponse"}}}},"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"]}},"/v3/reports/operation-statement-product":{"get":{"description":"Tag: api-baas-get-all-report-operation-statement-product
\n Description: Retrieve operation statement data filtered by product.
\n Date range must be within the same month. If no dates specified, defaults to current day.\n When using filters, both filter_type and filter_text must be provided together.","operationId":"V3GetAllReportOperationStatementProductRestController_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":true,"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. Must be provided if filter_text is used.
\n ","schema":{"example":"topic","type":"string","enum":["currency_symbol","merchant_id","topic","value"]}},{"name":"filter_text","required":false,"in":"query","description":"Filter Text. Required if filter_type is provided.
\n ","schema":{"example":"PIX","type":"string"}},{"name":"page_state","required":false,"in":"query","description":"Previous page state.","schema":{"type":"string"}},{"name":"transaction_created_at_start","required":false,"in":"query","description":"Transaction created at start. If not provided, defaults to the beginning of the current day (00:00:00).","schema":{"format":"date-time","type":"string"}},{"name":"transaction_created_at_end","required":false,"in":"query","description":"Transaction created at end. If not provided, defaults to the end of the current day (23:59:59).","schema":{"format":"date-time","type":"string"}},{"name":"page_size","required":false,"in":"query","description":"Page size.","schema":{"example":10,"type":"number"}}],"responses":{"200":{"description":"The operation statement data returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GetAllReportOperationStatementProductRestResponse"}}}},"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 By Product","tags":["Reports"]}},"/v1/reports/pix-statement-product":{"get":{"description":"Tag: api-baas-get-all-report-pix-statement-product
\n Description: Retrieve a list of PIX statement data filtered by product. 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.\n When using filters, both filter_type and filter_text must be provided together.","operationId":"GetAllReportPixStatementProductRestController_execute_v1","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":true,"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"]}},{"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":"Created at end.","schema":{"format":"date","type":"string"}}],"responses":{"200":{"description":"The PIX statement data returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllReportPixStatementProductRestResponse"}}}},"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 By Product","tags":["Reports"]}},"/v1/reports/pix-statement-product/exports":{"post":{"description":"Description: Initiate a request to retrieve a pix statement product file for the specified date range. Use the returned file_id with the 'storage/files/:id/url' endpoint to get url for download the pix statement in CSV format.","operationId":"V1GenerateReportPixStatementProductExportRestController_execute_v1","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":true,"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/V1GenerateReportPixStatementProductExportBody"}}}},"responses":{"201":{"description":"Pix statement product export generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GenerateReportPixStatementProductExportRestResponse"}}}},"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 Product Export File","tags":["Reports"]}},"/v1/reports/quote-statement/exports":{"post":{"description":"Export crossborder quotes within a date range. The export will be generated asynchronously and can be retrieved later using the file ID.","operationId":"V1QuoteExportRestController_execute_v1","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/QuoteExportBody"}}}},"responses":{"201":{"description":"Quote export created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteExportRestResponse"}}}},"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 Quote Statement Export File","tags":["Reports"]}},"/v1/reports/transaction-summary-product":{"get":{"description":"Tag: api-baas-get-all-report-transaction-summary-product
\n Description: Returns paginated transaction summary rows for the authenticated user. Optional filters: wallet account, currency, transaction type, movement date range.","operationId":"V1GetAllReportTransactionSummaryProductRestController_execute_v1","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":true,"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":"currency_symbol","required":false,"in":"query","description":"Currency symbol (e.g. BRL).","schema":{"type":"string"}},{"name":"transaction_type_tag","required":false,"in":"query","description":"Transaction type tag.","schema":{"type":"string"}},{"name":"movement_date_start","required":false,"in":"query","description":"Movement date start (YYYY-MM-DD).","schema":{"format":"date-time","type":"string"}},{"name":"movement_date_end","required":false,"in":"query","description":"Movement date end (YYYY-MM-DD).","schema":{"format":"date-time","type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number.","schema":{"default":1,"type":"number"}},{"name":"page_size","required":false,"in":"query","description":"Page size.","schema":{"default":20,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Page sort attribute.","schema":{"default":"movement_date","type":"string","enum":["movement_date"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Transaction summary returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllReportTransactionSummaryProductRestResponse"}}}},"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 transaction summary by product","tags":["Reports"]}},"/v1/reports/transaction-summary-product/exports":{"post":{"description":"Tag: api-baas-post-report-transaction-summary-product-export
\n Description: Initiates CSV export for the same filters as GET reports/transaction-summary-product. Use the returned file_id with storage/files/:id/url to download.","operationId":"V1GenerateReportTransactionSummaryProductExportRestController_execute_v1","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":true,"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/V1GenerateReportTransactionSummaryProductExportBody"}}}},"responses":{"201":{"description":"Transaction summary product export generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GenerateReportTransactionSummaryProductExportRestResponse"}}}},"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 Transaction Summary Product export file","tags":["Reports"]}},"/v3/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":"V3GenerateReportOperationStatementExportRestController_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"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GenerateReportOperationStatementExportBody"}}}},"responses":{"201":{"description":"Operation statement generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GenerateReportOperationStatementExportRestResponse"}}}},"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"]}},"/v1/storage/files":{"get":{"description":"Retrieve a list of files.","operationId":"V1GetAllFilesRestController_execute_v1","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":{"type":"string"}}],"responses":{"200":{"description":"File URL 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"]}},"/v1/storage/upload":{"post":{"description":"Tag: api-baas-post-storage-upload
\n Description: Retrieve a file URL to upload. When your upload finish, \n send the confirmation and you can download your file.","operationId":"UploadBySignedUrlFileV1RestController_execute_v1","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/UploadBySignedUrlFileV1Body"}}}},"responses":{"200":{"description":"File URL returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadBySignedUrlFileV1RestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload file by url.","tags":["Storage"]}},"/v1/storage/upload/{id}/confirm":{"post":{"description":"Tag: api-baas-post-storage-upload-confirm
\n Description: This request will be confirm the previous upload by signed url. \n You can send this request when you finish the upload.","operationId":"ConfirmUploadBySignedUrlFileV1RestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Confirm finish upload file.","tags":["Storage"]}},"/v1/users/accounts/{id}":{"delete":{"description":"Delete an user account. User account must have no operations\n registered. If not, it will be performed a soft delete.\n ","operationId":"V1DeleteUserAccountRestController_execute_v1","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":true,"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 account ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"User account deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DeleteUserAccountRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete User Account by ID","tags":["Users | User Account"]}},"/v2/users/accounts":{"get":{"description":"Get all user accounts related to the user.","operationId":"V2GetAllUserAccountRestController_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":true,"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":"name","type":"string","enum":["id","document","name","fullName","active","state","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 user account document.","schema":{"example":"71009845055","type":"string"}}],"responses":{"200":{"description":"User accounts returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetAllUserAccountRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get User Account","tags":["Users | User Account"]},"post":{"description":"Create an user account. User account is a base for all other \n entities. It must be created as first entity.\n ","operationId":"V2CreateUserAccountRestController_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":"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":true,"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 user account payload.","content":{"application/json":{"schema":{"oneOf":[{"title":"Natural Person","allOf":[{"$ref":"#/components/schemas/V2CreateUserAccountNaturalBodyDoc"}]},{"title":"Legal Person","allOf":[{"$ref":"#/components/schemas/V2CreateUserAccountLegalBodyDoc"}]}],"discriminator":{"propertyName":"person_type","mapping":{"NATURAL_PERSON":"#/components/schemas/V2CreateUserAccountNaturalBodyDoc","LEGAL_PERSON":"#/components/schemas/V2CreateUserAccountLegalBodyDoc"}}},"examples":{"natural_person":{"summary":"Natural person","value":{"name":"John","full_name":"John Doe","genre":"male","mother_name":"Jane Doe","birth_date":"1984-11-03","document":"02465676008","phone_number":"5511955551234","email":"new-user@zrobank.com.br","active":true,"person_type":"NATURAL_PERSON"}},"legal_person":{"summary":"Legal person","value":{"name":"ACME","full_name":"ACME LTDA","issue_date":"2000-01-01","document":"12345678000199","phone_number":"5511977777777","email":"contato@acme.com.br","active":true,"person_type":"LEGAL_PERSON","legal_person_type":"LTDA"}}}}}},"responses":{"201":{"description":"User account created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CreateUserAccountRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"409":{"description":"If the provided user id is already in use, if a user account with the same document is already registered for this product, or if the email or phone number is already in use."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create User Account","tags":["Users | User Account"]}},"/v2/users/accounts/{id}":{"get":{"description":"Get an user account by id.","operationId":"V2GetByIdUserAccountRestController_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":true,"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 account ID.","schema":{"example":"634e5619-9f5d-4bab-bf92-48934a016b5c","type":"string"}}],"responses":{"200":{"description":"User account returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetByIdUserAccountRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get User Account by ID","tags":["Users | User Account"]},"put":{"description":"Update an user account.","operationId":"V2UpdateUserAccountRestController_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":true,"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 account ID.","schema":{"example":"634e5619-9f5d-4bab-bf92-48934a016b5c","type":"string"}}],"requestBody":{"required":true,"description":"Update user account payload.","content":{"application/json":{"schema":{"oneOf":[{"title":"Natural Person","allOf":[{"$ref":"#/components/schemas/V2UpdateUserAccountNaturalBodyDoc"}]},{"title":"Legal Person","allOf":[{"$ref":"#/components/schemas/V2UpdateUserAccountLegalBodyDoc"}]}],"discriminator":{"propertyName":"person_type","mapping":{"NATURAL_PERSON":"#/components/schemas/V2UpdateUserAccountNaturalBodyDoc","LEGAL_PERSON":"#/components/schemas/V2UpdateUserAccountLegalBodyDoc"}}},"examples":{"natural_person":{"summary":"Natural person","value":{"name":"John","full_name":"John Doe","genre":"male","mother_name":"Jane Doe","birth_date":"1984-11-03","phone_number":"5511955551234","email":"new-email@zrobank.com.br","person_type":"NATURAL_PERSON","active":true}},"legal_person":{"summary":"Legal person","value":{"name":"ACME","full_name":"ACME LTDA","issue_date":"2000-01-01","phone_number":"5511977777777","email":"contato-novo@acme.com.br","person_type":"LEGAL_PERSON","legal_person_type":"LTDA","active":true}}}}}},"responses":{"200":{"description":"User account updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2UpdateUserAccountRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"409":{"description":"If a user account with the provided document or email or phone number already exists."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update User Account by ID","tags":["Users | User Account"]}},"/v1/users/banking/accounts":{"get":{"description":"Retrieve a user bank account.","operationId":"V1GetUserBankAccountByWalletRestController_execute_v1","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"]}},"/v1/users/onboardings/legal-person":{"get":{"description":"Get all legal person onboardings for the authenticated user.","operationId":"V1GetAllLegalPersonOnboardingRestController_execute_v1","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","updated_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":"Onboarding status.","schema":{"type":"string","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]}}],"responses":{"200":{"description":"The legal person onboardings returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllLegalPersonOnboardingRestResponse"}}}},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Legal Person Onboardings","tags":["Users | Legal Person"]}},"/v1/users/onboardings":{"get":{"description":"Get all onboarding related to the logged or target user.","operationId":"V1GetAllOnboardingRestController_execute_v1","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","updated_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":"Onboarding status.","schema":{"type":"string","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]}}],"responses":{"200":{"description":"The onboardings returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllOnboardingRestResponse"}}}},"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 Onboardings","tags":["Users | Natural Person Onboarding"]}},"/v2/users/onboardings":{"post":{"description":"Create an onboarding for user account. It must be created after user account entity.\n\nThis version requires the `accepted_terms` field set to `true` to register that the user accepted the terms of service.","operationId":"V2CreateOnboardingRestController_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":"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/V2CreateOnboardingBody"}}}},"responses":{"201":{"description":"Onboarding created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CreateOnboardingRestResponse"}}}},"400":{"description":"If any required params are missing or have invalid format or type, including `accepted_terms` not set to `true`."},"401":{"description":"User authentication failed."},"422":{"description":"If an active onboarding already exists for this user."}},"security":[{"bearer":[]}],"summary":"Create Onboarding (v2)","tags":["Users | Natural Person Onboarding"]}},"/v1/users/onboardings/{id}":{"put":{"description":"Update an onboarding data. \n It is only possible to update it when the onboarding status is pending.\n Otherwise, It is required to create another one.","operationId":"V1UpdateOnboardingRestController_execute_v1","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":"Onboarding ID.","schema":{"example":"6e32a190-e8c8-4cc9-98ef-b1ece7328bfb","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateOnboardingBody"}}}},"responses":{"200":{"description":"Onboarding updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateOnboardingRestResponse"}}}},"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 Onboarding by ID","tags":["Users | Natural Person Onboarding"]},"get":{"description":"Get onboarding by id related to the logged or target user.","operationId":"V1GetOnboardingByIdRestController_execute_v1","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":"Onboarding ID.","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","description":"Optional onboarding status filter.","schema":{"type":"string","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]}}],"responses":{"200":{"description":"The onboarding returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetOnboardingByIdRestResponse"}}}},"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 Onboarding by ID","tags":["Users | Natural Person Onboarding"]}},"/v1/users/onboardings/with-steps":{"get":{"description":"Get all onboardings for the authenticated user with their verification steps.","operationId":"V1GetAllOnboardingWithStepsRestController_execute_v1","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":{"example":"created_at","type":"string","enum":["created_at","updated_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":"Onboarding status.","schema":{"type":"string","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]}},{"name":"created_at_start","required":false,"in":"query","description":"Filter by created at start.","schema":{"format":"date-time","example":"2026-01-01T00:00:00.000Z","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"Filter by created at end.","schema":{"format":"date-time","example":"2026-01-31T23:59:59.999Z","type":"string"}},{"name":"search","required":false,"in":"query","description":"Search by name, CPF or CNPJ.","schema":{"example":"John Doe","type":"string"}},{"name":"person_type","required":false,"in":"query","description":"Person type filter.","schema":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"]}}],"responses":{"200":{"description":"The onboardings with steps returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllOnboardingWithStepsRestResponse"}}}},"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 Onboardings with Steps","tags":["Users | Onboarding"]}},"/v2/users/onboardings/legal-person":{"post":{"description":"Creates a legal person onboarding record in `PENDING` status.\n\nThis version requires the `accepted_terms` field set to `true` to register that the user accepted the terms of service.\n\n**Related endpoints commonly used with this resource:**\n- `POST /users/onboardings/legal-person` (this endpoint)\n- `POST /users/shareholders`\n- `POST /users/legal-representatives` (linked by `shareholder_id`)\n- `POST /users/legal-representatives/{id}/documents` for all representatives\n- `POST /users/onboardings/legal-person/{id}/documents` for legal person documents\n- `POST /users/onboardings/legal-person/{id}/finalize`\n\n**Prerequisite:** the user has already been created via `/users/accounts`.","operationId":"V2CreateLegalPersonOnboardingRestController_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":"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/V2CreateLegalPersonOnboardingBody"}}}},"responses":{"201":{"description":"Legal person onboarding created successfully. Status is `PENDING`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2CreateLegalPersonOnboardingRestResponse"}}}},"400":{"description":"If any required params are missing or have invalid format or type, including `accepted_terms` not set to `true`."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If an active onboarding already exists for this user."}},"security":[{"bearer":[]}],"summary":"Create Legal Person Onboarding (v2)","tags":["Users | Legal Person"]}},"/v1/users/onboardings/legal-person/{id}/finalize":{"post":{"description":"Triggers validation and finalization of legal person onboarding.\n\n- [ ] Legal person onboarding exists and is in `PENDING` status\n- [ ] Shareholders created for the legal person flow via `POST /users/shareholders`\n- [ ] Legal person documents uploaded: `social_contract` + (`balance_sheet` OR `revenue_statement`)\n- [ ] At least one active legal representative is registered\n- [ ] Each legal representative is linked to a shareholder (via `shareholder_id`)\n- [ ] Legal representative documents uploaded for all active representatives: `selfie`, `identity_document` family, `qualification_declaration`\n\n- Successful synchronous response is `IN_PROCESS`\n- Terminal onboarding result is asynchronous\n- On `422`, handle the returned business code. Common cases: `ONBOARDING_INVALID_STATUS`, `SHAREHOLDERS_REQUIRED`, `ONBOARDING_DOCUMENTS_MISSING`, `LEGAL_REPRESENTATIVE_DOCUMENTS_MISSING`, `SHAREHOLDER_MISSING_LEGAL_REPRESENTATIVES`","operationId":"V1FinalizeLegalPersonOnboardingRestController_execute_v1","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":"Legal person onboarding ID to finalize.","schema":{"example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","type":"string"}}],"responses":{"200":{"description":"Legal person onboarding submitted for review. Status is IN_PROCESS after successful validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1FinalizeLegalPersonOnboardingRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If validation fails or onboarding is in invalid status. The response includes the business code to handle."}},"security":[{"bearer":[]}],"summary":"Finalize Legal Person Onboarding","tags":["Users | Legal Person"]}},"/v1/users/onboardings/legal-person/{id}":{"get":{"description":"Get legal person onboarding by ID for the authenticated user.","operationId":"V1GetLegalPersonOnboardingByIdRestController_execute_v1","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":"Legal person onboarding ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"status","required":false,"in":"query","description":"Optional onboarding status filter.","schema":{"type":"string","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]}}],"responses":{"200":{"description":"The legal person onboarding returned successfully.","content":{"application/json":{"schema":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/V1GetLegalPersonOnboardingByIdRestResponse"}]}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Legal Person Onboarding by ID","tags":["Users | Legal Person"]},"put":{"description":"Updates onboarding data for a legal person. You can update headquarters or branch address and legal person revenue.","operationId":"V1UpdateLegalPersonOnboardingRestController_execute_v1","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":"Legal person onboarding ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateLegalPersonOnboardingBody"}}}},"responses":{"200":{"description":"Legal person onboarding updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateLegalPersonOnboardingRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update Legal Person Onboarding","tags":["Users | Legal Person"]}},"/v1/users/onboardings/{id}/documents":{"post":{"description":"Upload the onboarding document file (max size: 20 MB). There are two ways to complete onboarding: 1) Provide selfie, document_front, document_back and document_file_type, or 2) Provide only selfie and document_id. The process is finished once all required documents are submitted based on the chosen method.","operationId":"V1UploadOnboardingDocumentFileRestController_execute_v1","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":"Onboarding ID.","schema":{"example":"6e32a190-e8c8-4cc9-98ef-b1ece7328bfb","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"document_file_type":{"type":"string","description":"Document type specified for document_front and document_back. Required when not using document_id.\n Possible values: rg, cnh.","enum":["rg","cnh"]},"document_id":{"type":"string","description":"Document ID for digital identity validation. When provided, only selfie is required and document_front/document_back are not needed."},"document_front":{"type":"string","format":"binary","description":"Front side of the document. Required when document_id is not provided."},"document_back":{"type":"string","format":"binary","description":"Back side of the document. Required when document_id is not provided."},"selfie":{"type":"string","format":"binary","description":"User selfie. Always required."},"address_proof":{"type":"string","format":"binary","description":"Proof of address document. Optional."}}}}}},"responses":{"200":{"description":"The file upload returned 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":"Upload Onboarding Document File by ID","tags":["Users | Natural Person Onboarding"]},"get":{"description":"Get all onboarding documents related to the logged or target user.","operationId":"V1GetAllOnboardingDocumentRestController_execute_v1","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":"Onboarding ID.","schema":{"example":"6e32a190-e8c8-4cc9-98ef-b1ece7328bfb","type":"string"}}],"responses":{"200":{"description":"The onboarding documents returned successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1GetAllOnboardingDocumentRestResponse"}}}}},"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 Onboarding Documents","tags":["Users | Natural Person Onboarding"]}},"/v1/users/onboardings/legal-person/{id}/documents":{"post":{"description":"Uploads one legal person document per request for legal person onboarding (max size: 10 MB).\n\nThis endpoint only stores the selected legal person document; finalize enforces the full onboarding rules.\n\n**Accepted document types for this endpoint (API values):**\n- `social_contract`\n- `balance_sheet`\n- `revenue_statement`\n- `kyc_aml_policy`\n\n**Required for `finalize`:**\n- `social_contract`\n- At least one of `balance_sheet` or `revenue_statement`\n\n`kyc_aml_policy` is accepted here, but it is not required for `finalize`.\n\n**Related endpoint:** `POST /users/onboardings/legal-person/{id}/finalize`.","operationId":"V1UploadLegalPersonOnboardingDocumentRestController_execute_v1","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":"Legal person onboarding ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["type","file"],"properties":{"type":{"type":"string","enum":["social_contract","balance_sheet","revenue_statement","kyc_aml_policy"],"description":"Document type (API values).","example":"social_contract"},"file":{"type":"string","format":"binary","description":"Allowed file formats: image/jpg, image/jpeg, application/pdf."}}}}}},"responses":{"201":{"description":"The onboarding document uploaded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UploadLegalPersonOnboardingDocumentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload Legal Person Onboarding Document","tags":["Users | Legal Person"]},"get":{"description":"Retrieve all documents (doc_id, file_id, type, created_at, updated_at) for a specific legal person onboarding.","operationId":"V1GetAllLegalPersonOnboardingDocumentRestController_execute_v1","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":"Legal person onboarding ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Documents retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllLegalPersonOnboardingDocumentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get all Legal person onboarding documents by legal person onboarding ID.","tags":["Users | Legal Person"]}},"/v1/users/onboardings/legal-person/{id}/documents/{doc_id}":{"get":{"description":"Retrieve a specific document (doc_id, file_id, type, created_at, updated_at) by document ID for a specific legal person onboarding.","operationId":"V1GetByIdLegalPersonOnboardingDocumentRestController_execute_v1","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":"Legal person onboarding ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"doc_id","required":true,"in":"path","description":"Document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Document retrieved successfully.","content":{"application/json":{"schema":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/V1GetByIdLegalPersonOnboardingDocumentRestResponse"}]}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Legal person onboarding document by legal person onboarding ID.","tags":["Users | Legal Person"]},"patch":{"description":"Update an existing legal person document for a legal person onboarding.","operationId":"V1UpdateLegalPersonOnboardingDocumentRestController_execute_v1","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":"id","required":true,"in":"path","description":"Legal person onboarding ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"doc_id","required":true,"in":"path","description":"Legal person onboarding document ID to be updated.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["type","file"],"properties":{"type":{"type":"string","enum":["social_contract","balance_sheet","revenue_statement","kyc_aml_policy"],"description":"Document type (API values).","example":"social_contract"},"file":{"type":"string","format":"binary","description":"Allowed file formats: application/pdf, image/jpeg, image/jpg."}}}}}},"responses":{"200":{"description":"The legal person onboarding document updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateLegalPersonOnboardingDocumentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update Legal person onboarding document.","tags":["Users | Legal Person"]}},"/v1/users/onboardings/{id}/documents/{doc_id}":{"put":{"description":"Update an onboarding document file by providing its ID. If you haven't uploaded a file yet, use the appropriate endpoint to do so.","operationId":"V1UpdateOnboardingDocumentRestController_execute_v1","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":"doc_id","required":true,"in":"path","description":"onboarding document file ID to be updated.","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Onboarding ID.","schema":{"example":"6e32a190-e8c8-4cc9-98ef-b1ece7328bfb","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"document_file_type":{"type":"string","description":"Document type specified for document_front and document_back. Required when send this files.\n Possible values: rg, cnh.","enum":["rg","cnh"]},"type":{"type":"string","description":"Document type related to previous uploaded document.\n Possible values: selfie, document_front, document_back, address_proof.","enum":["selfie","document_front","document_back","address_proof"]},"document":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"The onboarding document file updated 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":"Update Onboarding Document File by ID","tags":["Users | Natural Person Onboarding"]}},"/v2/users/legal-representatives":{"get":{"description":"Get all legal representatives linked to the authenticated legal person and its shareholders.","operationId":"V2GetAllLegalRepresentativeRestController_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":["created_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Legal representatives returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2GetAllLegalRepresentativeRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get all legal representatives","tags":["Users | Legal Representative"]}},"/v3/users/legal-representatives":{"post":{"description":"Create a legal representative (partner, administrator, attorney, etc.) linked to a shareholder. Legal representatives are always natural persons that represent shareholders in the QSA structure.\n\n**Important:**\n- Legal representatives are always natural persons\n- Must be linked to an existing shareholder via `shareholder_id`\n- Both `email` and `phone_number` are required\n- `mother_name` is required\n\n**Constraints:**\n- `shareholder_id` must reference an existing shareholder from the authenticated legal person flow\n\n**Required documents (upload after creation):**\n- `selfie` - Representative selfie photo\n- `identity_document` - ID, CNH or Passport\n- `qualification_declaration` - Declaration of powers\n\n**Related endpoint:** `POST /users/legal-representatives/{id}/documents`.","operationId":"V3CreateLegalRepresentativeRestController_execute_v3","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/V3CreateLegalRepresentativeRestBody"}}}},"responses":{"201":{"description":"Legal representative created successfully. Proceed to upload required documents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3CreateLegalRepresentativeRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"409":{"description":"Reserved for conflicting request identifiers. Repeated create requests may return the existing legal representative idempotently."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Legal Representative","tags":["Users | Legal Representative"]}},"/v1/users/legal-representatives/{id}":{"get":{"description":"Get a legal representative by its unique identifier.","operationId":"V1GetByIdLegalRepresentativeRestController_execute_v1","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":"Legal representative ID.","schema":{"example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56","type":"string"}}],"responses":{"200":{"description":"Legal representative returned successfully.","content":{"application/json":{"schema":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/V1GetByIdLegalRepresentativeRestResponse"}]}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get legal representative by ID","tags":["Users | Legal Representative"]},"delete":{"description":"Delete a legal representative by ID.","operationId":"V1DeleteLegalRepresentativeRestController_execute_v1","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":"Legal representative ID.","schema":{"example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56","type":"string"}}],"responses":{"200":{"description":"Legal representative deleted."},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete legal representative","tags":["Users | Legal Representative"]}},"/v2/users/legal-representatives/{id}":{"put":{"description":"Update a legal representative information. You can optionally link or relink the representative to a shareholder.\n\n**Shareholder linking options:**\n- **Link to a shareholder**: Provide `shareholder_id` with a valid UUID\n- **Relink to a different shareholder**: Provide a different `shareholder_id`\n\n**Important notes:**\n- The `shareholder_id` must belong to the same authenticated legal person (same user)\n- Omitting `shareholder_id` keeps the current link unchanged\n- All other fields are optional and will only update if provided\n- For natural person legal representatives, both `email` and `phone_number` must remain informed after update\n- If you only want to update the shareholder link, you can send a minimal request with just `shareholder_id`","operationId":"V2UpdateLegalRepresentativeRestController_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":"Legal representative ID.","schema":{"example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2UpdateLegalRepresentativeRestBody"}}}},"responses":{"200":{"description":"Legal representative updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2UpdateLegalRepresentativeRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update legal representative","tags":["Users | Legal Representative"]}},"/v1/users/legal-representatives/{id}/documents":{"get":{"description":"Get all documents for a specific legal representative linked to the authenticated legal person.","operationId":"V1GetAllLegalRepresentativeDocumentRestController_execute_v1","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":"Legal representative ID.","schema":{"example":"6e32a190-e8c8-4cc9-98ef-b1ece7328bfb","type":"string"}}],"responses":{"200":{"description":"The legal representative documents returned successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1GetAllLegalRepresentativeDocumentRestResponse"}}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Legal Representative Documents","tags":["Users | Legal Representative"]}},"/v1/users/legal-representatives/{id}/documents/{doc_id}":{"get":{"description":"Get a specific document for a legal representative linked to the authenticated legal person.","operationId":"V1GetByIdLegalRepresentativeDocumentRestController_execute_v1","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":"Legal representative ID.","schema":{"example":"6e32a190-e8c8-4cc9-98ef-b1ece7328bfb","type":"string"}},{"name":"doc_id","required":true,"in":"path","description":"Document ID.","schema":{"example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","type":"string"}}],"responses":{"200":{"description":"The legal representative document returned successfully.","content":{"application/json":{"schema":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/V1GetByIdLegalRepresentativeDocumentRestResponse"}]}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Legal Representative Document by ID","tags":["Users | Legal Representative"]},"put":{"description":"Update a legal representative document file.","operationId":"V1UpdateLegalRepresentativeDocumentRestController_execute_v1","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":"doc_id","required":true,"in":"path","description":"Legal representative document ID to be updated.","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Legal representative ID.","schema":{"example":"6e32a190-e8c8-4cc9-98ef-b1ece7328bfb","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"document":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"The legal representative document updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateLegalRepresentativeDocumentRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update Legal Representative Document","tags":["Users | Legal Representative"]}},"/v2/users/legal-representatives/{id}/documents":{"post":{"description":"Uploads one legal representative document per request (max size: 20 MB).\n\n**Integration model:** use `document_type` + optional `document_side` as metadata and send a single binary `file`.\n\n**Identity documents:**\n- `document_type = identity_document`\n- `identity_document_type` is required (`national_id`, `driver_license`, `passport`)\n- if `identity_document_type` is `national_id` or `driver_license`, `document_side` is required (`front` or `back`)\n- if `identity_document_type` is `passport`, `document_side` must not be sent (internally mapped to FRONT)\n\n**Finalization rules:** each active legal representative must have `selfie`, `qualification_declaration`, and the identity document family.\n- For `passport`, upload a single `identity_document` without `document_side`\n- For `national_id` or `driver_license`, upload both `front` and `back`\n- `income_declaration` and `address_proof` remain optional\n\n**Other document types:** `selfie`, `qualification_declaration`, `income_declaration`, `address_proof` (without `document_side`/`identity_document_type`).","operationId":"V2UploadLegalRepresentativeDocumentFileRestController_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":"Legal representative ID.","schema":{"example":"6e32a190-e8c8-4cc9-98ef-b1ece7328bfb","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["document_type","file"],"properties":{"document_type":{"type":"string","enum":["selfie","identity_document","qualification_declaration","income_declaration","address_proof"],"example":"identity_document","description":"Document type to upload. When using identity_document, send identity_document_type and follow the document_side rules described below."},"identity_document_type":{"type":"string","enum":["national_id","driver_license","passport"],"example":"national_id","description":"Required only when document_type is identity_document. Use passport without document_side. Use national_id or driver_license with document_side."},"document_side":{"type":"string","enum":["front","back"],"example":"front","description":"Required when document_type is identity_document and identity_document_type is national_id or driver_license. Do not send for passport or non-identity documents."},"file":{"type":"string","format":"binary","description":"Document file. Formats: application/pdf, image/jpeg, image/jpg."}}}}}},"responses":{"201":{"description":"The file upload returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2UploadLegalRepresentativeDocumentFileRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload Legal Representative Document (v2)","tags":["Users | Legal Representative"]}},"/v1/users/company-registrations/{company_registration_id}/company-documents":{"post":{"description":"Submit a company document for registration using multipart/form-data to submit a document file. Representative-scoped categories require legal_representative_id. Use the Get Pending Documents endpoint to check which documents are required.","operationId":"V1UploadCompanyDocumentRestController_execute_v1","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":"company_registration_id","required":true,"in":"path","description":"Company registration ID.","schema":{"example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","type":"string"}}],"requestBody":{"required":true,"description":"Submit document using multipart/form-data.","content":{"multipart/form-data":{"schema":{"type":"object","required":["category","file"],"properties":{"category":{"type":"string","description":"Document category.","enum":["CCMEI","PRIVATE_LETTER_OF_ATTORNEY","ARTICLES_OF_ASSOCIATION","COMPANY_BYLAWS","PUBLIC_LETTER_OF_ATTORNEY","LEGAL_STATEMENT","EIRELI_INCORPORATION_STATEMENT","EI_REGISTRATION_REQUIREMENT","DRIVER_LICENSE_FRONT","DRIVER_LICENSE_VERSE","DIGITAL_DRIVER_LICENSE","IDENTITY_CARD_FRONT","IDENTITY_CARD_VERSE","WORK_CARD","PROFESSIONAL_IDENTIFICATION_CARD","MILITARY_IDENTIFICATION_CARD","REVENUES_RECEIPT","SIGNATURE_CARD","SELFIE","EXTRAORDINARY_DOCUMENTS","RNE_VERSE","RNE_FRONT"],"example":"ARTICLES_OF_ASSOCIATION"},"legal_representative_id":{"type":"string","format":"uuid","description":"Legal representative ID required for representative-scoped document categories.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","nullable":true},"file":{"type":"string","format":"binary","description":"Document file. Formats: application/pdf, image/jpeg, image/jpg. Max size is configured by APP_COMPANY_DOCUMENT_MAX_FILE_SIZE_BYTES (default: 4.5MB)."}}}}}},"responses":{"201":{"description":"Document submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UploadCompanyDocumentRestResponse"}}}},"400":{"description":"Invalid parameters."},"401":{"description":"User authentication failed."},"403":{"description":"User does not have permission to access this resource."},"422":{"description":"Business rule validation failed, including missing or invalid company registration."}},"security":[{"bearer":[]}],"summary":"Upload Company Document","tags":["Users | Company Document"]}},"/v1/users/onboardings/occupations":{"get":{"description":"**Tag**: api-baas-get-all-onboarding-occupation\n\n**Description**: Retrieve a list of all occupations filtered by name. This endpoint is used during onboarding when the user needs to select their occupation.","operationId":"V1GetAllOccupationRestController_execute_v1","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":["name","cod_cbo"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"name","required":true,"in":"query","description":"Occupation name to search.","schema":{"example":"Contador","type":"string"}}],"responses":{"200":{"description":"The occupations returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllOccupationRestResponse"}}}},"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 Occupations","tags":["Users | Natural Person Onboarding | Occupation"]}},"/v1/users/shareholders":{"post":{"description":"Creates a shareholder in the authenticated legal person equity structure.\n\n- User must be in the legal person onboarding flow\n- The legal person onboarding should already exist\n- Replay with the same `document` is idempotent and returns the existing shareholder\n- Replay does not merge or update the other fields from the new payload\n\n**Related endpoint:** legal representatives can be linked to shareholders at `POST /users/legal-representatives`.","operationId":"V1CreateShareholderRestController_execute_v1","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/V1CreateShareholderRestBody"}}}},"responses":{"201":{"description":"Shareholder created successfully. Proceed to create legal representatives linked to this shareholder.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateShareholderRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"409":{"description":"Reserved for conflicting request identifiers."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Shareholder","tags":["Users | Shareholder"]},"get":{"description":"**Tag**: api-baas-get-all-shareholder\n\n**Description**: Retrieve a list of shareholders linked to the authenticated legal person flow.","operationId":"V1GetAllShareholderRestController_execute_v1","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 shareholders returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllShareholderRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Shareholders","tags":["Users | Shareholder"]}},"/v1/users/shareholders/{id}":{"get":{"description":"**Tag**: api-baas-get-by-id-shareholder\n\n**Description**: Retrieve a shareholder by its unique identifier.","operationId":"V1GetByIdShareholderRestController_execute_v1","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":"Shareholder ID.","schema":{"example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56","type":"string"}}],"responses":{"200":{"description":"The shareholder returned successfully.","content":{"application/json":{"schema":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/V1GetByIdShareholderRestResponse"}]}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Shareholder by ID","tags":["Users | Shareholder"]},"put":{"description":"**Tag**: api-baas-update-shareholder\n\n**Description**: Update shareholder information. Only provided fields will be updated.","operationId":"V1UpdateShareholderRestController_execute_v1","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":"Shareholder ID.","schema":{"example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateShareholderRestBody"}}}},"responses":{"200":{"description":"The shareholder updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateShareholderRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the authenticated user does not have permission."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Update Shareholder","tags":["Users | Shareholder"]}},"/v1/users/company-registrations":{"post":{"description":"Creates a company registration in the Companies API. Requires a finished legal person onboarding.","operationId":"V1CreateCompanyRegistrationRestController_execute_v1","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/V1CreateCompanyRegistrationBody"}}}},"responses":{"201":{"description":"Company registration created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateCompanyRegistrationRestResponse"}}}},"400":{"description":"If any required parameter is missing or has invalid format/type."},"401":{"description":"User authentication failed."},"403":{"description":"User does not have permission to access this resource."},"422":{"description":"If any required parameter is missing or has invalid format/type."}},"security":[{"bearer":[]}],"summary":"Create Company Registration","tags":["Users | Company Registration"]},"get":{"description":"**Tag**: api-baas-get-all-company-registration\n\n**Description**: Retrieve a list of company registrations with optional filters.","operationId":"V1GetAllCompanyRegistrationRestController_execute_v1","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":{"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":"Company registration status.","schema":{"example":"ACTIVE","type":"string","enum":["WAITING_DOCUMENTS","WAITING_ANALYSIS","WAITING_CORRECTIONS","ACTIVE","DECLINED","CANCELED"]}},{"name":"cnpj","required":false,"in":"query","description":"Company CNPJ.","schema":{"example":"93999833000199","type":"string"}}],"responses":{"200":{"description":"Company registrations returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllCompanyRegistrationRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"User does not have permission to access this resource."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Company Registrations.","tags":["Users | Company Registration"]}},"/v1/users/company-registrations/{id}/pending-documents":{"get":{"description":"Returns the authoritative list of pending and already uploaded company-registration documents after provider registration exists, grouped by legal person and legal representatives.","operationId":"V1GetPendingDocumentsCompanyRegistrationRestController_execute_v1","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":"Company registration ID.","schema":{"example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","type":"string"}}],"responses":{"200":{"description":"Company registration pending and uploaded documents retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetPendingDocumentsCompanyRegistrationRestResponse"}}}},"400":{"description":"If any required parameter is missing or has invalid format/type."},"401":{"description":"User authentication failed."},"403":{"description":"User does not have permission to access this resource."},"422":{"description":"If any required parameter is missing or has invalid format/type."}},"security":[{"bearer":[]}],"summary":"Get Company Registration Pending Documents","tags":["Users | Company Registration"]}},"/v1/users/company-registrations/{id}":{"get":{"description":"**Tag**: api-baas-get-company-registration-by-id\n\n**Description**: Retrieves company registration details by ID. Returns company registration data stored in the system.","operationId":"V1GetCompanyRegistrationByIdRestController_execute_v1","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":"Company registration ID.","schema":{"example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","type":"string"}}],"responses":{"200":{"description":"Company registration retrieved successfully.","content":{"application/json":{"schema":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/V1GetCompanyRegistrationByIdRestResponse"}]}}}},"400":{"description":"If any required parameter is missing or has invalid format/type."},"401":{"description":"User authentication failed."},"403":{"description":"User does not have permission to access this resource."},"422":{"description":"If any required parameter is missing or has invalid format/type."}},"security":[{"bearer":[]}],"summary":"Get Company Registration by ID.","tags":["Users | Company Registration"]}},"/v1/cards/virtual":{"post":{"description":"Tag: api-baas-post-virtual-card
\n Description: Create a new virtual card.","operationId":"V1CreateVirtualCardRestController_execute_v1","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/V1CreateVirtualCardRestResponse"}}}},"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"]}},"/v1/cards":{"get":{"description":"Tag: api-baas-get-all-cards
\n Description: List all cards.","operationId":"V1GetAllCardsRestController_execute_v1","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"]}},"/v1/cards/{id}/unblock":{"post":{"description":"Tag: api-baas-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":"V1UnblockCardRestController_execute_v1","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/V1UnblockCardRestResponse"}}}},"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"]}},"/v1/cards/{id}/block":{"post":{"description":"Tag: api-baas-post-block-card
\n Description: Blocks a customer's card. The customer must provide the PIN.","operationId":"V1BlockCardRestController_execute_v1","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/V1BlockCardRestResponse"}}}},"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"]}},"/v1/cards/{id}/details":{"patch":{"description":"Tag: api-baas-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":"V1CardDetailsRestController_execute_v1","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/V1CardDetailsRestResponse"}}}},"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"]}},"/v1/cards/{id}":{"delete":{"description":"Tag: api-baas-delete-card
\n Description: Cancels a customer's card. The customer must provide the PIN.","operationId":"V1CancelCardRestController_execute_v1","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/V1CancelCardRestResponse"}}}},"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"]}},"/v1/cards/physical":{"post":{"description":"Tag: api-baas-post-physical-card
\n Description: Create a new physical card.","operationId":"V1CreatePhysicalCardRestController_execute_v1","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/V1CreatePhysicalCardBody"}}}},"responses":{"201":{"description":"Physical card created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreatePhysicalCardRestResponse"}}}},"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"]}},"/v1/cards/{id}/activate":{"post":{"description":"Tag: api-baas-post-activate-card
\n Description: Activates a customer's card. The customer must provide the PIN.","operationId":"V1ActivateCardRestController_execute_v1","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/V1ActivateCardBody"}}}},"responses":{"200":{"description":"Card activated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ActivateCardRestResponse"}}}},"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"]}},"/v1/cards/{id}/physical/new-via":{"post":{"description":"Tag: api-baas-post-new-physical-card-via
\n Description: Create a new version of a physical card.","operationId":"V1CreateNewPhysicalCardViaRestController_execute_v1","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/V1CreateNewPhysicalCardViaRestResponse"}}}},"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"]}},"/v1/cards/{id}/password":{"patch":{"description":"Tag: api-baas-patch-change-card-password
\n Description: Change card password.","operationId":"V1ChangeCardPasswordRestController_execute_v1","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/V1ChangeCardPasswordBody"}}}},"responses":{"200":{"description":"Card password changed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ChangeCardPasswordRestResponse"}}}},"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"]}},"/v1/cards/{id}/tracking":{"get":{"description":"Tag: api-baas-get-card-tracking
\n Description: Retrieve card tracking data.","operationId":"V1GetCardTrackingRestController_execute_v1","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/V1GetCardTrackingRestResponse"}}}},"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"]}},"/v1/card/onboarding/terms-of-use":{"get":{"description":"Tag: api-baas-get-terms-of-use
\n Description: Get terms of use for the customer. The customer must be finished onboarding.","operationId":"V1GetTermsOfUseRestController_execute_v1","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":"Get terms of use successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1GetTermsOfUseRestResponse"}}}}},"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-baas-post-accept-terms-of-use
\n Description: Accept terms of use for the customer. The customer must be finished onboarding.","operationId":"V1AcceptTermsOfUseRestController_execute_v1","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/V1AcceptTermsOfUseBody"}}}},"responses":{"200":{"description":"Accept terms of use successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1AcceptTermsOfUseRestResponse"}}}},"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"]}},"/v1/card/onboarding/{id}/documents":{"post":{"description":"Tag: api-baas-post-upload-document
\n Description: Upload card onboarding document.
","operationId":"V1UploadCardOnboardingDocumentRestController_execute_v1","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/V1UploadCardOnboardingDocumentRestResponse"}}}},"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"]}},"/v1/card/onboarding":{"post":{"description":"Tag: api-baas-post-card-onboarding
\n Description: Create card onboarding. The customer must have finished the onboarding.","operationId":"V1CreateCardOnboardingRestController_execute_v1","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/V1CreateCardOnboardingResponse"}}}},"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"]}},"/v1/card/onboarding/{id}":{"get":{"description":"Tag: api-baas-get-card-onboarding-by-id
\n Description: Get card onboarding by ID.
","operationId":"V1GetCardOnboardingByIdRestController_execute_v1","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/V1GetCardOnboardingByIdRestResponse"}}}},"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"]}},"/v1/pix/scheduled-payments":{"get":{"description":"Tag: api-baas-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_v1","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"]}}},{"name":"type","required":false,"in":"query","description":"Pix scheduled payment type","schema":{"example":"PIX_AUTOMATIC_PAYMENT","type":"string","enum":["PIX_RECURRING_PAYMENT","PIX_AUTOMATIC_PAYMENT","OTHER"]}}],"responses":{"200":{"description":"The 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."}},"security":[{"bearer":[]}],"summary":"List pix scheduled payments","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-authorizations":{"get":{"description":"Tag: api-baas-get-all-pix-automatic-authorizations
\n Description: Retrieve a list of the user's automatic pix authorizations. Use optional filter parameters to refine your search.","operationId":"GetAllPixAutomaticAuthorizationRestController_execute_v1","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"}}}},"400":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"List Automatic Pix Authorizations","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-authorizations/{id}":{"get":{"description":"Tag: api-baas-get-by-id-pix-automatic-authorization
\n Description: Retrieve the details of a pix automatic authorization by providing its ID.","operationId":"GetPixAutomaticAuthorizationByIdRestController_execute_v1","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/GetPixAutomaticAuthorizationByIdRestResponse"}}}},"400":{"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-baas-change-max-value-pix-automatic-authorization
\n Description: Updates the pending automatic pix authorization to be able to receive payment schedules.","operationId":"UpdatePixAutomaticAuthorizationRestController_execute_v1","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":"5dbbb951-e19d-44a6-93f9-4b14f0495dfb","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePixAutomaticAuthorizationBodyParam"}}}},"responses":{"200":{"description":"Authorization successfully rejected."},"400":{"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"]}},"/v1/pix/scheduled-payments/automatic-payments":{"get":{"description":"Tag: api-baas-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_v1","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."}},"security":[{"bearer":[]}],"summary":"List Automatic Pix Payments","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-payments/{id}":{"get":{"description":"Tag: api-baas-get-by-id-pix-automatic-payment
\n Description: Retrieve the details of a pix automatic payment by providing its ID.","operationId":"GetPixAutomaticPaymentByIdRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Get Automatic Pix Payment by ID","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-authorizations/approve-by-qrcode/{decoded_composite_qr_code_id}":{"post":{"description":"Tag: api-baas-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_v1","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."}},"security":[{"bearer":[]}],"summary":"Approve Automatic Pix Authorization","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-authorizations/{id}/approve":{"post":{"description":"Tag: api-baas-approve-pix-automatic-authorization
\n Description: Approves the pending automatic pix authorization to be able to receive payment schedules.","operationId":"ApprovePixAutomaticAuthorizationRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Approve Automatic Pix Authorization","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-authorizations/{id}/reject":{"post":{"description":"Tag: api-baas-reject-pix-automatic-authorization
\n Description: Rejects the pending automatic pix authorization.","operationId":"RejectPixAutomaticAuthorizationRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Reject an Automatic Pix Authorization","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-payments/by-pix-payment/{id}":{"get":{"description":"Tag: api-baas-get-by-id-pix-automatic-payment
\n Description: Retrieve the details of a pix automatic payment by providing its pix payment ID.","operationId":"GetPixAutomaticPaymentByPixPaymentIdRestController_execute_v1","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 payment ID.","schema":{"example":"d1952c4b-9348-41ab-99a3-05b11459aded","type":"string"}}],"responses":{"200":{"description":"Payment found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPixAutomaticPaymentByPixPaymentIdRestResponse"}}}},"400":{"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"]}},"/v1/pix/scheduled-payments/automatic-authorizations/{id}/cancel":{"post":{"description":"Tag: api-baas-cancel-pix-automatic-authorization
\n Description: Cancels an automatic pix authorization and its scheduled payments.","operationId":"CancelPixAutomaticAuthorizationRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Cancel Automatic Pix Authorization","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-payments/{id}/cancel":{"post":{"description":"Tag: api-baas-cancel-pix-automatic-payment
\n Description: Cancels an automatic pix payment and its associated scheduled payment.","operationId":"CancelPixAutomaticPaymentRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Cancel Automatic Pix Payment","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-recurrences/{id}/cancel":{"post":{"description":"Tag: api-baas-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_v1","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."}},"security":[{"bearer":[]}],"summary":"Cancels an Automatic Pix Recurrence","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-recurrences/{id}":{"put":{"description":"Tag: api-baas-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_v1","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-baas-get-by-id-pix-automatic-recurrence
\n Description: Retrieve the details of a pix automatic recurrence by providing its ID.","operationId":"GetPixAutomaticRecurrenceByIdRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Get Automatic Pix Recurrence by ID","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-recurrences":{"post":{"description":"Tag: api-baas-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_v1","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."},"403":{"description":"If user person type is not Legal Person"}},"security":[{"bearer":[]}],"summary":"Create an Automatic Pix Recurrence","tags":["Pix | Scheduled Payments"]},"get":{"description":"Tag: api-baas-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_v1","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."}},"security":[{"bearer":[]}],"summary":"List All Automatic Pix Recurrences","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-charges/{id}/cancel":{"post":{"description":"Tag: api-baas-cancel-pix-automatic-charge
\n Description: Cancels an automatic pix charge. Only charges with status CREATED can be canceled.","operationId":"CancelPixAutomaticChargeRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Cancels an Automatic Pix Charge","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-charges":{"post":{"description":"Tag: api-baas-create-pix-automatic-charge
\n Description: Creates an automatic pix charge.","operationId":"CreatePixAutomaticChargeRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Create an Automatic Pix Charge","tags":["Pix | Scheduled Payments"]},"get":{"description":"Tag: api-baas-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_v1","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."}},"security":[{"bearer":[]}],"summary":"List All Automatic Pix Charges","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-charges/{id}":{"get":{"description":"Tag: api-baas-get-by-id-pix-automatic-charge
\n Description: Retrieve the details of a pix automatic charge by providing its ID.","operationId":"GetPixAutomaticChargeByIdRestController_execute_v1","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."}},"security":[{"bearer":[]}],"summary":"Get Automatic Pix Charge by ID","tags":["Pix | Scheduled Payments"]}},"/v1/pix/scheduled-payments/automatic-receiver-limits":{"post":{"description":"Tag: api-baas-create-pix-automatic-receiver-limit
Description: Creates a daily limit for a specific receiver in automatic pix payments.","operationId":"CreatePixAutomaticReceiverLimitRestController_execute_v1","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-baas-get-all-by-wallet-pix-automatic-receiver-limit
Description: Gets all receiver limits for the authenticated wallet.","operationId":"GetAllPixAutomaticReceiverLimitByWalletRestController_execute_v1","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"]}},"/v1/pix/scheduled-payments/automatic-receiver-limits/{id}":{"patch":{"description":"Tag: api-baas-update-pix-automatic-receiver-limit
Description: Updates the daily limit for a specific receiver in automatic pix payments.","operationId":"UpdatePixAutomaticReceiverLimitRestController_execute_v1","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-baas-get-by-id-pix-automatic-receiver-limit
Description: Gets a specific receiver limit by its ID.","operationId":"GetPixAutomaticReceiverLimitByIdRestController_execute_v1","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"]}},"/v1/open-finance/participants":{"get":{"description":"Retrieve a list of all Open Finance participants.","operationId":"V1GetAllOpenFinanceParticipantsRestController_execute_v1","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/V1GetAllOpenFinanceParticipantsRestResponse"}}}},"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"]}},"/v1/open-finance/payment-consent/by-keys":{"post":{"description":"Create a new Open Finance payment consent by pix key.","operationId":"V1CreateOpenFinancePaymentConsentByPixKeyRestController_execute_v1","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/V1CreateOpenFinancePaymentConsentByPixKeyBody"}}}},"responses":{"201":{"description":"The payment consent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateOpenFinancePaymentConsentByPixKeyRestResponse"}}}},"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"]}},"/v1/open-finance/payment-consent/by-accounts":{"post":{"description":"Create a new Open Finance payment consent by pix account.","operationId":"V1CreateOpenFinancePaymentConsentByPixAccountRestController_execute_v1","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/V1CreateOpenFinancePaymentConsentByPixAccountBody"}}}},"responses":{"201":{"description":"The payment consent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateOpenFinancePaymentConsentByPixAccountRestResponse"}}}},"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"]}},"/v1/open-finance/payment-consent/by-qr-codes/dynamic":{"post":{"description":"Create a new Open Finance payment consent by qr code dynamic.","operationId":"V1CreateOpenFinancePaymentConsentByQrCodeDynamicRestController_execute_v1","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/V1CreateOpenFinancePaymentConsentByQrCodeDynamicBody"}}}},"responses":{"201":{"description":"The payment consent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateOpenFinancePaymentConsentByQrCodeDynamicRestResponse"}}}},"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"]}},"/v1/open-finance/payment-consent/by-qr-codes/static":{"post":{"description":"Create a new Open Finance payment consent by qr code static.","operationId":"V1CreateOpenFinancePaymentConsentByQrCodeStaticRestController_execute_v1","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/V1CreateOpenFinancePaymentConsentByQrCodeStaticBody"}}}},"responses":{"201":{"description":"The payment consent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateOpenFinancePaymentConsentByQrCodeStaticRestResponse"}}}},"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"]}},"/v1/open-finance/payment-consent/{id}":{"get":{"description":"Get an open finance payment consent by id.","operationId":"V1GetOpenFinancePaymentConsentByIdRestController_execute_v1","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/V1GetOpenFinancePaymentConsentByIdRestResponse"}}}},"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"]}},"/v1/open-finance/payments":{"get":{"description":"Get all open finance payments with filters.","operationId":"V1GetAllOpenFinancePaymentsRestController_execute_v1","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/V1GetAllOpenFinancePaymentsRestResponse"}}}},"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"]}},"/v1/open-finance/payment-consent/{id}/authorize-without-redirect":{"post":{"description":"Authorize a new Open Finance payment consent without redirect.","operationId":"V1AuthorizeWithoutRedirectOpenFinancePaymentConsentRestController_execute_v1","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/V1AuthorizeWithoutRedirectOpenFinancePaymentConsentBody"}}}},"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"]}},"/v1/open-finance/payments/{id}":{"get":{"description":"Get an open finance payment by id.","operationId":"V1GetOpenFinancePaymentByIdRestController_execute_v1","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/V1GetOpenFinancePaymentByIdRestResponse"}}}},"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":"V1CancelOpenFinancePaymentRestController_execute_v1","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/V1CancelOpenFinancePaymentBody"}}}},"responses":{"200":{"description":"The payment canceled successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CancelOpenFinancePaymentRestResponse"}}}},"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"]}},"/v1/open-finance/enrollments/{id}":{"get":{"description":"Get an open finance enrollment by id.","operationId":"V1GetEnrollmentByIdRestController_execute_v1","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/V1GetEnrollmentByIdRestResponse"}}}},"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"]}},"/v1/open-finance/enrollments/{enrollment_id}/device/{id}/credentials":{"get":{"description":"Get an open finance device enrollment credential by id.","operationId":"V1GetDeviceEnrollmentCredentialByIdRestController_execute_v1","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/V1GetDeviceEnrollmentCredentialByIdRestResponse"}}}},"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"]}},"/v1/open-finance/enrollments":{"get":{"description":"Get all enrollments with filters.","operationId":"V1GetAllEnrollmentRestController_execute_v1","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/V1GetAllEnrollmentsRestResponse"}}}},"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":"V1CreateEnrollmentRestController_execute_v1","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/V1CreateEnrollmentBody"}}}},"responses":{"201":{"description":"The enrollment created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateEnrollmentRestResponse"}}}},"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"]}},"/v1/open-finance/enrollments/{id}/revoke":{"patch":{"description":"Revoke an Open Finance enrollment.","operationId":"V1RevokeEnrollmentRestController_execute_v1","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/V1RevokeEnrollmentBody"}}}},"responses":{"200":{"description":"The enrollment revoked successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1RevokeEnrollmentRestResponse"}}}},"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"]}},"/v1/open-finance/enrollments/{id}/device/signin":{"post":{"description":"Create a new Open Finance device enrollment sign in.","operationId":"V1CreateDeviceEnrollmentSignInRestController_execute_v1","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/V1CreateDeviceEnrollmentSignInBody"}}}},"responses":{"201":{"description":"The device enrollment sign in created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateEnrollmentDeviceSignInRestResponse"}}}},"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"]}},"/v1/open-finance/enrollments/{id}/device/credentials":{"post":{"description":"Create a new Open Finance device enrollment credentials.","operationId":"V1CreateDeviceEnrollmentCredentialsRestController_execute_v1","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/V1CreateDeviceEnrollmentCredentialsBody"}}}},"responses":{"201":{"description":"The device enrollment credentials created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateEnrollmentDeviceCredentialRestResponse"}}}},"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"]}},"/v1/open-finance/enrollments/{id}/device/risk-signal":{"post":{"description":"Create a new Open Finance device enrollment risk signal.","operationId":"V1CreateDeviceEnrollmentRiskSignalRestController_execute_v1","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/V1CreateDeviceEnrollmentRiskSignalBody"}}}},"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"]}},"/v1/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":"V1CreateDeviceEnrollmentRestController_execute_v1","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/V1CreateDeviceEnrollmentBody"}}}},"responses":{"201":{"description":"The device enrollment created. Successfully!.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateEnrollmentDeviceRestResponse"}}}},"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"]}},"/v1/crossborder/clients":{"post":{"description":"Create a new crossborder client. The client will be associated with the specified user and wallet.","operationId":"V1CreateClientRestController_execute_v1","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/V1CreateClientBody"}}}},"responses":{"201":{"description":"Client created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateClientRestResponse"}}}},"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 Client","tags":["Crossborder | Clients"]},"get":{"description":"Paginated clients: id, name, document, country, type, status, risk, created_at, updated_at, optional client_verifications (id, type, provider, status). Filters: created_at_start/end (YYYY-MM-DD, both required to apply).","operationId":"V1GetAllClientRestController_execute_v1","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":"Field to sort the results by. Options: CREATED_AT (default) or NAME.","schema":{"example":"created_at","type":"string","enum":["created_at","name"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"type","required":false,"in":"query","description":"Filter results by client type. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","schema":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"]}},{"name":"status","required":false,"in":"query","description":"Filter results by client status. ACTIVE for active clients, INACTIVE for inactive clients.","schema":{"type":"string","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"]}},{"name":"document","required":false,"in":"query","description":"Filter results by client document number using exact match. Only clients whose document exactly matches the provided value will be returned.","schema":{"example":"12345678901","type":"string"}},{"name":"name","required":false,"in":"query","description":"Filter results by client name.","schema":{"example":"John Doe","type":"string"}},{"name":"country","required":false,"in":"query","description":"Country code of the client (ISO 3166-1 alpha-2).","schema":{"example":"US","type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},{"name":"risk","required":false,"in":"query","description":"Filter results by client risk. LOW for low risk, MEDIUM for medium risk, HIGH for high risk.","schema":{"example":"MEDIUM","type":"string","enum":["PENDING","LOW","MEDIUM","HIGH"]}},{"name":"created_at_start","required":false,"in":"query","description":"Start of created_at range (inclusive), YYYY-MM-DD. Use together with created_at_end.","schema":{"format":"date-time","type":"string"}},{"name":"created_at_end","required":false,"in":"query","description":"End of created_at range (inclusive), YYYY-MM-DD. Use together with created_at_start.","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"description":"Clients returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllClientRestResponse"}}}},"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 Clients","tags":["Crossborder | Clients"]}},"/v1/crossborder/clients/{id}":{"get":{"description":"Returns id, name, document, country, type, status, risk, email, link_url (externalUrl), created_at, updated_at, and client_verifications (id, type, provider, status, field_props, created_at, updated_at).","operationId":"V1GetClientByIdRestController_execute_v1","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":"Unique identifier (UUID) of the client to retrieve.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetClientByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"404":{"description":"Client not found."}},"security":[{"bearer":[]}],"summary":"Get Client by ID","tags":["Crossborder | Clients"]},"patch":{"description":"Update an existing crossborder client. Only provided fields will be updated. Note: type, document, and document_type cannot be updated. Status may only be set to ACTIVE or INACTIVE when the client is already in one of those states (toggle between them).","operationId":"V1UpdateClientRestController_execute_v1","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-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":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateClientBody"}}}},"responses":{"200":{"description":"Client updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateClientRestResponse"}}}},"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 Client","tags":["Crossborder | Clients"]},"delete":{"description":"Delete a crossborder client. The client will be permanently removed from the system.","operationId":"V1DeleteClientRestController_execute_v1","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-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":"Unique identifier (UUID) of the client to delete.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client 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 client was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Client","tags":["Crossborder | Clients"]}},"/v1/crossborder/clients/{client_id}/documents":{"post":{"description":"Upload a document file for a crossborder client (max size: 20 MB). The file will be associated with the specified client ID.","operationId":"V1UploadClientDocumentFileRestController_execute_v1","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"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Document name."},"description":{"type":"string","description":"Document description."},"document_type":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"],"description":"Document type."},"file":{"type":"string","format":"binary","description":"Document file. Required."}},"required":["name","document_type","file"]}}}},"responses":{"201":{"description":"The file upload returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadClientDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload Client Document File","tags":["Crossborder | Client Documents"]},"get":{"description":"Retrieve a list of all documents associated with a specific crossborder client. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllClientDocumentRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":["created_at","name"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"document_type","required":false,"in":"query","description":"Filter by document type.","schema":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}},{"name":"status","required":false,"in":"query","description":"Filter by document status.","schema":{"type":"string","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]}}],"responses":{"200":{"description":"Client documents returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllClientDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get All Client Documents","tags":["Crossborder | Client Documents"]}},"/v1/crossborder/clients/{client_id}/documents/{document_id}":{"delete":{"description":"Delete a document file for a crossborder client. The document will be permanently removed from the system.","operationId":"V1DeleteClientDocumentRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"document_id","required":true,"in":"path","description":"Document file ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client document deleted successfully."},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The document file was not found."},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Client Document","tags":["Crossborder | Client Documents"]},"patch":{"description":"Update metadata (name, description, type) of a client document.","operationId":"V1UpdateClientDocumentRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"document_id","required":true,"in":"path","description":"Document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientDocumentBody"}}}},"responses":{"200":{"description":"The client document was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The client document was not found."},"422":{"description":"If any required params are missing or have invalid format or type.","content":{"application/json":{"schema":{"example":{"statusCode":422,"error":"USER","message":"Missing data.","code":"MISSING_DATA"}}}}}},"security":[{"bearer":[]}],"summary":"Update Client Document","tags":["Crossborder | Client Documents"]}},"/v1/crossborder/clients/{client_id}/accounts":{"post":{"description":"Create a new bank account for a crossborder client. The account will be associated with the specified client ID.","operationId":"V1CreateClientAccountRestController_execute_v1","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"]}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"format":"uuid","example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateClientAccountBody"}}}},"responses":{"201":{"description":"Client account created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateClientAccountRestResponse"}}}},"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 Client Account","tags":["Crossborder | Client Accounts"]},"get":{"description":"Retrieve a list of all bank accounts associated with a specific crossborder client. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllClientAccountRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"format":"uuid","example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":{"example":"created_at","type":"string","enum":["created_at","account_number"]}},{"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":"Filter by currency symbol.","schema":{"type":"string","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]}},{"name":"name","required":false,"in":"query","description":"Partial match on bank name (bank_name column).","schema":{"type":"string"}}],"responses":{"200":{"description":"Client accounts returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllClientAccountRestResponse"}}}},"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 Client Accounts","tags":["Crossborder | Client Accounts"]}},"/v1/crossborder/clients/{client_id}/accounts/{account_id}":{"patch":{"description":"Partially update an existing bank account for a crossborder client. Field rules match create; only sent fields are applied. User ID is taken from the authenticated user.","operationId":"V1UpdateClientAccountRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"format":"uuid","example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"account_id","required":true,"in":"path","description":"Account ID.","schema":{"format":"uuid","example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateClientAccountBody"}}}},"responses":{"200":{"description":"Client account updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateClientAccountRestResponse"}}}},"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 Client Account","tags":["Crossborder | Client Accounts"]},"get":{"description":"Retrieve detailed information about a specific client account by providing the client ID and account ID.","operationId":"V1GetClientAccountByIdRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID","schema":{"format":"uuid","example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"account_id","required":true,"in":"path","description":"Account ID","schema":{"format":"uuid","example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client account returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetClientAccountByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"403":{"description":"If the client is not authorized to access this account."},"404":{"description":"If the account was not found."}},"security":[{"bearer":[]}],"summary":"Get Client Account by ID","tags":["Crossborder | Client Accounts"]},"delete":{"description":"Delete a bank account for a crossborder client. The account will be permanently removed from the system.","operationId":"V1DeleteClientAccountRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"format":"uuid","example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"account_id","required":true,"in":"path","description":"Account ID.","schema":{"format":"uuid","example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client account 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 account was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Client Account","tags":["Crossborder | Client Accounts"]}},"/v1/crossborder/clients/{id}/wallets":{"post":{"description":"Create a new wallet for a crossborder client. The wallet will be associated with the specified client ID.","operationId":"V1CreateClientWalletRestController_execute_v1","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"]}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateClientWalletBody"}}}},"responses":{"201":{"description":"Client wallet created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateClientWalletRestResponse"}}}},"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 Client Wallet","tags":["Crossborder | Client Wallets"]},"get":{"description":"Retrieve a list of all wallets associated with a specific crossborder client.","operationId":"V1GetAllClientWalletRestController_execute_v1","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":"id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":{"example":"created_at","type":"string","enum":["created_at","name"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"name","required":false,"in":"query","description":"Partial match on wallet display name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Client wallets returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllClientWalletRestResponse"}}}},"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 Client Wallets","tags":["Crossborder | Client Wallets"]}},"/v1/crossborder/clients/{id}/wallets/{wallet_id}":{"get":{"description":"Retrieve detailed information about a specific client wallet by providing the client ID and wallet ID.","operationId":"V1GetClientWalletByIdRestController_execute_v1","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":"id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"wallet_id","required":true,"in":"path","description":"Wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client wallet returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetClientWalletByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"If the wallet was not found."}},"security":[{"bearer":[]}],"summary":"Get Client Wallet by ID","tags":["Crossborder | Client Wallets"]},"put":{"description":"Update an existing wallet for a crossborder client. You may update name, address, and/or network; only fields sent in the body are applied.","operationId":"V1UpdateClientWalletRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"wallet_id","required":true,"in":"path","description":"Wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateClientWalletBody"}}}},"responses":{"200":{"description":"Client wallet updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateClientWalletRestResponse"}}}},"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 Client Wallet","tags":["Crossborder | Client Wallets"]},"delete":{"description":"Delete an wallet for a crossborder client. The wallet will be permanently removed from the system.","operationId":"V1DeleteClientWalletRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"wallet_id","required":true,"in":"path","description":"Wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client wallet 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 wallet was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Client Wallet","tags":["Crossborder | Client Wallets"]}},"/v1/crossborder/clients/{client_id}/wallets/{client_wallet_id}/documents":{"post":{"description":"Upload a document file for a crossborder client wallet (max size: 20 MB). The file will be associated with the specified client ID and client wallet ID.","operationId":"V1UploadClientWalletDocumentFileRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_wallet_id","required":true,"in":"path","description":"Client wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Document name."},"description":{"type":"string","description":"Document description."},"document_type":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"],"description":"Document type."},"file":{"type":"string","format":"binary","description":"Document file. Required."}},"required":["name","document_type","file"]}}}},"responses":{"201":{"description":"The file upload returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadClientWalletDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload Client Wallet Document File","tags":["Crossborder | Client Wallet Documents"]},"get":{"description":"Retrieve a list of all documents associated with a specific crossborder client wallet. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllClientWalletDocumentRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_wallet_id","required":true,"in":"path","description":"Wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":{"example":"created_at","type":"string","enum":["created_at","updated_at","name"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"document_type","required":false,"in":"query","description":"Filter by document type.","schema":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}},{"name":"status","required":false,"in":"query","description":"Filter by document status.","schema":{"type":"string","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]}}],"responses":{"200":{"description":"Client wallet documents returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllClientWalletDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get All Client Wallet Documents","tags":["Crossborder | Client Wallet Documents"]}},"/v1/crossborder/clients/{client_id}/wallets/{client_wallet_id}/documents/{document_id}":{"delete":{"description":"Delete a document file for a crossborder client wallet. The document will be permanently removed from the system.","operationId":"V1DeleteClientWalletDocumentRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_wallet_id","required":true,"in":"path","description":"Client wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"document_id","required":true,"in":"path","description":"Document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client wallet document deleted successfully."},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The document file was not found."},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Client Wallet Document","tags":["Crossborder | Client Wallet Documents"]},"patch":{"description":"Update metadata (name, description, type) of a client wallet document.","operationId":"V1UpdateClientWalletDocumentRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_wallet_id","required":true,"in":"path","description":"Client wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"document_id","required":true,"in":"path","description":"Document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientWalletDocumentBody"}}}},"responses":{"200":{"description":"The client wallet document was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientWalletDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The client wallet document was not found."},"422":{"description":"If any required params are missing or have invalid format or type.","content":{"application/json":{"schema":{"example":{"statusCode":422,"error":"USER","message":"Missing data.","code":"MISSING_DATA"}}}}}},"security":[{"bearer":[]}],"summary":"Update Client Wallet Document","tags":["Crossborder | Client Wallet Documents"]}},"/v1/crossborder/clients/{client_id}/business-structure":{"get":{"description":"Retrieve a paginated list of business structure entries associated with a specific crossborder client.","operationId":"V1GetAllBusinessStructureRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"format":"uuid","example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":{"example":"created_at","type":"string","enum":["created_at","name","participation_percentage"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"participation_percentage","required":false,"in":"query","description":"Filter by participation percentage.","schema":{"example":50,"type":"number"}},{"name":"document_type","required":false,"in":"query","description":"Filter by document type.","schema":{"example":"CPF","type":"string"}},{"name":"document_number","required":false,"in":"query","description":"Filter by document number.","schema":{"example":"12345678901","type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter by status.","schema":{"example":"ACTIVE","type":"string"}},{"name":"position","required":false,"in":"query","description":"Filter by position or role.","schema":{"example":"Legal Representative","type":"string"}}],"responses":{"200":{"description":"Business structure returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllBusinessStructureRestResponse"}}}},"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 Business Structure","tags":["Crossborder | Business Structure"]}},"/v1/crossborder/clients/{client_id}/accounts/{client_account_id}/documents":{"post":{"description":"Upload a document file for a crossborder client account (max size: 20 MB). The file will be associated with the specified client account ID.","operationId":"V1UploadClientAccountDocumentFileRestController_execute_v1","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"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_account_id","required":true,"in":"path","description":"Account ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Document name."},"description":{"type":"string","description":"Document description."},"document_type":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"],"description":"Document type."},"file":{"type":"string","format":"binary","description":"Document file. Required."}},"required":["name","document_type","file"]}}}},"responses":{"201":{"description":"The file upload returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadClientAccountDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload Client Account Document File","tags":["Crossborder | Client Account Documents"]},"get":{"description":"Retrieve a list of all documents associated with a specific crossborder client account. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllClientAccountDocumentRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_account_id","required":true,"in":"path","description":"Account ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":["created_at","name"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"document_type","required":false,"in":"query","description":"Filter by document type.","schema":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}},{"name":"status","required":false,"in":"query","description":"Filter by document status.","schema":{"type":"string","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]}}],"responses":{"200":{"description":"Client account documents returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllClientAccountDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get All Client Account Documents","tags":["Crossborder | Client Account Documents"]}},"/v1/crossborder/clients/{client_id}/accounts/{client_account_id}/documents/{document_id}":{"delete":{"description":"Delete a document file for a crossborder client account. The document will be permanently removed from the system.","operationId":"V1DeleteClientAccountDocumentRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_account_id","required":true,"in":"path","description":"Account ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"document_id","required":true,"in":"path","description":"Document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client account document deleted successfully."},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The document file was not found."},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Client Account Document","tags":["Crossborder | Client Account Documents"]},"patch":{"description":"Update metadata (name, description, type) of a client account document.","operationId":"V1UpdateClientAccountDocumentRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_account_id","required":true,"in":"path","description":"Account ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"document_id","required":true,"in":"path","description":"Document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientAccountDocumentBody"}}}},"responses":{"200":{"description":"The client account document was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientAccountDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The client account document was not found."},"422":{"description":"If any required params are missing or have invalid format or type.","content":{"application/json":{"schema":{"example":{"statusCode":422,"error":"USER","message":"Missing data.","code":"MISSING_DATA"}}}}}},"security":[{"bearer":[]}],"summary":"Update Client Account Document","tags":["Crossborder | Client Account Documents"]}},"/v1/crossborder/quotes/{quote_id}/documents":{"post":{"description":"Upload a document file for a crossborder quote (max size: 20 MB). The file will be associated with the specified quote ID.","operationId":"V1UploadQuoteDocumentFileRestController_execute_v1","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":"quote_id","required":true,"in":"path","description":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Document name."},"description":{"type":"string","description":"Document description."},"document_type":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"],"description":"Document type."},"file":{"type":"string","format":"binary","description":"Document file. Required."}},"required":["name","document_type","file"]}}}},"responses":{"201":{"description":"The file upload returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadQuoteDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload Quote Document File","tags":["Crossborder | Quotes"]},"get":{"description":"Retrieve a list of all documents associated with a specific crossborder quote. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllQuoteDocumentRestController_execute_v1","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":"quote_id","required":true,"in":"path","description":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":{"example":"created_at","allOf":[{"$ref":"#/components/schemas/Object"}]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"document_type","required":false,"in":"query","description":"Filter by document type.","schema":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}},{"name":"status","required":false,"in":"query","description":"Filter by document status.","schema":{"type":"string","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]}}],"responses":{"200":{"description":"Quote documents returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllQuoteDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get All Quote Documents","tags":["Crossborder | Quotes"]}},"/v1/crossborder/quotes/{quote_id}/files/{file_id}/assign":{"post":{"description":"Links a file already referenced by a client document or counterparty document for this quote to the given quote document. Does not perform a new upload.","operationId":"V1AssignFileQuoteDocumentRestController_execute_v1","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":"quote_id","required":true,"in":"path","description":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"file_id","required":true,"in":"path","description":"File ID already linked to a client or counterparty document to be linked for this quote (no new upload).","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"The quote document was updated with the file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignFileQuoteDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied or file is not allowed for this quote.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The quote or quote document was not found."},"422":{"description":"If any required params are missing or have invalid format or type.","content":{"application/json":{"schema":{"example":{"statusCode":422,"error":"USER","message":"Missing data.","code":"MISSING_DATA"}}}}}},"security":[{"bearer":[]}],"summary":"Assign file to quote document","tags":["Crossborder | Quotes"]}},"/v1/crossborder/quotes/{quote_id}/documents/{document_id}":{"patch":{"description":"Update metadata (name, description, type) of a quote document.","operationId":"V1UpdateQuoteDocumentRestController_execute_v1","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":"quote_id","required":true,"in":"path","description":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"document_id","required":true,"in":"path","description":"Quote document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQuoteDocumentBody"}}}},"responses":{"200":{"description":"The quote document was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQuoteDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The quote document was not found."},"422":{"description":"If any required params are missing or have invalid format or type.","content":{"application/json":{"schema":{"example":{"statusCode":422,"error":"USER","message":"Missing data.","code":"MISSING_DATA"}}}}}},"security":[{"bearer":[]}],"summary":"Update Quote Document","tags":["Crossborder | Quotes"]},"delete":{"description":"Delete a document file for a crossborder quote. The document will be permanently removed from the system.","operationId":"V1DeleteQuoteDocumentRestController_execute_v1","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":"quote_id","required":true,"in":"path","description":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"document_id","required":true,"in":"path","description":"Quote document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Quote document deleted successfully."},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The document file was not found."},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Quote Document","tags":["Crossborder | Quotes"]}},"/v1/crossborder/counterparties/{id}/documents/{doc_id}":{"patch":{"description":"Update metadata (name, description, type) of a counterparty document.","operationId":"V1UpdateCounterpartyDocumentRestController_execute_v1","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":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"doc_id","required":true,"in":"path","description":"Counterparty document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCounterpartyDocumentBody"}}}},"responses":{"200":{"description":"The counterparty document was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCounterpartyDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The counterparty document was not found."},"422":{"description":"If any required params are missing or have invalid format or type.","content":{"application/json":{"schema":{"example":{"statusCode":422,"error":"USER","message":"Missing data.","code":"MISSING_DATA"}}}}}},"security":[{"bearer":[]}],"summary":"Update Counterparty Document","tags":["Crossborder | Counterparty Documents"]},"delete":{"description":"Delete a document file for a crossborder counterparty. The document will be permanently removed from the system.","operationId":"V1DeleteCounterpartyDocumentRestController_execute_v1","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":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"doc_id","required":true,"in":"path","description":"Counterparty document ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Counterparty document deleted successfully."},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"404":{"description":"The document file was not found."},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Counterparty Document","tags":["Crossborder | Counterparty Documents"]}},"/v1/crossborder/counterparties/{id}/documents":{"get":{"description":"Retrieve a list of all documents associated with a specific crossborder counterparty. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllCounterpartyDocumentRestController_execute_v1","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":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":["created_at","updated_at","name"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"document_type","required":false,"in":"query","description":"Filter by document type.","schema":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}},{"name":"status","required":false,"in":"query","description":"Filter by document status.","schema":{"type":"string","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]}},{"name":"name","required":false,"in":"query","description":"Filter by document name.","schema":{"example":"Identity Document","type":"string"}}],"responses":{"200":{"description":"Counterparty documents returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllCounterpartyDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get All Counterparty Documents","tags":["Crossborder | Counterparty Documents"]},"post":{"description":"Upload a document file for a crossborder counterparty (max size: 25 MB). The file will be associated with the specified counterparty ID.","operationId":"V1UploadCounterpartyDocumentFileRestController_execute_v1","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":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Document name."},"description":{"type":"string","description":"Document description."},"document_type":{"type":"string","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"],"description":"Document type."},"file":{"type":"string","format":"binary","description":"Document file. Required."}},"required":["name","document_type","file"]}}}},"responses":{"201":{"description":"The file upload returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadCounterpartyDocumentRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Upload Counterparty Document File","tags":["Crossborder | Counterparty Documents"]}},"/v1/crossborder/rates":{"get":{"description":"Returns an exchange rate for the requested currency pair, side, and amount. The rate is valid for a limited period. To lock in the rate and proceed with the exchange, submit the returned rate ID to the quote endpoint (POST /crossborder/quotes).","operationId":"V1GetRateRestController_execute_v1","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":"base_currency_symbol","required":true,"in":"query","description":"Base currency symbol.","schema":{"example":"USD","type":"string"}},{"name":"quote_currency_symbol","required":true,"in":"query","description":"Quote currency symbol.","schema":{"example":"BRL","type":"string"}},{"name":"amount_currency","required":true,"in":"query","description":"Amount currency.","schema":{"example":"BASE_CURRENCY","type":"string","enum":["BASE_CURRENCY","QUOTE_CURRENCY"]}},{"name":"amount","required":true,"in":"query","description":"Amount in cents.","schema":{"example":10000,"type":"number"}},{"name":"side","required":true,"in":"query","description":"Side.","schema":{"example":"BUY","type":"string","enum":["BUY","SELL"]}},{"name":"settlement_date_code","required":true,"in":"query","description":"Settlement date code.","schema":{"example":"D0","type":"string","enum":["D0","D1","D2"]}},{"name":"client_extra_spread","required":false,"in":"query","description":"Client extra spread in percentage.","schema":{"example":1,"type":"number"}},{"name":"client_id","required":true,"in":"query","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_account_id","required":false,"in":"query","description":"Client account ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_wallet_id","required":false,"in":"query","description":"Client wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"counterparty_id","required":true,"in":"query","description":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"counterparty_account_id","required":false,"in":"query","description":"Counterparty account ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"counterparty_wallet_id","required":false,"in":"query","description":"Counterparty wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Rate returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Crossborder Rate","tags":["Crossborder | Rates"]}},"/v1/crossborder/quotes/purposes":{"get":{"description":"Retrieve a list of all crossborder quote purposes. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllQuotePurposeRestController_execute_v1","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":["tag"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Quote purposes returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllQuotePurposeRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get All Quote Purposes","tags":["Crossborder | Quotes"]}},"/v1/crossborder/quotes/{quote_id}/tracking/generate":{"post":{"description":"Generate a secure, time-limited tracking link for a crossborder quote by quote ID.","operationId":"V1GenerateQuoteTrackingRestController_execute_v1","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":"quote_id","required":true,"in":"path","description":"Quote ID.","schema":{"example":"550e8400-e29b-41d4-a716-446655440000","type":"string"}}],"responses":{"201":{"description":"Tracking link generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateQuoteTrackingRestResponse"}}}},"401":{"description":"User authentication failed."},"422":{"description":"Invalid parameters."}},"security":[{"bearer":[]}],"summary":"Generate Quote Tracking Link by Quote ID","tags":["Crossborder | Quote Tracking"]}},"/v1/crossborder/quotes":{"post":{"description":"Create a new crossborder quote. The quote will be associated with the specified user, wallet, rate, client, and counterparty.","operationId":"V1CreateQuoteRestController_execute_v1","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"]}},{"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/CreateQuoteBody"}}}},"responses":{"201":{"description":"Quote created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQuoteRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Create Quote","tags":["Crossborder | Quotes"]},"get":{"description":"Retrieve a list of all crossborder quotes. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllQuoteRestController_execute_v1","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","settlement_date","paid_at","updated_at"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"client_id","required":false,"in":"query","description":"Filter by client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"client_document","required":false,"in":"query","description":"Filter by client document.","schema":{"example":"11111111111","type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter by status.","schema":{"type":"string","enum":["PENDING","PAID","SETTLED","FAILED","BLOCKED"]}},{"name":"base_currency_symbol","required":false,"in":"query","description":"Filter by base currency (destination currency).","schema":{"example":"USD","type":"string","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]}},{"name":"quote_currency_symbol","required":false,"in":"query","description":"Filter by quote currency (origin currency).","schema":{"example":"BRL","type":"string","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]}},{"name":"settlement_date","required":false,"in":"query","description":"Filter by settlement date (format: YYYY-MM-DD).","schema":{"format":"date","example":"2026-01-01","type":"string"}},{"name":"created_at_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_end","required":false,"in":"query","description":"End date of the created at period in the format YYYY-MM-DD.","schema":{"format":"date","type":"string"}},{"name":"transaction_verification_type","required":false,"in":"query","description":"Filter quotes that have a transaction verification of this type (KYT or Travel Rule).","schema":{"example":"KYT | EXTERNAL","type":"string","enum":["KYT | INTERNAL","KYT | EXTERNAL","TRAVEL_RULE | INTERNAL","TRAVEL_RULE | EXTERNAL"]}}],"responses":{"200":{"description":"Quotes returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllQuoteRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get All Quotes","tags":["Crossborder | Quotes"]}},"/v1/crossborder/quotes/{id}":{"get":{"description":"Retrieve detailed information about a specific crossborder quote by providing the quote ID.","operationId":"V1GetQuoteByIdRestController_execute_v1","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":"id","required":true,"in":"path","description":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Quote returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQuoteByIdRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Quote by ID","tags":["Crossborder | Quotes"]}},"/v1/crossborder/quotes/{id}/pay":{"post":{"description":"Generate payment information for a crossborder quote. Returns EMV/payment code and expiration date for the payment.","operationId":"V1PayQuoteRestController_execute_v1","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":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"201":{"description":"Payment information generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PayQuoteRestResponse"}}}},"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":"Pay Quote","tags":["Crossborder | Quotes"]}},"/v1/crossborder/quotes/{id}/receipt":{"get":{"description":"Retrieve a receipt for a crossborder quote by specifying its quote ID, the quote must be settled to generate the receipt.","operationId":"V1GetQuoteReceiptRestController_execute_v1","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":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Receipt found by quote id successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQuoteReceiptRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Receipt by Quote ID","tags":["Crossborder | Quotes"]}},"/v1/crossborder/quotes/{id}/receipt/generate":{"post":{"description":"Initiate a request to generate a quote receipt PDF. Use the returned file_id with the 'storage/files/:id/url' endpoint to get the URL to download the quote receipt in PDF format. The quote must be settled to generate the receipt.","operationId":"V1GenerateQuoteReceiptRestController_execute_v1","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":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Quote receipt PDF generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateQuoteReceiptRestResponse"}}}},"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 Quote Receipt PDF","tags":["Crossborder | Quotes"]}},"/v1/crossborder/deposits/info/{quote_id}":{"get":{"description":"Retrieve deposit information for a specific quote.","operationId":"V1GetDepositInfoByQuoteRestController_execute_v1","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":"quote_id","required":true,"in":"path","description":"Quote ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Deposit info returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositInfoRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Deposit Info by Quote","tags":["Crossborder | Deposits"]}},"/v1/crossborder/clients/{client_id}/counterparties":{"post":{"description":"Create a new crossborder counterparty for a specific client. The counterparty will be associated with the specified client and user.","operationId":"V1CreateCounterpartyRestController_execute_v1","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"]}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Unique identifier (UUID) of the client that will own this counterparty.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateCounterpartyBody"}}}},"responses":{"201":{"description":"Counterparty created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateCounterpartyRestResponse"}}}},"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 Counterparty","tags":["Crossborder | Counterparties"]},"get":{"description":"Retrieve a paginated list of crossborder counterparties for a specific client. Optional filters: `type` and `status`.","operationId":"V1GetAllCounterpartyRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Unique identifier (UUID) of the client to retrieve counterparties for.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":"Field to sort the results by. Options: CREATED_AT (default) or NAME.","schema":{"example":"created_at","type":"string","enum":["created_at","name"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"type","required":false,"in":"query","description":"Filter results by counterparty type. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","schema":{"type":"string","enum":["NATURAL_PERSON","LEGAL_PERSON"]}},{"name":"status","required":false,"in":"query","description":"Filter results by counterparty status. ACTIVE for active counterparties, INACTIVE for inactive counterparties.","schema":{"type":"string","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"]}},{"name":"risk","required":false,"in":"query","description":"Filter results by counterparty risk.","schema":{"example":"MEDIUM","type":"string","enum":["PENDING","LOW","MEDIUM","HIGH"]}},{"name":"name","required":false,"in":"query","description":"Filter results by counterparty name.","schema":{"example":"John Doe","type":"string"}}],"responses":{"200":{"description":"Counterparties returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllCounterpartyRestResponse"}}}},"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 Counterparties","tags":["Crossborder | Counterparties"]}},"/v1/crossborder/clients/{client_id}/counterparties/{id}":{"get":{"description":"Retrieve detailed information about a specific crossborder counterparty by providing the counterparty ID.","operationId":"V1GetCounterpartyByIdRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Unique identifier (UUID) of the client that owns the counterparty.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"id","required":true,"in":"path","description":"Unique identifier (UUID) of the counterparty to retrieve.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Counterparty returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetCounterpartyByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"404":{"description":"Counterparty not found."}},"security":[{"bearer":[]}],"summary":"Get Counterparty by ID","tags":["Crossborder | Counterparties"]},"patch":{"description":"Update an existing counterparty. Optional fields: name, type, country, purpose, address, and status (ACTIVE or INACTIVE when the counterparty is already in one of those states).","operationId":"V1UpdateCounterpartyRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Unique identifier (UUID) of the client that owns the counterparty.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"id","required":true,"in":"path","description":"Unique identifier (UUID) of the counterparty to update.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateCounterpartyBody"}}}},"responses":{"200":{"description":"Counterparty updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateCounterpartyRestResponse"}}}},"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 Counterparty","tags":["Crossborder | Counterparties"]},"delete":{"description":"Delete a crossborder counterparty for a specific client. The counterparty will be permanently removed from the system.","operationId":"V1DeleteCounterpartyRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Unique identifier (UUID) of the client that owns the counterparty.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"id","required":true,"in":"path","description":"Unique identifier (UUID) of the counterparty to delete.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Counterparty 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 counterparty was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Counterparty","tags":["Crossborder | Counterparties"]}},"/v1/crossborder/counterparties/{id}/accounts":{"post":{"description":"Create a new bank account for a crossborder counterparty. The account will be associated with the specified counterparty ID.","operationId":"V1CreateCounterpartyAccountRestController_execute_v1","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"]}},{"name":"id","required":true,"in":"path","description":"Unique identifier (UUID) of the counterparty that will own this bank account.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateCounterpartyAccountBody"}}}},"responses":{"201":{"description":"Counterparty account created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateCounterpartyAccountRestResponse"}}}},"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 Counterparty Account","tags":["Crossborder | Counterparty Accounts"]},"get":{"description":"Retrieve a list of all bank accounts associated with a specific crossborder counterparty. Optional filter parameters can be used to refine your search.","operationId":"V1GetAllCounterpartyAccountRestController_execute_v1","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":"id","required":true,"in":"path","description":"Unique identifier (UUID) of the counterparty to list accounts for.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":{"example":"created_at","type":"string","enum":["created_at","account_number"]}},{"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":"Filter by currency symbol.","schema":{"example":"USD","type":"string","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]}},{"name":"name","required":false,"in":"query","description":"Partial match on bank name (bank_name column).","schema":{"type":"string"}}],"responses":{"200":{"description":"Counterparty accounts returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllCounterpartyAccountRestResponse"}}}},"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 Counterparty Accounts","tags":["Crossborder | Counterparty Accounts"]}},"/v1/crossborder/counterparties/{id}/accounts/{account_id}":{"get":{"description":"Retrieve detailed information about a specific counterparty account by providing the counterparty ID and account ID.","operationId":"V1GetCounterpartyAccountByIdRestController_execute_v1","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":"id","required":true,"in":"path","description":"Unique identifier (UUID) of the counterparty that owns the account.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"account_id","required":true,"in":"path","description":"Unique identifier (UUID) of the account to retrieve.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Counterparty account returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetCounterpartyAccountByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Get Counterparty Account by ID","tags":["Crossborder | Counterparty Accounts"]},"patch":{"description":"Update an existing bank account for a crossborder counterparty. Only provided fields will be updated.","operationId":"V1UpdateCounterpartyAccountRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Unique identifier (UUID) of the counterparty that owns the account.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"account_id","required":true,"in":"path","description":"Unique identifier (UUID) of the account to update.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateCounterpartyAccountBody"}}}},"responses":{"200":{"description":"Counterparty account updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateCounterpartyAccountRestResponse"}}}},"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 Counterparty Account","tags":["Crossborder | Counterparty Accounts"]},"delete":{"description":"Delete a bank account for a crossborder counterparty. The account will be permanently removed from the system.","operationId":"V1DeleteCounterpartyAccountRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Unique identifier (UUID) of the counterparty that owns the account.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"account_id","required":true,"in":"path","description":"Unique identifier (UUID) of the account to delete.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Counterparty account 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 account was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Counterparty Account","tags":["Crossborder | Counterparty Accounts"]}},"/v1/crossborder/counterparties/{id}/wallets":{"post":{"description":"Create a new external wallet for a crossborder counterparty. The wallet will be associated with the specified counterparty and will be created with PENDING status. Requires wallet name, address, and network.","operationId":"V1CreateCounterpartyWalletRestController_execute_v1","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"]}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateCounterpartyWalletBody"}}}},"responses":{"201":{"description":"Counterparty wallet created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateCounterpartyWalletRestResponse"}}}},"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 Counterparty External Wallet","tags":["Crossborder | Counterparty Wallets"]},"get":{"description":"Retrieve a paginated list of all external wallets associated with a specific crossborder counterparty. Supports pagination controls (page, page size, sort order). Returns wallet details including address, network, and status.","operationId":"V1GetAllCounterpartyWalletRestController_execute_v1","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":"id","required":true,"in":"path","description":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":{"example":"created_at","type":"string","enum":["created_at","name"]}},{"name":"order","required":false,"in":"query","description":"Page order.","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"name","required":false,"in":"query","description":"Partial match on wallet display name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Counterparty wallets returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllCounterpartyWalletRestResponse"}}}},"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 Counterparty External Wallets","tags":["Crossborder | Counterparty Wallets"]}},"/v1/crossborder/counterparties/{id}/wallets/{wallet_id}":{"get":{"description":"Retrieve detailed information about a specific counterparty external wallet, including its address, network, status, and associated counterparty information. Requires both the counterparty ID and the client wallet ID.","operationId":"V1GetCounterpartyWalletByIdRestController_execute_v1","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":"id","required":true,"in":"path","description":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"wallet_id","required":true,"in":"path","description":"Wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Counterparty wallet returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetCounterpartyWalletByIdRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."},"404":{"description":"Counterparty wallet not found."}},"security":[{"bearer":[]}],"summary":"Get Counterparty External Wallet by ID","tags":["Crossborder | Counterparty Wallets"]},"patch":{"description":"Update an existing external wallet for a crossborder counterparty. You may update name, address, and/or network; only fields sent in the body are applied. Status cannot be changed through this endpoint. Requires both counterparty ID and client wallet ID.","operationId":"V1UpdateCounterpartyWalletRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"wallet_id","required":true,"in":"path","description":"Wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateCounterpartyWalletBody"}}}},"responses":{"200":{"description":"Counterparty wallet updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateCounterpartyWalletRestResponse"}}}},"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 Counterparty External Wallet","tags":["Crossborder | Counterparty Wallets"]},"delete":{"description":"Delete an external wallet for a crossborder counterparty. The wallet will be permanently removed from the system using soft delete (marked as deleted). Requires both counterparty ID and client wallet ID.","operationId":"V1DeleteCounterpartyWalletRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Counterparty ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"wallet_id","required":true,"in":"path","description":"Wallet ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Counterparty wallet 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 wallet was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Counterparty External Wallet","tags":["Crossborder | Counterparty Wallets"]}},"/v1/crossborder/stream-quotations":{"get":{"description":"Returns a real-time indicative exchange rate for a given currency pair and side. This is not a firm quote (RFQ) and does not guarantee execution at the returned price. ","operationId":"V1GetStreamQuotationByFilterRestController_execute_v1","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_symbol","required":true,"in":"query","description":"Base currency symbol.","schema":{"example":"USD","type":"string","enum":["USD"]}},{"name":"quote_currency_symbol","required":true,"in":"query","description":"Quote currency symbol.","schema":{"example":"BRL","type":"string","enum":["BRL"]}},{"name":"side","required":true,"in":"query","description":"Side.","schema":{"example":"BUY","type":"string","enum":["BUY","SELL"]}}],"responses":{"200":{"description":"Stream quotation retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStreamQuotationByFilterRestResponse"}}}},"401":{"description":"User authentication failed.","content":{"application/json":{"schema":{"example":{"statusCode":401,"error":"USER","message":"Access is denied."}}}}},"403":{"description":"User access denied.","content":{"application/json":{"schema":{"example":{"statusCode":403,"error":"USER","message":"Access denied to requested resource. User may not have sufficient permission."}}}}},"422":{"description":"If any required params are missing or have invalid format or type.","content":{"application/json":{"schema":{"example":{"statusCode":422,"error":"USER","message":"The value BR is not accepted in param quote_currency_symbol. quote_currency_symbol must be one of the following values: BRL","code":"VALIDATION"}}}}}},"security":[{"bearer":[]}],"summary":"Get Indicative Stream Quotation","tags":["Crossborder | Stream Quotations"]}},"/v1/crossborder/clients/by-link":{"post":{"description":"Create a new crossborder client by link. The client will be associated with the specified user and wallet.","operationId":"V1CreateClientByLinkRestController_execute_v1","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/CreateClientByLinkBody"}}}},"responses":{"201":{"description":"Client created by link successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClientByLinkRestResponse"}}}},"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 Client by Link","tags":["Crossborder | Clients"]}},"/v1/crossborder/clients/{client_id}/limits":{"post":{"description":"Create daily and one-time limits for a crossborder client. The limit will be associated with the specified client and wallet.","operationId":"V1CreateClientLimitRestController_execute_v1","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"]}},{"name":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateClientLimitBody"}}}},"responses":{"201":{"description":"Client limit created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateClientLimitRestResponse"}}}},"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 Client Limit","tags":["Crossborder | Client Limit"]},"get":{"description":"Returns client limit with daily_limit, one_time_limit, and daily_use for the specified client.","operationId":"V1GetByClientIdClientLimitRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client limit returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetByClientIdClientLimitRestResponse"}}}},"400":{"description":"If any required params are missing or has invalid format or type."},"401":{"description":"User authentication failed."}},"security":[{"bearer":[]}],"summary":"Get Client Limit by Client ID","tags":["Crossborder | Client Limit"]}},"/v1/crossborder/clients/{client_id}/limits/all":{"get":{"description":"Retrieve a paginated list of crossborder client limits for a specific client.","operationId":"V1GetAllClientLimitRestController_execute_v1","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":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","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":"Field to sort the results by.","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":"currency_symbol","required":false,"in":"query","description":"Currency symbol.","schema":{"example":"BRL","type":"string","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]}}],"responses":{"200":{"description":"Client limits returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllClientLimitRestResponse"}}}},"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 Client Limits","tags":["Crossborder | Client Limit"]}},"/v1/crossborder/clients/{client_id}/limits/{id}":{"patch":{"description":"Partially update daily and/or one-time limits for a crossborder client. Only sent fields are applied.","operationId":"V1UpdateClientLimitRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"id","required":true,"in":"path","description":"Client limit ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateClientLimitBody"}}}},"responses":{"200":{"description":"Client limit updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateClientLimitRestResponse"}}}},"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 Client Limit","tags":["Crossborder | Client Limit"]},"delete":{"description":"Delete client limit by ID. The limit will be permanently removed from the system.","operationId":"V1DeleteClientLimitRestController_execute_v1","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":"x-wallet-uuid","in":"header","description":"Sender Wallet UUID (if empty, your default Wallet UUID will be settled)","schema":{"type":"string"}},{"name":"client_id","required":true,"in":"path","description":"Client ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}},{"name":"id","required":true,"in":"path","description":"Client limit ID.","schema":{"example":"f6e2e084-29b9-4935-a059-5473b13033aa","type":"string"}}],"responses":{"200":{"description":"Client limit 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 client limit was not found."},"422":{"description":"If any required params are missing or has invalid format or type."}},"security":[{"bearer":[]}],"summary":"Delete Client Limit","tags":["Crossborder | Client Limit"]}},"/v1/notifications":{"get":{"description":"Tag: api-baas-get-all-bell-notifications
\n Description: Retrieve a list of notifications related to the logged or target user.","operationId":"V1GetAllBellNotificationRestController_execute_v1","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":"Sort attribute for paging.","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":"Successfully retrieved notifications by user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAllBellNotificationRestResponse"}}}},"400":{"description":"Invalid or missing parameters in the request."},"401":{"description":"User authentication failed."},"403":{"description":"The user does not have permission to access this resource or the product does not allow this operation."},"422":{"description":"Validation error on request parameters."}},"security":[{"bearer":[]}],"summary":"List Notifications","tags":["Notifications"]}}},"info":{"title":"Zro Global Baas API","description":"Zro Global Baas 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 | Payments"},{"name":"Split Payments"},{"name":"Pix | Devolutions"},{"name":"Pix | Deposits"},{"name":"Pix | Account config"},{"name":"Otc | Conversions"},{"name":"Quotations | Conversions"},{"name":"Operations | Wallets"},{"name":"Permissions | Permission Types"},{"name":"Operations | P2P Transfers"},{"name":"Operations | Wallet Accounts"},{"name":"Operations | Currency"},{"name":"Operations | Operation"},{"name":"Operations | Balance"},{"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 Account"},{"name":"Users | User Bank Account"},{"name":"Users | Legal Person"},{"name":"Users | Natural Person Onboarding"},{"name":"Users | Onboarding"},{"name":"Users | Legal Representative"},{"name":"Users | Company Document"},{"name":"Users | Natural Person Onboarding | Occupation"},{"name":"Users | Shareholder"},{"name":"Users | Company Registration"},{"name":"Card"},{"name":"Card | Onboarding"},{"name":"Pix | Scheduled Payments"},{"name":"Pix | Automatic Receiver Limits"},{"name":"Open Finance | Participants"},{"name":"Open Finance | Payment Consents"},{"name":"Open Finance | Payments"},{"name":"Open Finance | Enrollment"},{"name":"Crossborder | Clients"},{"name":"Crossborder | Client Documents"},{"name":"Crossborder | Client Accounts"},{"name":"Crossborder | Client Wallets"},{"name":"Crossborder | Client Wallet Documents"},{"name":"Crossborder | Business Structure"},{"name":"Crossborder | Client Account Documents"},{"name":"Crossborder | Quotes"},{"name":"Crossborder | Counterparty Documents"},{"name":"Crossborder | Rates"},{"name":"Crossborder | Quote Tracking"},{"name":"Crossborder | Deposits"},{"name":"Crossborder | Counterparties"},{"name":"Crossborder | Counterparty Accounts"},{"name":"Crossborder | Counterparty Wallets"},{"name":"Crossborder | Stream Quotations"},{"name":"Crossborder | Client Limit"},{"name":"Notifications"}],"servers":[{"url":"https://api-baas-hml.zrobank.xyz","description":"Homolog Baas API"}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"V1AuthenticateRestRequest":{"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-29T21:41:49.384Z"}},"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-29T21:41:49.466Z"}},"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-29T21:41:49.466Z"},"failed_message":{"type":"string","description":"Pix Key failed message."}},"required":["id","key","type","state","created_at","failed_message"]},"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"]},"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-29T21:41:49.469Z"}},"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","enum":["NATURAL_PERSON","LEGAL_PERSON"],"description":"Person type:
\n ","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-29T21:41:49.469Z"}},"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-29T21:41:49.469Z"},"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-29T21:41:49.469Z"}},"required":["id","txid","emv","expiration_date","key_id","description","state","created_at"]},"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-29T21:41:49.466Z"},"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-29T21:41:49.466Z"},"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-29T21:41:49.466Z"}},"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-29T21:41:49.467Z"},"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-29T21:41:49.467Z"},"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-29T21:41:49.467Z"}},"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-29T21:41:49.468Z"},"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-29T21:41:49.468Z"}},"required":["id","txid","key_id","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-29T21:41:49.468Z"},"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-29T21:41:49.468Z"}},"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"]},"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-29T21:41:49.470Z"}},"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-29T21:41:49.470Z"}},"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-29T21:41:49.470Z"}},"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-29T21:41:49.471Z"}},"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-29T21:41:49.471Z"}},"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-29T21:41:49.472Z"}},"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-29T21:41:49.472Z"}},"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-29T21:41:49.472Z"}},"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-29T21:41:49.472Z"}},"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-29T21:41:49.472Z"}},"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-29T21:41:49.472Z"}},"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-29T21:41:50.467Z"},"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-29T21:41:50.468Z"},"created_at":{"format":"date-time","type":"string","description":"Split QR Code created at.","example":"2026-05-29T21:41:50.468Z"}},"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-29T21:41:50.468Z"},"updated_at":{"format":"date-time","type":"string","description":"Split pix payments history last update date.","example":"2026-05-29T21:41:50.468Z"}},"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-29T21:41:49.380Z"},"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-29T21:41:49.380Z"},"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-29T21:41:49.380Z"},"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-29T21:41:49.380Z"}},"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"}]}}},"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"},"ispb":{"type":"string","description":"Bank ISPB."},"bank_name":{"type":"string","description":"Bank name."}},"required":["id","name","ispb","bank_name"]},"V2CreatePaymentByPixAccountBody":{"type":"object","properties":{"decoded_pix_account_id":{"type":"string","description":"Decoded pix account 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_account_id","value"]},"V2CreateByAccountPaymentRestResponse":{"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"},"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-29T21:41:49.274Z"}},"required":["id","state","end_to_end_id","value","created_at"]},"DecodeAndCreatePaymentByAccountBody":{"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 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","bank_ispb","branch","account_number","account_type","value"]},"DecodeAndCreateByAccountPaymentRestResponse":{"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"},"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-29T21:41:49.378Z"}},"required":["id","state","end_to_end_id","value","created_at"]},"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"},"end_to_end_id":{"type":"string"},"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-29T21:41:49.376Z"}},"required":["id","state","end_to_end_id","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"},"end_to_end_id":{"type":"string"},"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-29T21:41:49.376Z"}},"required":["id","state","end_to_end_id","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"},"end_to_end_id":{"type":"string"},"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-29T21:41:49.376Z"}},"required":["id","state","end_to_end_id","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"},"end_to_end_id":{"type":"string"},"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-29T21:41:49.377Z"}},"required":["id","state","end_to_end_id","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"},"end_to_end_id":{"type":"string"},"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-29T21:41:49.377Z"}},"required":["id","state","end_to_end_id","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"},"end_to_end_id":{"type":"string"},"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-29T21:41:49.375Z"}},"required":["id","state","end_to_end_id","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":"YYYY-MM-DD","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"},"end_to_end_id":{"type":"string"},"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-29T21:41:49.276Z"}},"required":["id","state","end_to_end_id","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"},"end_to_end_id":{"type":"string"},"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-29T21:41:49.365Z"}},"required":["id","state","end_to_end_id","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-29T21:41:49.274Z"}},"required":["id","amount","state","created_at"]},"CancelPaymentRestResponse":{"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":"SCHEDULED"},"created_at":{"format":"date-time","type":"string","description":"Payment created at.","example":"2026-05-29T21:41:49.366Z"},"canceled_at":{"format":"date-time","type":"string","description":"Payment canceled at.","example":"2026-05-29T21:41:49.366Z"},"payment_date":{"format":"date-time","type":"string","description":"Payment date.","example":"2026-05-29T21:41:49.366Z"}},"required":["id","type","state","created_at","canceled_at","payment_date"]},"GetAllPaymentRestResponseItem":{"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-29T21:41:49.279Z"}},"required":["id","type","state","end_to_end_id","amount","owner_person_type","owner_bank_name","owner_bank_ispb","beneficiary_person_type","beneficiary_bank_name","beneficiary_bank_ispb","created_at"]},"GetAllPaymentRestResponse":{"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/GetAllPaymentRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V2GetAllPixDepositRestResponseItem":{"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-29T21:41:49.278Z"}},"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"]},"V2GetAllPixDepositRestResponse":{"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/V2GetAllPixDepositRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetAllPixDevolutionRestResponseItem":{"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-29T21:41:49.280Z"}},"required":["id","operation_id","type","amount","state","owner_person_type","owner_bank_name","beneficiary_person_type","beneficiary_bank_name","created_at"]},"GetAllPixDevolutionRestResponse":{"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/GetAllPixDevolutionRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetAllPixDevolutionReceivedRestResponseItem":{"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-29T21:41:49.281Z"}},"required":["id","state","operation_id","type","amount","owner_person_type","owner_bank_name","beneficiary_person_type","beneficiary_bank_name","created_at"]},"GetAllPixDevolutionReceivedRestResponse":{"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/GetAllPixDevolutionReceivedRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetPaymentByIdRestResponse":{"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."},"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."},"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-29T21:41:49.281Z"}},"required":["id","state","end_to_end_id","amount","owner_person_type","owner_bank_name","owner_bank_ispb","beneficiary_person_type","beneficiary_bank_name","beneficiary_bank_ispb","created_at"]},"V2GetByPixDevolutionIdRestResponse":{"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-29T21:41:49.282Z"}},"required":["id","operation_id","amount","state","owner_person_type","owner_bank_name","beneficiary_person_type","beneficiary_bank_name","created_at"]},"GetPixDepositByIdRestResponse":{"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-29T21:41:49.282Z"}},"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"]},"GetByPixDevolutionReceivedIdRestResponse":{"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-29T21:41:49.283Z"}},"required":["id","state","operation_id","amount","owner_person_type","owner_bank_name","beneficiary_person_type","beneficiary_bank_name","created_at"]},"V1CreatePixTrustedContactBody":{"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"]},"V1CreatePixTrustedContactRestResponse":{"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-29T21:41:49.380Z"}},"required":["id"]},"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-29T21:41:49.381Z"},"updated_at":{"format":"date-time","type":"string","description":"Pix Trusted Contact updated at.","example":"2026-05-29T21:41:49.381Z"}}},"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"]},"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-29T21:41:49.381Z"},"updated_at":{"format":"date-time","type":"string","description":"Pix Trusted Contact updated at.","example":"2026-05-29T21:41:49.381Z"}},"required":["name","document","person_type","account_number","account_type","branch_number","bank_name","bank_ispb","created_at","updated_at"]},"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-29T21:41:49.382Z"},"updated_at":{"format":"date-time","type":"string","description":"Date of updated Warning Pix Deposit.","example":"2026-05-29T21:41:49.382Z"}},"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"]},"GetPersonBucketAvailableTokenRestResponse":{"type":"object","properties":{"available_tokens":{"type":"number","description":"Total available tokens across all bucket slots.","example":42}},"required":["available_tokens"]},"CreatePixAccountConfigItemBody":{"type":"object","properties":{"wallet_id":{"type":"string","description":"UUID of the wallet that owns the Pix account.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"pix_account_id":{"type":"string","description":"Pix account UUID belonging to the wallet.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"}},"required":["wallet_id","pix_account_id"]},"CreatePixAccountConfigBody":{"type":"object","properties":{"name":{"type":"string","description":"PixAccountConfig name (config type) to create.","enum":["block_pix_devolution","block_pix_deposit_without_qrcode"],"example":"block_pix_devolution"},"apply_to_all":{"type":"boolean","description":"When true, creates the config for every wallet/Pix account belonging to the owner targets within the product. When false, the items array is required.","example":true},"items":{"description":"Required non-empty array when apply_to_all is false; omit when true.","type":"array","items":{"$ref":"#/components/schemas/CreatePixAccountConfigItemBody"}}},"required":["name","apply_to_all"]},"CreatePixAccountConfigRestResponse":{"type":"object","properties":{"affected_count":{"type":"number","description":"Number of pix account configs created.","example":10}},"required":["affected_count"]},"CreateConversionBody":{"type":"object","properties":{"quotation_id":{"type":"string","description":"Quotation ID to convert.","example":"abb8e578-6540-4104-8fa9-90a854ab0d1c"}},"required":["quotation_id"]},"CreateConversionRestResponse":{"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-29T21:41:49.068Z"}},"required":["id","operation_id","created_at"]},"GetAllConversionRestResponseItem":{"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-29T21:41:49.070Z"}},"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"]},"GetAllConversionRestResponse":{"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/GetAllConversionRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GetConversionCreditByUserRestResponse":{"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-29T21:41:49.071Z"}},"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-29T21:41:49.071Z"}},"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"]},"GetQuotationRestResponse":{"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-29T21:41:49.383Z"}},"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-29T21:41:49.570Z"}},"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-29T21:41:49.571Z"}},"required":["id","name","default","state","permission_types","owner_id","owner_name","created_at"]},"CreatePermissionTypeBody":{"type":"object","properties":{"tag":{"type":"string","description":"Permission type tag.","example":"CLIENT"},"active":{"type":"boolean","description":"Permission type active status.","example":true}},"required":["tag","active"]},"CreatePermissionTypeRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Permission type id.","example":"123e4567-e89b-12d3-a456-426614174000"},"created_at":{"format":"date-time","type":"string","description":"Permission type created at.","example":"2026-05-29T21:41:49.571Z"}},"required":["id","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-29T21:41:49.265Z"}},"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-29T21:41:49.266Z"}},"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-29T21:41:49.267Z"}},"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 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},"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"},"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-29T21:41:49.268Z"},"reverted_at":{"format":"date-time","type":"string","description":"Operation reverted at.","example":"2026-05-29T21:41:49.268Z"},"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-29T21:41:49.269Z"},"reverted_at":{"format":"date-time","type":"string","description":"Operation reverted at.","example":"2026-05-29T21:41:49.269Z"},"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-29T21:41:49.271Z"}},"required":["id","operation_id","amount_currency","amount","fee","created_at"]},"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-29T21:41:49.269Z"}},"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"]},"DailySummaryDetailedItemRestResponse":{"type":"object","properties":{"movement_date":{"format":"date-time","type":"string","description":"Movement date.","example":"2025-10-09T00:00:00.000Z"},"initial_balance":{"type":"number","description":"Initial balance in cents (R$).","example":150075},"final_balance":{"type":"number","description":"Final balance in cents (R$).","example":135025},"total_debit":{"type":"number","description":"Total debit in cents (R$).","example":15050},"total_credit":{"type":"number","description":"Total credit in cents (R$).","example":50000},"currency_symbol":{"type":"string","description":"Currency symbol.","example":"BRL"},"pix_receive":{"type":"number","description":"Pix receive.","example":10000},"pix_devolution_send":{"type":"number","description":"Pix devolution send."},"pix_send_self":{"type":"number","description":"Pix send self.","example":10000},"pix_send":{"type":"number","description":"Pix send.","example":10000}}},"GetDailySummaryDetailedRestResponse":{"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":"Daily summary detailed items.","type":"array","items":{"$ref":"#/components/schemas/DailySummaryDetailedItemRestResponse"}}},"required":["page","page_size","page_total","total","data"]},"GenerateDailySummaryDetailedExportBody":{"type":"object","properties":{"sort":{"type":"string","description":"Page sort attribute.","default":"movement_date","enum":["movement_date"]},"order":{"type":"string","description":"Page order.","default":"asc","enum":["asc","desc"]},"movement_date_start":{"type":"string","description":"Movement date start for the daily summary (YYYY-MM-DD).","example":"2025-10-01","format":"date"},"movement_date_end":{"type":"string","description":"Movement date end for the daily summary (YYYY-MM-DD).","example":"2025-10-09","format":"date"},"currency_symbol":{"type":"string","description":"The currency symbol.","example":"BRL"},"format":{"type":"string","description":"File format extension (CSV, PDF or XML). Defaults to CSV.","enum":["CSV","PDF","XML"],"example":"CSV"}},"required":["movement_date_start","movement_date_end","currency_symbol"]},"GenerateDailySummaryDetailedExportRestResponse":{"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-29T21:41:49.273Z"}},"required":["file_id","state","created_at"]},"GetAllBankingTedReceivedRestResponseItem":{"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":"Banking TED Received Owner Bank Code.","example":"12345"},"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"]},"GetAllBankingTedReceivedRestResponse":{"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/GetAllBankingTedReceivedRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetBankingTedReceivedByIdRestResponse":{"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":"Banking TED Received Owner Bank Code.","example":"12345"},"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"]},"GetBankingTedReceivedByOperationIdRestResponse":{"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":"Banking TED Received Owner Bank Code.","example":"12345"},"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-29T21:41:48.969Z"}},"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-29T21:41:48.890Z"}},"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":"BankingTed beneficiary bank id.","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-29T21:41:48.966Z"},"failed_at":{"format":"date-time","type":"string","description":"BankingTed failed date.","example":"2026-05-29T21:41:48.966Z"},"created_at":{"format":"date-time","type":"string","description":"BankingTed created date.","example":"2026-05-29T21:41:48.966Z"}},"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":"BankingTed beneficiary bank id.","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-29T21:41:48.892Z"},"failed_at":{"format":"date-time","type":"string","description":"BankingTed failed date.","example":"2026-05-29T21:41:48.892Z"},"created_at":{"format":"date-time","type":"string","description":"BankingTed created date.","example":"2026-05-29T21:41:48.892Z"}},"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":"BankingTed beneficiary bank code.","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-29T21:41:48.894Z"}},"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-29T21:41:48.970Z"}},"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-29T21:41:48.975Z"},"limit_due_date":{"format":"date-time","type":"string","description":"Limit due date.","example":"2026-05-29T21:41:48.975Z"},"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-29T21:41:48.975Z"},"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-29T21:41:48.976Z"},"limit_due_date":{"format":"date-time","type":"string","description":"Limit due date.","example":"2026-05-29T21:41:48.976Z"},"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-29T21:41:48.977Z"},"confirmed_at":{"format":"date-time","type":"string","description":"Confirmation date.","example":"2026-05-29T21:41:48.977Z"}},"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"]},"V1SendByEmailBankingBilletPixDepositBody":{"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"]},"V1GetBankingBilletPaymentByIdRestResponse":{"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-29T21:41:48.979Z"},"confirmed_at":{"format":"date-time","type":"string","description":"Confirmation date.","example":"2026-05-29T21:41:48.979Z"},"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-29T21:41:48.979Z"},"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"]},"V1CreateBankingBilletPixDepositBatchBody":{"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"]},"V1CreateBankingBilletPixDepositBatchRestResponse":{"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-29T21:41:48.981Z"}},"required":["id","batch_name","status","personalized","pix_key","file_id","created_at"]},"V1GetAllBankingBilletPixDepositBatchRestResponseItem":{"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-29T21:41:48.982Z"},"updated_at":{"format":"date-time","type":"string","description":"Update date.","example":"2026-05-29T21:41:48.982Z"}},"required":["id","pix_key_id","batch_name","status","personalized","created_at","updated_at"]},"V1GetAllBankingBilletPixDepositBatchRestResponse":{"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/V1GetAllBankingBilletPixDepositBatchRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GetBankingBilletPixDepositBatchByIdRestResponse":{"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-29T21:41:48.983Z"},"updated_at":{"format":"date-time","type":"string","description":"Update date.","example":"2026-05-29T21:41:48.983Z"}},"required":["id","pix_key_id","batch_name","status","personalized","created_at","updated_at"]},"V1UpdateBankingBilletPixDepositBatchBodyParam":{"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}}},"V1UpdateCsvFileBankingBilletPixDepositBatchBody":{"type":"object","properties":{"file_id":{"type":"string","description":"CSV file ID.","example":"295564a9-c5fd-4e73-9abb-72e0383f2dfb"}},"required":["file_id"]},"V1UpdateCsvFileBankingBilletPixDepositBatchRestResponse":{"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-29T21:41:48.984Z"}},"required":["id","batch_name","status","personalized","file_id","updated_at"]},"V1GetAllBankingBilletPixDepositBatchValidationErrorRestResponseItem":{"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-29T21:41:48.984Z"}},"required":["id","banking_billet_pix_deposit_batch_id","error_line","error_field","created_at"]},"V1GetAllBankingBilletPixDepositBatchValidationErrorRestResponse":{"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/V1GetAllBankingBilletPixDepositBatchValidationErrorRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1CreateBatchItemPixAutomaticRecurrenceBodyParam":{"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"]},"V1CreateBankingBilletPixDepositBatchItemBody":{"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":"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 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/V1CreateBatchItemPixAutomaticRecurrenceBodyParam"}]}},"required":["banking_billet_pix_deposit_batch_id","description","amount","due_date"]},"V1CreateBankingBilletPixDepositBatchItemRestResponse":{"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-29T21:41:48.985Z"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T21:41:48.985Z"}},"required":["id","banking_billet_pix_deposit_batch_id","status","payer_name","payer_document","description","amount","due_date","created_at"]},"V1GetAllBankingBilletPixDepositBatchItemByBatchIdRestResponseItem":{"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-29T21:41:48.986Z"},"updated_at":{"format":"date-time","type":"string","description":"Update date.","example":"2026-05-29T21:41:48.986Z"}},"required":["id","payer_name","payer_document","description","amount","status","due_date","banking_billet_pix_deposit_batch_id","created_at","updated_at"]},"V1GetAllBankingBilletPixDepositBatchItemByBatchIdRestResponse":{"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/V1GetAllBankingBilletPixDepositBatchItemByBatchIdRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GetBankingBilletPixDepositBatchItemByIdRestResponse":{"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-29T21:41:49.065Z"},"updated_at":{"format":"date-time","type":"string","description":"Update date.","example":"2026-05-29T21:41:49.065Z"}},"required":["id","payer_name","payer_document","description","amount","status","due_date","banking_billet_pix_deposit_batch_id","created_at","updated_at"]},"V1UpdateBankingBilletPixDepositBatchItemBodyParam":{"type":"object","properties":{"payer_email":{"type":"string","description":"Payer email.","example":"example@example.com"}}},"GetAllUserWithdrawSettingRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Withdraw setting id.","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-29T21:41:49.475Z"}},"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"],"example":"DAILY"},"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"],"example":"DAILY"},"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"],"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"},"created_at":{"format":"date-time","type":"string","description":"Date of created withdraw.","example":"2026-05-29T21:41:49.476Z"}},"required":["id","state","type","balance","wallet_id","transaction_type_tag","pix_key_type","pix_key","created_at"]},"V3GeneratePixStatementExportBody":{"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"]}}},"V3GeneratePixStatementExportRestResponse":{"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-29T21:41:49.484Z"}},"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.","example":"LEGAL_PERSON","enum":["NATURAL_PERSON","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.","example":"LEGAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"payment_confirmed_at":{"format":"date-time","type":"string","description":"Payment confirmed at.","example":"2026-05-29T21:41:49.483Z"},"payment_canceled_at":{"format":"date-time","type":"string","description":"Payment canceled at.","example":"2026-05-29T21:41:49.483Z"},"payment_date":{"format":"date-time","type":"string","description":"Payment date.","example":"2026-05-29T21:41:49.483Z"},"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":"ACCOUNT"},"priority_type":{"type":"string","description":"Priority type."},"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":"CONFIRMED"},"operation_created_at":{"format":"date-time","type":"string","description":"Operation created at.","example":"2026-05-29T21:41:49.483Z"},"transaction_id":{"type":"string","description":"Transaction ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"transaction_type_tag":{"type":"string","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"],"description":"Operation transaction type tag.","example":"PIXREC"},"transaction_updated_at":{"format":"date-time","type":"string","description":"Transaction updated at.","example":"2026-05-29T21:41:49.483Z"},"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"]},"GetAllReportPixStatementRestResponse":{"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"]},"V2GenerateReportOperationStatementProductExportBody":{"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"]},"filter_type":{"type":"string","enum":["currency_symbol","merchant_id","topic","value"],"description":"Filter type.
\n ","example":"topic"},"filter_text":{"type":"string","description":"Filter Text.
\n ","example":"PIX"},"created_at_start":{"type":"string","example":"2026-05-29","description":"Start date for the statement (format: YYYY-MM-DD). Filters operations where transaction_created_at >= this date (inclusive).","format":"date"},"created_at_end":{"type":"string","example":"2026-05-29","description":"End date for the statement (format: YYYY-MM-DD). Filters operations where transaction_created_at < this date (exclusive).","format":"date"}}},"V2GenerateReportOperationStatementProductExportRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"Generated file ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_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-29T21:41:49.483Z"}},"required":["file_id","file_state","created_at"]},"V3GetAllReportOperationStatementRestResponseItem":{"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-29T21:41:49.568Z"},"updated_at":{"format":"date-time","type":"string","description":"Operation updated date.","example":"2026-05-29T21:41:49.568Z"},"transaction_id":{"type":"string","description":"Transaction Id (Statement ID). Ledger ID when the balance changed.","example":"2026-05-29T21:41:49.568Z"},"transaction_created_at":{"format":"date-time","type":"string","description":"Transaction created date (Statement created date). The time when the balance changed.","example":"2026-05-29T21:41:49.568Z"},"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"]},"V3GetAllReportOperationStatementRestResponse":{"type":"object","properties":{"data":{"description":"Report operation statement data.","type":"array","items":{"$ref":"#/components/schemas/V3GetAllReportOperationStatementRestResponseItem"}},"has_next_page":{"type":"boolean","description":"Has next page."},"page_state":{"type":"string","description":"Page state."}},"required":["data","has_next_page"]},"V3GetAllReportOperationStatementProductRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"user_id":{"type":"string","description":"User ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"product_id":{"type":"string","description":"Product ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"year_month":{"type":"string","description":"Year Month.","example":"202403"},"topic":{"type":"string","description":"Topic.","example":"PIX"},"operation_type":{"type":"string","description":"Operation Type.","example":"DEBIT"},"operation_id":{"type":"string","description":"Operation ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"operation_created_at":{"format":"date-time","type":"string","description":"Operation Created At.","example":"2026-05-29T21:41:49.481Z"},"operation_created_at_us":{"type":"string","description":"Operation Created At Microseconds.","example":"123456"},"operation_reverted_at":{"format":"date-time","type":"string","description":"Operation Reverted At.","example":"2026-05-29T21:41:49.481Z"},"operation_updated_at":{"format":"date-time","type":"string","description":"Operation Updated At.","example":"2026-05-29T21:41:49.481Z"},"transaction_id":{"type":"string","description":"Transaction ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"transaction_created_at":{"format":"date-time","type":"string","description":"Transaction Created At.","example":"2026-05-29T21:41:49.481Z"},"fee":{"type":"number","description":"Fee.","example":1},"value":{"type":"number","description":"Value.","example":1},"description":{"type":"string","description":"Description.","example":"Transaction description"},"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"},"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.","example":"PIX_SEND"},"owner_id":{"type":"string","description":"Owner ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"owner_full_name":{"type":"string","description":"Owner Full Name.","example":"John Doe"},"owner_document":{"type":"string","description":"Owner Document.","example":"12345678900"},"owner_wallet_account_id":{"type":"string","description":"Owner Wallet Account ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"beneficiary_id":{"type":"string","description":"Beneficiary ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"beneficiary_full_name":{"type":"string","description":"Beneficiary Full Name.","example":"Jane Doe"},"beneficiary_document":{"type":"string","description":"Beneficiary Document.","example":"12345678901"},"beneficiary_wallet_account_id":{"type":"string","description":"Beneficiary Wallet Account ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"previous_balance":{"type":"number","description":"Previous Balance.","example":1000},"updated_balance":{"type":"number","description":"Updated Balance.","example":900},"txid":{"type":"string","description":"Txid.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"},"original_end_to_end_id":{"type":"string","description":"Original End To End ID.","example":"E262642202026051112067HyWpBOX0UI"},"end_to_end_id":{"type":"string","description":"End To End ID.","example":"E99999999202610200000MOCKERROR02"},"original_id":{"type":"string","description":"Original ID.","example":"23bf3d55-b336-4ca2-be4b-4b8df3cdd94a"}},"required":["id","user_id","wallet_id","product_id","year_month","topic","operation_type","operation_id","operation_created_at","transaction_id","transaction_created_at","value","currency_id","currency_symbol","transaction_type_id","transaction_type_tag"]},"V3GetAllReportOperationStatementProductRestResponse":{"type":"object","properties":{"data":{"description":"Report operation statement data.","type":"array","items":{"$ref":"#/components/schemas/V3GetAllReportOperationStatementProductRestResponseItem"}},"has_next_page":{"type":"boolean","description":"Has next page."},"page_state":{"type":"string","description":"Page state."}},"required":["data","has_next_page"]},"GetAllReportPixStatementProductRestResponseItem":{"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.","example":"LEGAL_PERSON","enum":["NATURAL_PERSON","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"},"product_id":{"type":"string","description":"Product 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.","example":"LEGAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"payment_confirmed_at":{"format":"date-time","type":"string","description":"Payment confirmed at.","example":"2026-05-29T21:41:49.566Z"},"payment_canceled_at":{"format":"date-time","type":"string","description":"Payment canceled at.","example":"2026-05-29T21:41:49.566Z"},"payment_date":{"format":"date-time","type":"string","description":"Payment date.","example":"2026-05-29T21:41:49.566Z"},"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":"ACCOUNT"},"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":"CONFIRMED"},"operation_created_at":{"format":"date-time","type":"string","description":"Operation created at.","example":"2026-05-29T21:41:49.566Z"},"transaction_id":{"type":"string","description":"Transaction ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"transaction_type_tag":{"type":"string","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"],"description":"Operation transaction type tag.","example":"PIXREC"},"transaction_updated_at":{"format":"date-time","type":"string","description":"Transaction updated at.","example":"2026-05-29T21:41:49.566Z"},"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":["product_id","operation_type","state","operation_created_at","transaction_id","transaction_type_tag","value"]},"GetAllReportPixStatementProductRestResponse":{"type":"object","properties":{"data":{"description":"Pix statement data.","type":"array","items":{"$ref":"#/components/schemas/GetAllReportPixStatementProductRestResponseItem"}},"has_next_page":{"type":"boolean","description":"Has next page."},"page_state":{"type":"string","description":"Page state."}},"required":["data","has_next_page"]},"V1GenerateReportPixStatementProductExportBody":{"type":"object","properties":{"sort":{"type":"string","description":"Page sort attribute.","default":"operation_created_at","enum":["operation_created_at"]},"order":{"type":"string","description":"Page order.","default":"desc","enum":["asc","desc"]},"filter_type":{"type":"string","enum":["beneficiary_document","owner_document","end_to_end_id","merchant_id","txid"],"description":"Filter type.
\n ","example":"beneficiary_document"},"filter_text":{"type":"string","description":"Filter text."},"created_at_start":{"format":"date","type":"string","example":"2026-05-29","description":"Start date for the statement (format: YYYY-MM-DD). Filters operations where operation_created_at >= this date (inclusive)."},"created_at_end":{"format":"date","type":"string","example":"2026-05-29","description":"End date for the statement (format: YYYY-MM-DD). Filters operations where operation_created_at <= this date (inclusive)."}}},"V1GenerateReportPixStatementProductExportRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"Generated file ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_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-29T21:41:49.567Z"}},"required":["file_id","file_state","created_at"]},"QuoteExportBody":{"type":"object","properties":{"sort":{"type":"string","description":"Page sort attribute.","default":"quote_created_at","enum":["quote_created_at","settled_date"]},"order":{"type":"string","description":"Page order.","default":"desc","enum":["asc","desc"]},"filter_type":{"type":"string","enum":["client_id","client_document"],"description":"Filter type.
\n ","example":"client_id"},"filter_text":{"type":"string"},"date_start":{"type":"string","example":"2026-05-29","description":"Quote statement date start. Filters quotes where date_start >= this date. This date is chosen by the sort attribute with quote_created_at used by default.","format":"date"},"date_end":{"type":"string","example":"2026-05-29","description":"Quote statement date end. Filters quotes where date_end < this date (exclusive). This date is chosen by the sort attribute with quote_created_at used by default.","format":"date"},"type_extension":{"type":"string","description":"File format extension (CSV).","enum":["CSV"],"example":"CSV"}}},"QuoteExportRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"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-29T21:41:49.566Z"}},"required":["file_id","file_state","created_at"]},"GetAllReportTransactionSummaryProductRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Row ID.","format":"uuid"},"movement_date":{"format":"date","type":"string","description":"Movement date."},"currency_symbol":{"type":"string","description":"Currency symbol."},"transaction_type_title":{"type":"string","description":"Transaction type title."},"transaction_type_tag":{"type":"string","description":"Transaction type tag."},"amount":{"type":"number","description":"Amount."},"transaction_count":{"type":"number","description":"Transactions count used in amount."}},"required":["id","movement_date","currency_symbol","transaction_type_title","transaction_type_tag","amount","transaction_count"]},"GetAllReportTransactionSummaryProductRestResponse":{"type":"object","properties":{"page":{"type":"number","description":"Current page."},"page_size":{"type":"number","description":"Page size."},"page_total":{"type":"number","description":"Total pages."},"total":{"type":"number","description":"Total rows."},"data":{"description":"Report rows.","type":"array","items":{"$ref":"#/components/schemas/GetAllReportTransactionSummaryProductRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GenerateReportTransactionSummaryProductExportBody":{"type":"object","properties":{"currency_symbol":{"type":"string","description":"Currency symbol (e.g. BRL)."},"transaction_type_tag":{"type":"string","description":"Transaction type tag."},"format":{"type":"string","description":"File format extension (CSV, PDF or XML). Defaults to CSV.","enum":["CSV","PDF","XML"],"example":"CSV"},"movement_date_start":{"format":"date","type":"string","example":"2026-05-29","description":"Movement date start (YYYY-MM-DD)."},"movement_date_end":{"format":"date","type":"string","example":"2026-05-29","description":"Movement date end (YYYY-MM-DD)."},"sort":{"type":"string","description":"Page sort attribute.","default":"movement_date","enum":["movement_date"]},"order":{"type":"string","description":"Page order.","default":"asc","enum":["asc","desc"]}}},"V1GenerateReportTransactionSummaryProductExportRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"Generated file ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_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-29T21:41:49.480Z"}},"required":["file_id","file_state","created_at"]},"V3GenerateReportOperationStatementExportBody":{"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"]},"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-29T21:41:49.567Z","description":"Transaction created at start. Filters transactions where transaction_created_at >= this date."},"created_at_end":{"format":"date-time","type":"string","example":"2026-05-29T21:41:49.567Z","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"]}}},"V3GenerateReportOperationStatementExportRestResponse":{"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-29T21:41:49.567Z"}},"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-onboarding-doc.png"},"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":"ONBOARDING_DOCUMENTS"},"created_at":{"format":"date-time","type":"string","description":"File created at.","example":"2026-05-29T21:41:49.569Z"},"updated_at":{"format":"date-time","type":"string","description":"File updated at.","example":"2026-05-29T21:41:49.569Z"}},"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 Bytes => 300 KB => 0.3 MB","example":307504},"state":{"type":"string","description":"File State. When READY you receive the url for download.","enum":["PENDING","WAITING_UPLOAD","READY","ERROR","ABORTED"],"example":"READY"}},"required":["url","size","state"]},"UploadBySignedUrlFileV1Body":{"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":"teste_file.csv"},"folder_name":{"type":"string","description":"Folder name. The requested value will be concatenated with the identifier of the user making the request.","example":"endr/test/folder"},"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_ARCHIVE"}},"required":["file_date","file_name","folder_name","file_type","gateway_name"]},"UploadBySignedUrlFileV1RestResponse":{"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"]},"V1DeleteUserAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"User account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","description":"User state.","example":"deactivated","enum":["pending","active","expired","deactivated","deleting"]},"created_at":{"format":"date-time","type":"string","description":"User created date.","example":"2026-05-29T21:41:49.578Z"},"updated_at":{"format":"date-time","type":"string","description":"User updated date.","example":"2026-05-29T21:41:49.578Z"},"deleted_at":{"format":"date-time","type":"string","description":"User deleted date.","example":"2026-05-29T21:41:49.578Z"}},"required":["id","state","created_at","updated_at","deleted_at"]},"V2GetAllUserAccountRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"User account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","description":"User state.","example":"active","enum":["pending","active","expired","deactivated","deleting"]},"name":{"type":"object","description":"User short name or company trade name."},"full_name":{"type":"object","description":"User full name or company name."},"genre":{"type":"object","description":"User gender."},"mother_name":{"type":"object","description":"User mother name."},"birth_date":{"format":"date-time","type":"string","description":"User birth date.","example":"1984-11-03T00:00:00.000Z"},"issue_date":{"format":"date-time","type":"string","description":"Company document issue date.","example":"1984-11-03T00:00:00.000Z"},"document":{"type":"object","description":"User CPF or company CNPJ."},"phone_number":{"type":"string","description":"User or company phone number.","example":"5511955551234"},"email":{"type":"string","description":"User or company e-mail.","example":"new-user@zrobank.com.br"},"active":{"type":"object","description":"User should start as active?"},"person_type":{"type":"string","description":"Person type:
\n ","example":"LEGAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"legal_person_type":{"type":"string","description":"Legal type:
\n ","enum":["EI","MEI","EIRELI","SLU","LTDA","SS","SA","COOP","OTHER"],"example":"LTDA"},"created_at":{"format":"date-time","type":"string","description":"User created date.","example":"2026-05-29T21:41:49.579Z"}},"required":["id","state","name","full_name","document","phone_number","email","active","person_type","created_at"]},"V2GetAllUserAccountRestResponse":{"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":"Onboarding data.","type":"array","items":{"$ref":"#/components/schemas/V2GetAllUserAccountRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V2GetByIdUserAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"User account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","description":"User state.","example":"active","enum":["pending","active","expired","deactivated","deleting"]},"name":{"type":"string","description":"User short name or company trade name.","example":"John"},"full_name":{"type":"string","description":"User full name or company name.","example":"John Doe"},"genre":{"type":"string","description":"User gender.","enum":["male","female","non_binary","other","prefer_not_to_say"],"example":"male"},"mother_name":{"type":"string","description":"User mother name.","example":"Jane Doe"},"birth_date":{"format":"date-time","type":"string","description":"User birth date.","example":"1984-11-03T00:00:00.000Z"},"issue_date":{"format":"date-time","type":"string","description":"Company document issue date.","example":"1984-11-03T00:00:00.000Z"},"document":{"type":"string","description":"User CPF or company CNPJ.","example":"02465676008"},"phone_number":{"type":"string","description":"User or company phone number.","example":"5511955551234"},"email":{"type":"string","description":"User or company e-mail.","example":"new-user@zrobank.com.br"},"active":{"type":"boolean","description":"User should start as active?","example":true},"person_type":{"type":"string","description":"Person type:
\n ","example":"LEGAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"legal_person_type":{"type":"string","description":"Legal type:
\n ","example":"LTDA","enum":["EI","MEI","EIRELI","SLU","LTDA","SS","SA","COOP","OTHER"]},"created_at":{"format":"date-time","type":"string","description":"User created date.","example":"2026-05-29T21:41:49.580Z"},"updated_at":{"format":"date-time","type":"string","description":"User updated date.","example":"2026-05-29T21:41:49.580Z"}},"required":["id","state","name","full_name","document","phone_number","email","active","person_type","created_at","updated_at"]},"V2UpdateUserAccountNaturalBodyDoc":{"type":"object","properties":{"name":{"type":"string","description":"User short name or company trade name.","example":"John"},"full_name":{"type":"string","description":"User full name or company name.","example":"John Doe"},"genre":{"type":"string","description":"User gender:
\n ","example":"male","enum":["male","female","non_binary","other","prefer_not_to_say"]},"mother_name":{"type":"string","description":"User mother name.","example":"Jane Doe"},"birth_date":{"type":"string","description":"User birth date.","example":"1984-11-03","format":"date"},"phone_number":{"type":"string","description":"User or company phone number.","example":"5511955551234"},"email":{"type":"string","description":"User or company e-mail.","example":"new-user@zrobank.com.br"},"person_type":{"type":"string","description":"Person type:
\n ","example":"NATURAL_PERSON","enum":["NATURAL_PERSON"]},"active":{"type":"boolean","description":"User active","example":true}},"required":["person_type"]},"V2UpdateUserAccountLegalBodyDoc":{"type":"object","properties":{"name":{"type":"string","description":"User short name or company trade name.","example":"John"},"full_name":{"type":"string","description":"User full name or company name.","example":"John Doe"},"issue_date":{"type":"string","description":"Company document issue date.","example":"1984-11-03","format":"date"},"phone_number":{"type":"string","description":"User or company phone number.","example":"5511955551234"},"email":{"type":"string","description":"User or company e-mail.","example":"new-user@zrobank.com.br"},"person_type":{"type":"string","description":"Person type:
\n ","example":"LEGAL_PERSON","enum":["LEGAL_PERSON"]},"legal_person_type":{"type":"string","description":"Legal type:
\n ","example":"LTDA","enum":["EI","MEI","EIRELI","SLU","LTDA","SS","SA","COOP","OTHER"]},"active":{"type":"boolean","description":"User active","example":true}},"required":["person_type"]},"V2UpdateUserAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"User account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","description":"User state.","example":"active","enum":["pending","active","expired","deactivated","deleting"]},"created_at":{"format":"date-time","type":"string","description":"User created date.","example":"2026-05-29T21:41:49.581Z"},"updated_at":{"format":"date-time","type":"string","description":"User updated date.","example":"2026-05-29T21:41:49.581Z"}},"required":["id","state","created_at","updated_at"]},"V2CreateUserAccountNaturalBodyDoc":{"type":"object","properties":{"name":{"type":"string","description":"User short name or company trade name.","example":"John"},"full_name":{"type":"string","description":"User full name or company name.","example":"John Doe"},"genre":{"type":"string","description":"User gender:
\n ","example":"male","enum":["male","female","non_binary","other","prefer_not_to_say"]},"mother_name":{"type":"string","description":"User mother name.","example":"Jane Doe"},"birth_date":{"type":"string","description":"User birth date.","example":"1984-11-03","format":"date"},"document":{"type":"string","description":"User CPF or company CNPJ (only numbers)","example":"02465676008"},"phone_number":{"type":"string","description":"User or company phone number. At least one contact detail (email or phone number)","example":"5511955551234"},"email":{"type":"string","description":"User or company e-mail. At least one contact detail (email or phone number)","example":"new-user@zrobank.com.br"},"active":{"type":"boolean","description":"User should start as active?","example":true},"person_type":{"type":"string","description":"Person type:
\n ","example":"NATURAL_PERSON","enum":["NATURAL_PERSON"]}},"required":["name","full_name","document","active","person_type"]},"V2CreateUserAccountLegalBodyDoc":{"type":"object","properties":{"name":{"type":"string","description":"User short name or company trade name.","example":"John"},"full_name":{"type":"string","description":"User full name or company name.","example":"John Doe"},"issue_date":{"type":"string","description":"Company document issue date.","example":"1984-11-03","format":"date"},"document":{"type":"string","description":"User CPF or company CNPJ (only numbers)","example":"02465676008"},"phone_number":{"type":"string","description":"User or company phone number. At least one contact detail (email or phone number)","example":"5511955551234"},"email":{"type":"string","description":"User or company e-mail. At least one contact detail (email or phone number)","example":"new-user@zrobank.com.br"},"active":{"type":"boolean","description":"User should start as active?","example":true},"person_type":{"type":"string","description":"Person type:
\n ","example":"LEGAL_PERSON","enum":["LEGAL_PERSON"]},"legal_person_type":{"type":"string","description":"Legal type:
\n ","example":"LTDA","enum":["EI","MEI","EIRELI","SLU","LTDA","SS","SA","COOP","OTHER"],"nullable":true}},"required":["name","full_name","document","active","person_type"]},"V2CreateUserAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"User account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"state":{"type":"string","description":"User state.","example":"active","enum":["pending","active","expired","deactivated","deleting"]},"created_at":{"format":"date-time","type":"string","description":"User created date.","example":"2026-05-29T21:41:49.578Z"}},"required":["id","state","created_at"]},"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-29T21:41:49.581Z"}},"required":["id","user_id","user_document","onboarding_id","account_number","branch_number","active","default","created_at"]},"OnboardingAddressInfoResponse":{"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 city.","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"]},"V1GetAllLegalPersonOnboardingRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Legal person onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"legal_person_name":{"type":"string","description":"Legal person name.","example":"ACME LTDA"},"cnpj":{"type":"string","description":"Legal person CNPJ.","example":"12345678000190"},"status":{"type":"string","description":"Onboarding Status.","example":"finished","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]},"address":{"description":"Legal person address information.","allOf":[{"$ref":"#/components/schemas/OnboardingAddressInfoResponse"}]},"company_revenue":{"type":"number","description":"Legal person annual revenue in R$ cents.","example":10000000},"failed_code":{"type":"string","description":"Failure code returned for legal person onboarding.","enum":["ONBOARDING_REJECTED","ONBOARDING_REJECTED_BY_COMPLIANCE","ONBOARDING_FAILED"],"example":"ONBOARDING_FAILED"},"failed_message":{"type":"string","description":"Failure message returned for legal person onboarding.","example":"Onboarding failed in provider."},"rejected_legal_representative_id":{"type":"string","description":"Rejected legal representative ID when rejection is representative-scoped.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Legal person onboarding created at.","example":"2026-05-29T21:41:49.585Z"},"updated_at":{"format":"date-time","type":"string","description":"Legal person onboarding updated at.","example":"2026-05-29T21:41:49.585Z"}},"required":["id","legal_person_name","cnpj","status","created_at","updated_at"]},"V1GetAllLegalPersonOnboardingRestResponse":{"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":"Legal person onboarding data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllLegalPersonOnboardingRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"OmitTypeClass":{"type":"object","properties":{"zip_code":{"type":"string","description":"User address zip code.","example":"01310100"},"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 city.","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":["zip_code","street","number","city","federative_unit","country"]},"V2CreateOnboardingBody":{"type":"object","properties":{"address":{"description":"User address information.","allOf":[{"$ref":"#/components/schemas/OmitTypeClass"}]},"nationality":{"type":"string","description":"User nationality.","example":"Brasileiro"},"pep":{"type":"boolean","description":"User PEP (Politically Exposed Person).","example":false},"pep_since":{"type":"string","description":"User PEP (Politically Exposed Person) initial date.","format":"YYYY-MM-DD","example":"2024-01-02"},"occupation_cbo_code":{"type":"number","description":"User occupation cbo (Brazilian Classification of Occupations (CBO) code.","example":25394},"occupation_income":{"type":"number","description":"User occupation income in R$ cents."},"patrimony":{"type":"number","description":"User patrimony value in R$ cents.","example":1299},"accepted_terms":{"type":"boolean","description":"Indicates the user has read and accepted the terms of service. Must be `true` to proceed.","example":true}},"required":["address","nationality","pep","accepted_terms"]},"V2CreateOnboardingRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"status":{"type":"string","description":"Onboarding Status.","example":"pending","enum":["pending","finished","failed","rejected","expired"]},"created_at":{"format":"date-time","type":"string","description":"Onboarding Created at.","example":"2026-05-29T21:41:49.583Z"}},"required":["id","status","created_at"]},"OnboardingAddressInfoRequest":{"type":"object","properties":{"id":{"type":"number","description":"User address ID.","example":1234},"zip_code":{"type":"string","description":"User address zip code.","example":"01310100"},"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 city.","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":["zip_code","street","number","city","federative_unit","country"]},"V1UpdateOnboardingBody":{"type":"object","properties":{"address":{"description":"User address information.","allOf":[{"$ref":"#/components/schemas/OnboardingAddressInfoRequest"}]},"nationality":{"type":"string","description":"User nationality.","example":"Brasileiro"},"pep":{"type":"boolean","description":"User PEP (Politically Exposed Person).","example":false},"pep_since":{"type":"string","description":"User PEP (Politically Exposed Person) initial date.","format":"date","example":null,"nullable":true},"occupation_cbo_code":{"type":"number","description":"User occupation cbo (Brazilian Classification of Occupations (CBO) code.","example":null,"nullable":true},"occupation_income":{"type":"number","description":"User occupation income in R$ cents."},"patrimony":{"type":"number","description":"User patrimony value in R$ cents.","example":1299}},"required":["nationality"]},"V1UpdateOnboardingRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"status":{"type":"string","description":"Onboarding Status.","example":"pending","enum":["pending","finished","failed","rejected","expired"]},"created_at":{"format":"date-time","type":"string","description":"Onboarding Created at.","example":"2026-05-29T21:41:49.587Z"},"updated_at":{"format":"date-time","type":"string","description":"Onboarding Updated at.","example":"2026-05-29T21:41:49.587Z"}},"required":["id","status","created_at","updated_at"]},"V1OnboardingStepRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Step ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"name":{"type":"string","description":"Step name.","example":"BC_PROTEGE","enum":["BC_PROTEGE","CAF","DICT","RUFRA"]},"status":{"type":"string","description":"Step status.","example":"APPROVED","enum":["PENDING","PROCESSING","APPROVED","REJECTED","ERROR","MANUAL_REVIEW"]},"order":{"type":"number","description":"Step order.","example":1},"finished_at":{"format":"date-time","type":"string","description":"Step finished at.","example":"2026-05-29T21:41:49.588Z"},"legal_representative_id":{"type":"string","description":"Legal representative ID linked to the step. Null means company-level step.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"}},"required":["id","name","status","order"]},"V1GetAllOnboardingWithStepsRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"document":{"type":"string","description":"User document.","example":"36131399988"},"full_name":{"type":"string","description":"User full name.","example":"John Doe"},"status":{"type":"string","description":"Onboarding Status.","example":"finished","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]},"nationality":{"type":"string","description":"User nationality.","example":"Brasileiro"},"pep":{"type":"boolean","description":"User PEP.","example":false},"pep_since":{"type":"string","description":"User PEP initial date.","example":"2026-01-01","nullable":true},"occupation_cbo_code":{"type":"number","description":"User occupation cbo code.","example":212405,"nullable":true},"occupation_income":{"type":"number","description":"User occupation income in cents."},"patrimony":{"type":"number","description":"User patrimony in cents.","example":1299},"failed_code":{"type":"string","description":"Onboarding failed code.","example":"ONBOARDING_REJECTED_BY_COMPLIANCE"},"failed_message":{"type":"string","description":"Onboarding failed message.","example":"Rejected by compliance"},"rejected_legal_representative_id":{"type":"string","description":"Rejected legal representative ID when rejection is representative-scoped.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","nullable":true},"address":{"description":"User address information.","allOf":[{"$ref":"#/components/schemas/OnboardingAddressInfoResponse"}]},"steps":{"description":"Onboarding steps. Company-level steps have `legal_representative_id = null`.","type":"array","items":{"$ref":"#/components/schemas/V1OnboardingStepRestResponse"}},"created_at":{"format":"date-time","type":"string","description":"Onboarding created at.","example":"2026-05-29T21:41:49.588Z"},"updated_at":{"format":"date-time","type":"string","description":"Onboarding updated at.","example":"2026-05-29T21:41:49.588Z"}},"required":["id","status","created_at","updated_at"]},"V1GetAllOnboardingWithStepsRestResponse":{"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":"Onboarding data with steps.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllOnboardingWithStepsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GetOnboardingByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"status":{"type":"string","description":"Onboarding Status.","example":"expired","enum":["pending","finished","failed","rejected","expired"]},"address":{"description":"User address information.","allOf":[{"$ref":"#/components/schemas/OnboardingAddressInfoResponse"}]},"nationality":{"type":"string","description":"User nationality.","example":"Brasileiro"},"pep":{"type":"boolean","description":"User PEP (Politically Exposed Person).","example":false},"pep_since":{"type":"string","description":"User PEP (Politically Exposed Person) initial date.","format":"YYYY-MM-DD","example":null,"nullable":true},"occupation_cbo_code":{"type":"number","description":"User occupation cbo (Brazilian Classification of Occupations (CBO) code.","example":null,"nullable":true},"occupation_income":{"type":"number","description":"User occupation income in R$ cents."},"patrimony":{"type":"number","description":"User patrimony value in R$ cents."},"failed_code":{"type":"string","description":"Failure code returned for onboarding.","enum":["ONBOARDING_REJECTED","ONBOARDING_REJECTED_BY_COMPLIANCE","ONBOARDING_FAILED"],"example":"ONBOARDING_REJECTED"},"failed_message":{"type":"string","description":"Failure message returned for onboarding.","example":"Onboarding rejected by provider."},"rejected_legal_representative_id":{"type":"string","description":"Rejected legal representative ID when rejection is representative-scoped.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Onboarding Created at.","example":"2026-05-29T21:41:49.587Z"},"updated_at":{"format":"date-time","type":"string","description":"Onboarding Updated at.","example":"2026-05-29T21:41:49.587Z"}},"required":["id","status","pep","created_at","updated_at"]},"V1GetAllOnboardingRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"status":{"type":"string","description":"Onboarding Status.","example":"finished","enum":["pending","finished","failed","rejected","expired"]},"address":{"description":"User address information.","allOf":[{"$ref":"#/components/schemas/OnboardingAddressInfoResponse"}]},"nationality":{"type":"string","description":"User nationality.","example":"Brasileiro"},"pep":{"type":"boolean","description":"User PEP (Politically Exposed Person).","example":false},"pep_since":{"type":"string","description":"User PEP (Politically Exposed Person) initial date.","format":"YYYY-MM-DD","example":null,"nullable":true},"occupation_cbo_code":{"type":"number","description":"User occupation cbo (Brazilian Classification of Occupations (CBO) code.","example":null,"nullable":true},"occupation_income":{"type":"number","description":"User occupation income in R$ cents."},"patrimony":{"type":"number","description":"User patrimony value in R$ cents.","example":1299},"failed_code":{"type":"string","description":"Failure code returned for onboarding.","enum":["ONBOARDING_REJECTED","ONBOARDING_REJECTED_BY_COMPLIANCE","ONBOARDING_FAILED"],"example":"ONBOARDING_FAILED"},"failed_message":{"type":"string","description":"Failure message returned for onboarding.","example":"Onboarding failed in provider."},"rejected_legal_representative_id":{"type":"string","description":"Rejected legal representative ID when rejection is representative-scoped.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Onboarding Created at.","example":"2026-05-29T21:41:49.587Z"},"updated_at":{"format":"date-time","type":"string","description":"Onboarding Updated at.","example":"2026-05-29T21:41:49.587Z"}},"required":["id","status","pep","created_at","updated_at"]},"V1GetAllOnboardingRestResponse":{"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":"Onboarding data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllOnboardingRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V2CreateLegalPersonOnboardingBody":{"type":"object","properties":{"address":{"description":"Legal person headquarters or branch address information.","allOf":[{"$ref":"#/components/schemas/OmitTypeClass"}]},"company_revenue":{"type":"number","description":"Legal person annual revenue in R$ cents.","example":10000000},"accepted_terms":{"type":"boolean","description":"Indicates the user has read and accepted the terms of service. Must be `true` to proceed.","example":true}},"required":["address","accepted_terms"]},"V2CreateLegalPersonOnboardingRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal person onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"status":{"type":"string","description":"Onboarding status. The initial status is PENDING until onboarding is finalized.","example":"pending","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]},"created_at":{"format":"date-time","type":"string","description":"Onboarding Created at.","example":"2026-05-29T21:41:49.584Z"}},"required":["id","status","created_at"]},"V1FinalizeLegalPersonOnboardingRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal person onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"status":{"type":"string","description":"Onboarding Status. Status will be IN_PROCESS after successful finalization.","example":"in_process","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]}},"required":["id","status"]},"V1GetLegalPersonOnboardingByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal person onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"legal_person_name":{"type":"string","description":"Legal person name.","example":"ACME LTDA"},"cnpj":{"type":"string","description":"Legal person CNPJ.","example":"12345678000190"},"status":{"type":"string","description":"Onboarding Status.","example":"pending","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]},"address":{"description":"Legal person address information.","allOf":[{"$ref":"#/components/schemas/OnboardingAddressInfoResponse"}]},"company_revenue":{"type":"number","description":"Legal person annual revenue in R$ cents.","example":10000000},"failed_code":{"type":"string","description":"Failure code returned for legal person onboarding.","enum":["ONBOARDING_REJECTED","ONBOARDING_REJECTED_BY_COMPLIANCE","ONBOARDING_FAILED"],"example":"ONBOARDING_REJECTED"},"failed_message":{"type":"string","description":"Failure message returned for legal person onboarding.","example":"Onboarding rejected by provider."},"rejected_legal_representative_id":{"type":"string","description":"Rejected legal representative ID when rejection is representative-scoped.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","nullable":true},"created_at":{"format":"date-time","type":"string","description":"Legal person onboarding created at.","example":"2026-05-29T21:41:49.585Z"},"updated_at":{"format":"date-time","type":"string","description":"Legal person onboarding updated at.","example":"2026-05-29T21:41:49.585Z"}},"required":["id","legal_person_name","cnpj","status","created_at","updated_at"]},"V1UpdateLegalPersonOnboardingBody":{"type":"object","properties":{"address":{"description":"Legal person headquarters or branch address information.","allOf":[{"$ref":"#/components/schemas/OmitTypeClass"}]},"company_revenue":{"type":"number","description":"Legal person annual revenue in R$ cents.","example":10000000}}},"V1UpdateLegalPersonOnboardingRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal person onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"status":{"type":"string","description":"Onboarding status. The initial status is PENDING until onboarding is finalized.","example":"pending","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"]},"created_at":{"format":"date-time","type":"string","description":"Legal person onboarding created at.","example":"2026-05-29T21:41:49.586Z"},"updated_at":{"format":"date-time","type":"string","description":"Legal person onboarding updated at.","example":"2026-05-29T21:41:49.586Z"}},"required":["id","status","created_at"]},"V1UploadLegalPersonOnboardingDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal person onboarding ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Onboarding status.","enum":["pending","invalid","in_process","approved","rejected","finished","expired","failed","in_process_delayed"],"example":"pending"},"created_at":{"format":"date-time","type":"string","description":"Onboarding creation date.","example":"2026-05-29T21:41:49.589Z"},"updated_at":{"format":"date-time","type":"string","description":"Onboarding update date.","example":"2026-05-29T21:41:49.589Z"},"document_id":{"type":"string","description":"Legal person document ID created by this upload.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID associated with the uploaded onboarding document.","example":"151cddb6-1b0d-4a8c-bd21-e3bcf8b63226"},"document_type":{"type":"string","description":"Document type.","enum":["social_contract","balance_sheet","revenue_statement","kyc_aml_policy"],"example":"social_contract"},"document_created_at":{"format":"date-time","type":"string","description":"Onboarding document creation date.","example":"2026-05-29T21:41:49.589Z"},"document_updated_at":{"format":"date-time","type":"string","description":"Onboarding document update date.","example":"2026-05-29T21:41:49.589Z"}},"required":["id","status","created_at","updated_at","document_id","file_id","document_type","document_created_at","document_updated_at"]},"V1GetAllOnboardingDocumentRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"Onboarding document file ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"file_name":{"type":"string","description":"Onboarding document file name.","example":"RG - Front."},"created_at":{"format":"date-time","type":"string","description":"Onboarding document file created at.","example":"2026-05-29T21:41:49.589Z"}},"required":["file_id","file_name","created_at"]},"V1GetAllLegalPersonOnboardingDocumentItem":{"type":"object","properties":{"id":{"type":"string","description":"Document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","description":"Document type.","enum":["social_contract","balance_sheet","revenue_statement","kyc_aml_policy"],"example":"social_contract"},"created_at":{"format":"date-time","type":"string","description":"Document creation date.","example":"2026-05-29T21:41:49.590Z"},"updated_at":{"format":"date-time","type":"string","description":"Document update date.","example":"2026-05-29T21:41:49.590Z"}},"required":["id","file_id","type","created_at","updated_at"]},"V1GetAllLegalPersonOnboardingDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal person onboarding ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"documents":{"description":"List of documents.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllLegalPersonOnboardingDocumentItem"}}},"required":["id","documents"]},"V1GetByIdLegalPersonOnboardingDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","description":"Document type.","enum":["social_contract","balance_sheet","revenue_statement","kyc_aml_policy"],"example":"social_contract"},"created_at":{"format":"date-time","type":"string","description":"Document creation date.","example":"2026-05-29T21:41:49.590Z"},"updated_at":{"format":"date-time","type":"string","description":"Document update date.","example":"2026-05-29T21:41:49.590Z"}},"required":["id","file_id","type","created_at","updated_at"]},"V1UpdateLegalPersonOnboardingDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal person onboarding document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","description":"Document type.","enum":["social_contract","balance_sheet","revenue_statement","kyc_aml_policy"],"example":"social_contract"},"created_at":{"format":"date-time","type":"string","description":"Document creation date.","example":"2026-05-29T21:41:49.590Z"},"updated_at":{"format":"date-time","type":"string","description":"Document update date.","example":"2026-05-29T21:41:49.590Z"}},"required":["id","file_id","type","created_at","updated_at"]},"V3CreateLegalRepresentativeAddressBody":{"type":"object","properties":{"zip_code":{"type":"string","description":"User address zip code.","example":"01310100"},"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 city.","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":["zip_code","street","number","neighborhood","city","federative_unit","country"]},"V3CreateLegalRepresentativeRestBody":{"type":"object","properties":{"name":{"type":"string","description":"Legal representative name.","example":"Jane Doe"},"mother_name":{"type":"string","description":"Mother name.","example":"Mary Jane Doe"},"document":{"type":"string","description":"CPF number (only numbers).","example":"02465676008"},"document_country":{"type":"string","description":"Document country of issue (default BRA).","example":"BRA"},"birth_date":{"type":"string","description":"Birth date.","example":"1980-01-15","format":"date"},"income":{"type":"number","description":"Income in cents.","example":100000},"patrimony":{"type":"number","description":"Patrimony in cents.","example":5000000},"participation_percentage":{"type":"number","description":"Participation percentage in management/representation (0 to 100).\n\n**Note**: This represents the legal representative's participation in legal person management, which may differ from their equity stake. If this legal representative is linked to a shareholder, the shareholder has its own `participation_percentage` representing equity stake.","example":35.5},"pep":{"type":"boolean","description":"PEP self-declaration.","example":false},"is_public_server":{"type":"boolean","description":"Public server flag.","example":false},"representor_type":{"type":"string","description":"Legal representative qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"],"example":"PARTNER"},"phone_number":{"type":"string","description":"Phone number.","example":"5511955551234"},"email":{"type":"string","description":"Email.","example":"partner@example.com"},"relationship_start_date":{"type":"string","description":"Relationship start date with the legal entity.","example":"2020-05-01","format":"date"},"relationship_end_date":{"type":"string","description":"Relationship end date with the legal entity.","example":"2024-01-01","format":"date"},"registration_update_date":{"type":"string","description":"Registration update date. If omitted, defaults to relationship_start_date.","example":"2024-02-01","format":"date"},"shareholder_id":{"type":"string","description":"Shareholder ID this legal representative is linked to. **Required**.\n\n**Constraints:**\n- The `shareholder_id` must reference an existing shareholder\n- The shareholder must belong to the same authenticated legal person (same user)\n\n**Relationship:**\n- Links the legal representative to a specific shareholder in the legal person structure\n- The legal representative can represent the shareholder in legal matters\n- Both entities can have different `participation_percentage` values:\n - Shareholder: equity stake in the legal person\n - Legal Representative: management participation percentage","example":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"},"address":{"description":"Residential address.","allOf":[{"$ref":"#/components/schemas/V3CreateLegalRepresentativeAddressBody"}]}},"required":["name","mother_name","document","birth_date","pep","is_public_server","representor_type","phone_number","email","relationship_start_date","shareholder_id","address"]},"V3CreateLegalRepresentativeRestDocument":{"type":"object","properties":{"id":{"type":"string","description":"Document ID.","example":"a1df6c59-359d-4ec1-b7da-98dcc555dd76"},"type":{"type":"string","description":"Document type.","enum":["CPF"],"example":"CPF"},"number":{"type":"string","description":"Document number.","example":"02465676008"},"country_of_issue":{"type":"string","description":"Document country of issue.","example":"BRA"}},"required":["id","type","number","country_of_issue"]},"V3CreateLegalRepresentativeRestAddress":{"type":"object","properties":{"id":{"type":"string","description":"Address ID.","example":"7b5e8c47-b6a3-4e29-942f-7f5ec06b26a2"},"zip_code":{"type":"string","description":"ZIP code.","example":"60123456"},"street":{"type":"string","description":"Street.","example":"Main Street"},"number":{"type":"number","description":"Street number.","example":123},"neighborhood":{"type":"string","description":"Neighborhood.","example":"Downtown"},"city":{"type":"string","description":"City.","example":"São Paulo"},"federative_unit":{"type":"string","description":"Federative unit.","example":"SP"},"country":{"type":"string","description":"Country.","example":"BRA"},"complement":{"type":"string","description":"Address complement.","example":"Apt 12"}},"required":["id","zip_code","street","number","neighborhood","city","federative_unit","country"]},"V3CreateLegalRepresentativeRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal representative ID.","example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56"},"document":{"description":"Document information.","allOf":[{"$ref":"#/components/schemas/V3CreateLegalRepresentativeRestDocument"}]},"address":{"description":"Address information.","allOf":[{"$ref":"#/components/schemas/V3CreateLegalRepresentativeRestAddress"}]},"name":{"type":"string","description":"Legal representative name.","example":"Jane Doe"},"representor_type":{"type":"string","description":"Legal representative qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"]},"person_type":{"type":"string","description":"Person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"income":{"type":"number","description":"Income in cents.","example":100000},"patrimony":{"type":"number","description":"Patrimony in cents.","example":5000000},"participation_percentage":{"type":"number","description":"Participation percentage.","example":35.5},"pep":{"type":"boolean","description":"PEP flag.","example":false},"is_public_server":{"type":"boolean","description":"Public server flag.","example":false},"phone_number":{"type":"string","description":"Phone number.","example":"5511955551234"},"email":{"type":"string","description":"Email.","example":"partner@example.com"},"registration_update_date":{"format":"date-time","type":"string","description":"Registration update date.","example":"2024-02-01T00:00:00.000Z"},"birth_date":{"format":"date-time","type":"string","description":"Birth date.","example":"1980-01-15T00:00:00.000Z"},"relationship_start_date":{"format":"date-time","type":"string","description":"Relationship start date with the legal entity.","example":"2020-05-01T00:00:00.000Z"},"relationship_end_date":{"format":"date-time","type":"string","description":"Relationship end date with the legal entity.","example":"2024-01-01T00:00:00.000Z"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T21:41:49.665Z"},"shareholder_id":{"type":"string","description":"Shareholder ID this legal representative is linked to.","example":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"}},"required":["id","document","address","name","representor_type","person_type","pep","is_public_server","phone_number","email","registration_update_date","birth_date","relationship_start_date","created_at"]},"V2GetAllLegalRepresentativeRestDocument":{"type":"object","properties":{"id":{"type":"string","description":"Document ID.","example":"a1df6c59-359d-4ec1-b7da-98dcc555dd76"},"type":{"type":"string","description":"Document type.","enum":["CPF"],"example":"CPF"},"number":{"type":"string","description":"Document number.","example":"02465676008"},"country_of_issue":{"type":"string","description":"Document country of issue.","example":"BRA"}},"required":["id","type","number","country_of_issue"]},"V2GetAllLegalRepresentativeRestAddress":{"type":"object","properties":{"id":{"type":"string","description":"Address ID.","example":"7b5e8c47-b6a3-4e29-942f-7f5ec06b26a2"},"zip_code":{"type":"string","description":"ZIP code.","example":"60123456"},"street":{"type":"string","description":"Street.","example":"Main Street"},"number":{"type":"number","description":"Street number.","example":123},"neighborhood":{"type":"string","description":"Neighborhood.","example":"Downtown"},"city":{"type":"string","description":"City.","example":"São Paulo"},"federative_unit":{"type":"string","description":"Federative unit.","example":"SP"},"country":{"type":"string","description":"Country.","example":"BRA"},"complement":{"type":"string","description":"Address complement.","example":"Apt 12"}},"required":["id","zip_code","street","number","neighborhood","city","federative_unit","country"]},"V2GetAllLegalRepresentativeRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Legal representative ID.","example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56"},"document":{"description":"Document information.","allOf":[{"$ref":"#/components/schemas/V2GetAllLegalRepresentativeRestDocument"}]},"address":{"description":"Address information.","allOf":[{"$ref":"#/components/schemas/V2GetAllLegalRepresentativeRestAddress"}]},"name":{"type":"string","description":"Legal representative name.","example":"Jane Doe"},"representor_type":{"type":"string","description":"Legal representative qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"]},"person_type":{"type":"string","description":"Person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"income":{"type":"number","description":"Income in cents.","example":100000},"patrimony":{"type":"number","description":"Patrimony in cents.","example":5000000},"participation_percentage":{"type":"number","description":"Participation percentage.","example":35.5},"pep":{"type":"boolean","description":"PEP flag.","example":false},"is_public_server":{"type":"boolean","description":"Public server flag.","example":false},"phone_number":{"type":"string","description":"Phone number.","example":"5511955551234"},"email":{"type":"string","description":"Email.","example":"partner@example.com"},"registration_update_date":{"format":"date-time","type":"string","description":"Registration update date.","example":"2024-02-01T00:00:00.000Z"},"birth_date":{"format":"date-time","type":"string","description":"Birth date.","example":"1980-01-15T00:00:00.000Z"},"relationship_start_date":{"format":"date-time","type":"string","description":"Relationship start date with the legal entity.","example":"2020-05-01T00:00:00.000Z"},"relationship_end_date":{"format":"date-time","type":"string","description":"Relationship end date with the legal entity.","example":"2024-01-01T00:00:00.000Z"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T21:41:49.667Z"},"shareholder_id":{"type":"string","description":"Shareholder ID this legal representative is linked to.","example":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"}},"required":["id","document","address","name","representor_type","person_type","pep","is_public_server","registration_update_date","birth_date","relationship_start_date","created_at"]},"V2GetAllLegalRepresentativeRestResponse":{"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":"Legal representatives data.","type":"array","items":{"$ref":"#/components/schemas/V2GetAllLegalRepresentativeRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GetByIdLegalRepresentativeRestDocument":{"type":"object","properties":{"id":{"type":"string","description":"Document ID.","example":"a1df6c59-359d-4ec1-b7da-98dcc555dd76"},"type":{"type":"string","description":"Document type.","enum":["CPF"],"example":"CPF"},"number":{"type":"string","description":"Document number.","example":"02465676008"},"country_of_issue":{"type":"string","description":"Document country of issue.","example":"BRA"}},"required":["id","type","number","country_of_issue"]},"V1GetByIdLegalRepresentativeRestAddress":{"type":"object","properties":{"id":{"type":"string","description":"Address ID.","example":"7b5e8c47-b6a3-4e29-942f-7f5ec06b26a2"},"zip_code":{"type":"string","description":"ZIP code.","example":"60123456"},"street":{"type":"string","description":"Street.","example":"Main Street"},"number":{"type":"number","description":"Street number.","example":123},"neighborhood":{"type":"string","description":"Neighborhood.","example":"Downtown"},"city":{"type":"string","description":"City.","example":"São Paulo"},"federative_unit":{"type":"string","description":"Federative unit.","example":"SP"},"country":{"type":"string","description":"Country.","example":"BRA"},"complement":{"type":"string","description":"Address complement.","example":"Apt 12"}},"required":["id","zip_code","street","number","neighborhood","city","federative_unit","country"]},"V1GetByIdLegalRepresentativeRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal representative ID.","example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56"},"document":{"description":"Document information.","allOf":[{"$ref":"#/components/schemas/V1GetByIdLegalRepresentativeRestDocument"}]},"address":{"description":"Address information.","allOf":[{"$ref":"#/components/schemas/V1GetByIdLegalRepresentativeRestAddress"}]},"name":{"type":"string","description":"Legal representative name.","example":"Jane Doe"},"representor_type":{"type":"string","description":"Legal representative qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"]},"person_type":{"type":"string","description":"Person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"income":{"type":"number","description":"Income in cents.","example":100000},"patrimony":{"type":"number","description":"Patrimony in cents.","example":5000000},"participation_percentage":{"type":"number","description":"Participation percentage.","example":35.5},"pep":{"type":"boolean","description":"PEP flag.","example":false},"is_public_server":{"type":"boolean","description":"Public server flag.","example":false},"phone_number":{"type":"string","description":"Phone number.","example":"5511955551234"},"email":{"type":"string","description":"Email.","example":"partner@example.com"},"registration_update_date":{"format":"date-time","type":"string","description":"Registration update date.","example":"2024-02-01T00:00:00.000Z"},"birth_date":{"format":"date-time","type":"string","description":"Birth date.","example":"1980-01-15T00:00:00.000Z"},"relationship_start_date":{"format":"date-time","type":"string","description":"Relationship start date with the legal entity.","example":"2020-05-01T00:00:00.000Z"},"relationship_end_date":{"format":"date-time","type":"string","description":"Relationship end date with the legal entity.","example":"2024-01-01T00:00:00.000Z"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T21:41:49.667Z"},"shareholder_id":{"type":"string","description":"Shareholder ID this legal representative is linked to.","example":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"},"mother_name":{"type":"string","description":"Mother name.","example":"Maria Doe"}},"required":["id","document","address","name","representor_type","person_type","pep","is_public_server","registration_update_date","birth_date","relationship_start_date","created_at"]},"V2UpdateLegalRepresentativeAddressBody":{"type":"object","properties":{"zip_code":{"type":"string","description":"User address zip code.","example":"01310100"},"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 city.","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":["zip_code","street","number","city","federative_unit","country"]},"V2UpdateLegalRepresentativeRestBody":{"type":"object","properties":{"name":{"type":"string","description":"Legal representative name.","example":"Jane Doe"},"mother_name":{"type":"string","description":"Mother name.","example":"Mary Jane Doe"},"income":{"type":"number","description":"Income in cents.","example":100000},"patrimony":{"type":"number","description":"Patrimony in cents.","example":5000000},"participation_percentage":{"type":"number","description":"Participation percentage in management/representation (0 to 100).\n\n**Note**: This represents the legal representative's participation in legal person management, which may differ from their equity stake. If this legal representative is linked to a shareholder, the shareholder has its own `participation_percentage` representing equity stake.","example":50.5},"pep":{"type":"boolean","description":"PEP self-declaration.","example":false},"representor_type":{"type":"string","description":"Legal representative qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"],"example":"PARTNER"},"phone_number":{"type":"string","description":"Phone number.","example":"5511955551234"},"email":{"type":"string","description":"Email.","example":"partner@example.com"},"relationship_start_date":{"type":"string","description":"Relationship start date with the legal entity.","example":"2020-05-01","format":"date"},"relationship_end_date":{"type":"string","description":"Relationship end date with the legal entity.","example":"2024-01-01","format":"date"},"shareholder_id":{"type":"string","description":"Shareholder ID to link this legal representative to. It must belong to the same authenticated legal person.\n\n**Usage:**\n- **Link/Relink**: send a valid shareholder UUID\n- **Keep current link**: omit this field","example":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"},"address":{"description":"Residential address.","allOf":[{"$ref":"#/components/schemas/V2UpdateLegalRepresentativeAddressBody"}]}}},"V2UpdateLegalRepresentativeRestDocument":{"type":"object","properties":{"id":{"type":"string","description":"Document ID.","example":"a1df6c59-359d-4ec1-b7da-98dcc555dd76"},"type":{"type":"string","description":"Document type.","enum":["CPF"],"example":"CPF"},"number":{"type":"string","description":"Document number.","example":"02465676008"},"country_of_issue":{"type":"string","description":"Document country of issue.","example":"BRA"}},"required":["id","type","number","country_of_issue"]},"V2UpdateLegalRepresentativeRestAddress":{"type":"object","properties":{"id":{"type":"string","description":"Address ID.","example":"7b5e8c47-b6a3-4e29-942f-7f5ec06b26a2"},"zip_code":{"type":"string","description":"ZIP code.","example":"60123456"},"street":{"type":"string","description":"Street.","example":"Main Street"},"number":{"type":"number","description":"Street number.","example":123},"neighborhood":{"type":"string","description":"Neighborhood.","example":"Downtown"},"city":{"type":"string","description":"City.","example":"São Paulo"},"federative_unit":{"type":"string","description":"Federative unit.","example":"SP"},"country":{"type":"string","description":"Country.","example":"BRA"},"complement":{"type":"string","description":"Address complement.","example":"Apt 12"}},"required":["id","zip_code","street","number","neighborhood","city","federative_unit","country"]},"V2UpdateLegalRepresentativeRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal representative ID.","example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56"},"document":{"description":"Document information.","allOf":[{"$ref":"#/components/schemas/V2UpdateLegalRepresentativeRestDocument"}]},"address":{"description":"Address information.","allOf":[{"$ref":"#/components/schemas/V2UpdateLegalRepresentativeRestAddress"}]},"name":{"type":"string","description":"Legal representative name.","example":"Jane Doe"},"representor_type":{"type":"string","description":"Legal representative qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"]},"person_type":{"type":"string","description":"Person type.","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"income":{"type":"number","description":"Income in cents.","example":100000},"patrimony":{"type":"number","description":"Patrimony in cents.","example":5000000},"participation_percentage":{"type":"number","description":"Participation percentage.","example":35.5},"pep":{"type":"boolean","description":"PEP flag.","example":false},"is_public_server":{"type":"boolean","description":"Public server flag.","example":false},"phone_number":{"type":"string","description":"Phone number.","example":"5511955551234"},"email":{"type":"string","description":"Email.","example":"partner@example.com"},"registration_update_date":{"format":"date-time","type":"string","description":"Registration update date.","example":"2024-02-01T00:00:00.000Z"},"birth_date":{"format":"date-time","type":"string","description":"Birth date.","example":"1980-01-15T00:00:00.000Z"},"relationship_start_date":{"format":"date-time","type":"string","description":"Relationship start date with the legal entity.","example":"2020-05-01T00:00:00.000Z"},"relationship_end_date":{"format":"date-time","type":"string","description":"Relationship end date with the legal entity.","example":"2024-01-01T00:00:00.000Z"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T21:41:49.669Z"},"shareholder_id":{"type":"string","description":"Shareholder ID this legal representative is linked to.","example":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"}},"required":["id","document","address","name","representor_type","person_type","pep","is_public_server","registration_update_date","birth_date","relationship_start_date","created_at"]},"V1GetAllLegalRepresentativeDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal representative document ID.","example":"1b2c3d4e-1234-5678-9abc-def012345678"},"file_id":{"type":"string","description":"Legal representative document file ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"file_name":{"type":"string","description":"Legal representative document file name.","example":"selfie.jpg"},"created_at":{"format":"date-time","type":"string","description":"Legal representative document file created at.","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"format":"date-time","type":"string","description":"Legal representative document file updated at.","example":"2024-01-15T10:35:00.000Z"},"type":{"type":"string","description":"Legal representative document type.","enum":["selfie","identity_document","identity_document_front","identity_document_back","qualification_declaration","income_declaration","address_proof"],"example":"selfie"},"identity_document_type":{"type":"string","description":"Identity document subtype (id, cnh, passport). Only for identity_document/identity_document_front/identity_document_back.","enum":["id","cnh","passport"]}},"required":["id","file_id","file_name","created_at","type"]},"V1GetByIdLegalRepresentativeDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal representative document ID.","example":"1b2c3d4e-1234-5678-9abc-def012345678"},"file_id":{"type":"string","description":"Legal representative document file ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"file_name":{"type":"string","description":"Legal representative document file name.","example":"selfie.jpg"},"created_at":{"format":"date-time","type":"string","description":"Legal representative document file created at.","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"format":"date-time","type":"string","description":"Legal representative document file updated at.","example":"2024-01-15T10:35:00.000Z"},"type":{"type":"string","description":"Legal representative document type.","enum":["selfie","identity_document","identity_document_front","identity_document_back","qualification_declaration","income_declaration","address_proof"],"example":"selfie"},"identity_document_type":{"type":"string","description":"Identity document subtype (id, cnh, passport). Only for identity_document/identity_document_front/identity_document_back.","enum":["id","cnh","passport"]}},"required":["id","file_id","file_name","created_at","type"]},"V1UpdateLegalRepresentativeDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal representative document ID.","example":"1b2c3d4e-1234-5678-9abc-def012345678"},"file_id":{"type":"string","description":"Legal representative document file ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"file_name":{"type":"string","description":"Legal representative document file name.","example":"selfie.jpg"},"created_at":{"format":"date-time","type":"string","description":"Legal representative document file created at.","example":"2026-05-29T21:41:49.670Z"}},"required":["id","file_id","file_name","created_at"]},"V2UploadLegalRepresentativeDocumentFileRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Legal representative document ID.","example":"1b2c3d4e-1234-5678-9abc-def012345678"},"file_id":{"type":"string","description":"Uploaded file ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"file_name":{"type":"string","description":"Uploaded file name.","example":"identity_document_front.jpg"},"created_at":{"format":"date-time","type":"string","description":"Upload creation date.","example":"2024-01-15T10:30:00.000Z"},"identity_document_type":{"type":"string","description":"Identity document type (national_id, driver_license, passport). Present for identity documents.","enum":["national_id","driver_license","passport"],"example":"national_id"},"type":{"type":"string","description":"Stored legal representative document type.","enum":["selfie","identity_document","identity_document_front","identity_document_back","qualification_declaration","income_declaration","address_proof"],"example":"identity_document_front"}},"required":["id","file_id","file_name","created_at","type"]},"V1UploadCompanyDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Document ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"company_registration_id":{"type":"string","description":"Company registration ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"category":{"type":"string","description":"Document category.","enum":["CCMEI","PRIVATE_LETTER_OF_ATTORNEY","ARTICLES_OF_ASSOCIATION","COMPANY_BYLAWS","PUBLIC_LETTER_OF_ATTORNEY","LEGAL_STATEMENT","EIRELI_INCORPORATION_STATEMENT","EI_REGISTRATION_REQUIREMENT","DRIVER_LICENSE_FRONT","DRIVER_LICENSE_VERSE","DIGITAL_DRIVER_LICENSE","IDENTITY_CARD_FRONT","IDENTITY_CARD_VERSE","WORK_CARD","PROFESSIONAL_IDENTIFICATION_CARD","MILITARY_IDENTIFICATION_CARD","REVENUES_RECEIPT","SIGNATURE_CARD","SELFIE","EXTRAORDINARY_DOCUMENTS","RNE_VERSE","RNE_FRONT"],"example":"ARTICLES_OF_ASSOCIATION"},"legal_representative_id":{"type":"string","description":"Legal representative ID used for representative-scoped document categories when provided.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","nullable":true},"status":{"type":"string","description":"Processing status. PENDING: Document submitted and being processed. READY: Document processed successfully. FAILED: Document processing failed.","enum":["PENDING","READY","FAILED"],"example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Document creation date.","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"format":"date-time","type":"string","description":"Document last update date.","example":"2024-01-15T10:30:00.000Z"}},"required":["id","company_registration_id","category","status","created_at","updated_at"]},"V1GetAllOccupationRestResponseItem":{"type":"object","properties":{"cod_cbo":{"type":"number","description":"Occupation CBO code (Brazilian Classification of Occupations).","example":252205},"cbo":{"type":"number","description":"Occupation CBO number.","example":252205},"name":{"type":"string","description":"Occupation name.","example":"Contador"},"created_at":{"format":"date-time","type":"string","description":"Occupation creation date.","example":"2024-01-01T00:00:00Z"}},"required":["cod_cbo","cbo","name"]},"V1GetAllOccupationRestResponse":{"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":"Occupations data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllOccupationRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1CreateShareholderRestBody":{"type":"object","properties":{"name":{"type":"string","description":"Shareholder full name (corporate name for legal person, full name for natural person).","example":"João Silva"},"document":{"type":"string","description":"Document number (CPF for natural person, CNPJ for legal person). Only numbers.","example":"02465676008"},"type":{"type":"string","description":"Shareholder type/qualification in the legal person equity structure.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"],"example":"PARTNER"},"participation_percentage":{"type":"number","description":"Participation percentage in legal person capital (participacao acionaria). Range: 0.00 to 100.00.\n\n**Note**: This represents the equity stake in the legal person. If this shareholder is a legal person, you will need to create linked legal representatives (natural persons) and link them to this shareholder via the legal representatives endpoint.","example":35.5},"zip_code":{"type":"string","description":"Zip code (CEP) of the shareholder address. Used in CAF validation for QSA structure.","example":"01310100"}},"required":["name","document","type"]},"V1CreateShareholderRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Shareholder ID.","example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56"},"document":{"type":"string","description":"Document number (CPF or CNPJ).","example":"02465676008"},"person_type":{"type":"string","description":"Person type (natural person or legal person).","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"name":{"type":"string","description":"Shareholder name.","example":"João Silva"},"participation_percentage":{"type":"number","description":"Participation percentage in legal person capital.","example":35.5},"type":{"type":"string","description":"Shareholder type/qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"],"example":"PARTNER"},"zip_code":{"type":"string","description":"Zip code (CEP) of the shareholder address.","example":"01310100"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T21:41:49.592Z"}},"required":["id","document","person_type","name","type","created_at"]},"V1GetAllShareholderRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Shareholder ID.","example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56"},"document":{"type":"string","description":"Document number (CPF or CNPJ).","example":"02465676008"},"person_type":{"type":"string","description":"Person type (natural person or legal person).","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"name":{"type":"string","description":"Shareholder name.","example":"João Silva"},"participation_percentage":{"type":"number","description":"Participation percentage in legal person capital.","example":35.5},"type":{"type":"string","description":"Shareholder type/qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"],"example":"PARTNER"},"zip_code":{"type":"string","description":"Zip code (CEP) of the shareholder address.","example":"01310100"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T21:41:49.592Z"}},"required":["id","document","person_type","name","type","created_at"]},"V1GetAllShareholderRestResponse":{"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":"Shareholders data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllShareholderRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GetByIdShareholderRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Shareholder ID.","example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56"},"document":{"type":"string","description":"Document number (CPF or CNPJ).","example":"02465676008"},"person_type":{"type":"string","description":"Person type (natural person or legal person).","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"name":{"type":"string","description":"Shareholder name.","example":"João Silva"},"participation_percentage":{"type":"number","description":"Participation percentage in legal person capital.","example":35.5},"type":{"type":"string","description":"Shareholder type/qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"],"example":"PARTNER"},"zip_code":{"type":"string","description":"Zip code (CEP) of the shareholder address.","example":"01310100"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T21:41:49.592Z"}},"required":["id","document","person_type","name","type","created_at"]},"V1UpdateShareholderRestBody":{"type":"object","properties":{"name":{"type":"string","description":"Shareholder full name.","example":"João Silva"},"participation_percentage":{"type":"number","description":"Participation percentage in legal person capital. Range: 0.00 to 100.00.","example":35.5},"type":{"type":"string","description":"Shareholder type/qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"],"example":"PARTNER"},"zip_code":{"type":"string","description":"Zip code (CEP) of the shareholder address.","example":"01310100"}}},"V1UpdateShareholderRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Shareholder ID.","example":"d13ca8f2-4f0a-4a3d-b81e-5ee9c8bb8c56"},"document":{"type":"string","description":"Document number (CPF or CNPJ).","example":"02465676008"},"person_type":{"type":"string","description":"Person type (natural person or legal person).","enum":["NATURAL_PERSON","LEGAL_PERSON"],"example":"NATURAL_PERSON"},"name":{"type":"string","description":"Shareholder name.","example":"João Silva"},"participation_percentage":{"type":"number","description":"Participation percentage in legal person capital.","example":35.5},"type":{"type":"string","description":"Shareholder type/qualification.","enum":["PARTNER","ATTORNEY","ADMINISTRATOR","OTHER"],"example":"PARTNER"},"zip_code":{"type":"string","description":"Zip code (CEP) of the shareholder address.","example":"01310100"},"created_at":{"format":"date-time","type":"string","description":"Creation date.","example":"2026-05-29T21:41:49.592Z"},"updated_at":{"format":"date-time","type":"string","description":"Update date.","example":"2026-05-29T21:41:49.592Z"}},"required":["id","document","person_type","name","type","created_at","updated_at"]},"V1CreateCompanyRegistrationBody":{"type":"object","properties":{"onboarding_id":{"type":"string","description":"Finished legal person onboarding ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"opening_date":{"type":"string","description":"Company opening date (YYYY-MM-DD).","example":"2020-01-15","format":"date"},"revenue":{"type":"number","description":"Company annual revenue in BRL cents.","example":100000000},"establishment_format":{"type":"string","description":"Establishment format.","enum":["EI","MEI","EIRELI","LTDA","SS","SA","ME","EPP","EMPG","COOP","OTHER"],"example":"LTDA"},"state_registration":{"type":"string","description":"State registration number.","example":"123456789"},"partner_changed":{"type":"boolean","description":"Indicates if partner has changed.","example":false},"cnae":{"type":"string","description":"Main CNAE code (7 digits).","example":"6201501"},"legal_nature_code":{"type":"string","description":"Legal nature code (4 digits).","example":"2063"}},"required":["onboarding_id","opening_date","revenue","establishment_format","cnae","legal_nature_code"]},"V1CreateCompanyRegistrationRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Company registration ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"cnpj":{"type":"string","description":"Company CNPJ.","example":"93999833000199"},"status":{"type":"string","description":"Company registration status.","enum":["WAITING_DOCUMENTS","WAITING_ANALYSIS","WAITING_CORRECTIONS","ACTIVE","DECLINED","CANCELED"],"example":"WAITING_ANALYSIS"},"created_at":{"format":"date-time","type":"string","description":"Created at timestamp.","example":"2024-01-15T10:00:00.000Z"}},"required":["id","cnpj","status","created_at"]},"V1PendingDocumentsSubjectRestResponse":{"type":"object","properties":{"legal_representative_id":{"type":"string","description":"Legal representative ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d","nullable":true},"type":{"type":"string","description":"Subject type for document rules.","enum":["COMPANY","LEGAL_REPRESENTATIVE"],"example":"COMPANY"},"uploaded":{"type":"array","description":"Uploaded document categories for this subject.","example":["ARTICLES_OF_ASSOCIATION","REVENUES_RECEIPT"],"items":{"type":"string","enum":["CCMEI","PRIVATE_LETTER_OF_ATTORNEY","ARTICLES_OF_ASSOCIATION","COMPANY_BYLAWS","PUBLIC_LETTER_OF_ATTORNEY","LEGAL_STATEMENT","EIRELI_INCORPORATION_STATEMENT","EI_REGISTRATION_REQUIREMENT","DRIVER_LICENSE_FRONT","DRIVER_LICENSE_VERSE","DIGITAL_DRIVER_LICENSE","IDENTITY_CARD_FRONT","IDENTITY_CARD_VERSE","WORK_CARD","PROFESSIONAL_IDENTIFICATION_CARD","MILITARY_IDENTIFICATION_CARD","REVENUES_RECEIPT","SIGNATURE_CARD","SELFIE","EXTRAORDINARY_DOCUMENTS","RNE_VERSE","RNE_FRONT"]}},"required":{"type":"array","description":"Pending required document categories for this subject.","example":["CCMEI"],"items":{"type":"string","enum":["CCMEI","PRIVATE_LETTER_OF_ATTORNEY","ARTICLES_OF_ASSOCIATION","COMPANY_BYLAWS","PUBLIC_LETTER_OF_ATTORNEY","LEGAL_STATEMENT","EIRELI_INCORPORATION_STATEMENT","EI_REGISTRATION_REQUIREMENT","DRIVER_LICENSE_FRONT","DRIVER_LICENSE_VERSE","DIGITAL_DRIVER_LICENSE","IDENTITY_CARD_FRONT","IDENTITY_CARD_VERSE","WORK_CARD","PROFESSIONAL_IDENTIFICATION_CARD","MILITARY_IDENTIFICATION_CARD","REVENUES_RECEIPT","SIGNATURE_CARD","SELFIE","EXTRAORDINARY_DOCUMENTS","RNE_VERSE","RNE_FRONT"]}},"one_of":{"type":"array","description":"Pending groups where at least one category from each group must be uploaded.","example":[["CCMEI","ARTICLES_OF_ASSOCIATION"]],"items":{"type":"array","items":{"type":"string","enum":["CCMEI","PRIVATE_LETTER_OF_ATTORNEY","ARTICLES_OF_ASSOCIATION","COMPANY_BYLAWS","PUBLIC_LETTER_OF_ATTORNEY","LEGAL_STATEMENT","EIRELI_INCORPORATION_STATEMENT","EI_REGISTRATION_REQUIREMENT","DRIVER_LICENSE_FRONT","DRIVER_LICENSE_VERSE","DIGITAL_DRIVER_LICENSE","IDENTITY_CARD_FRONT","IDENTITY_CARD_VERSE","WORK_CARD","PROFESSIONAL_IDENTIFICATION_CARD","MILITARY_IDENTIFICATION_CARD","REVENUES_RECEIPT","SIGNATURE_CARD","SELFIE","EXTRAORDINARY_DOCUMENTS","RNE_VERSE","RNE_FRONT"]}}}},"required":["type","uploaded","required","one_of"]},"V1GetPendingDocumentsCompanyRegistrationRestResponse":{"type":"object","properties":{"subjects":{"description":"Authoritative document status grouped by legal person and legal representatives.","type":"array","items":{"$ref":"#/components/schemas/V1PendingDocumentsSubjectRestResponse"}}},"required":["subjects"]},"V1GetCompanyRegistrationByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Company registration ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"cnpj":{"type":"string","description":"Company CNPJ.","example":"93999833000199"},"status":{"type":"string","description":"Company registration status.","enum":["WAITING_DOCUMENTS","WAITING_ANALYSIS","WAITING_CORRECTIONS","ACTIVE","DECLINED","CANCELED"],"example":"ACTIVE"},"opening_date":{"format":"date-time","type":"string","description":"Company opening date (ISO 8601 date-time).","example":"1959-05-12T00:00:00.000Z"},"revenue":{"type":"number","description":"Company revenue.","example":201},"establishment_format":{"type":"string","description":"Establishment format.","enum":["EI","MEI","EIRELI","LTDA","SS","SA","ME","EPP","EMPG","COOP","OTHER"],"example":"ME"},"state_registration":{"type":"string","description":"State registration.","example":"12345678"},"partner_changed":{"type":"boolean","description":"Whether partners changed.","example":false},"bank_number":{"type":"string","description":"Bank number.","example":"001"},"bank_account_status":{"type":"string","description":"Bank account status.","enum":["ACTIVE","NOT_ACTIVE","PENDING","LOCKED","CLOSED"],"example":"ACTIVE"},"alias_created_date":{"type":"string","description":"Alias bank account creation date.","example":"2024-01-15T10:00:00.000Z"},"failed_code":{"type":"string","description":"Failed error code.","enum":["COMPANY_REGISTRATION_DECLINED","COMPANY_REGISTRATION_CANCELED","GATEWAY_ERROR","LOCAL_PRECONDITION_ERROR"],"example":"COMPANY_REGISTRATION_DECLINED"},"failed_message":{"type":"string","description":"Failed error message.","example":"Registration rejected."},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2024-01-15T10:00:00.000Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2024-01-15T10:00:00.000Z"}},"required":["id","cnpj","status","created_at","updated_at"]},"V1GetAllCompanyRegistrationRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Company registration ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"cnpj":{"type":"string","description":"Company CNPJ.","example":"93999833000199"},"status":{"type":"string","description":"Company registration status.","enum":["WAITING_DOCUMENTS","WAITING_ANALYSIS","WAITING_CORRECTIONS","ACTIVE","DECLINED","CANCELED"],"example":"ACTIVE"},"opening_date":{"format":"date-time","type":"string","description":"Company opening date (ISO 8601 date-time).","example":"1959-05-12T00:00:00.000Z"},"revenue":{"type":"number","description":"Company revenue.","example":201},"establishment_format":{"type":"string","description":"Establishment format.","enum":["EI","MEI","EIRELI","LTDA","SS","SA","ME","EPP","EMPG","COOP","OTHER"],"example":"ME"},"state_registration":{"type":"string","description":"State registration.","example":"12345678"},"partner_changed":{"type":"boolean","description":"Whether partners changed.","example":false},"bank_number":{"type":"string","description":"Bank number.","example":"001"},"bank_account_status":{"type":"string","description":"Bank account status.","enum":["ACTIVE","NOT_ACTIVE","PENDING","LOCKED","CLOSED"],"example":"ACTIVE"},"alias_created_date":{"type":"string","description":"Alias bank account creation date.","example":"2024-01-15T10:00:00.000Z"},"failed_code":{"type":"string","description":"Failed error code.","enum":["COMPANY_REGISTRATION_DECLINED","COMPANY_REGISTRATION_CANCELED","GATEWAY_ERROR","LOCAL_PRECONDITION_ERROR"],"example":"COMPANY_REGISTRATION_CANCELED"},"failed_message":{"type":"string","description":"Failed error message.","example":"Registration rejected."},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2024-01-15T10:00:00.000Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2024-01-15T10:00:00.000Z"}},"required":["id","cnpj","status","created_at","updated_at"]},"V1GetAllCompanyRegistrationRestResponse":{"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":"Company registrations data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllCompanyRegistrationRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1CreateVirtualCardRestResponse":{"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"]},"V1GetAllCardsRestResponseItem":{"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-29T21:41:49.677Z"},"created_at":{"format":"date-time","type":"string","description":"Card creation date.","example":"2026-05-29T21:41:49.677Z"}},"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/V1GetAllCardsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1UnblockCardRestResponse":{"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-29T21:41:49.677Z"}},"required":["id","is_virtual","status","created_at"]},"V1BlockCardRestResponse":{"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-29T21:41:49.676Z"}},"required":["id","is_virtual","status","created_at"]},"V1CardDetailsRestResponse":{"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-29T21:41:49.677Z"},"cvv":{"type":"string","description":"CVV.","example":"123"},"activated_at":{"format":"date-time","type":"string","description":"Card Activation Date.","example":"2026-05-29T21:41:49.677Z"}},"required":["id","is_virtual","status","number","card_name","expiry","cvv","activated_at"]},"V1CancelCardRestResponse":{"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-29T21:41:49.677Z"}},"required":["id","is_virtual","status","created_at"]},"V1CreatePhysicalCardBody":{"type":"object","properties":{"password":{"type":"string","description":"Card Password.","example":"0000"}},"required":["password"]},"V1CreatePhysicalCardRestResponse":{"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"]},"V1ActivateCardBody":{"type":"object","properties":{"activation_code":{"type":"string","description":"Activation Code.","example":"0000"}},"required":["activation_code"]},"V1ActivateCardRestResponse":{"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-29T21:41:49.677Z"}},"required":["id","is_virtual","status","created_at"]},"V1CreateNewPhysicalCardViaRestResponse":{"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"]},"V1ChangeCardPasswordBody":{"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"]},"V1ChangeCardPasswordRestResponse":{"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-29T21:41:49.678Z"}},"required":["id","is_virtual","status","created_at"]},"V1GetCardTrackingRestResponse":{"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"]},"V1GetTermsOfUseRestResponse":{"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"]},"V1AcceptTermsOfUseBody":{"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"]},"V1AcceptTermsOfUseRestResponse":{"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-29T21:41:49.679Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Updated At.","example":"2026-05-29T21:41:49.679Z"}},"required":["id","user_id","onboarding_id","status","created_at","updated_at"]},"V1UploadCardOnboardingDocumentRestResponse":{"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-29T21:41:49.678Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Updated At.","example":"2026-05-29T21:41:49.678Z"}},"required":["id","user_id","status","created_at","updated_at"]},"V1CreateCardOnboardingResponse":{"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-29T21:41:49.679Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Updated At.","example":"2026-05-29T21:41:49.679Z"}},"required":["id","status","created_at","updated_at"]},"V1CardOnboardingAddressInfoResponse":{"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"]},"V1CardOnboardingDocumentInfoResponse":{"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-29T21:41:49.676Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Document Updated At.","example":"2026-05-29T21:41:49.676Z"}},"required":["id","card_onboarding_id","file_id","type","created_at","updated_at"]},"V1GetCardOnboardingByIdRestResponse":{"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-29T21:41:49.676Z"},"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/V1CardOnboardingAddressInfoResponse"}]},"documents":{"description":"User card onboarding documents.","type":"array","items":{"$ref":"#/components/schemas/V1CardOnboardingDocumentInfoResponse"}},"created_at":{"format":"date-time","type":"string","description":"Card Onboarding Created At.","example":"2026-05-29T21:41:49.676Z"},"updated_at":{"format":"date-time","type":"string","description":"Card Onboarding Updated At.","example":"2026-05-29T21:41:49.676Z"}},"required":["id","user_id","birth_date","document","mother_name","name","pep","pep_since","status","address","created_at","updated_at"]},"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-29T21:41:49.680Z"},"created_at":{"format":"date-time","type":"string","description":"Pix scheduled payment creation date.","example":"2026-05-29T21:41:49.680Z"},"updated_at":{"format":"date-time","type":"string","description":"Pix scheduled payment update date.","example":"2026-05-29T21:41:49.680Z"}},"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":{"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-29T21:41:49.680Z"},"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-29T21:41:49.680Z"},"updated_at":{"format":"date-time","type":"string","description":"Authorization update date.","example":"2026-05-29T21:41:49.680Z"}},"required":["id","journey","frequency","start_date","beneficiary_ispb","beneficiary_document","beneficiary_name","owner_document","contract_number","contract_description","request_expiration_date","status"]},"GetAllPixAutomaticAuthorizationRestResponse":{"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"}}},"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-29T21:41:49.680Z"},"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-29T21:41:49.680Z"},"updated_at":{"format":"date-time","type":"string","description":"Authorization update date.","example":"2026-05-29T21:41:49.680Z"}},"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-29T21:41:49.681Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment update date.","example":"2026-05-29T21:41:49.681Z"}},"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"]},"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-29T21:41:49.681Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment update date.","example":"2026-05-29T21:41:49.681Z"}},"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-29T21:41:49.770Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment update date.","example":"2026-05-29T21:41:49.770Z"}},"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-29T21:41:49.772Z"}},"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-29T21:41:49.774Z"},"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-29T21:41:49.774Z"},"updated_at":{"format":"date-time","type":"string","description":"Recurrence update date.","example":"2026-05-29T21:41:49.774Z"}},"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-29T21:41:49.865Z"},"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-29T21:41:49.865Z"},"updated_at":{"format":"date-time","type":"string","description":"Recurrence update date.","example":"2026-05-29T21:41:49.865Z"}},"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-29T21:41:49.866Z"},"updated_at":{"format":"date-time","type":"string","description":"Charge update date.","example":"2026-05-29T21:41:49.866Z"}},"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-29T21:41:49.867Z"},"updated_at":{"format":"date-time","type":"string","description":"Charge update date.","example":"2026-05-29T21:41:49.867Z"}},"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-29T21:41:49.771Z"}},"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-29T21:41:49.771Z"}},"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-29T21:41:49.771Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:49.771Z"}},"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-29T21:41:49.771Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:49.771Z"}},"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"]},"V1GetAllOpenFinanceParticipantsRestResponseItem":{"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"]},"V1GetAllOpenFinanceParticipantsRestResponse":{"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/V1GetAllOpenFinanceParticipantsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1CreateOpenFinancePaymentConsentByPixKeyBody":{"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"]},"V1CreateOpenFinancePaymentConsentByPixKeyRestResponse":{"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-29T21:41:49.868Z"},"created_at":{"format":"date-time","type":"string","description":"Payment consent created at.","example":"2026-05-29T21:41:49.868Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T21:41:49.868Z"}},"required":["id","status","created_at","updated_at"]},"V1CreateOpenFinancePaymentConsentByPixAccountBody":{"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"]},"V1CreateOpenFinancePaymentConsentByPixAccountRestResponse":{"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-29T21:41:49.868Z"},"created_at":{"format":"date-time","type":"string","description":"Payment consent created at.","example":"2026-05-29T21:41:49.868Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T21:41:49.868Z"}},"required":["id","status","created_at","updated_at"]},"V1CreateOpenFinancePaymentConsentByQrCodeDynamicBody":{"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"]},"V1CreateOpenFinancePaymentConsentByQrCodeDynamicRestResponse":{"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-29T21:41:49.869Z"},"created_at":{"format":"date-time","type":"string","description":"Payment consent created at.","example":"2026-05-29T21:41:49.869Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T21:41:49.869Z"}},"required":["id","status","created_at","updated_at"]},"V1CreateOpenFinancePaymentConsentByQrCodeStaticBody":{"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"]},"V1CreateOpenFinancePaymentConsentByQrCodeStaticRestResponse":{"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-29T21:41:49.869Z"},"created_at":{"format":"date-time","type":"string","description":"Payment consent created at.","example":"2026-05-29T21:41:49.869Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T21:41:49.869Z"}},"required":["id","status","created_at","updated_at"]},"V1GetOpenFinancePaymentConsentByIdRestResponse":{"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-29T21:41:49.869Z"},"authorized_date":{"format":"date-time","type":"string","description":"Payment consent authorized date.","example":"2026-05-29T21:41:49.869Z"},"rejected_date":{"format":"date-time","type":"string","description":"Payment consent rejected date.","example":"2026-05-29T21:41:49.869Z"},"revoked_date":{"format":"date-time","type":"string","description":"Payment consent revoked date.","example":"2026-05-29T21:41:49.869Z"},"expired_date":{"format":"date-time","type":"string","description":"Payment consent expired date.","example":"2026-05-29T21:41:49.869Z"},"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-29T21:41:49.869Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment consent updated at.","example":"2026-05-29T21:41:49.869Z"}},"required":["id","status","amount","payment_type","created_at","updated_at"]},"V1AuthorizeWithoutRedirectOpenFinancePaymentConsentBody":{"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"]},"V1GetOpenFinancePaymentByIdRestResponse":{"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-29T21:41:49.870Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment updated at.","example":"2026-05-29T21:41:49.870Z"}},"required":["id","status","amount","created_at","updated_at"]},"V1CancelOpenFinancePaymentBody":{"type":"object","properties":{"canceled_by_document":{"type":"string","description":"Canceled by document.","example":"40995401039"}},"required":["canceled_by_document"]},"V1CancelOpenFinancePaymentRestResponse":{"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-29T21:41:49.876Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment updated at.","example":"2026-05-29T21:41:49.876Z"}},"required":["id","status","created_at","updated_at"]},"V1GetAllOpenFinancePaymentsRestResponseItem":{"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-29T21:41:49.871Z"},"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-29T21:41:49.871Z"},"created_at":{"format":"date-time","type":"string","description":"Payment created at.","example":"2026-05-29T21:41:49.871Z"},"updated_at":{"format":"date-time","type":"string","description":"Payment updated at.","example":"2026-05-29T21:41:49.871Z"}},"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"]},"V1GetAllOpenFinancePaymentsRestResponse":{"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/V1GetAllOpenFinancePaymentsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GetEnrollmentByIdRestResponse":{"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-29T21:41:49.873Z"},"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-29T21:41:49.873Z"},"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-29T21:41:49.873Z"},"updated_at":{"format":"date-time","type":"string","description":"Enrollment updated at.","example":"2026-05-29T21:41:49.873Z"}},"required":["id","status","logged_user_document","logged_user_document_type","permissions","participant_id","participant_friendly_name","created_at","updated_at"]},"V1DeviceEnrollmentPublicKeyCredentialParamRest":{"type":"object","properties":{"alg":{"type":"number","description":"Credential algorithm.","example":-257},"type":{"type":"string","description":"Credential type.","example":"public-key"}},"required":["alg","type"]},"V1DeviceEnrollmentBaseCredentialRest":{"type":"object","properties":{"id":{"type":"string","description":"Credential ID.","example":"00aa11bb22cc33dd"},"type":{"type":"string","description":"Credential type.","example":"public-key"}},"required":["id","type"]},"V1GetDeviceEnrollmentCredentialByIdRestResponse":{"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/V1DeviceEnrollmentPublicKeyCredentialParamRest"}},"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/V1DeviceEnrollmentBaseCredentialRest"}},"allow_credentials":{"description":"Device enrollment credential allow credentials.","example":[{"id":"00aa11bb22cc33dd","type":"public-key"}],"type":"array","items":{"$ref":"#/components/schemas/V1DeviceEnrollmentBaseCredentialRest"}},"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-29T21:41:49.875Z"}},"required":["enrollment_id","challenge","request_date"]},"V1GetAllEnrollmentsRestResponseItem":{"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-29T21:41:49.872Z"},"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-29T21:41:49.872Z"},"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-29T21:41:49.872Z"},"updated_at":{"format":"date-time","type":"string","description":"Enrollment updated at.","example":"2026-05-29T21:41:49.872Z"}},"required":["id","status","logged_user_document","logged_user_document_type","permissions","participant_id","participant_friendly_name","created_at","updated_at"]},"V1GetAllEnrollmentsRestResponse":{"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/V1GetAllEnrollmentsRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1RevokeEnrollmentBody":{"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"]},"V1RevokeEnrollmentRestResponse":{"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-29T21:41:49.873Z"},"updated_at":{"format":"date-time","type":"string","description":"Enrollment updated at.","example":"2026-05-29T21:41:49.873Z"}},"required":["id","status","created_at","updated_at"]},"V1CreateDeviceEnrollmentSignInBody":{"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"]},"V1CreateEnrollmentDeviceSignInRestResponse":{"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-29T21:41:49.877Z"}},"required":["id","enrollment_id","consent_id","status","created_at"]},"V1CreateDeviceEnrollmentCredentialsBody":{"type":"object","properties":{"platform":{"type":"string","description":"Platform of the device.","example":"CROSS_PLATFORM","enum":["ANDROID","IOS","BROWSER","CROSS_PLATFORM"]}},"required":["platform"]},"V1CreateEnrollmentDeviceCredentialRestResponse":{"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-29T21:41:49.875Z"}},"required":["id","enrollment_id","status","created_at"]},"V1CreateDeviceEnrollmentRiskSignalBody":{"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"]},"V1CreateDeviceEnrollmentBody":{"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"]},"V1CreateEnrollmentDeviceRestResponse":{"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-29T21:41:49.876Z"}},"required":["id","enrollment_id","status","created_at"]},"V1CreateEnrollmentBody":{"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"]},"V1CreateEnrollmentRestResponse":{"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-29T21:41:49.873Z"},"created_at":{"format":"date-time","type":"string","description":"Enrollment created at.","example":"2026-05-29T21:41:49.873Z"}},"required":["id","status","created_at"]},"AddressInfoRequest":{"type":"object","properties":{"street_line_1":{"type":"string","description":"Street line 1.","example":"123 Main Street"},"street_line_2":{"type":"string","description":"Street line 2.","example":"Suite 500"},"city":{"type":"string","description":"City.","example":"San Francisco"},"state":{"type":"string","description":"State.","example":"CA"},"subdivision":{"type":"string","description":"Subdivision (optional).","example":"CA"},"postal_code":{"type":"string","description":"Postal code.","example":"94102"},"country":{"type":"string","description":"Country.","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["street_line_1","city","state","postal_code","country"]},"V1CreateClientBody":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the client. Must be a valid string with maximum 80 characters. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"type":{"type":"string","description":"Type of client entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Country code of the client (ISO 3166-1 alpha-2).","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"nationality":{"type":"string","description":"Nationality of the client. Country name or nationality identifier. Maximum 80 characters.","example":"American"},"document":{"type":"string","description":"Official document number used for identification (e.g., passport number, ID number, tax ID). Maximum 50 characters.","example":"12345678901"},"document_type":{"type":"string","description":"Type of identification document provided. PASSPORT for passport, NATIONAL_ID for national ID card, TAX_ID for tax identification number.","example":"PASSPORT","enum":["DRIVERS_LICENSE","IDENTITY_CARD","PASSPORT","OTHERS"]},"email":{"type":"string","description":"Valid email address of the client. Used for communication and notifications. Maximum 255 characters.","example":"john.doe@example.com"},"birth_date":{"type":"string","description":"Date of birth of the client. Format: YYYY-MM-DD.","example":"1990-01-01","format":"date"},"issue_date":{"type":"string","description":"Date when the identification document was issued. Format: YYYY-MM-DD.","example":"2020-01-01","format":"date"},"issuing_country":{"type":"string","description":"Country code or name where the identification document was issued. Maximum 80 characters.","example":"USA"},"phone_number":{"type":"string","description":"Phone number of the client (digits only, e.g. country code + number).","example":"5511955551234"},"address":{"description":"Complete address information of the client.","allOf":[{"$ref":"#/components/schemas/AddressInfoRequest"}]}},"required":["name","type","nationality","document","document_type","email","address"]},"AddressInfoResponse":{"type":"object","properties":{"id":{"type":"string","description":"Address ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"street_line_1":{"type":"string","description":"Street line 1.","example":"123 Main Street"},"street_line_2":{"type":"string","description":"Street line 2.","example":"Suite 500"},"city":{"type":"string","description":"City.","example":"San Francisco"},"state":{"type":"string","description":"State.","example":"CA"},"subdivision":{"type":"string","description":"Subdivision (optional).","example":"CA"},"postal_code":{"type":"string","description":"Postal code.","example":"94102"},"country":{"type":"string","description":"Country.","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["id","street_line_1","city","state","postal_code","country"]},"V1CreateClientRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the created client.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Full name of the client. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"type":{"type":"string","description":"Type of client entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"nationality":{"type":"string","description":"Nationality of the client.","example":"American"},"document":{"type":"string","description":"Official document number used for identification.","example":"12345678901"},"document_type":{"type":"string","description":"Type of identification document.","example":"PASSPORT","enum":["DRIVERS_LICENSE","IDENTITY_CARD","PASSPORT","OTHERS"]},"email":{"type":"string","description":"Email address of the client.","example":"john.doe@example.com"},"birth_date":{"format":"date-time","type":"string","description":"Date of birth of the client. Format: YYYY-MM-DD.","example":"1990-01-01T00:00:00.000Z"},"issue_date":{"format":"date-time","type":"string","description":"Date when the identification document was issued. Format: YYYY-MM-DD.","example":"2020-01-01T00:00:00.000Z"},"issuing_country":{"type":"string","description":"Country where the identification document was issued.","example":"USA"},"address":{"description":"Complete address information of the client including street, city, state, postal code, and country.","allOf":[{"$ref":"#/components/schemas/AddressInfoResponse"}]},"status":{"type":"string","description":"Current status of the client.","example":"PENDING","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"]},"phone_number":{"type":"string","description":"Phone number of the client (digits only).","example":"5511955551234"},"created_at":{"format":"date-time","type":"string","description":"Client created date.","example":"2026-05-29T21:41:49.882Z"},"updated_at":{"format":"date-time","type":"string","description":"Client updated date.","example":"2026-05-29T21:41:49.882Z"},"country":{"type":"string","description":"Country code of the client (ISO 3166-1 alpha-2).","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"risk":{"type":"string","description":"Risk of the client.","example":"LOW","enum":["PENDING","LOW","MEDIUM","HIGH"]}},"required":["id","name","type","email","status","created_at","updated_at"]},"ClientVerificationInfoResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client verification ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"type":{"type":"string","description":"Verification type (e.g. KYC).","example":"KYC"},"provider":{"type":"string","description":"Provider name (e.g. persona).","example":"persona"},"status":{"type":"string","description":"Status: created, waiting, processed.","example":"processed"},"field_props":{"type":"object","description":"Per-field metadata or validation state for the verification."},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T21:41:49.881Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:49.881Z"}},"required":["id","type","provider","status","created_at","updated_at"]},"V1GetClientByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the client.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Full name of the client. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"document":{"type":"string","description":"Official document number used for identification.","example":"12345678901"},"country":{"type":"string","description":"Country code of the client (ISO 3166-1 alpha-2).","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"type":{"type":"string","description":"Type of client entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"pep":{"type":"boolean","description":"PEP status of the client.","example":true},"status":{"type":"string","description":"Current status of the client.","example":"ACTIVE","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"]},"risk":{"type":"string","description":"Risk of the client.","example":"LOW","enum":["PENDING","LOW","MEDIUM","HIGH"]},"email":{"type":"string","description":"Email address of the client.","example":"john.doe@example.com"},"link_url":{"type":"string","description":"Link URL to the client finished onboarding.","example":"https://www.example.com"},"created_at":{"format":"date-time","type":"string","description":"Client created date.","example":"2026-05-29T21:41:49.965Z"},"updated_at":{"format":"date-time","type":"string","description":"Client updated date.","example":"2026-05-29T21:41:49.965Z"},"client_verifications":{"description":"Client verifications: id, type, provider, status, field_props, created_at, updated_at.","type":"array","items":{"$ref":"#/components/schemas/ClientVerificationInfoResponse"}}},"required":["id","name","type","pep","status","email","created_at","updated_at"]},"V1GetAllClientRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the client.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Full name of the client. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"pep":{"type":"boolean","description":"PEP status of the client.","example":true},"document":{"type":"string","description":"Official document number used for identification.","example":"12345678901"},"country":{"type":"string","description":"Country code of the client (ISO 3166-1 alpha-2).","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"type":{"type":"string","description":"Type of client entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"status":{"type":"string","description":"Current status of the client.","example":"ACTIVE","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"]},"risk":{"type":"string","description":"Risk of the client.","example":"LOW","enum":["PENDING","LOW","MEDIUM","HIGH"]},"created_at":{"format":"date-time","type":"string","description":"Client created date.","example":"2026-05-29T21:41:49.965Z"},"updated_at":{"format":"date-time","type":"string","description":"Client updated date.","example":"2026-05-29T21:41:49.965Z"}},"required":["id","name","pep","type","status","created_at","updated_at"]},"V1GetAllClientRestResponse":{"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":"Array of client objects matching the search criteria and pagination parameters.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllClientRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"UpdateAddressInfoRequest":{"type":"object","properties":{"street_line_1":{"type":"string","description":"Street line 1.","example":"123 Main Street"},"street_line_2":{"type":"string","description":"Street line 2.","example":"Suite 500"},"city":{"type":"string","description":"City.","example":"San Francisco"},"state":{"type":"string","description":"State.","example":"CA"},"subdivision":{"type":"string","description":"Subdivision.","example":"CA"},"postal_code":{"type":"string","description":"Postal code.","example":"94102"},"country":{"type":"string","description":"Country.","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}}},"V1UpdateClientBody":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the client. Must be a valid string with maximum 80 characters. For legal entities, the name field corresponds to the legal name. Only provided fields will be updated.","example":"John Doe"},"country":{"type":"string","description":"Country code of the client (ISO 3166-1 alpha-2). Only provided fields will be updated.","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"nationality":{"type":"string","description":"Nationality of the client. Country name or nationality identifier. Maximum 80 characters. Only provided fields will be updated.","example":"American"},"email":{"type":"string","description":"Valid email address of the client. Used for communication and notifications. Maximum 255 characters. Only provided fields will be updated.","example":"john.doe@example.com"},"birth_date":{"type":"string","description":"Date of birth of the client. Format: YYYY-MM-DD. Only provided fields will be updated.","example":"1990-01-01","format":"date"},"issue_date":{"type":"string","description":"Date when the identification document was issued. Format: YYYY-MM-DD. Only provided fields will be updated.","example":"2020-01-01","format":"date"},"issuing_country":{"type":"string","description":"Country code or name where the identification document was issued. Maximum 80 characters. Only provided fields will be updated.","example":"USA"},"phone_number":{"type":"string","description":"Phone number of the client (digits only, e.g. country code + number). Only provided fields will be updated.","example":"5511955551234"},"status":{"type":"string","description":"Toggle client activity. Only ACTIVE or INACTIVE are accepted. The stored status must already be ACTIVE or INACTIVE; otherwise the request fails.","enum":["ACTIVE","INACTIVE"],"example":"INACTIVE"},"address":{"description":"Complete address information of the client. All address fields can be updated. Only provided fields will be updated.","allOf":[{"$ref":"#/components/schemas/UpdateAddressInfoRequest"}]}}},"V1UpdateClientRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the client.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Full name of the client. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"type":{"type":"string","description":"Type of client entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations. This field cannot be updated.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Country code of the client (ISO 3166-1 alpha-2).","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"nationality":{"type":"string","description":"Nationality of the client.","example":"American"},"document":{"type":"string","description":"Official document number used for identification. This field cannot be updated.","example":"12345678901"},"document_type":{"type":"string","description":"Type of identification document. PASSPORT, NATIONAL_ID, or TAX_ID. This field cannot be updated.","example":"PASSPORT","enum":["DRIVERS_LICENSE","IDENTITY_CARD","PASSPORT","OTHERS"]},"email":{"type":"string","description":"Email address of the client.","example":"john.doe@example.com"},"birth_date":{"format":"date-time","type":"string","description":"Date of birth of the client. Format: YYYY-MM-DD.","example":"1990-01-01T00:00:00.000Z"},"issue_date":{"format":"date-time","type":"string","description":"Date when the identification document was issued. Format: YYYY-MM-DD.","example":"2020-01-01T00:00:00.000Z"},"issuing_country":{"type":"string","description":"Country where the identification document was issued.","example":"USA"},"phone_number":{"type":"string","description":"Phone number of the client (digits only).","example":"5511955551234"},"address":{"description":"Complete address information of the client including street, city, state, postal code, and country.","allOf":[{"$ref":"#/components/schemas/AddressInfoResponse"}]},"status":{"type":"string","description":"Current status of the client. ACTIVE indicates the client is active and can perform transactions.","example":"ACTIVE","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"]},"created_at":{"format":"date-time","type":"string","description":"Timestamp indicating when the client record was created in the system. Format: ISO 8601.","example":"2026-05-29T21:41:49.966Z"},"updated_at":{"format":"date-time","type":"string","description":"Timestamp indicating when the client record was last updated. Format: ISO 8601.","example":"2026-05-29T21:41:49.966Z"}},"required":["id","name","type","nationality","document","document_type","email","address","status","created_at","updated_at"]},"UploadClientDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.067Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.067Z"}},"required":["id","client_id","user_id","file_id","name","type","status","created_at","updated_at"]},"GetAllClientDocumentRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Client document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.066Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.066Z"}},"required":["id","client_id","user_id","name","type","status","created_at","updated_at"]},"GetAllClientDocumentRestResponse":{"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":"Client documents data.","type":"array","items":{"$ref":"#/components/schemas/GetAllClientDocumentRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"UpdateClientDocumentBody":{"type":"object","properties":{"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"document_type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}}},"UpdateClientDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.066Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.066Z"}},"required":["id","client_id","user_id","name","type","status","created_at","updated_at"]},"V1CreateClientAccountBody":{"type":"object","properties":{"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"}},"required":["country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type"]},"V1CreateClientAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"},"status":{"type":"string","description":"Account status.","example":"ACTIVE","enum":["ACTIVE","INACTIVE","PENDING"]},"created_at":{"format":"date-time","type":"string","description":"Account created date.","example":"2026-05-29T21:41:49.971Z"},"updated_at":{"format":"date-time","type":"string","description":"Account updated date.","example":"2026-05-29T21:41:49.971Z"}},"required":["id","user_id","client_id","country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type","status","created_at","updated_at"]},"V1UpdateClientAccountBody":{"type":"object","properties":{"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"}}},"V1UpdateClientAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"},"status":{"type":"string","description":"Account status.","example":"PENDING","enum":["ACTIVE","INACTIVE","PENDING"]},"created_at":{"format":"date-time","type":"string","description":"Account created date.","example":"2026-05-29T21:41:50.065Z"},"updated_at":{"format":"date-time","type":"string","description":"Account updated date.","example":"2026-05-29T21:41:50.065Z"}},"required":["id","user_id","client_id","country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type","status","created_at","updated_at"]},"V1GetClientAccountByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"},"status":{"type":"string","description":"Account status.","example":"PENDING","enum":["ACTIVE","INACTIVE","PENDING"]},"created_at":{"format":"date-time","type":"string","description":"Account created date.","example":"2026-05-29T21:41:49.972Z"},"updated_at":{"format":"date-time","type":"string","description":"Account updated date.","example":"2026-05-29T21:41:49.972Z"}},"required":["id","user_id","client_id","country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type","status","created_at","updated_at"]},"V1GetAllClientAccountRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"},"status":{"type":"string","description":"Account status.","example":"PENDING","enum":["ACTIVE","INACTIVE","PENDING"]},"created_at":{"format":"date-time","type":"string","description":"Account created date.","example":"2026-05-29T21:41:49.973Z"},"updated_at":{"format":"date-time","type":"string","description":"Account updated date.","example":"2026-05-29T21:41:49.973Z"}},"required":["id","user_id","client_id","country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type","status","created_at","updated_at"]},"V1GetAllClientAccountRestResponse":{"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":"Client accounts data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllClientAccountRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1CreateClientWalletBody":{"type":"object","properties":{"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"}},"required":["name","address","network"]},"V1CreateClientWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"},"status":{"type":"string","description":"Wallet status.","enum":["ACTIVE","INACTIVE","PENDING","BLOCKED"],"example":"ACTIVE"},"created_at":{"format":"date-time","type":"string","description":"Wallet created date.","example":"2026-05-29T21:41:50.166Z"},"updated_at":{"format":"date-time","type":"string","description":"Wallet updated date.","example":"2026-05-29T21:41:50.166Z"}},"required":["id","user_id","client_id","name","address","network","status","created_at","updated_at"]},"V1GetAllClientWalletRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"},"status":{"type":"string","description":"Wallet status.","enum":["ACTIVE","INACTIVE","PENDING","BLOCKED"],"example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Wallet created date.","example":"2026-05-29T21:41:50.167Z"},"updated_at":{"format":"date-time","type":"string","description":"Wallet updated date.","example":"2026-05-29T21:41:50.167Z"}},"required":["id","user_id","client_id","name","address","network","status","created_at","updated_at"]},"V1GetAllClientWalletRestResponse":{"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":"Client wallets data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllClientWalletRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GetClientWalletByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"},"status":{"type":"string","description":"Wallet status.","enum":["ACTIVE","INACTIVE","PENDING","BLOCKED"],"example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Wallet created date.","example":"2026-05-29T21:41:50.168Z"},"updated_at":{"format":"date-time","type":"string","description":"Wallet updated date.","example":"2026-05-29T21:41:50.168Z"}},"required":["id","user_id","client_id","name","address","network","status","created_at","updated_at"]},"V1UpdateClientWalletBody":{"type":"object","properties":{"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"}}},"V1UpdateClientWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"},"status":{"type":"string","description":"Wallet status.","enum":["ACTIVE","INACTIVE","PENDING","BLOCKED"],"example":"ACTIVE"},"created_at":{"format":"date-time","type":"string","description":"Wallet created date.","example":"2026-05-29T21:41:50.169Z"},"updated_at":{"format":"date-time","type":"string","description":"Wallet updated date.","example":"2026-05-29T21:41:50.169Z"}},"required":["id","user_id","client_id","name","address","network","status","created_at","updated_at"]},"UploadClientWalletDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client wallet document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_wallet_id":{"type":"string","description":"Client Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.072Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.072Z"}},"required":["id","client_wallet_id","user_id","file_id","name","type","status","created_at","updated_at"]},"ClientWalletDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client wallet document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_wallet_id":{"type":"string","description":"Client wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.071Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.071Z"}},"required":["id","client_wallet_id","user_id","name","type","status","created_at","updated_at"]},"GetAllClientWalletDocumentRestResponse":{"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":"Client wallet documents data.","type":"array","items":{"$ref":"#/components/schemas/ClientWalletDocumentRestResponse"}}},"required":["page","page_size","page_total","total","data"]},"UpdateClientWalletDocumentBody":{"type":"object","properties":{"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"document_type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}}},"UpdateClientWalletDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client wallet document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_wallet_id":{"type":"string","description":"Client wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.071Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.071Z"}},"required":["id","client_wallet_id","user_id","name","type","status","created_at","updated_at"]},"V1GetAllBusinessStructureAddressRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Address ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"street_line_1":{"type":"string","description":"Street line 1.","example":"Avenida Paulista"},"street_line_2":{"type":"string","description":"Street line 2.","example":"Apto 1001"},"city":{"type":"string","description":"City.","example":"Sao Paulo"},"state":{"type":"string","description":"State or region.","example":"SP"},"subdivision":{"type":"string","description":"Subdivision.","example":"BR"},"postal_code":{"type":"string","description":"Postal code.","example":"01310100"},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"BR"},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T21:41:50.165Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:50.165Z"}},"required":["id","street_line_1","city","state","subdivision","postal_code","country","created_at","updated_at"]},"V1GetAllBusinessStructureRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Business structure ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Name.","example":"John Doe"},"email":{"type":"string","description":"Email.","example":"john.doe@example.com"},"position":{"type":"string","description":"Position or role.","example":"Legal Representative"},"participation_percentage":{"type":"number","description":"Participation percentage.","example":50},"is_control_person":{"type":"boolean","description":"Whether this entry is a control person.","example":false},"status":{"type":"string","description":"Status.","example":"ACTIVE"},"risk_flag":{"type":"string","description":"Risk flag.","example":"LOW"},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T21:41:50.166Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:50.166Z"},"address":{"description":"Address.","allOf":[{"$ref":"#/components/schemas/V1GetAllBusinessStructureAddressRestResponseItem"}]}},"required":["id","client_id","name","is_control_person","created_at","updated_at"]},"V1GetAllBusinessStructureRestResponse":{"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":"Business structure data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllBusinessStructureRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"UploadClientAccountDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client account document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"account_id":{"type":"string","description":"Account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:49.968Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:49.968Z"}},"required":["id","client_id","account_id","user_id","file_id","name","type","status","created_at","updated_at"]},"GetAllClientAccountDocumentRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Client account document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"account_id":{"type":"string","description":"Account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:49.968Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:49.968Z"}},"required":["id","client_id","account_id","user_id","file_id","name","type","status","created_at","updated_at"]},"GetAllClientAccountDocumentRestResponse":{"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":"Client account documents data.","type":"array","items":{"$ref":"#/components/schemas/GetAllClientAccountDocumentRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"UpdateClientAccountDocumentBody":{"type":"object","properties":{"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"document_type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}}},"UpdateClientAccountDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client account document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"account_id":{"type":"string","description":"Account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:49.968Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:49.968Z"}},"required":["id","client_id","account_id","user_id","file_id","name","type","status","created_at","updated_at"]},"UploadQuoteDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Quote document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"quote_id":{"type":"string","description":"Quote ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.466Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.466Z"}},"required":["id","quote_id","user_id","file_id","name","type","status","created_at","updated_at"]},"AssignFileQuoteDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Quote document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"quote_id":{"type":"string","description":"Quote ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.375Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.375Z"}},"required":["id","quote_id","user_id","wallet_id","name","type","status","created_at","updated_at"]},"UpdateQuoteDocumentBody":{"type":"object","properties":{"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"document_type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}}},"UpdateQuoteDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Quote document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"quote_id":{"type":"string","description":"Quote ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.375Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.375Z"}},"required":["id","quote_id","user_id","wallet_id","name","type","status","created_at","updated_at"]},"UpdateCounterpartyDocumentBody":{"type":"object","properties":{"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"document_type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]}}},"UpdateCounterpartyDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Counterparty document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Counterparty ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.369Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.369Z"}},"required":["id","counterparty_id","user_id","file_id"]},"CounterpartyDocumentGetAllRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Counterparty document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Counterparty ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.368Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.368Z"}},"required":["id","counterparty_id","user_id","file_id","created_at"]},"GetAllCounterpartyDocumentRestResponse":{"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":"Counterparty documents data.","type":"array","items":{"$ref":"#/components/schemas/CounterpartyDocumentGetAllRestResponse"}}},"required":["page","page_size","page_total","total","data"]},"UploadCounterpartyDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Counterparty document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Counterparty ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.369Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.369Z"}},"required":["id","counterparty_id","user_id","file_id","created_at"]},"Object":{"type":"object","properties":{}},"QuoteDocumentRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Quote document ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"quote_id":{"type":"string","description":"Quote ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_id":{"type":"string","description":"File ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Document name.","example":"Identity Document"},"description":{"type":"string","description":"Document description.","example":"Front side of identity document"},"type":{"type":"string","description":"Document type.","example":"IDENTITY","enum":["IDENTITY","PROOF_OF_ADDRESS","BANK_STATEMENT","INVOICE","CONTRACT","OTHER"]},"status":{"type":"string","description":"Document status.","example":"PENDING_ANALYSIS","enum":["PENDING_ANALYSIS","APPROVED","REJECTED"]},"rejection_reason":{"type":"string","description":"Document rejection reason.","example":"Document is expired"},"created_at":{"format":"date-time","type":"string","description":"Document created date.","example":"2026-05-29T21:41:50.375Z"},"updated_at":{"format":"date-time","type":"string","description":"Document updated date.","example":"2026-05-29T21:41:50.375Z"}},"required":["id","quote_id","user_id","wallet_id","name","type","status","created_at","updated_at"]},"GetAllQuoteDocumentRestResponse":{"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":"Quote documents data.","type":"array","items":{"$ref":"#/components/schemas/QuoteDocumentRestResponse"}}},"required":["page","page_size","page_total","total","data"]},"RateFeeRestItem":{"type":"object","properties":{"name":{"type":"string","description":"Fee name.","example":"SYSTEM_SPREAD","enum":["SYSTEM_SPREAD","CLIENT_EXTRA_SPREAD","IOF"]},"fee":{"type":"number","description":"Fee.","example":1},"fee_format":{"type":"string","description":"Fee format.","example":"PERCENTAGE","enum":["PERCENTAGE"]},"amount":{"type":"number","description":"Fee total amount charged in cents.","example":100},"amount_decimals":{"type":"number","description":"Amount decimals.","example":4},"amount_currency_symbol":{"type":"string","description":"Amount currency symbol.","example":"BRL","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]}},"required":["name","fee","fee_format","amount","amount_decimals","amount_currency_symbol"]},"RateRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Rate ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"base_currency_symbol":{"type":"string","description":"Base currency symbol.","example":"USD","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]},"base_currency_decimals":{"type":"number","description":"Base currency decimals.","example":2},"quote_currency_symbol":{"type":"string","description":"Quote currency symbol.","example":"BRL","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]},"quote_currency_decimals":{"type":"number","description":"Quote currency decimals.","example":2},"side":{"type":"string","description":"Side.","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Price.","example":5.1234},"price_decimals":{"type":"number","description":"Price decimals.","example":4},"fees":{"description":"Fees charged.","type":"array","items":{"$ref":"#/components/schemas/RateFeeRestItem"}},"vet":{"type":"number","description":"VET.","example":5.1234},"base_currency_amount":{"type":"number","description":"Base currency amount in cents.","example":10000},"quote_currency_amount":{"type":"number","description":"Quote currency amount in cents.","example":51234},"settlement_date_code":{"type":"string","description":"Settlement date code.","example":"D0","enum":["D0","D1","D2"]},"settlement_date":{"type":"string","description":"Settlement date in YYYY-MM-DD format.","example":"2026-05-29","format":"date"},"expires_at":{"format":"date-time","type":"string","description":"Expiration date in YYYY-MM-DDTHH:mm:ss.SSSZ format.","example":"2026-05-29T21:41:50.372Z"},"created_at":{"format":"date-time","type":"string","description":"Creation date in YYYY-MM-DDTHH:mm:ss.SSSZ format.","example":"2026-05-29T21:41:50.372Z"}},"required":["id","base_currency_symbol","base_currency_decimals","quote_currency_symbol","quote_currency_decimals","side","price","price_decimals","fees","vet","base_currency_amount","quote_currency_amount","settlement_date_code","settlement_date","expires_at","created_at"]},"GetAllQuotePurposeRestResponseItem":{"type":"object","properties":{"tag":{"type":"string","description":"Quote purpose tag.","example":"INTERNATIONAL_PERSONAL_REMITTANCE"},"description":{"type":"string","description":"Description.","example":"Payment for services"}},"required":["tag","description"]},"GetAllQuotePurposeRestResponse":{"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":"Quotes data.","type":"array","items":{"$ref":"#/components/schemas/GetAllQuotePurposeRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GenerateQuoteTrackingRestResponse":{"type":"object","properties":{"url":{"type":"string","description":"Generated tracking URL.","example":"https://app.example.com/quote/tracking?v=encrypted_data"}},"required":["url"]},"CreateQuoteBody":{"type":"object","properties":{"rate_id":{"type":"string","description":"Rate ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Counterparty ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_account_id":{"type":"string","description":"Client account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_wallet_id":{"type":"string","description":"Client wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_account_id":{"type":"string","description":"Counterparty account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_wallet_id":{"type":"string","description":"Counterparty wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"description":{"type":"string","description":"Description.","example":"Payment for services"},"purpose":{"type":"string","description":"Purpose of the quote.","example":"INTERNATIONAL_PERSONAL_REMITTANCE"}},"required":["rate_id","client_id","counterparty_id","purpose"]},"ClientRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Client name. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"email":{"type":"string","description":"Client email.","example":"john.doe@example.com"},"type":{"type":"string","description":"Client type.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Client country.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"phone_number":{"type":"string","description":"Client phone number.","example":"+5511999999999"},"document":{"type":"string","description":"Client document.","example":"12345678901"}},"required":["id","name"]},"ClientAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"account_type":{"type":"string","description":"Client account type.","example":"CHECKING","enum":["CHECKING","SAVINGS"]},"account_number":{"type":"string","description":"Client account number.","example":"12345-6"},"account_name":{"type":"string","description":"Friendly client account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Client branch.","example":"0001"},"bank_name":{"type":"string","description":"Client bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Client bank code.","example":"001"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"}},"required":["id"]},"ClientWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"}},"required":["id"]},"CounterpartyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Counterparty ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Counterparty name. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"nickname":{"type":"string","description":"Nickname to identify the counterparty.","example":"Doe"},"type":{"type":"string","description":"Counterparty type.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Counterparty country.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"relationship":{"type":"string","description":"Relationship to the beneficiary.","example":"FAMILY","enum":["EMPLOYEE","CONTRACTOR","VENDOR","SUBSIDIARY","MERCHANT","CUSTOMER","LANDLORD","FAMILY","OTHER"]},"status":{"type":"string","description":"Counterparty lifecycle / verification status.","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"],"example":"ACTIVE"},"created_at":{"format":"date-time","type":"string","description":"Counterparty created date.","example":"2026-05-29T21:41:50.372Z"},"updated_at":{"format":"date-time","type":"string","description":"Counterparty updated date.","example":"2026-05-29T21:41:50.372Z"}},"required":["id","name"]},"CounterpartyAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Counterparty account ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"account_type":{"type":"string","description":"Counterparty account type.","example":"CHECKING","enum":["CHECKING","SAVINGS"]},"account_number":{"type":"string","description":"Counterparty account number.","example":"12345-6"},"account_name":{"type":"string","description":"Friendly counterparty account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Counterparty branch.","example":"0001"},"bank_name":{"type":"string","description":"Counterparty bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Counterparty bank code.","example":"001"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"}},"required":["id"]},"CounterpartyWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Counterparty wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"}},"required":["id"]},"DepositInfoRestResponse":{"type":"object","properties":{"currency_symbol":{"type":"string","description":"Currency symbol.","example":"BRL","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]},"country_code":{"type":"string","description":"Country code.","example":"BR","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"type":{"type":"string","description":"Type.","example":"TED","enum":["TED"]},"details":{"type":"string","description":"Beneficiary document.","example":"12345678901"}},"required":["currency_symbol","type","details"]},"CreateQuoteRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Quote ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Status.","example":"PENDING","enum":["PENDING","PAID","SETTLED","FAILED","BLOCKED"]},"rate":{"description":"Rate.","allOf":[{"$ref":"#/components/schemas/RateRestResponse"}]},"client":{"description":"Client.","allOf":[{"$ref":"#/components/schemas/ClientRestResponse"}]},"client_account":{"description":"Client account.","allOf":[{"$ref":"#/components/schemas/ClientAccountRestResponse"}]},"client_wallet":{"description":"Client wallet.","allOf":[{"$ref":"#/components/schemas/ClientWalletRestResponse"}]},"counterparty":{"description":"Counterparty.","allOf":[{"$ref":"#/components/schemas/CounterpartyRestResponse"}]},"counterparty_account":{"description":"Counterparty account.","allOf":[{"$ref":"#/components/schemas/CounterpartyAccountRestResponse"}]},"counterparty_wallet":{"description":"Counterparty wallet.","allOf":[{"$ref":"#/components/schemas/CounterpartyWalletRestResponse"}]},"deposit_info":{"description":"Deposit info.","allOf":[{"$ref":"#/components/schemas/DepositInfoRestResponse"}]},"description":{"type":"string","description":"Description.","example":"Payment for services"},"purpose":{"type":"string","description":"Purpose of the quote.","example":"INTERNATIONAL_PERSONAL_REMITTANCE"},"created_at":{"format":"date-time","type":"string","description":"Quote created date.","example":"2026-05-29T21:41:50.372Z"}},"required":["id","status","rate","client","client_account","client_wallet","counterparty","deposit_info","created_at"]},"TransactionVerificationRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Transaction verification ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"quote_id":{"type":"string","description":"Quote ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"type":{"type":"string","description":"Transaction verification type (e.g. provider or workflow key).","example":"chainalysis"},"props":{"type":"object","description":"Provider or workflow payload for the verification."},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T21:41:50.375Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:50.375Z"}},"required":["id","type","created_at","updated_at"]},"GetAllQuoteRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Quote ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Status.","example":"PENDING","enum":["PENDING","PAID","SETTLED","FAILED","BLOCKED"]},"rate":{"description":"Rate.","allOf":[{"$ref":"#/components/schemas/RateRestResponse"}]},"client":{"description":"Client.","allOf":[{"$ref":"#/components/schemas/ClientRestResponse"}]},"client_account":{"description":"Client account.","allOf":[{"$ref":"#/components/schemas/ClientAccountRestResponse"}]},"client_wallet":{"description":"Client wallet.","allOf":[{"$ref":"#/components/schemas/ClientWalletRestResponse"}]},"counterparty":{"description":"Counterparty.","allOf":[{"$ref":"#/components/schemas/CounterpartyRestResponse"}]},"counterparty_account":{"description":"Counterparty account.","allOf":[{"$ref":"#/components/schemas/CounterpartyAccountRestResponse"}]},"counterparty_wallet":{"description":"Counterparty wallet.","allOf":[{"$ref":"#/components/schemas/CounterpartyWalletRestResponse"}]},"deposit_info":{"description":"Deposit info.","allOf":[{"$ref":"#/components/schemas/DepositInfoRestResponse"}]},"quote_documents":{"description":"Quote documents.","type":"array","items":{"$ref":"#/components/schemas/QuoteDocumentRestResponse"}},"transaction_verifications":{"description":"Transaction verifications linked to the quote, when present.","type":"array","items":{"$ref":"#/components/schemas/TransactionVerificationRestResponse"}},"wallet_owner_name":{"type":"string","description":"Wallet owner (company) name.","example":"Acme Corp LTDA"},"description":{"type":"string","description":"Description.","example":"Payment for services"},"purpose":{"type":"string","description":"Purpose of the quote.","example":"INTERNATIONAL_PERSONAL_REMITTANCE"},"approval_at":{"format":"date-time","type":"string","description":"Approval date.","example":"2026-05-29T21:41:50.375Z"},"paid_at":{"format":"date-time","type":"string","description":"Paid date.","example":"2026-05-29T21:41:50.375Z"},"settled_at":{"format":"date-time","type":"string","description":"Settled date.","example":"2026-05-29T21:41:50.375Z"},"failure_at":{"format":"date-time","type":"string","description":"Failure date.","example":"2026-05-29T21:41:50.375Z"},"created_at":{"format":"date-time","type":"string","description":"Quote created date.","example":"2026-05-29T21:41:50.375Z"},"updated_at":{"format":"date-time","type":"string","description":"Quote updated date.","example":"2026-05-29T21:41:50.375Z"}},"required":["id","status","rate","client","client_account","client_wallet","counterparty","deposit_info","quote_documents","created_at","updated_at"]},"GetAllQuoteRestResponse":{"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":"Quotes data.","type":"array","items":{"$ref":"#/components/schemas/GetAllQuoteRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"GetQuoteByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Quote ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"status":{"type":"string","description":"Status.","example":"PENDING","enum":["PENDING","PAID","SETTLED","FAILED","BLOCKED"]},"rate":{"description":"Rate.","allOf":[{"$ref":"#/components/schemas/RateRestResponse"}]},"client":{"description":"Client.","allOf":[{"$ref":"#/components/schemas/ClientRestResponse"}]},"client_account":{"description":"Client account.","allOf":[{"$ref":"#/components/schemas/ClientAccountRestResponse"}]},"client_wallet":{"description":"Client wallet.","allOf":[{"$ref":"#/components/schemas/ClientWalletRestResponse"}]},"counterparty":{"description":"Counterparty.","allOf":[{"$ref":"#/components/schemas/CounterpartyRestResponse"}]},"counterparty_account":{"description":"Counterparty account.","allOf":[{"$ref":"#/components/schemas/CounterpartyAccountRestResponse"}]},"counterparty_wallet":{"description":"Counterparty wallet.","allOf":[{"$ref":"#/components/schemas/CounterpartyWalletRestResponse"}]},"deposit_info":{"description":"Deposit info.","allOf":[{"$ref":"#/components/schemas/DepositInfoRestResponse"}]},"quote_documents":{"description":"Quote documents.","type":"array","items":{"$ref":"#/components/schemas/QuoteDocumentRestResponse"}},"transaction_verifications":{"description":"Transaction verifications linked to the quote, when present.","type":"array","items":{"$ref":"#/components/schemas/TransactionVerificationRestResponse"}},"wallet_owner_name":{"type":"string","description":"Wallet owner (company) name.","example":"Acme Corp LTDA"},"description":{"type":"string","description":"Description.","example":"Payment for services"},"purpose":{"type":"string","description":"Purpose of the quote.","example":"INTERNATIONAL_PERSONAL_REMITTANCE"},"approval_at":{"format":"date-time","type":"string","description":"Approval date.","example":"2026-05-29T21:41:50.375Z"},"paid_at":{"format":"date-time","type":"string","description":"Paid date.","example":"2026-05-29T21:41:50.375Z"},"settled_at":{"format":"date-time","type":"string","description":"Settled date.","example":"2026-05-29T21:41:50.375Z"},"failure_at":{"format":"date-time","type":"string","description":"Failure date.","example":"2026-05-29T21:41:50.375Z"},"created_at":{"format":"date-time","type":"string","description":"Quote created date.","example":"2026-05-29T21:41:50.375Z"},"updated_at":{"format":"date-time","type":"string","description":"Quote updated date.","example":"2026-05-29T21:41:50.375Z"}},"required":["id","status","rate","client","client_account","client_wallet","counterparty","deposit_info","quote_documents","created_at","updated_at"]},"V1PayQuoteRestResponse":{"type":"object","properties":{"pix_qr_code_id":{"type":"string","description":"Pix QR Code ID.","example":"8b265a25-186d-41ed-984c-6b542406fa86"},"expiration_date":{"format":"date-time","type":"string","description":"Payment expiration date.","example":"2024-12-31T23:59:59Z"},"amount":{"type":"number","description":"Payment Amount in R$ cents.","example":100050},"created_at":{"format":"date-time","type":"string","description":"Payment created date.","example":"2026-05-29T21:41:50.376Z"}},"required":["pix_qr_code_id","amount","created_at"]},"GetQuoteReceiptRestResponse":{"type":"object","properties":{"receipt_data":{"type":"object","description":"Receipt data (Rate ID, Client, Counterparty, Amounts, etc)."},"receipt_title":{"type":"string","description":"Receipt title.","example":"Crossborder quote receipt."},"quote_id":{"type":"string","description":"Quote ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"reference_id":{"type":"string","description":"Reference ID.","example":"123456"}},"required":["receipt_data","receipt_title","quote_id"]},"GenerateQuoteReceiptRestResponse":{"type":"object","properties":{"file_id":{"type":"string","description":"Generated file ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"file_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-29T21:41:50.373Z"}},"required":["file_id","file_state","created_at"]},"V1CreateCounterpartyBody":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the counterparty. Must be a valid string with maximum 80 characters. For legal entities, the name field corresponds to the legal name.","example":"John"},"nickname":{"type":"string","description":"Nickname to identify the counterparty.","example":"Doe"},"type":{"type":"string","description":"Type of counterparty entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Country code.","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"relationship":{"type":"string","description":"Relationship to the beneficiary.","example":"FAMILY","enum":["EMPLOYEE","CONTRACTOR","VENDOR","SUBSIDIARY","MERCHANT","CUSTOMER","LANDLORD","FAMILY","OTHER"]},"address":{"description":"Complete address information of the counterparty.","allOf":[{"$ref":"#/components/schemas/AddressInfoRequest"}]},"reference_id":{"type":"string","description":"Reference ID.","example":"1234567890"}},"required":["name","type","country","relationship","address"]},"V1CreateCounterpartyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the created counterparty.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Full name of the counterparty. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"nickname":{"type":"string","description":"Nickname to identify the counterparty.","example":"Doe"},"type":{"type":"string","description":"Type of counterparty entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Country code.","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"relationship":{"type":"string","description":"Relationship to the beneficiary.","example":"FAMILY","enum":["EMPLOYEE","CONTRACTOR","VENDOR","SUBSIDIARY","MERCHANT","CUSTOMER","LANDLORD","FAMILY","OTHER"]},"risk":{"type":"string","description":"Counterparty risk.","example":"PENDING","enum":["PENDING","LOW","MEDIUM","HIGH"]},"status":{"type":"string","description":"Counterparty lifecycle / verification status (e.g. ACTIVE, INACTIVE, PENDING).","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"],"example":"ACTIVE"},"address":{"description":"Persisted address for the counterparty.","allOf":[{"$ref":"#/components/schemas/AddressInfoResponse"}]},"reference_id":{"type":"string","description":"Reference ID.","example":"1234567890"},"created_at":{"format":"date-time","type":"string","description":"Counterparty created date.","example":"2026-05-29T21:41:50.170Z"},"updated_at":{"format":"date-time","type":"string","description":"Counterparty updated date.","example":"2026-05-29T21:41:50.170Z"}},"required":["id","name","type","country","relationship","status","created_at","updated_at"]},"CounterpartyVerificationInfoResponse":{"type":"object","properties":{"id":{"type":"string","description":"Counterparty verification ID.","example":"8fc58500-b12e-49d7-892c-dfd704b94c2d"},"type":{"type":"string","description":"Verification type (e.g. KYC).","example":"KYC"},"provider":{"type":"string","description":"Provider name (e.g. persona).","example":"persona"},"status":{"type":"string","description":"Status: created, waiting, processed.","example":"processed"},"field_props":{"type":"object","description":"Per-field metadata or validation state for the verification."},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T21:41:49.881Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:49.881Z"}},"required":["id","type","provider","status","created_at","updated_at"]},"V1GetCounterpartyByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the counterparty.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Full name of the counterparty. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"nickname":{"type":"string","description":"Nickname to identify the counterparty.","example":"Doe"},"type":{"type":"string","description":"Type of counterparty entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"relationship":{"type":"string","description":"Relationship to the beneficiary.","example":"FAMILY","enum":["EMPLOYEE","CONTRACTOR","VENDOR","SUBSIDIARY","MERCHANT","CUSTOMER","LANDLORD","FAMILY","OTHER"]},"risk":{"type":"string","description":"Counterparty risk.","example":"LOW","enum":["PENDING","LOW","MEDIUM","HIGH"]},"pep":{"type":"boolean","description":"PEP status of the counterparty.","example":true},"status":{"type":"string","description":"Counterparty lifecycle / verification status (e.g. ACTIVE, INACTIVE, PENDING).","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"],"example":"ACTIVE"},"address":{"description":"Address on file for the counterparty.","allOf":[{"$ref":"#/components/schemas/AddressInfoResponse"}]},"reference_id":{"type":"string","description":"Reference ID.","example":"1234567890"},"counterparty_verifications":{"description":"Counterparty verifications: id, type, provider, status, field_props, created_at, updated_at.","type":"array","items":{"$ref":"#/components/schemas/CounterpartyVerificationInfoResponse"}},"created_at":{"format":"date-time","type":"string","description":"Counterparty created date.","example":"2026-05-29T21:41:50.276Z"},"updated_at":{"format":"date-time","type":"string","description":"Counterparty updated date.","example":"2026-05-29T21:41:50.276Z"}},"required":["id","name","type","pep","status","created_at","updated_at"]},"V1GetAllCounterpartyRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the counterparty.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Full name of the counterparty. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"nickname":{"type":"string","description":"Nickname to identify the counterparty.","example":"Doe"},"type":{"type":"string","description":"Type of counterparty entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"relationship":{"type":"string","description":"Relationship to the beneficiary.","example":"FAMILY","enum":["EMPLOYEE","CONTRACTOR","VENDOR","SUBSIDIARY","MERCHANT","CUSTOMER","LANDLORD","FAMILY","OTHER"]},"risk":{"type":"string","description":"Counterparty risk.","example":"LOW","enum":["PENDING","LOW","MEDIUM","HIGH"]},"pep":{"type":"boolean","description":"PEP status of the counterparty.","example":true},"status":{"type":"string","description":"Counterparty lifecycle / verification status (e.g. ACTIVE, INACTIVE, PENDING).","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"],"example":"ACTIVE"},"reference_id":{"type":"string","description":"Reference ID.","example":"1234567890"},"created_at":{"format":"date-time","type":"string","description":"Counterparty created date.","example":"2026-05-29T21:41:50.275Z"},"updated_at":{"format":"date-time","type":"string","description":"Counterparty updated date.","example":"2026-05-29T21:41:50.275Z"}},"required":["id","name","type","pep","status","created_at","updated_at"]},"V1GetAllCounterpartyRestResponse":{"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":"Array of counterparty objects matching the search criteria and pagination parameters.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllCounterpartyRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1UpdateCounterpartyBody":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the counterparty. Maximum 80 characters. For legal entities, the name field corresponds to the legal name. Only provided fields are updated.","example":"John Doe"},"nickname":{"type":"string","description":"Nickname to identify the counterparty.","example":"Doe"},"type":{"type":"string","description":"Counterparty type. NATURAL_PERSON or LEGAL_PERSON. Only provided fields are updated.","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Country code. Only provided fields are updated.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"relationship":{"type":"string","description":"Relationship to the beneficiary. Maximum 255 characters. Only provided fields are updated.","example":"FAMILY","enum":["EMPLOYEE","CONTRACTOR","VENDOR","SUBSIDIARY","MERCHANT","CUSTOMER","LANDLORD","FAMILY","OTHER"]},"status":{"type":"string","description":"Toggle activity when the counterparty is already ACTIVE or INACTIVE.","enum":["ACTIVE","INACTIVE"],"example":"INACTIVE"},"reference_id":{"type":"string","description":"Reference ID.","example":"1234567890"},"address":{"description":"Structured address. Only provided fields are updated.","allOf":[{"$ref":"#/components/schemas/UpdateAddressInfoRequest"}]}}},"V1UpdateCounterpartyRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the counterparty.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Full name of the counterparty. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"nickname":{"type":"string","description":"Nickname to identify the counterparty.","example":"Doe"},"type":{"type":"string","description":"Type of counterparty entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"relationship":{"type":"string","description":"Relationship to the beneficiary.","example":"FAMILY","enum":["EMPLOYEE","CONTRACTOR","VENDOR","SUBSIDIARY","MERCHANT","CUSTOMER","LANDLORD","FAMILY","OTHER"]},"risk":{"type":"string","description":"Counterparty risk.","example":"LOW","enum":["PENDING","LOW","MEDIUM","HIGH"]},"status":{"type":"string","description":"Counterparty lifecycle / verification status (e.g. ACTIVE, INACTIVE, PENDING).","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"],"example":"ACTIVE"},"reference_id":{"type":"string","description":"Reference ID.","example":"1234567890"},"address":{"description":"Address on file for the counterparty.","allOf":[{"$ref":"#/components/schemas/AddressInfoResponse"}]},"created_at":{"format":"date-time","type":"string","description":"Counterparty created date.","example":"2026-05-29T21:41:50.365Z"},"updated_at":{"format":"date-time","type":"string","description":"Counterparty updated date.","example":"2026-05-29T21:41:50.365Z"}},"required":["id","name","type","relationship","status","created_at","updated_at"]},"V1CreateCounterpartyAccountBody":{"type":"object","properties":{"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Bank account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name. Maximum 200 characters.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account. Maximum 100 characters.","example":"Main USD"},"branch":{"type":"string","description":"Branch number. Maximum 20 characters.","example":"0001"},"bank_name":{"type":"string","description":"Bank name. Maximum 200 characters.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code. Maximum 20 characters.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code. Maximum 50 characters.","example":"021000021"}},"required":["country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type"]},"V1CreateCounterpartyAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the created account.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"Unique identifier (UUID) of the user.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Unique identifier (UUID) of the counterparty.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Bank account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"},"status":{"type":"string","description":"Account status.","enum":["ACTIVE","INACTIVE","PENDING"],"example":"ACTIVE"},"created_at":{"format":"date-time","type":"string","description":"Account created date.","example":"2026-05-29T21:41:50.365Z"},"updated_at":{"format":"date-time","type":"string","description":"Account updated date.","example":"2026-05-29T21:41:50.365Z"}},"required":["id","user_id","counterparty_id","country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type","created_at","updated_at"]},"V1GetCounterpartyAccountByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the account.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"Unique identifier (UUID) of the user.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Unique identifier (UUID) of the counterparty.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Bank account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"},"status":{"type":"string","description":"Account status.","enum":["ACTIVE","INACTIVE","PENDING"],"example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Account created date.","example":"2026-05-29T21:41:50.366Z"},"updated_at":{"format":"date-time","type":"string","description":"Account updated date.","example":"2026-05-29T21:41:50.366Z"}},"required":["id","user_id","counterparty_id","country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type","created_at","updated_at"]},"V1GetAllCounterpartyAccountRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the account.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"Unique identifier (UUID) of the user.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Unique identifier (UUID) of the counterparty.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Bank account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"},"status":{"type":"string","description":"Account status.","enum":["ACTIVE","INACTIVE","PENDING"],"example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Account created date.","example":"2026-05-29T21:41:50.367Z"},"updated_at":{"format":"date-time","type":"string","description":"Account updated date.","example":"2026-05-29T21:41:50.367Z"}},"required":["id","user_id","counterparty_id","country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type","created_at","updated_at"]},"V1GetAllCounterpartyAccountRestResponse":{"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":"Counterparty accounts data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllCounterpartyAccountRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1UpdateCounterpartyAccountBody":{"type":"object","properties":{"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Bank account number. Maximum 50 characters.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name. Maximum 200 characters.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account. Maximum 100 characters.","example":"Main USD"},"branch":{"type":"string","description":"Branch number. Maximum 20 characters.","example":"0001"},"bank_name":{"type":"string","description":"Bank name. Maximum 200 characters.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code. Maximum 20 characters.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code. Maximum 50 characters.","example":"021000021"}}},"V1UpdateCounterpartyAccountRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the account.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"Unique identifier (UUID) of the user.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Unique identifier (UUID) of the counterparty.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"country":{"type":"string","description":"Country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"account_type":{"type":"string","description":"Account type.","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"account_number":{"type":"string","description":"Bank account number.","example":"12345678"},"account_name":{"type":"string","description":"Friendly account name.","example":"USD operating account"},"nickname":{"type":"string","description":"Friendly nickname for the account.","example":"Main USD"},"branch":{"type":"string","description":"Branch number.","example":"0001"},"bank_name":{"type":"string","description":"Bank name.","example":"Bank of America"},"bank_code":{"type":"string","description":"Bank code.","example":"BOFAUS3N"},"bank_code_type":{"type":"string","description":"Bank code type.","enum":["ABA","BIC","FEBRABAN","IBAN","CLABE","CBU","BSB","IFSC","SORT_CODE","TRANSIT_NUMBER"],"example":"BIC"},"clearing_code":{"type":"string","description":"Bank clearing code.","example":"021000021"},"status":{"type":"string","description":"Account status.","enum":["ACTIVE","INACTIVE","PENDING"],"example":"PENDING"},"created_at":{"format":"date-time","type":"string","description":"Account created date.","example":"2026-05-29T21:41:50.368Z"},"updated_at":{"format":"date-time","type":"string","description":"Account updated date.","example":"2026-05-29T21:41:50.368Z"}},"required":["id","user_id","counterparty_id","country","currency_symbol","account_type","account_number","bank_name","bank_code","bank_code_type","created_at","updated_at"]},"V1CreateCounterpartyWalletBody":{"type":"object","properties":{"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"}},"required":["name","address","network"]},"V1CreateCounterpartyWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Counterparty ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"},"status":{"type":"string","description":"Wallet status.","example":"ACTIVE","enum":["ACTIVE","INACTIVE","PENDING","BLOCKED"]},"created_at":{"format":"date-time","type":"string","description":"Wallet created date.","example":"2026-05-29T21:41:50.370Z"},"updated_at":{"format":"date-time","type":"string","description":"Wallet updated date.","example":"2026-05-29T21:41:50.370Z"}},"required":["id","user_id","counterparty_id","name","address","network","status","created_at","updated_at"]},"V1GetAllCounterpartyWalletRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Counterparty ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"},"status":{"type":"string","description":"Wallet status.","example":"PENDING","enum":["ACTIVE","INACTIVE","PENDING","BLOCKED"]},"created_at":{"format":"date-time","type":"string","description":"Wallet created date.","example":"2026-05-29T21:41:50.370Z"},"updated_at":{"format":"date-time","type":"string","description":"Wallet updated date.","example":"2026-05-29T21:41:50.370Z"}},"required":["id","user_id","counterparty_id","name","address","network","status","created_at","updated_at"]},"V1GetAllCounterpartyWalletRestResponse":{"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":"Counterparty wallets data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllCounterpartyWalletRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1GetCounterpartyWalletByIdRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Counterparty ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"},"status":{"type":"string","description":"Wallet status.","example":"PENDING","enum":["ACTIVE","INACTIVE","PENDING","BLOCKED"]},"created_at":{"format":"date-time","type":"string","description":"Wallet created date.","example":"2026-05-29T21:41:50.370Z"},"updated_at":{"format":"date-time","type":"string","description":"Wallet updated date.","example":"2026-05-29T21:41:50.370Z"}},"required":["id","user_id","counterparty_id","name","address","network","status","created_at","updated_at"]},"V1UpdateCounterpartyWalletBody":{"type":"object","properties":{"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"}}},"V1UpdateCounterpartyWalletRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"user_id":{"type":"string","description":"User ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"counterparty_id":{"type":"string","description":"Counterparty ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Wallet name.","example":"My Bitcoin Wallet"},"address":{"type":"string","description":"Wallet address.","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"network":{"type":"string","description":"Network.","example":"ethereum"},"status":{"type":"string","description":"Wallet status.","example":"PENDING","enum":["ACTIVE","INACTIVE","PENDING","BLOCKED"]},"created_at":{"format":"date-time","type":"string","description":"Wallet created date.","example":"2026-05-29T21:41:50.370Z"},"updated_at":{"format":"date-time","type":"string","description":"Wallet updated date.","example":"2026-05-29T21:41:50.370Z"}},"required":["id","user_id","counterparty_id","name","address","network","status","created_at","updated_at"]},"GetStreamQuotationByFilterRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Stream Quotation ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"base_currency_symbol":{"type":"string","description":"Base currency symbol.","example":"USD"},"quote_currency_symbol":{"type":"string","description":"Quote currency symbol.","example":"BRL"},"price":{"type":"number","description":"Rate price.","example":5.1234},"side":{"type":"string","enum":["BUY","SELL"],"description":"Side.","example":"BUY"},"timestamp":{"format":"date-time","type":"string","description":"Timestamp.","example":"2026-05-29T21:41:50.467Z"}},"required":["id","base_currency_symbol","quote_currency_symbol","price","side","timestamp"]},"CreateClientByLinkBody":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the client. Must be a valid string with maximum 80 characters. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"type":{"type":"string","description":"Type of client entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"email":{"type":"string","description":"Valid email address of the client. Used for communication and notifications. Maximum 255 characters.","example":"john.doe@example.com"}},"required":["name","type","email"]},"CreateClientByLinkRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the created client.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"name":{"type":"string","description":"Full name of the client. For legal entities, the name field corresponds to the legal name.","example":"John Doe"},"type":{"type":"string","description":"Type of client entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.","example":"NATURAL_PERSON","enum":["NATURAL_PERSON","LEGAL_PERSON"]},"email":{"type":"string","description":"Email address of the client.","example":"john.doe@example.com"},"status":{"type":"string","description":"Current status of the client.","example":"PENDING","enum":["ACTIVE","INACTIVE","PENDING","REJECTED","EXPIRED"]},"external_url":{"type":"string","description":"External URL of the client.","example":"https://www.example.com"},"created_at":{"format":"date-time","type":"string","description":"Client created date.","example":"2026-05-29T21:41:49.883Z"},"updated_at":{"format":"date-time","type":"string","description":"Client updated date.","example":"2026-05-29T21:41:49.883Z"}},"required":["id","name","type","email","status","external_url","created_at","updated_at"]},"V1CreateClientLimitBody":{"type":"object","properties":{"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"BRL"},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":1000000},"one_time_limit":{"type":"number","description":"One-time limit in cents.","example":500000}},"required":["currency_symbol","daily_limit","one_time_limit"]},"V1CreateClientLimitRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client limit ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"BRL"},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":1000000},"one_time_limit":{"type":"number","description":"One-time limit in cents.","example":500000},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T21:41:50.068Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:50.068Z"}},"required":["id","client_id","wallet_id","currency_symbol","daily_limit","one_time_limit","created_at","updated_at"]},"V1GetByClientIdClientLimitRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client limit ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"BRL"},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":1000000},"one_time_limit":{"type":"number","description":"One-time limit in cents.","example":500000},"daily_use":{"type":"number","description":"Daily use amount consumed today in cents.","example":250000},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T21:41:50.069Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:50.070Z"}},"required":["id","client_id","wallet_id","currency_symbol","daily_limit","one_time_limit","daily_use","created_at","updated_at"]},"V1GetAllClientLimitRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Client limit ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"currency_symbol":{"type":"string","description":"Currency symbol.","example":"BRL","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"]},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":1000000},"one_time_limit":{"type":"number","description":"One-time limit in cents.","example":500000},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T21:41:50.069Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:50.069Z"}},"required":["id","client_id","wallet_id","currency_symbol","daily_limit","one_time_limit","created_at","updated_at"]},"V1GetAllClientLimitRestResponse":{"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":"Array of client limits matching the search criteria.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllClientLimitRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]},"V1UpdateClientLimitBody":{"type":"object","properties":{"daily_limit":{"type":"number","description":"Daily limit in cents.","example":1000000},"one_time_limit":{"type":"number","description":"One-time limit in cents.","example":500000}}},"V1UpdateClientLimitRestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Client limit ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"client_id":{"type":"string","description":"Client ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"wallet_id":{"type":"string","description":"Wallet ID.","example":"f6e2e084-29b9-4935-a059-5473b13033aa"},"currency_symbol":{"type":"string","description":"Currency symbol.","enum":["USD","BRL","EUR","MXN","ARS","COP","CLP","PEN","ECU","UYU","PYG","USDC","USDT"],"example":"USD"},"daily_limit":{"type":"number","description":"Daily limit in cents.","example":1000000},"one_time_limit":{"type":"number","description":"One-time limit in cents.","example":500000},"created_at":{"format":"date-time","type":"string","description":"Created at.","example":"2026-05-29T21:41:50.070Z"},"updated_at":{"format":"date-time","type":"string","description":"Updated at.","example":"2026-05-29T21:41:50.070Z"}},"required":["id","client_id","wallet_id","currency_symbol","daily_limit","one_time_limit","created_at","updated_at"]},"V1GetAllBellNotificationRestResponseItem":{"type":"object","properties":{"id":{"type":"string","description":"Notification UUID.","example":"a22054f5-baf1-4cc2-850c-ab95966cef46"},"user_id":{"type":"string","description":"User UUID.","example":"b28163ec-3d28-4786-a154-7a28ab3600a6"},"title":{"type":"string","description":"Notification title.","example":"Pix recebido."},"description":{"type":"string","description":"Notification description.","example":"Uhuu! Pix recebido no valor de R$ 10,00."},"read":{"type":"boolean","description":"Indicates if the notification has been read.","example":false},"created_at":{"format":"date-time","type":"string","description":"Notification created at.","example":"2026-04-22T12:38:21.056Z"}},"required":["id","user_id","title","description","read","created_at"]},"V1GetAllBellNotificationRestResponse":{"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":"Notification data.","type":"array","items":{"$ref":"#/components/schemas/V1GetAllBellNotificationRestResponseItem"}}},"required":["page","page_size","page_total","total","data"]}}}}