Skip to main content
GET
/
customer
/
{customerId}
Find a customer by id
curl --request GET \
  --url https://rest.staging.nickel.com/customer/{customerId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "clkqzo2y1000cx9tfohoiodq1",
  "name": "Claudio Wilson",
  "emails": [
    "<string>"
  ],
  "achEnabled": false,
  "feePassthroughPercent": 100
}

Authorizations

Authorization
string
header
required

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

Path Parameters

customerId
string
required

ID of the customer that needs to be fetched

Response

Successful operation

id
string
Example:

"clkqzo2y1000cx9tfohoiodq1"

name
string
Example:

"Claudio Wilson"

emails
string[]
achEnabled
boolean | null

Per-customer override for whether ACH/bank payments are allowed. null means no customer-level override (inherits the organization default). A payment link can further override this at checkout, so a customer-level true may still be disabled for a specific link.

Example:

false

feePassthroughPercent
integer | null

Effective percent (0-100) of the card processing fee passed through to this customer: the per-customer override if one is set, otherwise the organization default. A per-payment-link feePassthroughPercent takes precedence over this value.

Example:

100