Skip to main content
PUT
/
v1
/
businesses
/
{businessId}
/
vendor-payouts
/
{payoutId}
Update vendor payout
curl --request PUT \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts/{payoutId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paid_out_amount": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "bill_payments": [
    {
      "bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_payment_external_id": "<string>"
    }
  ],
  "vendor_refund_payments": [
    {
      "vendor_refund_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_refund_payment_external_id": "<string>"
    }
  ],
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "other_transactions": [
    {
      "amount": 123,
      "account": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "description": "<string>",
      "external_id": "<string>"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}
'
import requests

url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts/{payoutId}"

payload = {
    "paid_out_amount": 123,
    "completed_at": "2023-11-07T05:31:56Z",
    "bill_payments": [
        {
            "bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bill_payment_external_id": "<string>"
        }
    ],
    "vendor_refund_payments": [
        {
            "vendor_refund_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "vendor_refund_payment_external_id": "<string>"
        }
    ],
    "tags": [
        {
            "key": "department",
            "value": "sales",
            "dimension_display_name": "Department",
            "value_display_name": "Sales Department"
        }
    ],
    "other_transactions": [
        {
            "amount": 123,
            "account": {
                "type": "AccountId",
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "description": "<string>",
            "external_id": "<string>"
        }
    ],
    "memo": "<string>",
    "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
            "meaning of life": 42,
            "array": []
        }
    },
    "reference_number": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    paid_out_amount: 123,
    completed_at: '2023-11-07T05:31:56Z',
    bill_payments: [
      {
        bill_payment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        bill_payment_external_id: '<string>'
      }
    ],
    vendor_refund_payments: [
      {
        vendor_refund_payment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        vendor_refund_payment_external_id: '<string>'
      }
    ],
    tags: [
      {
        key: 'department',
        value: 'sales',
        dimension_display_name: 'Department',
        value_display_name: 'Sales Department'
      }
    ],
    other_transactions: [
      {
        amount: 123,
        account: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
        description: '<string>',
        external_id: '<string>'
      }
    ],
    memo: '<string>',
    metadata: {
      custom_field: 'value',
      'any valid json': 'below 1kb',
      nested: {'meaning of life': 42, array: []}
    },
    reference_number: '<string>'
  })
};

fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts/{payoutId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts/{payoutId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'paid_out_amount' => 123,
    'completed_at' => '2023-11-07T05:31:56Z',
    'bill_payments' => [
        [
                'bill_payment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'bill_payment_external_id' => '<string>'
        ]
    ],
    'vendor_refund_payments' => [
        [
                'vendor_refund_payment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'vendor_refund_payment_external_id' => '<string>'
        ]
    ],
    'tags' => [
        [
                'key' => 'department',
                'value' => 'sales',
                'dimension_display_name' => 'Department',
                'value_display_name' => 'Sales Department'
        ]
    ],
    'other_transactions' => [
        [
                'amount' => 123,
                'account' => [
                                'type' => 'AccountId',
                                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'description' => '<string>',
                'external_id' => '<string>'
        ]
    ],
    'memo' => '<string>',
    'metadata' => [
        'custom_field' => 'value',
        'any valid json' => 'below 1kb',
        'nested' => [
                'meaning of life' => 42,
                'array' => [
                                
                ]
        ]
    ],
    'reference_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts/{payoutId}"

	payload := strings.NewReader("{\n  \"paid_out_amount\": 123,\n  \"completed_at\": \"2023-11-07T05:31:56Z\",\n  \"bill_payments\": [\n    {\n      \"bill_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"bill_payment_external_id\": \"<string>\"\n    }\n  ],\n  \"vendor_refund_payments\": [\n    {\n      \"vendor_refund_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"vendor_refund_payment_external_id\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    {\n      \"key\": \"department\",\n      \"value\": \"sales\",\n      \"dimension_display_name\": \"Department\",\n      \"value_display_name\": \"Sales Department\"\n    }\n  ],\n  \"other_transactions\": [\n    {\n      \"amount\": 123,\n      \"account\": {\n        \"type\": \"AccountId\",\n        \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      },\n      \"description\": \"<string>\",\n      \"external_id\": \"<string>\"\n    }\n  ],\n  \"memo\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"any valid json\": \"below 1kb\",\n    \"nested\": {\n      \"meaning of life\": 42,\n      \"array\": []\n    }\n  },\n  \"reference_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts/{payoutId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paid_out_amount\": 123,\n  \"completed_at\": \"2023-11-07T05:31:56Z\",\n  \"bill_payments\": [\n    {\n      \"bill_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"bill_payment_external_id\": \"<string>\"\n    }\n  ],\n  \"vendor_refund_payments\": [\n    {\n      \"vendor_refund_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"vendor_refund_payment_external_id\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    {\n      \"key\": \"department\",\n      \"value\": \"sales\",\n      \"dimension_display_name\": \"Department\",\n      \"value_display_name\": \"Sales Department\"\n    }\n  ],\n  \"other_transactions\": [\n    {\n      \"amount\": 123,\n      \"account\": {\n        \"type\": \"AccountId\",\n        \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      },\n      \"description\": \"<string>\",\n      \"external_id\": \"<string>\"\n    }\n  ],\n  \"memo\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"any valid json\": \"below 1kb\",\n    \"nested\": {\n      \"meaning of life\": 42,\n      \"array\": []\n    }\n  },\n  \"reference_number\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts/{payoutId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paid_out_amount\": 123,\n  \"completed_at\": \"2023-11-07T05:31:56Z\",\n  \"bill_payments\": [\n    {\n      \"bill_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"bill_payment_external_id\": \"<string>\"\n    }\n  ],\n  \"vendor_refund_payments\": [\n    {\n      \"vendor_refund_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"vendor_refund_payment_external_id\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    {\n      \"key\": \"department\",\n      \"value\": \"sales\",\n      \"dimension_display_name\": \"Department\",\n      \"value_display_name\": \"Sales Department\"\n    }\n  ],\n  \"other_transactions\": [\n    {\n      \"amount\": 123,\n      \"account\": {\n        \"type\": \"AccountId\",\n        \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      },\n      \"description\": \"<string>\",\n      \"external_id\": \"<string>\"\n    }\n  ],\n  \"memo\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"any valid json\": \"below 1kb\",\n    \"nested\": {\n      \"meaning of life\": 42,\n      \"array\": []\n    }\n  },\n  \"reference_number\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "type": "Vendor_Payout",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "vendor-payout-1234",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "paid_out_amount": 123,
    "processor": "STRIPE",
    "imported_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "payments": [
      {
        "type": "com.layerfi.routers.ApiBillPayment",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "vendor": {
          "type": "VendorData",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "individual_name": "<string>",
          "company_name": "<string>",
          "email": "<string>",
          "mobile_phone": "<string>",
          "office_phone": "<string>",
          "address_string": "<string>",
          "memo": "<string>",
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ]
        },
        "at": "2023-11-07T05:31:56Z",
        "amount": 123,
        "processor": "<string>",
        "payment_clearing_account": {
          "type": "Single_Chart_Account",
          "id": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "name": "Current Assets",
          "account_number": "4000",
          "stable_name": {
            "type": "StableName",
            "stable_name": "CURRENT_ASSETS"
          },
          "account_type": {
            "display_name": "Asset"
          },
          "account_subtype": {
            "display_name": "Current Assets"
          }
        },
        "imported_at": "2023-11-07T05:31:56Z",
        "allocations": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "amount": 123,
            "transaction_tags": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "key": "ExampleTagKey",
                "value": "ExampleTagValue",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 1kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "transaction_tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "ExampleTagKey",
            "value": "ExampleTagValue",
            "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dimension_display_name": "<string>",
            "value_display_name": "<string>",
            "archived_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 1kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      }
    ],
    "refunds": [
      {
        "type": "Vendor_Refund",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "vendor-refund-123",
        "refunded_amount": 123,
        "status": "PAID",
        "completed_at": "2023-11-07T05:31:56Z",
        "allocations": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "amount": 123,
            "line_items": [
              {
                "external_id": "<string>",
                "amount": 123,
                "ledger_account": {
                  "type": "Single_Chart_Account",
                  "id": {
                    "type": "AccountId",
                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  },
                  "name": "Current Assets",
                  "account_number": "4000",
                  "stable_name": {
                    "type": "StableName",
                    "stable_name": "CURRENT_ASSETS"
                  },
                  "account_type": {
                    "display_name": "Asset"
                  },
                  "account_subtype": {
                    "display_name": "Current Assets"
                  }
                },
                "prepayment_account": {
                  "type": "Single_Chart_Account",
                  "id": {
                    "type": "AccountId",
                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  },
                  "name": "Current Assets",
                  "account_number": "4000",
                  "stable_name": {
                    "type": "StableName",
                    "stable_name": "CURRENT_ASSETS"
                  },
                  "account_type": {
                    "display_name": "Asset"
                  },
                  "account_subtype": {
                    "display_name": "Current Assets"
                  }
                },
                "transaction_tags": [
                  {
                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "key": "ExampleTagKey",
                    "value": "ExampleTagValue",
                    "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "dimension_display_name": "<string>",
                    "value_display_name": "<string>",
                    "archived_at": "2023-11-07T05:31:56Z"
                  }
                ],
                "memo": "<string>",
                "metadata": {
                  "custom_field": "value",
                  "any valid json": "below 1kb",
                  "nested": {
                    "meaning of life": 42,
                    "array": []
                  }
                },
                "reference_number": "<string>"
              }
            ],
            "bill_external_id": "<string>",
            "bill_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bill_line_item_external_id": "<string>",
            "bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bill_payment_external_id": "<string>",
            "vendor": {
              "type": "VendorData",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "external_id": "<string>",
              "individual_name": "<string>",
              "company_name": "<string>",
              "email": "<string>",
              "mobile_phone": "<string>",
              "office_phone": "<string>",
              "address_string": "<string>",
              "memo": "<string>",
              "transaction_tags": [
                {
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "key": "ExampleTagKey",
                  "value": "ExampleTagValue",
                  "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "dimension_display_name": "<string>",
                  "value_display_name": "<string>",
                  "archived_at": "2023-11-07T05:31:56Z"
                }
              ]
            },
            "transaction_tags": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "key": "ExampleTagKey",
                "value": "ExampleTagValue",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 1kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "payments": [
          {
            "type": "Vendor_Refund_Payment",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "external_id": "payment-456",
            "refunded_amount": 123,
            "refund_processing_fee": 123,
            "completed_at": "2023-11-07T05:31:56Z",
            "method": "ACH",
            "processor": "STRIPE",
            "payment_clearing_account": {
              "type": "Single_Chart_Account",
              "id": {
                "type": "AccountId",
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              },
              "name": "Current Assets",
              "account_number": "4000",
              "stable_name": {
                "type": "StableName",
                "stable_name": "CURRENT_ASSETS"
              },
              "account_type": {
                "display_name": "Asset"
              },
              "account_subtype": {
                "display_name": "Current Assets"
              }
            },
            "transaction_tags": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "key": "ExampleTagKey",
                "value": "ExampleTagValue",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 1kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "transaction_tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "ExampleTagKey",
            "value": "ExampleTagValue",
            "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dimension_display_name": "<string>",
            "value_display_name": "<string>",
            "archived_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 1kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      }
    ],
    "other_transactions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "account": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "description": "<string>",
        "external_id": "<string>"
      }
    ],
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ],
    "match": {
      "type": "Match",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bank_transaction": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "date": "2023-11-07T05:31:56Z",
        "amount": 123,
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
        "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
        "external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "imported_at": "2023-11-07T05:31:56Z",
        "counterparty_name": "WeWork",
        "description": "WeWork monthly rent payment",
        "account_name": "Plaid Checking",
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 1kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      },
      "details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "Transfer from SavingsAccount to CheckingAccount"
      }
    },
    "suggested_matches": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "details": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "date": "2023-11-07T05:31:56Z",
          "description": "Transfer from SavingsAccount to CheckingAccount"
        }
      }
    ],
    "memo": "<string>",
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 1kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    },
    "reference_number": "<string>"
  }
}

ā€‹
Rate Limiting

This endpoint has a custom rate limit policy. Rate Limit Details:
EnvironmentLimitRefill PeriodInitial Size
Sandbox20 requests1 second40 requests
Production20 requests1 second40 requests
Response Headers: All responses include the following rate limit headers:
  • X-RateLimit-Limit: The rate limit bucket capacity
  • X-RateLimit-Remaining: The number of tokens remaining in the bucket
  • X-RateLimit-Reset: UTC timestamp (in seconds) when the bucket will be refilled
For more details on rate limiting, see Rate Limiting.

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ā€‹
Content-Type
string

Content-Type must be set to application/json.

Path Parameters

ā€‹
businessId
string
required

The UUID of the business to update the vendor payout for.

ā€‹
payoutId
string
required

The UUID of the vendor payout to update.

Body

application/json
ā€‹
paid_out_amount
integer<int64>

The amount of the vendor payout, in cents.

ā€‹
processor
enum<string> | null

Processor used to make the payment, if any. Any processor name can be provided and will be tracked.

Available options:
STRIPE,
PAYPAL,
SHOPIFY,
ADYEN,
RAINFOREST
ā€‹
completed_at
string<date-time>

Timestamp of when the vendor payout was completed.

ā€‹
bill_payments
object[]

A list of bill payments associated with the vendor payout.

ā€‹
vendor_refund_payments
object[]

A list of vendor refund payments associated with the vendor payout.

ā€‹
tags
object[]

A list of tags associated with the vendor payout.

ā€‹
other_transactions
object[]

A list of other transactions associated with the vendor payout.

ā€‹
memo
string | null

Memo for any text you would like to associate with the vendor payout (for example, to display to end users).

ā€‹
metadata
object | null

Arbitrary custom metadata in JSON format with a size limit of 1KB.

Example:
{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}
ā€‹
reference_number
string | null

Any (typically user-visible) identifier you would like to associate with the vendor payout. Can be used to filter when listing vendor payouts.

Response

200 - application/json
ā€‹
data
object
required