### GET /websites/app_venopayments/status/{transactionId} Source: https://app.venopayments.com/docs/index_api-docs.json= Retrieves the status of a specific transaction using its unique transaction ID. ```APIDOC ## GET /websites/app_venopayments/status/{transactionId} ### Description Retrieves the status of a specific transaction using its unique transaction ID. ### Method GET ### Endpoint /websites/app_venopayments/status/{transactionId} ### Parameters #### Path Parameters - **transactionId** (string) - Required - The unique identifier of the transaction to query. ### Response #### Success Response (200) - **transactionId** (string) - The unique identifier for the transaction. - **status** (string) - The current status of the transaction (e.g., "Pending", "Completed", "Failed"). - **type** (string) - The type of transaction (e.g., "deposit", "withdraw"). - **amount** (number) - The transaction amount. - **createdAt** (string) - The date and time the transaction was created. #### Response Example ```json { "transactionId": "tx12345", "status": "Completed", "type": "deposit", "amount": 100.50, "createdAt": "2025-04-19T20:04:53.166Z" } ``` #### Error Response (404) - **status** (string) - Indicates an error status. - **message** (string) - A message indicating the transaction was not found. #### Error Response Example ```json { "status": "error", "message": "Transação não encontrada." } ``` ``` -------------------------------- ### POST /wallet/deposit/payment Source: https://app.venopayments.com/docs/index_api-docs.json= Gera um pagamento via QR Code PIX para depósito. Esta endpoint permite iniciar um processo de depósito utilizando o método de pagamento PIX. ```APIDOC ## POST /wallet/deposit/payment ### Description Gera um pagamento via QR Code PIX para depósito. ### Method POST ### Endpoint /wallet/deposit/payment ### Parameters #### Query Parameters None #### Request Body - **token** (string) - Required - Token de autenticação - **secret** (string) - Required - Secret de autenticação - **postback** (string) - Required - URL de callback para receber notificações - **amount** (number) - Required - Valor do depósito - **debtor_name** (string) - Required - Nome do pagador - **email** (string) - Required - Email do pagador - **debtor_document_number** (string) - Required - CPF/CNPJ do pagador - **phone** (string) - Required - Telefone do pagador - **method_pay** (string) - Required - Método de pagamento (pix) ### Request Example ```json { "token": "seu_token", "secret": "seu_secret", "postback": "https://seusite.com/webhook", "amount": 100, "debtor_name": "João Silva", "email": "joao@email.com", "debtor_document_number": "12345678900", "phone": "11999999999", "method_pay": "pix" } ``` ### Response #### Success Response (200) - **idTransaction** (string) - ID da transação #### Response Example ```json { "idTransaction": "string" } ``` ``` -------------------------------- ### POST /pixout Source: https://app.venopayments.com/docs/index_api-docs.json= Realizes a PIX withdrawal/transfer to a PIX key. ```APIDOC ## POST /pixout ### Description Realizes a PIX withdrawal/transfer to a PIX key. ### Method POST ### Endpoint /pixout ### Parameters #### Query Parameters #### Request Body - **token** (string) - Required - Authentication token - **secret** (string) - Required - Authentication secret - **baasPostbackUrl** (string) - Required - Callback URL to receive notifications - **amount** (number) - Required - Withdrawal amount - **pixKey** (string) - Required - Destination PIX key - **pixKeyType** (string) - Required - Type of the PIX key (enum: cpf, cnpj, email, telefone, aleatoria) ### Request Example ```json { "token": "seu_token", "secret": "seu_secret", "baasPostbackUrl": "https://seusite.com/webhook", "amount": 100, "pixKey": "12345678900", "pixKeyType": "cpf" } ``` ### Response #### Success Response (200) - **id** (string) - Transaction ID - **amount** (number) - Withdrawal amount #### Response Example ```json { "id": "b522a295-e404-4a1b-9c3d-123456789abc", "amount": 100 } ``` ``` -------------------------------- ### POST /websites/app_venopayments/pix/deposit Source: https://app.venopayments.com/docs/index_api-docs.json= Initiates a PIX deposit transaction. Requires details of the transaction and the recipient's PIX information. ```APIDOC ## POST /websites/app_venopayments/pix/deposit ### Description Initiates a PIX deposit transaction. Requires details of the transaction and the recipient's PIX information. ### Method POST ### Endpoint /websites/app_venopayments/pix/deposit ### Parameters #### Request Body - **transactionId** (string) - Required - Unique identifier for the transaction. - **amount** (number) - Required - The amount to be deposited. - **pixKey** (string) - Required - The PIX key of the recipient. - **pixKeyType** (string) - Required - The type of the PIX key (e.g., "cpf", "cnpj", "email", "phone"). ### Request Example ```json { "transactionId": "tx12345", "amount": 100.50, "pixKey": "12345678900", "pixKeyType": "cpf" } ``` ### Response #### Success Response (200) - **status** (string) - The status of the deposit request (e.g., "Pending", "Completed"). - **message** (string) - A confirmation message. - **depositId** (string) - The unique identifier for the created deposit. - **createdAt** (string) - The date and time the deposit was created. #### Response Example ```json { "status": "Pending", "message": "Depósito PIX iniciado com sucesso.", "depositId": "dep98765", "createdAt": "2025-04-19T20:04:53.166Z" } ``` #### Error Response (400) - **status** (string) - Indicates an error status. - **message** (string) - A description of the error. #### Error Response Example ```json { "status": "error", "message": "Informações de depósito inválidas." } ``` ``` -------------------------------- ### POST /status - Consultar Status da Transação Source: https://app.venopayments.com/docs/index_api-docs.json= This endpoint allows you to query the status of a specific transaction using its unique ID. Authentication is required. ```APIDOC ## POST /status ### Description Consultar o status de uma transação pelo ID. ### Method POST ### Endpoint /status ### Parameters #### Request Body - **token** (string) - Required - Token de autenticação - **secret** (string) - Required - Secret de autenticação - **idTransaction** (string) - Required - ID da transação ### Request Example ```json { "token": "seu_token", "secret": "seu_secret", "idTransaction": "TX123456789" } ``` ### Response #### Success Response (200) - **status** (string) - The current status of the transaction. - **message** (string) - A message indicating the transaction status. - **qrcode** (object) - Details about the PIX QR code if applicable. - **description** (string) - Description of the PIX code. - **type** (string) - Type of the PIX code. - **example** (string) - The PIX copy-paste code. - **qr_code_image_url** (string) - URL for the QR code image. #### Response Example ```json { "status": "success", "message": "Transação encontrada.", "qrcode": { "description": "Código PIX copia e cola", "type": "string", "example": "00020126..." }, "qr_code_image_url": "https://api.exemplo.com/qrcode/123.png" } ``` #### Error Responses - **401**: Erro de autenticação ou valor mínimo não atingido. - **status** (string) - "error" - **message** (string) - Error message, e.g., "O valor mínimo de depósito é de R$ 10,00." - **422**: Erro de validação. - **status** (string) - "error" - **message** (string) - "Erro de validação" - **errors** (object) - Object containing validation errors. ``` -------------------------------- ### POST /websites/app_venopayments/pix/withdraw Source: https://app.venopayments.com/docs/index_api-docs.json= Initiates a PIX withdrawal transaction. Requires details for the withdrawal and recipient's PIX information. ```APIDOC ## POST /websites/app_venopayments/pix/withdraw ### Description Initiates a PIX withdrawal transaction. Requires details for the withdrawal and recipient's PIX information. ### Method POST ### Endpoint /websites/app_venopayments/pix/withdraw ### Parameters #### Request Body - **transactionId** (string) - Required - Unique identifier for the transaction. - **amount** (number) - Required - The amount to be withdrawn. - **pixKey** (string) - Required - The PIX key of the recipient. - **pixKeyType** (string) - Required - The type of the PIX key (e.g., "cpf", "cnpj", "email", "phone"). ### Request Example ```json { "transactionId": "wd12345", "amount": 50.00, "pixKey": "09876543210", "pixKeyType": "email" } ``` ### Response #### Success Response (200) - **status** (string) - The status of the withdrawal request (e.g., "PendingProcessing", "Completed"). - **message** (string) - A confirmation message. - **withdrawId** (string) - The unique identifier for the created withdrawal. - **createdAt** (string) - The date and time the withdrawal was created. - **updatedAt** (string) - The date and time the withdrawal was last updated. #### Response Example ```json { "status": "PendingProcessing", "message": "Saque PIX iniciado com sucesso.", "withdrawId": "wd98765", "createdAt": "2025-04-19T20:04:53.166Z", "updatedAt": "2025-04-19T20:04:53.166Z" } ``` #### Error Response (400) - **status** (string) - Indicates an error status. - **message** (string) - A description of the error. #### Error Response Example ```json { "status": "error", "message": "Informações de saque inválidas." } ``` #### Error Response (401) - **status** (string) - Indicates an error status. - **message** (string) - Describes the error (e.g., insufficient balance). #### Error Response Example ```json { "status": "error", "message": "Saldo Insuficiente." } ``` #### Error Response (422) - **status** (string) - Indicates an error status. - **message** (string) - A general validation error message. - **errors** (object) - Object containing specific validation errors. #### Error Response Example ```json { "status": "error", "message": "Erro de validação", "errors": {} } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.