GET
/
payments
/
search-payees
curl --request GET \
  --url https://agent.payman.ai/api/payments/search-payees \
  --header 'x-payman-api-secret: <api-key>'
[
  {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "providerInfo": {},
    "name": "<string>",
    "organizationId": "<string>",
    "tags": [
      "<string>"
    ],
    "type": "US_ACH",
    "payeeDetails": {},
    "contactDetails": {
      "email": "<string>",
      "phoneNumber": "<string>",
      "address": {
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "addressLine3": "<string>",
        "addressLine4": "<string>",
        "locality": "<string>",
        "region": "<string>",
        "postcode": "<string>",
        "country": "<string>"
      },
      "taxId": "<string>"
    },
    "status": "ACTIVE",
    "searchHashes": {},
    "replacesId": "<string>"
  }
]

Authorizations

x-payman-api-secret
string
header
required

Query Parameters

name
string

The name of the payee to search for. This can be a partial, case-insensitive match.

contactEmail
string

The contact email to search for.

contactPhoneNumber
string

The contact phone number to search for.

contactTaxId
string

The contact tax id to search for.

accountNumber
string

The US Bank account number to search for.

routingNumber
string

The US Bank routing number to search for.

agentReference
string

The Payman agent reference (id or handle) to search for.

cryptoAddress
string

The crypto address to search for.

cryptoCurrency
string

The crypto currency to search for.

cryptoChain
string

The crypto chain to search for.

Response

200
application/vnd.payman.v1+json
The search was successful and any matches returned.

The response is of type object[].