List account payment methods across accounts in this entity

curl --request GET \
  --url https://api.arcuserp.com/v1/account-payment-methods \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.arcuserp.com/v1/account-payment-methods', 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/account-payment-methods",
  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/account-payment-methods"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/account-payment-methods")

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

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "stripe_payment_method_id": "<string>",
      "card_brand": "<string>",
      "last_four": "<string>",
      "exp_month": 123,
      "exp_year": 123,
      "bank_name": "<string>",
      "account_type": "<string>",
      "routing_last_four": "<string>",
      "funding_type": "<string>",
      "verification_status": "<string>",
      "is_default": true,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "/v1/account-payment-methods"
}

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

Accounts

List account payment methods across accounts in this entity

Returns payment methods (cards + ACH bank accounts) for ALL accounts in the API key’s entity, with optional filters by account, payment type, default state, or active state. Stripe-style cursor pagination via starting_after.

Use cases:

Card-expiration reports across all customers in the entity.
ACH micro-deposit verification dashboards.
Account-360 sync resolvers (cross-account PM views).

Layer 1 (multi-tenant isolation): unlike account_addresses and account_contacts, the account_payment_methods table HAS its own entity_id column. Scope is enforced directly via WHERE entity_id = $1 (no JOIN), backed by the idx_apm_entity_account composite index. A crafted cursor pointing at a sister-entity row returns 0 rows from the inner cursor SELECT (which also binds entity_id), so the tuple comparison evaluates UNKNOWN and no row leak occurs.

Sister of /v1/account-addresses and /v1/account-contacts. Cross-refs: docs/prompts/completed/NEW-GAP-MIGRATION-API-V1-GET-ACCOUNT-PAYMENT-METHODS [COMPLETE].md.

Note: the account_payment_methods table does NOT today carry external_source / external_id provenance columns, so migration back-read by source-system tuple is NOT supported on this endpoint. See NEW-GAP-ACCOUNT-PAYMENT-METHODS-EXTERNAL-PROVENANCE-COLS for the follow-up to add those columns.

Requires accounts:read OR payments:read scope.

GET

account-payment-methods

List account payment methods across accounts in this entity

curl --request GET \
  --url https://api.arcuserp.com/v1/account-payment-methods \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.arcuserp.com/v1/account-payment-methods', 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/account-payment-methods",
  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/account-payment-methods"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/account-payment-methods")

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

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "stripe_payment_method_id": "<string>",
      "card_brand": "<string>",
      "last_four": "<string>",
      "exp_month": 123,
      "exp_year": 123,
      "bank_name": "<string>",
      "account_type": "<string>",
      "routing_last_four": "<string>",
      "funding_type": "<string>",
      "verification_status": "<string>",
      "is_default": true,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "/v1/account-payment-methods"
}

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

Query Parameters

account_id

string<uuid>

Filter to payment methods belonging to this account.

type

enum<string>

Filter by payment method type.

Available options:

card,

ach

is_default

boolean

Filter by default-PM state.

is_active

boolean

Filter by active state. Omit to return both active and soft-removed PMs.

limit

integer

default:25

Number of rows to return. Default 25, max 500.

Required range: 1 <= x <= 500

starting_after

string<uuid>

Cursor: a payment-method id from a previous response. Returns rows ordered before this cursor by (created_at DESC, id DESC).

Response

List of account payment methods

object

enum<string>

Available options:

list

data

object[]

Show child attributes

has_more

boolean

next_cursor

string<uuid> | null

url

string

Example:

"/v1/account-payment-methods"

List account contacts across accounts in this entity List accounts

Overview

All Endpoints

List account payment methods across accounts in this entity

Authorizations

Query Parameters

Response