Match a bank deposit to a customer payment receipt

Required API key scope: accounting:write

Atomically links an inbound bank transaction to an order_payments receipt by setting bank_transactions.matched_order_payment_id and flipping reconciliation_status to 'matched'.

No GL postings occur. The GL entry (DR Bank / CR AR) was posted when the payment receipt was recorded. This operation records only the reconciliation link for the bank statement.

Guards enforced:

• Transaction must be inbound (direction='in' or NULL); outbound transactions use the AP-side matcher instead.
• Transaction must not already be matched to a customer payment.
• Payment status must be posted, partial_refund, or succeeded.
• Entity isolation: bank transaction and order payment must belong to the same entity as the API key.

Amount warning: If the absolute difference between the bank transaction amount and the payment amount exceeds $0.05, amount_warning is populated in the response (non-blocking, for operator awareness).

A.2 Multi-invoice payments: Payments where order_id IS NULL (applied across multiple invoices) are fully supported as match targets.

Idempotency: Matching an already-matched transaction to the same payment is a no-op returning the same matched: true response.

POST /accounting/bank-transactions/{bank_transaction_id}/match-customer-payment

Match a bank deposit to a customer payment receipt

cURL

curl --request POST \
  --url https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/match-customer-payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reconciliation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/match-customer-payment"

payload = {
    "order_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reconciliation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    order_payment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    reconciliation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/match-customer-payment', 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.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/match-customer-payment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'order_payment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'reconciliation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/match-customer-payment"

	payload := strings.NewReader("{\n  \"order_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"reconciliation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/match-customer-payment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"reconciliation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/match-customer-payment")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"reconciliation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

200

{
  "data": {
    "bank_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "matched": true,
    "amount_warning": "<string>"
  }
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization · string · header · required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

bank_transaction_id · string<uuid> · required

Body

application/json

order_payment_id · string<uuid> · required

UUID of the order_payment to match to this bank transaction

reconciliation_id · string<uuid> | null

Optional active reconciliation session this match belongs to

Response

200

application/json

Matched successfully

data · object

Show child attributes