> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# Deposit funds

POST https://api-sandbox.payabli.com/api/Funding/depositFunds
Content-Type: application/json

Deposits funds into a paypoint's available payout balance. Deposited funds enter a pending state and aren't available for instant payouts until confirmed through FBO reconciliation.

Reference: https://docs.payabli.com/developers/api-reference/funding/deposit-funds

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: payabliApi-oas
  version: 1.0.0
paths:
  /Funding/depositFunds:
    post:
      operationId: deposit-funds
      summary: Deposit funds
      description: >-
        Deposits funds into a paypoint's available payout balance. Deposited
        funds enter a pending state and aren't available for instant payouts
        until confirmed through FBO reconciliation.
      tags:
        - subpackage_funding
      parameters:
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositFundsResponse'
        '400':
          description: Bad request / invalid data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
        '401':
          description: Unauthorized request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
        '503':
          description: Database connection error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepositFundsBody'
servers:
  - url: https://api-sandbox.payabli.com/api
    description: Sandbox
  - url: https://api.payabli.com/api
    description: Production
components:
  schemas:
    Entrypointfield:
      type: string
      description: The entrypoint identifier.
      title: Entrypointfield
    PaypointId:
      type: integer
      format: int64
      description: The paypoint's ID. Note that this is different than the entryname.
      title: PaypointId
    DepositFundsBody:
      type: object
      properties:
        amount:
          type: number
          format: double
          description: The amount to deposit, in dollars. Must be greater than zero.
        entrypoint:
          $ref: '#/components/schemas/Entrypointfield'
          description: The entry point identifier for the paypoint receiving the deposit.
        accountId:
          type: string
          description: The remittance account ID to withdraw funds from.
        paypointId:
          $ref: '#/components/schemas/PaypointId'
          description: >-
            The paypoint ID. Optional if the entry point uniquely identifies the
            paypoint.
        sameDayAch:
          type: boolean
          description: >-
            When `true` and the request is submitted before 2 PM ET, the deposit
            processes as same-day ACH. If the request is submitted after 2 PM
            ET, it processes as standard ACH regardless of this flag.
      required:
        - amount
        - entrypoint
        - accountId
      description: >-
        Request body for depositing funds into a paypoint's available payout
        balance.
      title: DepositFundsBody
    IsSuccess:
      type: boolean
      description: |
        Boolean indicating whether the operation was successful. A `true` value
        indicates success. A `false` value indicates failure.
      title: IsSuccess
    ResponseText:
      type: string
      description: |
        Response text for operation: 'Success' or 'Declined'.
      title: ResponseText
    Responsedata:
      type: object
      additionalProperties:
        description: Any type
      description: The object containing the response data.
      title: Responsedata
    PageIdentifier:
      type: string
      description: Auxiliary validation used internally by payment pages and components.
      title: PageIdentifier
    DepositFundsResponse:
      type: object
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          oneOf:
            - $ref: '#/components/schemas/Responsedata'
            - type: 'null'
          description: The object containing the response data.
        pageIdentifier:
          oneOf:
            - $ref: '#/components/schemas/PageIdentifier'
            - type: 'null'
          description: >-
            Auxiliary validation used internally by payment pages and
            components.
      required:
        - responseText
        - responseData
        - pageIdentifier
      description: Response for a deposit funds request.
      title: DepositFundsResponse
    PayabliErrorBodyResponseData:
      type: object
      properties:
        explanation:
          type: string
          description: Human-readable explanation of what happened.
        todoAction:
          type: string
          description: Suggested resolution.
      description: Object with detailed error context.
      title: PayabliErrorBodyResponseData
    PayabliErrorBody:
      type: object
      properties:
        isSuccess:
          type: boolean
          description: Always `false` for error responses.
        responseCode:
          type: integer
          description: |
            Code for the response. Learn more in
            [API Response Codes](/developers/api-reference/api-responses).
        responseText:
          type: string
          description: Error text describing what went wrong.
        responseData:
          $ref: '#/components/schemas/PayabliErrorBodyResponseData'
          description: Object with detailed error context.
      required:
        - isSuccess
        - responseText
      description: |
        Shape returned by every Payabli API error response. The `responseData`
        object carries human-readable error context.
      title: PayabliErrorBody
  securitySchemes:
    APIKeyAuth:
      type: apiKey
      in: header
      name: requestToken

```

## Examples



**Request**

```json
{
  "amount": 10,
  "entrypoint": "48acde49",
  "accountId": "333"
}
```

**Response**

```json
{
  "responseText": "Success",
  "responseData": null,
  "pageIdentifier": null,
  "isSuccess": true
}
```

**SDK Code**

```typescript
import { PayabliClient } from "@payabli/sdk-node";

async function main() {
    const client = new PayabliClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.funding.depositFunds({
        amount: 10,
        entrypoint: "48acde49",
        accountId: "333",
    });
}
main();

```

```python
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY_HERE",
)

client.funding.deposit_funds(
    amount=10,
    entrypoint="48acde49",
    account_id="333",
)

```

```java
package com.example.usage;

import io.github.payabli.api.PayabliPayabliApiOasClient;
import io.github.payabli.api.resources.funding.requests.DepositFundsRequest;

public class Example {
    public static void main(String[] args) {
        PayabliPayabliApiOasClient client = PayabliPayabliApiOasClient
            .builder()
            .apiKey("YOUR_API_KEY_HERE")
            .build();

        client.funding().depositFunds(
            DepositFundsRequest
                .builder()
                .amount(10.0)
                .entrypoint("48acde49")
                .accountId("333")
                .build()
        );
    }
}
```

```ruby
require "payabli"

client = Payabli::Client.new(api_key: "YOUR_API_KEY_HERE")

client.funding.deposit_funds(
  amount: 10,
  entrypoint: "48acde49",
  account_id: "333"
)

```

```csharp
using PayabliPayabliApiOas;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliPayabliApiOasClient(
            apiKey: "YOUR_API_KEY_HERE"
        );

        await client.Funding.DepositFundsAsync(
            new DepositFundsRequest {
                Amount = 10,
                Entrypoint = "48acde49",
                AccountId = "333"
            }
        );
    }

}

```

```go
package example

import (
    context "context"

    payabli "github.com/payabli/sdk-go"
    client "github.com/payabli/sdk-go/client"
    option "github.com/payabli/sdk-go/option"
)

func do() {
    client := client.NewClient(
        option.WithApiKey(
            "YOUR_API_KEY_HERE",
        ),
    )
    request := &payabli.DepositFundsRequest{
        Amount: 10,
        Entrypoint: "48acde49",
        AccountId: "333",
    }
    client.Funding.DepositFunds(
        context.TODO(),
        request,
    )
}

```

```php
<?php

namespace Example;

use Payabli\PayabliClient;
use Payabli\Funding\Requests\DepositFundsRequest;

$client = new PayabliClient(
    apiKey: 'YOUR_API_KEY_HERE',
);
$client->funding->depositFunds(
    new DepositFundsRequest([
        'amount' => 10,
        'entrypoint' => '48acde49',
        'accountId' => '333',
    ]),
);

```

```swift
import Foundation

let headers = [
  "requestToken": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "amount": 10,
  "entrypoint": "48acde49",
  "accountId": "333"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Funding/depositFunds")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```