> ## Documentation Index > Fetch the complete documentation index at: https://docs.fastpaybrasil.com/llms.txt > Use this file to discover all available pages before exploring further. # Get payout request by ID > Retorna os detalhes completos de uma solicitação de saque. **Somente admin.** Contas merchant recebem `403` neste endpoint — para consultar as próprias solicitações, use a listagem `GET /v1/payout-requests`. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/payout-requests/{payoutRequestId} openapi: 3.0.0 info: title: FastPay API version: 1.0.0 description: >- API for creating and managing payment charges. ## Authentication This API uses **Basic Authentication** for direct API access, such as creating charges. Use your API key as the username and an empty string as password. The header should be formatted as: `Authorization: Basic {base64(apiKey:)}`. For example: ``` Authorization: Basic YWxleG91dG9uOiIi ``` ## Webhooks FastPay sends webhooks to notify your application about charge status changes in real-time. Webhooks are sent via HTTP POST requests to your configured webhook endpoints. ### Webhook Events The following webhook events are available for charges: - `charge.created` - Sent when a new charge is created - `charge.pending` - Sent when a charge is pending payment - `charge.paid` - Sent when a charge is successfully paid - `charge.updated` - Sent when a charge is updated ### Webhook Payload Structure All webhook payloads follow this structure: ```json { "id": "webhook_event_id", "event": "charge.paid", "data": { // Complete charge object } } ``` ### Webhook Delivery - Webhooks are sent via HTTP POST requests - Content-Type: `application/json` - Retry logic is implemented for failed deliveries - Webhook events are stored in the database for audit purposes - Delivery logs are maintained for debugging and monitoring ### Webhook Security - Webhooks are sent to pre-configured endpoints - Endpoints can be enabled/disabled per merchant - Event filtering is supported (only receive specific events) - Failed deliveries are retried with exponential backoff servers: - url: https://api-global.fastpaybrasil.com description: Produção e Sandbox (diferenciados pela API key) security: [] paths: /v1/payout-requests/{payoutRequestId}: get: tags: - FastConnect summary: Get payout request by ID description: >- Retorna os detalhes completos de uma solicitação de saque. **Somente admin.** Contas merchant recebem `403` neste endpoint — para consultar as próprias solicitações, use a listagem `GET /v1/payout-requests`. parameters: - name: payoutRequestId in: path required: true description: ID of the payout request schema: type: string example: 2vorkDcXyvzifL63YX09S9VqcnI responses: '200': description: Payout request found successfully content: application/json: schema: $ref: '#/components/schemas/PayoutRequest' '401': description: Unauthorized - invalid credentials content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: statusCode: 401 message: Unauthorized '403': description: Forbidden - insufficient permissions content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: statusCode: 403 message: Forbidden '404': description: Not Found - payout request not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: statusCode: 404 message: Payout request not found '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: statusCode: 500 message: Internal server error security: - bearer: [] components: schemas: PayoutRequest: type: object properties: id: type: string description: Unique identifier of the request example: 2vorkDcXyvzifL63YX09S9VqcnI merchantId: type: string description: ID of the submerchant that requested the payout example: 36OO3bcGjhPjjF3tzrqOGcmQuKo amount: type: number description: Gross amount requested (in reais / BRL) example: 100 currency: type: string description: Currency (always BRL for submerchants) example: BRL payoutFee: type: number description: Calculated payout fee (in reais / BRL) example: 1 netAmount: type: number description: >- Net amount that will be transferred after fee deduction (in reais / BRL) example: 99 status: type: string enum: - pending - approved - rejected description: Current status example: pending externalAccountDetails: type: object description: Account details for payout (PIX with CNPJ) properties: type: type: string example: pix pixKey: type: string description: PIX key (submerchant CNPJ) example: '12345678000199' rejectionReason: type: string nullable: true description: Rejection reason (only if status = 'rejected') example: null processedAt: type: string format: date-time nullable: true description: Processing date/time (only if approved or rejected) example: null createdAt: type: string format: date-time description: Creation date/time example: '2025-12-04T18:45:52.988Z' updatedAt: type: string format: date-time description: Last update date/time example: '2025-12-04T18:45:52.988Z' merchantLegalName: type: string description: Legal name of the submerchant (included in the list response). example: ACME PAGAMENTOS LTDA merchantEmail: type: string description: Contact email of the submerchant (included in the list response). example: contato@acme.com ErrorResponse: type: object properties: statusCode: type: integer description: HTTP status code example: 422 message: type: string description: Descriptive error message example: SubMerchant is not active error: type: string description: Error type example: Unprocessable Entity securitySchemes: bearer: type: http scheme: bearer bearerFormat: JWT description: |- JWT Bearer token authentication. Use the JWT token obtained from the login endpoint in the Authorization header as 'Bearer {token}'. ````