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

Remove the association, not the payee entity

DELETE /v1/remit/payees/{id} scope: remittances:write
On behalf of a member · x-on-behalf-of required

Deletes the association between this member and this payee, not the payee entity. The entity is shared platform-wide; other members may be sending to the same bank account. Deleting it would make a decision on their behalf.

Recreating with identical fields afterward will therefore usually return outcome: linked and the same id, because the fingerprint is unchanged. This is correct.

Existing orders are unaffected because their rows contain payee snapshots.

⚠ This endpoint does not require an idempotency key. It is naturally idempotent; a second deletion returns 404. It is still a write operation, so the usual signing rules apply.

Path Parameters

FieldTypeRequiredDescription
id string Required Payee ID. Optional pye_ prefix; the remaining value must contain digits only.
FieldTypeRequiredDescription
x-on-behalf-of string Required Member on whose behalf the call is made.

Response

200Association removed
{
  "deleted": true
}
404not_found: this member has no association with the payee, or it was removed. A nonnumeric id produces the same result deliberately.
Request 
curl -X DELETE 'https://api.zinfra.vip/v1/remit/payees/{id}' \
  -H 'x-auth-token: Bearer $TOKEN' \
  -H 'x-on-behalf-of: $MEMBER_ID'
const res = await fetch("https://api.zinfra.vip/v1/remit/payees/{id}", {
  method: "DELETE",
  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.delete(
    "https://api.zinfra.vip/v1/remit/payees/{id}",
    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("DELETE", "https://api.zinfra.vip/v1/remit/payees/{id}",
    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/{id}"))
    .header("x-auth-token", "Bearer $TOKEN")
    .header("x-on-behalf-of", "$MEMBER_ID")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();
// Use String / BigDecimal for amounts, not double.
$ch = curl_init('https://api.zinfra.vip/v1/remit/payees/{id}');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  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 
{
  "deleted": true
}