> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcarbon.co/llms.txt > Use this file to discover all available pages before exploring further. # Approve or Decline Payout > Approve or decline a pending payout request using its authorization code. ## Overview This endpoint allows you to approve or decline a pending payout request. You must provide the `authCode` from the pending approval record along with the desired `action`. A `reason` is required when declining. ### Request **Method:** `POST` **URL:** `/v1/payouts/approvals/approve` #### Parameters | Name | In | Type | Required | Description | | -------------- | ------ | -------- | -------- | --------------------------- | | `x-carbon-key` | Header | `string` | Yes | API key for authentication. | #### Request Body | Field | Type | Required | Description | | ---------- | ------ | --------------------------------- | ---------------------------------------------------------- | | `authCode` | string | Yes | Authorization code of the pending payout (e.g. `TRF-...`). | | `action` | string | Yes | Action to take: `approve` or `decline`. | | `reason` | string | Required if `action` is `decline` | Reason for declining the payout. | ```json theme={null} { "authCode": "TRF-1771341301552SNKED", "action": "approve", "reason": "" } ``` When `action` is `decline`, the `reason` field is required. For `approve`, it can be left as an empty string or omitted. ### Response **Status Code:** `200 OK` **Content-Type:** `application/json` #### Example Response (Approved) ```json theme={null} { "status": "success", "message": "Payout approved successfully" } ``` #### Example Response (Declined) ```json theme={null} { "status": "success", "message": "Payout declined successfully" } ``` ### Error Responses **Status Code:** `400 Bad Request` ```json theme={null} { "status": "failed", "message": "invalid authorization code" } ``` **Status Code:** `422 Unprocessable Entity` Returned when `action` is `decline` but `reason` is missing. ```json theme={null} { "status": "failed", "message": "reason is required when declining a payout" } ``` ## OpenAPI ````yaml POST /v1/payouts/approvals/approve openapi: 3.0.0 info: title: Carbon Business API description: >- ## Welcome to our API Developer Documentation Carbon aims to unlock the full potential of your business with a feature-rich account designed for growth. ## Integrations We aim to provide our APIs for developers and businesses to offer financial services to their existing customer base through REST APIs without doing the heavy lifting. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. ### Authentication `Authorization : API Key` Header `x-carbon-key : value` `x-carbon-key` can be generated via developer page on Carbon Business | Environment | URL | | --- | --- | | Live | | | Sandbox | [https://carbonapistagingsecure.getcarbon.co/baas/api](https://carbonapistagingsecure.getcarbon.co/baas/api) | ### **Handling Errors** We use the conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with our servers. | Error | Description | | --- | --- | | 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. | | 401 - Unauthorized | Not a valid API key was provided. | | 402 - Request Failed | The parameters were valid but the request failed. | | 403 - Forbidden | The API key doesn't have permission to perform the request. | | 404 - Not Found | The requested resource doesn't exist. | | 429 - Too Many Requests | Too many requests hit the API | | 500, 502, 503, 504 - Server Errors | System Error | version: 1.0.0 servers: - url: https://carbonapistagingsecure.getcarbon.co/baas/api description: >- Replace {{base_url}} with your API base URL (e.g., https://api.example.com) security: - apikeyAuth: [] tags: - name: Accounts description: >- Virtual accounts are generated account details (account number and bank) that allow Carbon Business merchants to receive payments from customers via NGN bank transfer. This is currently only available in naira (NGN). Virtual accounts are either dynamic (temporary) or static (permanent). A dynamic account number expires after handling a transaction, while a static account number doesn't expire. **Static Account** Creating static accounts can be useful when receiving recurring payments through bank transfers. The process involves generating a static virtual account with customer information. Once payment is made, we will send you a webhook notification, which you can then manage. **Dynamic Account** Creating dynamic accounts can be useful when receiving one-time payments through bank transfers. The process involves generating a dynamic virtual account with a set amount for the customer during checkout. Once payment is made, we will send you a webhook notification, which you can then manage. Key things you can do with these endpoints: - Create an account - Retreive an account - Verify Transaction - Retreive a list of transactions - name: Accounts > Transactions - name: Banks description: |- - Get a list of banks and financial institutions - Verify/resolve account details - name: Customers description: >- This collection contains a set of API endpoints to manage customer-related operations for an application. The endpoints allow for creating a new customer, retrieving a list of all customers, and fetching details of a single customer. - Create Customer - Fetch Customer/Customers - name: Payout description: |- - Make Transfer - Verify Transfer - name: Status description: '- Service Health check' - name: Verification - name: Webhook description: |- ## EVENTS `account.incoming-transaction` ``` json { "event": "account.incoming-transaction", "data": { "id": "string", "amount": "float", "currency": "string", "transactionType": "string", "entryDate": "datetime", "uniqueRef": "string", "account": { "id": "string", "bankAccount": { "accountName": "string", "accountNumber": "string", "bank": { "code": "string", "name": "string" } }, "static": boolean, "currency": "string", "clientId": "string" } } } ``` `account.outgoing-transaction` ``` json { "event": "account.outgoing-transaction", "data": { "id": "string", "amount": "float", "currency": "string", "transactionType": "string", "entryDate": "datetime", "uniqueRef": "string", "account": { "id": "string", "bankAccount": { "accountName": "string", "accountNumber": "string", "bank": { "code": "string", "name": "string" } }, "static": boolean, "currency": "string", "clientId": "string" } } } ``` - name: Loans description: >- Partner lending API. Enables fintech partners to originate business loans for their end-customers. - Enroll customers for lending and trigger KYC - Submit loan applications and supporting documents - Manage offer acceptance, disbursement account, and post-offer steps - Charge repayments and retrieve repayment schedules paths: /v1/payouts/approvals/approve: post: tags: - Payout summary: Approve or Decline Payout description: >- Approves or declines a pending payout request using its authorization code. ### Request Body - `authCode` (string, required): Authorization code of the pending payout (e.g. `TRF-...`). - `action` (string, required): Action to take — `approve` or `decline`. - `reason` (string, required if action is `decline`): Reason for declining the payout. ### Response - `status` (string): Overall request status. - `message` (string): Human-readable result message. parameters: - name: x-carbon-key in: header schema: type: string required: true example: '{{access_token}}' requestBody: description: Provide the required values for the request body. required: true content: application/json: schema: type: object required: - authCode - action properties: authCode: type: string description: Authorization code of the pending payout. example: TRF-1771341301552SNKED action: type: string description: 'Action to take: approve or decline.' enum: - approve - decline example: approve reason: type: string description: Reason for declining. Required when action is decline. example: '' example: authCode: TRF-1771341301552SNKED action: approve reason: '' responses: '200': description: OK content: application/json: schema: type: object example: status: success message: Payout approved successfully '400': description: Bad Request content: application/json: schema: type: object example: status: failed message: invalid authorization code '422': description: Unprocessable Entity content: application/json: schema: type: object example: status: failed message: reason is required when declining a payout components: securitySchemes: apikeyAuth: type: apiKey in: header name: apikey description: Provide your API key in the 'apikey' header. ````