Skip to main content
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>'
{
  "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>"
      }
    ],
    "top_candidate": {},
    "already_matched": true,
    "note": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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