Suggest marketplace-payout matches for an inbound bank deposit

curl --request GET \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/marketplace-payout-candidates \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/marketplace-payout-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/entities/{entity_id}/reconciliation/marketplace-payout-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/entities/{entity_id}/reconciliation/marketplace-payout-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/entities/{entity_id}/reconciliation/marketplace-payout-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/entities/{entity_id}/reconciliation/marketplace-payout-candidates")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/marketplace-payout-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

{
  "bank_transaction": {},
  "marketplace_payouts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platform": "<string>",
      "platform_payout_id": "<string>",
      "amount": 123,
      "payout_date": "2023-12-25",
      "score": 123,
      "match_reason": "<string>",
      "days_apart": 123
    }
  ],
  "top_candidate": {}
}

{
  "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"
}

Reconciliation

Suggest marketplace-payout matches for an inbound bank deposit

For an inbound (deposit) bank transaction, returns confidence-scored unmatched marketplace payouts (Shopify / Amazon / eBay) within +/-$0.05 and +/-7 days, scored 1.0 (exact amount + same day + platform memo) down to 0.6 (within window + platform memo). Suggest-only: posts nothing and mutates nothing. Requires accounting:read scope. THE ONE RULE: this endpoint delegates to the canonical listMarketplacePayoutCandidates handler shared with the internal UI.

GET

entities

{entity_id}

reconciliation

marketplace-payout-candidates

Suggest marketplace-payout matches for an inbound bank deposit

curl --request GET \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/marketplace-payout-candidates \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/marketplace-payout-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/entities/{entity_id}/reconciliation/marketplace-payout-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/entities/{entity_id}/reconciliation/marketplace-payout-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/entities/{entity_id}/reconciliation/marketplace-payout-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/entities/{entity_id}/reconciliation/marketplace-payout-candidates")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/marketplace-payout-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

{
  "bank_transaction": {},
  "marketplace_payouts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platform": "<string>",
      "platform_payout_id": "<string>",
      "amount": 123,
      "payout_date": "2023-12-25",
      "score": 123,
      "match_reason": "<string>",
      "days_apart": 123
    }
  ],
  "top_candidate": {}
}

{
  "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

entity_id

string<uuid>

required

Query Parameters

bank_transaction_id

string<uuid>

required

The inbound bank transaction to find marketplace-payout candidates for.

Response

Scored candidate payouts for the bank transaction.

bank_transaction

object

The bank transaction the candidates were scored against.

marketplace_payouts

object[]

Up to 25 scored candidate payouts (highest score first).

Show child attributes

top_candidate

object | null

The highest-scored candidate (or null when none qualify).

Overview

All Endpoints

Suggest marketplace-payout matches for an inbound bank deposit

Authorizations

Path Parameters

Query Parameters

Response