API Reference

List Customer Billing Addresses

get
https://api.prahsys.com/yments/n1/merchant//customers//addresses

Returns all unique billing addresses that have been used by a customer across their payments. Addresses are deduplicated using case-insensitive and whitespace-insensitive comparison.

Path Params
string
required

The merchant ID

string
required

The customer ID, UUID, or email address

Query Params
string
required

Filter addresses by various attributes.

Partial match: street, city, postcodeZip, company

Exact match: stateProvince, country

Examples:

  • ?filter[city]=New York
  • ?filter[stateProvince]=NY
  • ?filter[street]=Main
string
required

Sort by: street, city, stateProvince, country, postcodeZip. Use - prefix for descending.

Headers
string
Response

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago