### Auth Token Response Example Source: https://syncpay.apidog.io/ Example of a successful response when generating an authentication token. ```JSON { "access_token": "123003123|XzrqSwIMFS2EMuHBUPa2zhyOlcQ5cGgTgKieiuAp6a3fa3a5", "token_type": "Bearer", "expires_in": 3600, "expires_at": "2025-06-22T02:49:47.440458Z" } ``` -------------------------------- ### Pix Cash-Out Request Example Source: https://syncpay.apidog.io/solicita%C3%A7%C3%A3o-de-saque-pix-18075881e0 This example demonstrates a valid request body for initiating a Pix cash-out. Ensure all required fields like amount, pix_key_type, pix_key, and document are correctly provided. ```yaml amount: 10 description: Teste pix_key_type: CPF pix_key: '12345678900' document: type: cpf number: '12345678900' ``` -------------------------------- ### OnCreate Webhook Payload Example (YAML) Source: https://syncpay.apidog.io/oncreate-19542402e0 Example payload for the OnCreate webhook, sent when a new cashin transaction is created. Note that all webhooks have a 5-second timeout. ```yaml openapi: 3.1.0 info: title: '' description: '' version: 1.0.0 paths: {} webhooks: onCreate: post: summary: OnCreate deprecated: false description: >- Payload do webhook enviado no evento de criação de uma nova transação de cashin. TODOS OS WEBHOOKS TEM TIMEOUT DE 5 SEGUNDOS tags: - Webhooks/Cashin parameters: - name: event in: header description: '' required: false example: cashin.create schema: type: string - name: Authorization in: header description: '' required: false example: Bearer {TOKEN} schema: type: string requestBody: content: application/json: schema: type: object properties: data: type: object properties: id: type: string client: type: object properties: name: type: string email: type: string document: type: string required: - name - email - document x-apidog-orders: - name - email - document pix_code: type: string amount: type: integer final_amount: type: number currency: type: string status: type: string enum: - pending - completed - failed - refunded - med x-apidog-enum: - value: pending name: '' description: '' - value: completed name: '' description: '' - value: failed name: '' description: '' - value: refunded name: '' description: '' - value: med name: '' description: '' payment_method: type: string created_at: type: string description: >- Timezone GMT, caso necessário converter para o seu timezone. updated_at: type: string description: >- Timezone GMT, caso necessário converter para o seu timezone. required: - id - client - pix_code - amount - final_amount - currency - status - payment_method - created_at - updated_at x-apidog-orders: - id - client - pix_code - amount - final_amount - currency - status - payment_method - created_at - updated_at required: - data x-apidog-orders: - data example: data: id: 9f2a58ed-028b-4636-bda1-b366ca4913ff client: name: John Doe email: johndoe@example.com document: '12345678909' pix_code: 00020126880014br.gov.bcb... amount: 10 final_amount: 9.4 currency: BRL status: pending payment_method: PIX created_at: '2025-07-24 14:54:57' updated_at: '2025-07-24 15:09:10' responses: '200': description: '' content: application/json: schema: type: object properties: {} headers: {} x-apidog-name: Success security: [] x-apidog-folder: Webhooks/Cashin x-apidog-status: released ``` -------------------------------- ### Pix Cash-Out Success Response Example Source: https://syncpay.apidog.io/solicita%C3%A7%C3%A3o-de-saque-pix-18075881e0 This example shows a successful response from the Pix cash-out request. A successful request returns a message and a unique reference_id. ```yaml message: Cashout request successfully submitted. reference_id: d0f37529-d361-4a4a-b3df-0d1193bbc19f ``` -------------------------------- ### Pix Cash-Out Unauthorized Response Example Source: https://syncpay.apidog.io/solicita%C3%A7%C3%A3o-de-saque-pix-18075881e0 This example illustrates an unauthorized response. It indicates that the request could not be authenticated. ```yaml message: Unauthenticated. ``` -------------------------------- ### Pix Cash-Out Invalid Data Response Example Source: https://syncpay.apidog.io/solicita%C3%A7%C3%A3o-de-saque-pix-18075881e0 This example shows a response when invalid data is provided. The 'errors' object details which fields have validation issues. ```yaml message: Dados inválidos errors: amount: - 'Invalid value' pix_key_type: - 'Invalid value' pix_key: - 'Invalid value' ``` -------------------------------- ### Get Balance Source: https://syncpay.apidog.io/llms.txt Retrieves the user's current balance. ```APIDOC ## Get Balance ### Description Returns the user's balance. ### Method GET ### Endpoint /balance ### Parameters #### Query Parameters - **userId** (string) - Required - The ID of the user whose balance to retrieve. ### Response #### Success Response (200) - **balance** (number) - The current balance of the user. - **currency** (string) - The currency of the balance (e.g., "BRL"). ``` -------------------------------- ### Get Partner Data (Old API) Source: https://syncpay.apidog.io/llms.txt Retrieves partner data, replicated from V1. ```APIDOC ## Get Partner Data (Old API) ### Description Retrieves partner data, replicated from V1. ### Method GET ### Endpoint /v1/partner/data ### Parameters #### Query Parameters - **partnerId** (string) - Required - The ID of the partner. ### Response #### Success Response (200) - **partnerId** (string) - The partner's unique identifier. - **name** (string) - The partner's name. ``` -------------------------------- ### OpenAPI Specification for Partner Data Source: https://syncpay.apidog.io/consulta-os-dados-do-parceiro-20187697e0 This OpenAPI specification defines the `/s1/getCompany` endpoint for querying partner data. It includes details on the response schema and an example of a successful response. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /s1/getCompany: get: summary: Consulta os dados do Parceiro deprecated: false description: '' tags: - Old API parameters: [] responses: '200': description: '' content: application/json: schema: type: object properties: dados_seller: type: object properties: empresa: type: object properties: id: type: string nome: type: string email: type: string ip_user: type: 'null' user_id: type: string cpf_cnpj: type: string telefone: type: string taxa_cash_in: type: number data_cadastro: type: string data_nascimento: type: string required: - id - nome - email - ip_user - user_id - cpf_cnpj - telefone - taxa_cash_in - data_cadastro - data_nascimento x-apidog-orders: - id - nome - email - ip_user - user_id - cpf_cnpj - telefone - taxa_cash_in - data_cadastro - data_nascimento endereco: type: object properties: completo: type: string required: - completo x-apidog-orders: - completo required: - empresa - endereco x-apidog-orders: - empresa - endereco required: - dados_seller x-apidog-orders: - dados_seller example: dados_seller: empresa: id: 09826ab-ddc0-482d-b1c9-8e785cdcf8d4 nome: Test User email: test@example.com ip_user: null user_id: 50cae768-7cf1-4be9-bab3-30a4ffaae93e cpf_cnpj: '04209381098' telefone: 478-217-1762 taxa_cash_in: 0.5 data_cadastro: '2025-08-08 14:46:14' data_nascimento: '1992-12-14' endereco: completo: |- 87734 Wilber Plains New Lowellchester, MI 30088-4991 headers: {} x-apidog-name: Success security: - bearer: [] x-apidog-folder: Old API x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/909914/apis/api-20187697-run components: schemas: {} securitySchemes: BasicAuth: type: basic scheme: basic bearer: type: http scheme: bearer servers: [] security: - bearer: [] ``` -------------------------------- ### Get Partner Data Source: https://syncpay.apidog.io/llms.txt Retrieves data for a specific partner. ```APIDOC ## Get Partner Data ### Description Queries data for a specific partner. ### Method GET ### Endpoint /partner/{partnerId} ### Parameters #### Path Parameters - **partnerId** (string) - Required - The unique identifier of the partner. ### Response #### Success Response (200) - **partnerId** (string) - The partner's unique identifier. - **name** (string) - The partner's name. - **contactEmail** (string) - The partner's contact email. ``` -------------------------------- ### Consulta Dados do Parceiro OpenAPI Specification Source: https://syncpay.apidog.io/consulta-dados-do-parceiro-18075878e0 Especificação OpenAPI para o endpoint de consulta de dados do parceiro. Define a estrutura da requisição GET e as respostas possíveis (200 OK, 401 Unauthorized, 429 Too Many Requests). ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/partner/v1/profile: get: summary: Consulta dados do Parceiro deprecated: false description: '' tags: - Partner - Seller parameters: [] responses: '200': description: '' content: application/json: schema: type: object properties: data: type: object properties: name: type: string description: Nome do Representante email: type: string description: 'Email ' status: type: string enum: - approved - pending_verification - incomplete_kyc - kyc_under_review - rejected - banned x-apidog-enum: - value: approved name: Aprovado description: '' - value: pending_verification name: Aguardando Verificação description: '' - value: incomplete_kyc name: Verificação de Segurança Incompleta description: '' - value: kyc_under_review name: Verificação de Segurança em Revisão description: '' - value: rejected name: Rejeitado description: '' - value: banned name: Banido description: '' document: type: string phone: type: string address: type: object properties: address: type: string x-apidog-orders: - address required: - address legalRepresentative: type: object properties: name: type: string description: name cpf: type: string phone: type: string x-apidog-orders: - name - cpf - phone required: - name - phone - cpf client_id: type: string description: ID format: uuid x-apidog-orders: - client_id - name - email - status - document - phone - address - legalRepresentative required: - name - email - status - document - phone - address - client_id x-apidog-orders: - data required: - data example: data: client_id: 9f3c5b3a-41bc-4322-90e6-a87a98eefeca name: Usuario Teste email: teste@syncpayments.com status: approved document: 123.456.789-00 phone: (11) 943354-4909 address: address: Teste headers: {} x-apidog-name: OK '401': description: '' content: application/json: schema: type: object properties: message: type: string x-apidog-orders: - message required: - message example: message: Unauthenticated. headers: {} x-apidog-name: Não autorizado '429': description: '' content: application/json: ``` -------------------------------- ### OnUpdate Webhook OpenAPI Specification Source: https://syncpay.apidog.io/onupdate-19542541e0 This OpenAPI specification defines the structure and behavior of the OnUpdate webhook for cashout transactions. It includes details on headers, request body schema, and example payload. ```yaml openapi: 3.1.0 info: title: '' description: '' version: 1.0.0 paths: webhooks: OnUpdate: post: summary: OnUpdate deprecated: false description: >- Payload do webhook enviado no evento da atualização de uma transação de cashout. TODOS OS WEBHOOKS TEM TIMEOUT DE 5 SEGUNDOS tags: - Webhooks/Cashout parameters: - name: event in: header description: '' required: false example: cashout.update schema: type: string - name: Authorization in: header description: '' required: false example: Bearer {TOKEN} schema: type: string requestBody: content: application/json: schema: type: object properties: data: type: object properties: id: type: string amount: type: integer final_amount: type: number currency: type: string status: type: string enum: - pending - completed - failed - refunded - med x-apidog-enum: - value: pending name: '' description: '' - value: completed name: '' description: '' - value: failed name: '' description: '' - value: refunded name: '' description: '' - value: med name: '' description: '' payment_method: type: string pix_type: type: string pix_key: type: string created_at: type: string description: >- Timezone GMT, caso necessário converter para o seu timezone. updated_at: type: string description: >- Timezone GMT, caso necessário converter para o seu timezone. required: - id - amount - final_amount - currency - status - payment_method - pix_type - pix_key - created_at - updated_at x-apidog-orders: - id - amount - final_amount - currency - status - payment_method - pix_type - pix_key - created_at - updated_at required: - data x-apidog-orders: - data example: data: id: 74922f31-c5c4-4238-8075-56d7e89ae551 amount: 10 final_amount: 9.4 currency: BRL status: pending payment_method: PIX pix_type: cpf pix_key: '12345678909' created_at: '2025-07-24 15:11:45' updated_at: '2025-07-24 15:11:45' responses: '200': description: '' content: application/json: schema: type: object properties: {} headers: {} x-apidog-name: Success security: [] x-apidog-folder: Webhooks/Cashout x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/909914/apis/api-19542541-run components: schemas: {} securitySchemes: BasicAuth: type: basic scheme: basic bearer: type: http scheme: bearer servers: [] security: - bearer: [] ``` -------------------------------- ### OpenAPI Specification for User Balance Source: https://syncpay.apidog.io/retorna-o-saldo-do-usu%C3%A1rio-18308815e0 This OpenAPI specification defines the endpoint for retrieving the user's balance. It includes details on the GET request, success response (200) with balance, and error responses (401, 429). ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/partner/v1/balance: get: summary: Retorna o Saldo do Usuário deprecated: false description: '' tags: - Saldo parameters: [] responses: '200': description: '' content: application/json: schema: type: object properties: balance: type: string x-apidog-orders: - balance required: - balance example: balance: '90.00' headers: {} x-apidog-name: Success '401': description: '' content: application/json: schema: title: '' type: object properties: message: type: string x-apidog-orders: - message required: - message example: message: Unauthorized headers: {} x-apidog-name: Não autorizado '429': description: '' headers: {} x-apidog-name: Pedido inválido security: - bearer: [] x-apidog-folder: Saldo x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/909914/apis/api-18308815-run components: schemas: {} securitySchemes: BasicAuth: type: basic scheme: basic bearer: type: http scheme: bearer servers: [] security: - bearer: [] ``` -------------------------------- ### OpenAPI Specification for OnUpdate Webhook Source: https://syncpay.apidog.io/onupdate-19542520e0 This OpenAPI 3.1.0 specification defines the structure and parameters for the OnUpdate webhook, which is triggered upon a cashin transaction update. It includes details on headers, request body schema, and example payload. Note that all webhooks have a 5-second timeout. ```yaml openapi: 3.1.0 info: title: '' description: '' version: 1.0.0 paths: {} webhooks: OnUpdate: post: summary: OnUpdate deprecated: false description: >- Payload do webhook enviado no evento da atualização de uma transação de cashin. TODOS OS WEBHOOKS TEM TIMEOUT DE 5 SEGUNDOS tags: - Webhooks/Cashin parameters: - name: event in: header description: '' required: false example: cashin.update schema: type: string - name: Authorization in: header description: '' required: false example: Bearer {TOKEN} schema: type: string requestBody: content: application/json: schema: type: object properties: data: type: object properties: id: type: string end_to_end: type: string client: type: object properties: name: type: string email: type: string document: type: string required: - name - email - document x-apidog-orders: - name - email - document debtor_account: type: object properties: name: type: string document: type: string required: - name - document x-apidog-orders: - name - document pix_code: type: string amount: type: integer final_amount: type: number currency: type: string status: type: string payment_method: type: string created_at: type: string description: >- Timezone GMT, caso necessário converter para o seu timezone. updated_at: type: string description: >- Timezone GMT, caso necessário converter para o seu timezone. required: - id - end_to_end - client - debtor_account - pix_code - amount - final_amount - currency - status - payment_method - created_at - updated_at x-apidog-orders: - id - end_to_end - client - debtor_account - pix_code - amount - final_amount - currency - status - payment_method - created_at - updated_at required: - data x-apidog-orders: - data example: data: id: 9f2a58ed-028b-4636-bda1-b366ca4913ff end_to_end: E22896431302511911549eERuvHRo50V client: name: John Doe email: johndoe@example.com document: '12345678909' debtor_account: name: John Doe document: '12345678909' pix_code: 00020126880014br.gov.bcb... amount: 10 final_amount: 9.4 currency: BRL status: completed payment_method: PIX created_at: '2025-07-24 14:54:57' updated_at: '2025-07-24 15:09:10' responses: '200': description: '' content: application/json: schema: type: object properties: {} headers: {} x-apidog-name: Success security: [] x-apidog-folder: Webhooks/Cashin x-apidog-status: released ``` -------------------------------- ### List All Webhooks Source: https://syncpay.apidog.io/llms.txt Retrieves a list of all configured webhooks. ```APIDOC ## List All Webhooks ### Description Retrieves a list of all configured webhooks. ### Method GET ### Endpoint /webhooks ### Response #### Success Response (200) - **webhooks** (array) - A list of webhook configurations. ``` -------------------------------- ### Solicitação de Depósito via Pix Source: https://syncpay.apidog.io/solicita%C3%A7%C3%A3o-de-dep%C3%B3sito-via-pix-18075879e0 Utilize este endpoint para iniciar uma solicitação de depósito via Pix. Certifique-se de que seu IP e chave de API estejam autorizados. Webhooks serão enviados para a `callbackUrl` após o processamento. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/partner/v1/cash-in: post: summary: Solicitação de depósito via Pix deprecated: false description: >- Permite requisição de pagamento Pix. IP e chave de API devem ser autorizados. Após o processamento, webhooks de criação ou atualização serão enviados para a callbackUrl fornecida. tags: - Pix - CashIn - Pix - CashIn parameters: - name: Accept in: header description: '' required: true example: application/json schema: type: string requestBody: content: application/json: schema: type: object x-apidog-orders: - amount - description - webhook_url - client - split properties: amount: type: number description: Valor a ser depositado minimum: 0 format: double examples: - 14.67 description: type: string description: Descrição da transação nullable: true client: type: object properties: name: type: string cpf: type: string pattern: /^\d{11}$/ email: type: string format: email phone: type: string pattern: /^\d{10,11}$/ x-apidog-orders: - name - cpf - email - phone required: - name - cpf - email - phone description: Dados do cliente que fará a transferência split: type: array items: type: object properties: percentage: type: integer description: Porcentagem do amount que será enviado para o user_id maximum: 100 exclusiveMaximum: true user_id: type: string format: uuid description: >- client_id utilizado no endpoint /api/partner/v1/auth-token x-apidog-orders: - percentage - user_id required: - user_id - percentage nullable: true minItems: 1 maxItems: 3 webhook_url: type: string format: uri description: Endpoint para receber webhooks no padrão OLD required: - amount example: amount: 14.67 description: Teste webhook_url: https://site.com/webhook client: name: Roberto cpf: '12345678900' email: roberto@test.com phone: '51123123123' split: - percentage: 10 user_id: 9f3c5b3a-41bc-4322-90e6-a87a98eefeca responses: '200': description: >- Requisição de Cash-in recebida com sucesso. O resultado será enviado para a callbackUrl. content: application/json: schema: type: object properties: message: type: string pix_code: type: string description: Código pix, serve como copia e cola e QRCode identifier: type: string format: uuid description: >- Identificador pra transação para buscar informações e tratar webhooks x-apidog-orders: - message - pix_code - identifier required: - message - pix_code - identifier examples: '1': summary: Sucesso value: message: Cashin request successfully submitted pix_code: 00020126820014br.gov.bcb.pix... ``` -------------------------------- ### OnCreate Webhook Source: https://syncpay.apidog.io/oncreate-19542523e0 Payload do webhook enviado no evento de criação de uma nova transação de cashout. TODOS OS WEBHOOKS TEM TIMEOUT DE 5 SEGUNDOS ```APIDOC ## POST /webhooks/cashout/onCreate ### Description Payload do webhook enviado no evento de criação de uma nova transação de cashout. TODOS OS WEBHOOKS TEM TIMEOUT DE 5 SEGUNDOS ### Method POST ### Endpoint /webhooks/cashout/onCreate ### Parameters #### Header Parameters - **event** (string) - Optional - - **Authorization** (string) - Optional - #### Request Body - **data** (object) - Required - - **id** (string) - Required - - **amount** (integer) - Required - - **final_amount** (number) - Required - - **currency** (string) - Required - - **status** (string) - Required - Enum: pending, completed, failed, refunded, med - **payment_method** (string) - Required - - **pix_type** (string) - Required - - **pix_key** (string) - Required - - **created_at** (string) - Required - Timezone GMT, caso necessário converter para o seu timezone. - **updated_at** (string) - Required - Timezone GMT, caso necessário converter para o seu timezone. ### Request Example { "data": { "id": "74922f31-c5c4-4238-8075-56d7e89ae551", "amount": 10, "final_amount": 9.4, "currency": "BRL", "status": "pending", "payment_method": "PIX", "pix_type": "cpf", "pix_key": "12345678909", "created_at": "2025-07-24 15:11:45", "updated_at": "2025-07-24 15:11:45" } } ### Response #### Success Response (200) - **(empty)** #### Response Example (No example provided) ``` -------------------------------- ### Consulta Status da Transação Source: https://syncpay.apidog.io/consulta-status-da-transa%C3%A7%C3%A3o-18075877e0 Utilize este endpoint para consultar o status de uma transação específica. O `identifier` é o ID da transação, retornado tanto no cash-in quanto no cash-out. A resposta inclui detalhes da transação como `reference_id`, `currency`, `amount`, `transaction_date`, `status`, `description`, e `pix_code`. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/partner/v1/transaction/{identifier}: get: summary: Consulta status da transação deprecated: false description: O identifier é retornado tanto no cashin quanto no cashout. tags: - Transações - Transações parameters: - name: identifier in: path description: ID da transação required: true schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: type: object properties: data: type: object properties: reference_id: type: string format: uuid currency: type: string enum: - BRL - USD - EUR x-apidog-enum: - value: BRL name: '' description: '' - value: USD name: '' description: '' - value: EUR name: '' description: '' amount: type: number format: double transaction_date: type: string description: >- Timezone GMT, caso necessário converter para o seu timezone. status: type: string enum: - pending - completed - failed - refunded - med x-apidog-enum: - value: pending name: Pendente description: '' - value: completed name: Completo description: '' - value: failed name: Falho description: '' - value: refunded name: Estornado description: '' - value: med name: MED description: '' description: type: string nullable: true pix_code: type: string nullable: true x-apidog-orders: - reference_id - currency - amount - transaction_date - status - description - pix_code required: - reference_id - currency - amount - transaction_date - status x-apidog-orders: - data required: - data example: data: reference_id: d22413c2-c768-4066-af70-c3b4e0f418ac currency: BRL amount: 14.67 transaction_date: '2025-06-16T17:32:44.000000Z' status: completed description: Teste pix_code: null headers: {} x-apidog-name: OK '401': description: '' content: application/json: schema: type: object properties: message: type: string x-apidog-orders: - message required: - message example: message: Unauthenticated. headers: {} x-apidog-name: Não autorizado '404': description: '' content: application/json: schema: type: object properties: message: type: string x-apidog-orders: - message required: - message example: message: Transação não encontrada headers: {} x-apidog-name: Registro não encontrado ``` -------------------------------- ### OnCreate Webhook Source: https://syncpay.apidog.io/oncreate-19542402e0 Payload do webhook enviado no evento de criação de uma nova transação de cashin. TODOS OS WEBHOOKS TEM TIMEOUT DE 5 SEGUNDOS ```APIDOC ## POST /webhooks/cashin ### Description Payload do webhook enviado no evento de criação de uma nova transação de cashin. TODOS OS WEBHOOKS TEM TIMEOUT DE 5 SEGUNDOS ### Method POST ### Endpoint /webhooks/cashin #### Headers - **event** (string) - Optional - - **Authorization** (string) - Optional - #### Request Body - **data** (object) - Required - - **id** (string) - Required - - **client** (object) - Required - - **name** (string) - Required - - **email** (string) - Required - - **document** (string) - Required - - **pix_code** (string) - Required - - **amount** (integer) - Required - - **final_amount** (number) - Required - - **currency** (string) - Required - - **status** (string) - Required - Enum: pending, completed, failed, refunded, med - - **payment_method** (string) - Required - - **created_at** (string) - Required - Timezone GMT, caso necessário converter para o seu timezone. - **updated_at** (string) - Required - Timezone GMT, caso necessário converter para o seu timezone. ### Request Example { "data": { "id": "9f2a58ed-028b-4636-bda1-b366ca4913ff", "client": { "name": "John Doe", "email": "johndoe@example.com", "document": "12345678909" }, "pix_code": "00020126880014br.gov.bcb...", "amount": 10, "final_amount": 9.4, "currency": "BRL", "status": "pending", "payment_method": "PIX", "created_at": "2025-07-24 14:54:57", "updated_at": "2025-07-24 15:09:10" } } ### Response #### Success Response (200) - (object) - ``` -------------------------------- ### Get Transaction Status Source: https://syncpay.apidog.io/llms.txt Queries the status of a transaction using its identifier. ```APIDOC ## Get Transaction Status ### Description Queries the status of a transaction. The identifier is returned in both cashin and cashout. ### Method GET ### Endpoint /transactions/{identifier} ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the transaction. ### Response #### Success Response (200) - **transactionId** (string) - The unique ID of the transaction. - **status** (string) - The current status of the transaction (e.g., "PENDING", "COMPLETED", "FAILED"). - **amount** (number) - The transaction amount. - **currency** (string) - The currency of the transaction. ``` -------------------------------- ### Create Webhook Source: https://syncpay.apidog.io/llms.txt Creates a new webhook subscription. ```APIDOC ## Create Webhook ### Description Creates a new webhook subscription. ### Method POST ### Endpoint /webhooks ### Request Body - **url** (string) - Required - The URL to send webhook events to. - **event** (string) - Required - The event to subscribe to (e.g., "transaction.created"). ``` -------------------------------- ### OpenAPI Specification - Transações Source: https://syncpay.apidog.io/consulta-status-da-transa%C3%A7%C3%A3o-18075877e0 Especificação OpenAPI para o endpoint de transações, incluindo detalhes de segurança e respostas de erro. ```yaml openapi: 3.0.0 info: title: SyncPay API version: 1.0.0 paths: /transactions/{transactionId}: get: summary: Consulta o status de uma transação parameters: - name: transactionId in: path required: true schema: type: string description: O ID da transação a ser consultada responses: '200': description: Detalhes da transação encontrados content: application/json: schema: type: object properties: id: type: string status: type: string amount: type: number createdAt: type: string format: date-time '404': description: Transação não encontrada '429': description: Pedido inválido headers: Retry-After: schema: type: integer security: - bearer: [] x-apidog-folder: Transações x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/909914/apis/api-18075877-run components: schemas: {} securitySchemes: BasicAuth: type: basic scheme: basic bearer: type: http scheme: bearer servers: [] security: - bearer: [] ``` -------------------------------- ### Webhook Cashin OnCreate/OnUpdate (Old) Source: https://syncpay.apidog.io/llms.txt Handles webhook events for Cashin creation or update. All webhooks have a 5-second timeout. ```APIDOC ## Webhook Cashin OnCreate/OnUpdate (Old) ### Description Handles webhook events for Cashin creation or update. All webhooks have a 5-second timeout. ### Method POST ### Endpoint /webhooks/cashin/old ### Request Body (Schema for Cashin creation/update webhook payload) ``` -------------------------------- ### Solicitação de depósito via Pix Source: https://syncpay.apidog.io/solicita%C3%A7%C3%A3o-de-dep%C3%B3sito-via-pix-18075879e0 Permite requisição de pagamento Pix. IP e chave de API devem ser autorizados. Após o processamento, webhooks de criação ou atualização serão enviados para a callbackUrl fornecida. ```APIDOC ## POST /api/partner/v1/cash-in ### Description Permite requisição de pagamento Pix. IP e chave de API devem ser autorizados. Após o processamento, webhooks de criação ou atualização serão enviados para a callbackUrl fornecida. ### Method POST ### Endpoint /api/partner/v1/cash-in ### Parameters #### Header Parameters - **Accept** (string) - Required - #### Request Body - **amount** (number) - Required - Valor a ser depositado - **description** (string) - Optional - Descrição da transação - **webhook_url** (string) - Required - Endpoint para receber webhooks no padrão OLD - **client** (object) - Required - Dados do cliente que fará a transferência - **name** (string) - Required - - **cpf** (string) - Required - - **email** (string) - Required - - **phone** (string) - Required - - **split** (array) - Optional - Porcentagem do amount que será enviado para o user_id - **percentage** (integer) - Required - Porcentagem do amount que será enviado para o user_id - **user_id** (string) - Required - client_id utilizado no endpoint /api/partner/v1/auth-token ### Request Example ```json { "amount": 14.67, "description": "Teste", "webhook_url": "https://site.com/webhook", "client": { "name": "Roberto", "cpf": "12345678900", "email": "roberto@test.com", "phone": "51123123123" }, "split": [ { "percentage": 10, "user_id": "9f3c5b3a-41bc-4322-90e6-a87a98eefeca" } ] } ``` ### Response #### Success Response (200) - **message** (string) - - **pix_code** (string) - Código pix, serve como copia e cola e QRCode - **identifier** (string) - Identificador pra transação para buscar informações e tratar webhooks #### Response Example ```json { "message": "Cashin request successfully submitted", "pix_code": "00020126820014br.gov.bcb.pix...", "identifier": "9f3c5b3a-41bc-4322-90e6-a87a98eefeca" } ``` ```