RFIs

Answer 1 to N items

Answer one or more items of the RFI in a single call — each element of items[] names its own item_id. This is still per-item: each named item gets its own transition and its own event; what you avoid is one round-trip per item for what was, for you, one action (fill the form, submit).

Marks each item answered on receipt — not when anything downstream accepts it. All-or-nothing: every item in the batch is validated against its own answer_spec before any of them is written; if one fails, the whole call returns 422 naming which, and the server is left exactly as it was.

Answering a returned item is answering it again with the same item_id — a returned item is still pending, carrying a review_note, and there is no successor RFI or item to discover. A document item is never answered here; upload files to it instead (see the document endpoints below). Partial answers are the normal case, not an edge case: answering item 1 and 3 and leaving item 2 is expected.

PATCH

rfis

{rfi_id}

items

Answer 1 to N items

curl --request PATCH \
  --url https://api.balampay.com/v1/rfis/{rfi_id}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "items": [
    {
      "item_id": "0198f2c2-0000-0000-0000-000000000000",
      "answer_value": "12-3456789"
    },
    {
      "item_id": "0198f2c3-0000-0000-0000-000000000000",
      "answer_value": "Export sales to three LATAM customers"
    }
  ]
}
'

import requests

url = "https://api.balampay.com/v1/rfis/{rfi_id}/items"

payload = { "items": [
        {
            "item_id": "0198f2c2-0000-0000-0000-000000000000",
            "answer_value": "12-3456789"
        },
        {
            "item_id": "0198f2c3-0000-0000-0000-000000000000",
            "answer_value": "Export sales to three LATAM customers"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    items: [
      {item_id: '0198f2c2-0000-0000-0000-000000000000', answer_value: '12-3456789'},
      {
        item_id: '0198f2c3-0000-0000-0000-000000000000',
        answer_value: 'Export sales to three LATAM customers'
      }
    ]
  })
};

fetch('https://api.balampay.com/v1/rfis/{rfi_id}/items', 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://api.balampay.com/v1/rfis/{rfi_id}/items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'item_id' => '0198f2c2-0000-0000-0000-000000000000',
                'answer_value' => '12-3456789'
        ],
        [
                'item_id' => '0198f2c3-0000-0000-0000-000000000000',
                'answer_value' => 'Export sales to three LATAM customers'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://api.balampay.com/v1/rfis/{rfi_id}/items"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"item_id\": \"0198f2c2-0000-0000-0000-000000000000\",\n      \"answer_value\": \"12-3456789\"\n    },\n    {\n      \"item_id\": \"0198f2c3-0000-0000-0000-000000000000\",\n      \"answer_value\": \"Export sales to three LATAM customers\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")
	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.patch("https://api.balampay.com/v1/rfis/{rfi_id}/items")
  .header("Authorization", "Bearer <token>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"item_id\": \"0198f2c2-0000-0000-0000-000000000000\",\n      \"answer_value\": \"12-3456789\"\n    },\n    {\n      \"item_id\": \"0198f2c3-0000-0000-0000-000000000000\",\n      \"answer_value\": \"Export sales to three LATAM customers\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/v1/rfis/{rfi_id}/items")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"item_id\": \"0198f2c2-0000-0000-0000-000000000000\",\n      \"answer_value\": \"12-3456789\"\n    },\n    {\n      \"item_id\": \"0198f2c3-0000-0000-0000-000000000000\",\n      \"answer_value\": \"Export sales to three LATAM customers\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ordinal": 123,
      "prompt": "<string>",
      "answer_type": "text_long",
      "answer_spec": {
        "mime_types": [
          "application/pdf"
        ],
        "max_files": 5
      },
      "target_key": "<string>",
      "status": "pending",
      "answer_value": "<string>",
      "documents": [
        {
          "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "file_name": "january.pdf",
          "mime_type": "application/pdf",
          "size_bytes": 123,
          "uploaded_at": "2023-11-07T05:31:56Z",
          "checksum": "<string>"
        }
      ],
      "review_note": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "returned_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<array>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "errors": [
    {
      "item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message": "<string>"
    }
  ]
}

Stable since 2025-01-01 — unchanged in 2026-06-01.

Authorizations

Authorization

string

header

required

Access token from POST /auth (the data.access_token value).

x-api-key

string

header

required

API key issued by Kira. Required on every request, including /auth.

Headers

X-Api-Version

string

Optional. The date-versioned API version to apply for this request (e.g. 2026-04-14). When sent it always wins, even over your pinned account default. When omitted, the API uses your account's pinned version if set, otherwise a baseline default.

Example:

"2026-06-01"

Path Parameters

rfi_id

string<uuid>

required

RFI UUID.

Body

application/json

items

object[]

required

1 to N items to answer in one call, each naming its item_id. Validated against every named item's answer_spec before anything is written: if any entry fails, the whole batch is rejected with 422 and the server is left exactly as it was. A document item is never answered here — upload files to it instead.

Minimum array length: 1

Show child attributes

Response

All named items were valid and are now answered.

items

object[]

required

The items named in the request, each reflecting the write (status: "answered", answer_value/documents, updated_at).

Show child attributes

Answer 1 to N items

curl --request PATCH \
  --url https://api.balampay.com/v1/rfis/{rfi_id}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "items": [
    {
      "item_id": "0198f2c2-0000-0000-0000-000000000000",
      "answer_value": "12-3456789"
    },
    {
      "item_id": "0198f2c3-0000-0000-0000-000000000000",
      "answer_value": "Export sales to three LATAM customers"
    }
  ]
}
'

import requests

url = "https://api.balampay.com/v1/rfis/{rfi_id}/items"

payload = { "items": [
        {
            "item_id": "0198f2c2-0000-0000-0000-000000000000",
            "answer_value": "12-3456789"
        },
        {
            "item_id": "0198f2c3-0000-0000-0000-000000000000",
            "answer_value": "Export sales to three LATAM customers"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    items: [
      {item_id: '0198f2c2-0000-0000-0000-000000000000', answer_value: '12-3456789'},
      {
        item_id: '0198f2c3-0000-0000-0000-000000000000',
        answer_value: 'Export sales to three LATAM customers'
      }
    ]
  })
};

fetch('https://api.balampay.com/v1/rfis/{rfi_id}/items', 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://api.balampay.com/v1/rfis/{rfi_id}/items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'item_id' => '0198f2c2-0000-0000-0000-000000000000',
                'answer_value' => '12-3456789'
        ],
        [
                'item_id' => '0198f2c3-0000-0000-0000-000000000000',
                'answer_value' => 'Export sales to three LATAM customers'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://api.balampay.com/v1/rfis/{rfi_id}/items"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"item_id\": \"0198f2c2-0000-0000-0000-000000000000\",\n      \"answer_value\": \"12-3456789\"\n    },\n    {\n      \"item_id\": \"0198f2c3-0000-0000-0000-000000000000\",\n      \"answer_value\": \"Export sales to three LATAM customers\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")
	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.patch("https://api.balampay.com/v1/rfis/{rfi_id}/items")
  .header("Authorization", "Bearer <token>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"item_id\": \"0198f2c2-0000-0000-0000-000000000000\",\n      \"answer_value\": \"12-3456789\"\n    },\n    {\n      \"item_id\": \"0198f2c3-0000-0000-0000-000000000000\",\n      \"answer_value\": \"Export sales to three LATAM customers\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/v1/rfis/{rfi_id}/items")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"item_id\": \"0198f2c2-0000-0000-0000-000000000000\",\n      \"answer_value\": \"12-3456789\"\n    },\n    {\n      \"item_id\": \"0198f2c3-0000-0000-0000-000000000000\",\n      \"answer_value\": \"Export sales to three LATAM customers\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ordinal": 123,
      "prompt": "<string>",
      "answer_type": "text_long",
      "answer_spec": {
        "mime_types": [
          "application/pdf"
        ],
        "max_files": 5
      },
      "target_key": "<string>",
      "status": "pending",
      "answer_value": "<string>",
      "documents": [
        {
          "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "file_name": "january.pdf",
          "mime_type": "application/pdf",
          "size_bytes": 123,
          "uploaded_at": "2023-11-07T05:31:56Z",
          "checksum": "<string>"
        }
      ],
      "review_note": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "returned_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<array>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "errors": [
    {
      "item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message": "<string>"
    }
  ]
}

Authentication

Versioning

Users

Virtual Accounts

Quotations

Payouts

Recipients

Reference

RFIs

Answer 1 to N items

Authorizations

Headers

Path Parameters

Body

Response