Search your customers

GET

customers

const { FedaPay, Customer } = require('fedapay');
/* Replace YOUR_SECRETE_API_KEY with your real API key */
FedaPay.setApiKey("YOUR_SECRETE_API_KEY");
/* Specify whether you want to run your query in test or live mode */
FedaPay.setEnvironment('sandbox'); //or setEnvironment('live');
/* Show customers */
const customer = await Customer.all( params = {}, headers = {} );

[
  {
    "id": 123,
    "firstname": "<string>",
    "lastname": "<string>",
    "full_name": "<string>",
    "email": "jsmith@example.com",
    "account_id": 123,
    "phone_number_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

List of customers.

integer

Customer ID.

firstname

string

Customer's first name.

lastname

string

Customer's last name.

full_name

string

Customer's full name.

string

Customer's email address.

account_id

integer

ID of the customer's account.

phone_number_id

integer

ID of the customer's phone number.

created_at

string

Date and time of customer creation.

updated_at

string

Date and time of last customer update.

deleted_at

string

Date and time of customer deletion (if applicable).

Delete a customer Get a transaction

const { FedaPay, Customer } = require('fedapay');
/* Replace YOUR_SECRETE_API_KEY with your real API key */
FedaPay.setApiKey("YOUR_SECRETE_API_KEY");
/* Specify whether you want to run your query in test or live mode */
FedaPay.setEnvironment('sandbox'); //or setEnvironment('live');
/* Show customers */
const customer = await Customer.all( params = {}, headers = {} );

[
  {
    "id": 123,
    "firstname": "<string>",
    "lastname": "<string>",
    "full_name": "<string>",
    "email": "jsmith@example.com",
    "account_id": 123,
    "phone_number_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
]

API Documentation

Authorizations

Response