API Reference›LMS API›Payment instruments›List external-party payment instruments

List external-party payment instruments

GEThttps://sandbox.api.lendeasy.ai/v1/external-parties/{partyId}/payment-instruments Bearer token · READ_LMS_PAYMENT_INSTRUMENT

Lists masked instruments with verification and validation state; tokens and authorization references are never returned on masked reads.

Request

curl https://sandbox.api.lendeasy.ai/v1/external-parties/$PARTY_ID/payment-instruments \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/external-parties/${partyId}/payment-instruments`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/external-parties/{party_id}/payment-instruments",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "items": [
    {
      "instrumentId": 704,
      "instrumentType": "ACH_BANK",
      "maskedDisplay": "••6789",
      "railCapabilities": [
        "ACH"
      ],
      "verificationState": "VERIFIED",
      "accountValidationStatus": "VALIDATED",
      "status": "ACTIVE",
      "createdAt": "2026-08-11T16: 10:00Z",
      "lastModifiedAt": "2026-08-11T16: 12:00Z"
    }
  ]
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.
partyId required in path	string	Stable opaque party identifier.
status optional in query	string	Filter by instrument status. One of `ACTIVE · INACTIVE`.
instrumentType optional in query	string	Filter by instrument type. One of `ACH_BANK · CARD`.
verificationState optional in query	string	Filter by verification state. One of `UNVERIFIED · VERIFIED · FAILED`.
limit optional in query	integer	Maximum records to return.
offset optional in query	integer	Zero-based offset into the result set.

Request

curl https://sandbox.api.lendeasy.ai/v1/external-parties/$PARTY_ID/payment-instruments \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/external-parties/${partyId}/payment-instruments`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/external-parties/{party_id}/payment-instruments",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "items": [
    {
      "instrumentId": 704,
      "instrumentType": "ACH_BANK",
      "maskedDisplay": "••6789",
      "railCapabilities": [
        "ACH"
      ],
      "verificationState": "VERIFIED",
      "accountValidationStatus": "VALIDATED",
      "status": "ACTIVE",
      "createdAt": "2026-08-11T16: 10:00Z",
      "lastModifiedAt": "2026-08-11T16: 12:00Z"
    }
  ]
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}