List scored customer payment candidates for a bank transaction

curl --request GET \
  --url https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/customer-payment-candidates \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/customer-payment-candidates', 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}/customer-payment-candidates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/customer-payment-candidates")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "bank_transaction": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "transaction_date": "2023-11-07T05:31:56Z",
      "direction": "<string>",
      "description": "<string>"
    },
    "order_payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "posted_at": "2023-11-07T05:31:56Z",
        "payment_method": "<string>",
        "status": "<string>",
        "check_number": "<string>",
        "external_reference": "<string>",
        "customer_name": "<string>",
        "score": 123,
        "match_reason": "<string>",
        "days_apart": 123,
        "is_multi_application": true,
        "application_count": 123,
        "display_label": "<string>",
        "applications": [
          {
            "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "order_number": "<string>",
            "amount_applied": 123
          }
        ]
      }
    ],
    "top_candidate": {},
    "already_matched": true,
    "note": "<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"
}

Accounting

List scored customer payment candidates for a bank transaction

Required API key scope: accounting:read

Returns a 5-band scored list of order_payments candidates that could be matched to an inbound bank deposit. Only applies to inbound transactions (direction='in' or NULL). Returns already_matched: true if the transaction is already matched.

Scoring bands:

1.0 — Exact amount + same calendar day
0.9 — Exact amount + within 2 days
0.8 — Within $0.01 + same day
0.7 — Within $0.05 + within 2 days + customer name in description
0.6 — Within $0.05 fallback (remaining candidates)

A.2 Multi-invoice payments: Payments where order_id IS NULL but have one or more rows in order_payment_applications are flagged with is_multi_application: true and application_count.

No GL postings occur on match. GL was posted when the payment receipt was recorded. This endpoint is read-only scoring only.

GET

accounting

bank-transactions

{bank_transaction_id}

customer-payment-candidates

List scored customer payment candidates for a bank transaction

curl --request GET \
  --url https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/customer-payment-candidates \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/customer-payment-candidates', 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}/customer-payment-candidates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/accounting/bank-transactions/{bank_transaction_id}/customer-payment-candidates")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "bank_transaction": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "transaction_date": "2023-11-07T05:31:56Z",
      "direction": "<string>",
      "description": "<string>"
    },
    "order_payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "posted_at": "2023-11-07T05:31:56Z",
        "payment_method": "<string>",
        "status": "<string>",
        "check_number": "<string>",
        "external_reference": "<string>",
        "customer_name": "<string>",
        "score": 123,
        "match_reason": "<string>",
        "days_apart": 123,
        "is_multi_application": true,
        "application_count": 123,
        "display_label": "<string>",
        "applications": [
          {
            "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "order_number": "<string>",
            "amount_applied": 123
          }
        ]
      }
    ],
    "top_candidate": {},
    "already_matched": true,
    "note": "<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"
}

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

UUID of the inbound bank transaction to score candidates for

Response

Candidate list (may be empty)

data

object

Show child attributes

Apply a one-time reconciliation baseline (migration cutover anchor)Match a bank deposit to a customer payment receipt

Overview

All Endpoints

List scored customer payment candidates for a bank transaction

Authorizations

Path Parameters

Response