Z Zise Developers
/
简体中文
Global Account › API Reference › Payees

Payee list, including the name_mismatch risk flag

GET /v1/remit/payees scope: remittances:read
On behalf of a member · x-on-behalf-of required

Lists this member’s associations with payees, newest association first. Payee entities are shared platform-wide because multiple members may send to the same bank account. Fields therefore combine the entity’s public information and association-specific information; nickname / name_mismatch / created_at belong to the latter.

⚠ name_mismatch: true means this bank account was previously registered under another account-holder name. This is a valuable signal of money laundering or incorrect input. We feed it into risk checks at ordering, but do not block on your behalf; your own risk policy determines whether to block. Previously it appeared only in the creation response and became invisible after the user closed the dialog.

⚠ status and upstream_status are different; read both. status is our local enable/disable flag, active / blocked. New payees are always active, which does not mean the upstream accepts the payee. upstream_status describes the upstream side; see GET /v1/remit/payees/{id} for values. Before 2026-08-13 this field was omitted entirely, making every new payee appear fully ready.

Query Parameters

FieldTypeRequiredDescription
line "express" | "pobo" Optional Line used to determine upstream_status. The same payee has independent upstream records for the two lines; the personal line uses the member’s own subaccount context. Each is created and can fail independently, so this status requires a line. Other fields are unaffected.
limit integer Optional Items per page. Defaults to 20, capped at 100; invalid values fall back to 20.
cursor string Optional next_cursor returned by the previous page. Opaque string; do not construct it yourself. An undecodable cursor restarts from the beginning instead of returning an error.
FieldTypeRequiredDescription
x-on-behalf-of string Required Member on whose behalf the call is made.

Response

200OK
{
  "data": [
    {
      "id": "pye_1042",
      "nickname": "房东",
      "entity_type": "INDIVIDUAL",
      "country": "GB",
      "currency": "GBP",
      "payment_method": "LOCAL",
      "clearing_system": "FASTER PAYMENTS",
      "summary": "Barclays ····4821",
      "bank_name": "Barclays",
      "account_holder": "MARY SMITH",
      "status": "active",
      "upstream_status": "not_submitted",
      "name_mismatch": false,
      "created_at": "2026-08-01T02:11:04Z"
    }
  ],
  "next_cursor": "MjAyNi0wOC0wMVQwMjoxMTowNFp8MTA0Mg",
  "has_more": true
}
Request 
curl -X GET 'https://api.zinfra.vip/v1/remit/payees' \
  -H 'x-auth-token: Bearer $TOKEN' \
  -H 'x-on-behalf-of: $MEMBER_ID'
const res = await fetch("https://api.zinfra.vip/v1/remit/payees", {
  method: "GET",
  headers: {
    "x-auth-token": "Bearer $TOKEN",
    "x-on-behalf-of": "$MEMBER_ID",
  },
});
// Keep monetary amounts as strings, never numbers.
const data = await res.json();
import requests

res = requests.get(
    "https://api.zinfra.vip/v1/remit/payees",
    headers={
        "x-auth-token": "Bearer $TOKEN",
        "x-on-behalf-of": "$MEMBER_ID",
    },
)
# Use Decimal(str(...)) for amounts, not float.
data = res.json()
req, _ := http.NewRequest("GET", "https://api.zinfra.vip/v1/remit/payees",
    nil)
req.Header.Set("x-auth-token", "Bearer $TOKEN")
req.Header.Set("x-on-behalf-of", "$MEMBER_ID")
res, err := http.DefaultClient.Do(req)
// Decode amount fields as string, not float64.
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.zinfra.vip/v1/remit/payees"))
    .header("x-auth-token", "Bearer $TOKEN")
    .header("x-on-behalf-of", "$MEMBER_ID")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
// Use String / BigDecimal for amounts, not double.
$ch = curl_init('https://api.zinfra.vip/v1/remit/payees');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'x-auth-token: Bearer $TOKEN',
    'x-on-behalf-of: $MEMBER_ID',
  ],
]);
$res = curl_exec($ch);
// Use bcmath / strings for amounts, not floatval.
200 
{
  "data": [
    {
      "id": "pye_1042",
      "nickname": "房东",
      "entity_type": "INDIVIDUAL",
      "country": "GB",
      "currency": "GBP",
      "payment_method": "LOCAL",
      "clearing_system": "FASTER PAYMENTS",
      "summary": "Barclays ····4821",
      "bank_name": "Barclays",
      "account_holder": "MARY SMITH",
      "status": "active",
      "upstream_status": "not_submitted",
      "name_mismatch": false,
      "created_at": "2026-08-01T02:11:04Z"
    }
  ],
  "next_cursor": "MjAyNi0wOC0wMVQwMjoxMTowNFp8MTA0Mg",
  "has_more": true
}