Customers

List customers

get

Get a paginated list of customers with optional filtering

Authorizations

OAuth2applicationRequired

Token URL:

Query parameters

limitintegerOptional

Number of items to return

afterstringOptional

Specifies the cursor after which to start returning results. For the first page, this should be left empty. For subsequent pages, use the value of the end_cursor field from the previous response.

beforestringOptional

Specifies the cursor before which to return results. Use this to paginate backwards. For example, to load the previous page, provide the value of the start_cursor field from the last response.

created_at_startstringOptional

Filter by creation date start (RFC3339 format)

created_at_endstringOptional

Filter by creation date end (RFC3339 format)

company_namestringOptional

Filter by customer name

Responses

200

application/json

end_cursorstringOptionalExample: gaFpxBACEaXBVABEYbHG+X9LyLnH

has_next_pagebooleanOptionalExample: true

has_previous_pagebooleanOptional

start_cursorstringOptionalExample: gaFpxBACEaXBVABEYbHG+X9LyLnH

get

/customers

GET /customers HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

{
  "data": [
    {
      "city": "text",
      "country": "text",
      "created_at": "text",
      "default_payment_method_id": "text",
      "ein": "text",
      "email": "text",
      "external_id": "text",
      "id": "text",
      "legal_name": "text",
      "name": "text",
      "postal_code": "text",
      "state": "text",
      "street_address": "text",
      "sub_premise": "text"
    }
  ],
  "end_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH",
  "has_next_page": true,
  "has_previous_page": false,
  "start_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH"
}

Create a customer

post

Create a new customer with the provided information

Authorizations

OAuth2applicationRequired

Token URL:

Body

Customer information

citystringOptional

countrystringOptional

einstringOptional

emailstringOptional

external_idstringOptional

legal_namestringOptional

namestringOptional

postal_codestringOptional

statestringOptional

street_addressstringOptional

sub_premisestringOptional

Responses

201

Created

application/json

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post

/customers

POST /customers HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 196

{
  "city": "text",
  "country": "text",
  "ein": "text",
  "email": "text",
  "external_id": "text",
  "legal_name": "text",
  "name": "text",
  "postal_code": "text",
  "state": "text",
  "street_address": "text",
  "sub_premise": "text"
}

{
  "city": "text",
  "country": "text",
  "created_at": "text",
  "default_payment_method_id": "text",
  "ein": "text",
  "email": "text",
  "external_id": "text",
  "id": "text",
  "legal_name": "text",
  "name": "text",
  "postal_code": "text",
  "state": "text",
  "street_address": "text",
  "sub_premise": "text"
}

Get a customer

get

Get customer details by ID

Authorizations

OAuth2applicationRequired

Token URL:

Path parameters

idstringRequired

Customer ID

Responses

200

application/json

citystringOptional

countrystringOptional

created_atstringOptional

default_payment_method_idstringOptional

einstringOptional

emailstringOptional

external_idstringOptional

idstringOptional

legal_namestringOptional

namestringOptional

postal_codestringOptional

statestringOptional

street_addressstringOptional

sub_premisestringOptional

404

Not Found

application/json

get

/customers/{id}

GET /customers/{id} HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "city": "text",
  "country": "text",
  "created_at": "text",
  "default_payment_method_id": "text",
  "ein": "text",
  "email": "text",
  "external_id": "text",
  "id": "text",
  "legal_name": "text",
  "name": "text",
  "postal_code": "text",
  "state": "text",
  "street_address": "text",
  "sub_premise": "text"
}

Archive a customer

delete

Archive a customer

Authorizations

OAuth2applicationRequired

Token URL:

Path parameters

idstringRequired

Customer ID

Responses

200

application/json

citystringOptional

countrystringOptional

created_atstringOptional

default_payment_method_idstringOptional

einstringOptional

emailstringOptional

external_idstringOptional

idstringOptional

legal_namestringOptional

namestringOptional

postal_codestringOptional

statestringOptional

street_addressstringOptional

sub_premisestringOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/customers/{id}

DELETE /customers/{id} HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "city": "text",
  "country": "text",
  "created_at": "text",
  "default_payment_method_id": "text",
  "ein": "text",
  "email": "text",
  "external_id": "text",
  "id": "text",
  "legal_name": "text",
  "name": "text",
  "postal_code": "text",
  "state": "text",
  "street_address": "text",
  "sub_premise": "text"
}

Patch customer

patch

Patch customer information (company, legal name, EIN, street address, sub-premise, city, state, postal code, country)

Authorizations

OAuth2applicationRequired

Token URL:

Path parameters

idstringRequired

Customer ID

Body

Request body for patching customer information

citystringOptionalExample: New York

countrystringOptionalExample: USA

einstringOptionalExample: 12-3456789

legal_namestringOptionalExample: Acme Corporation Inc.

namestringOptionalExample: Acme Corp

postal_codestringOptionalExample: 10001

statestringOptionalExample: NY

street_addressstringOptionalExample: 123 Main St, New York, NY 10001

sub_premisestringOptionalExample: Apt 1

Responses

200

application/json

citystringOptional

countrystringOptional

created_atstringOptional

default_payment_method_idstringOptional

einstringOptional

emailstringOptional

external_idstringOptional

idstringOptional

legal_namestringOptional

namestringOptional

postal_codestringOptional

statestringOptional

street_addressstringOptional

sub_premisestringOptional

400

Bad Request

application/json

404

Not Found

application/json

patch

/customers/{id}

PATCH /customers/{id} HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "city": "New York",
  "country": "USA",
  "ein": "12-3456789",
  "legal_name": "Acme Corporation Inc.",
  "name": "Acme Corp",
  "postal_code": "10001",
  "state": "NY",
  "street_address": "123 Main St, New York, NY 10001",
  "sub_premise": "Apt 1"
}

{
  "city": "text",
  "country": "text",
  "created_at": "text",
  "default_payment_method_id": "text",
  "ein": "text",
  "email": "text",
  "external_id": "text",
  "id": "text",
  "legal_name": "text",
  "name": "text",
  "postal_code": "text",
  "state": "text",
  "street_address": "text",
  "sub_premise": "text"
}

List payment methods

get

Get payment methods associated with a customer

Authorizations

OAuth2applicationRequired

Token URL:

Path parameters

idstringRequired

Customer ID

Responses

200

application/json

get

/customers/{id}/payment-methods

GET /customers/{id}/payment-methods HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

{
  "data": [
    {
      "brand": "visa",
      "created_at": "text",
      "default": true,
      "exp_month": "01",
      "exp_year": "2025",
      "id": "text",
      "last4": "text",
      "type": "card"
    }
  ]
}

Get payment method by ID

get

Get a specific payment method associated with a customer by payment method ID

Authorizations

OAuth2applicationRequired

Token URL:

Path parameters

idstringRequired

Customer ID

payment_method_idstringRequired

Payment Method ID

Responses

200

application/json

brandstringOptionalExample: visa

created_atstringOptional

defaultbooleanOptional

exp_monthstringOptionalExample: 01

exp_yearstringOptionalExample: 2025

idstringOptional

last4stringOptional

typestring · enumOptionalPossible values:

400

Bad Request

application/json

404

Not Found

application/json

get

/customers/{id}/payment-methods/{payment_method_id}

GET /customers/{id}/payment-methods/{payment_method_id} HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "brand": "visa",
  "created_at": "text",
  "default": true,
  "exp_month": "01",
  "exp_year": "2025",
  "id": "text",
  "last4": "text",
  "type": "card"
}

Restore a customer

post

Restore a customer

Authorizations

OAuth2applicationRequired

Token URL:

Path parameters

idstringRequired

Customer ID

Responses

200

application/json

citystringOptional

countrystringOptional

created_atstringOptional

default_payment_method_idstringOptional

einstringOptional

emailstringOptional

external_idstringOptional

idstringOptional

legal_namestringOptional

namestringOptional

postal_codestringOptional

statestringOptional

street_addressstringOptional

sub_premisestringOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/customers/{id}/restore

POST /customers/{id}/restore HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "city": "text",
  "country": "text",
  "created_at": "text",
  "default_payment_method_id": "text",
  "ein": "text",
  "email": "text",
  "external_id": "text",
  "id": "text",
  "legal_name": "text",
  "name": "text",
  "postal_code": "text",
  "state": "text",
  "street_address": "text",
  "sub_premise": "text"
}

List customer users

get

Get a paginated list of users from a customer

Authorizations

OAuth2applicationRequired

Token URL:

Path parameters

idstringRequired

Customer ID

Query parameters

limitintegerOptional

Number of items to return

afterstringOptional

Specifies the cursor after which to start returning results. For the first page, this should be left empty. For subsequent pages, use the value of the end_cursor field from the previous response.

beforestringOptional

Specifies the cursor before which to return results. Use this to paginate backwards. For example, to load the previous page, provide the value of the start_cursor field from the last response.

Responses

200

application/json

end_cursorstringOptionalExample: gaFpxBACEaXBVABEYbHG+X9LyLnH

has_next_pagebooleanOptionalExample: true

has_previous_pagebooleanOptional

start_cursorstringOptionalExample: gaFpxBACEaXBVABEYbHG+X9LyLnH

get

/customers/{id}/users

GET /customers/{id}/users HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

{
  "data": [
    {
      "created_at": "text",
      "email": "text",
      "first_name": "text",
      "id": "text",
      "job_title": "text",
      "last_name": "text",
      "phone": "text"
    }
  ],
  "end_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH",
  "has_next_page": true,
  "has_previous_page": false,
  "start_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH"
}

Create a customer user

post

Create a new customer user with the provided information

Authorizations

OAuth2applicationRequired

Token URL:

Path parameters

idstringRequired

Customer ID

Body

emailstringOptional

first_namestringOptional

last_namestringOptional

Responses

201

Created

application/json

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post

/customers/{id}/users

POST /customers/{id}/users HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "email": "text",
  "first_name": "text",
  "last_name": "text"
}

{
  "created_at": "text",
  "email": "text",
  "first_name": "text",
  "id": "text",
  "job_title": "text",
  "last_name": "text",
  "phone": "text"
}

PreviousTheming NextPaymentMethods

Last updated 2 months ago

Was this helpful?

hashtagList customers

hashtagCreate a customer

hashtagGet a customer

hashtagArchive a customer

hashtagPatch customer

hashtagList payment methods

hashtagGet payment method by ID

hashtagRestore a customer

hashtagList customer users

hashtagCreate a customer user

List customers

Create a customer

Get a customer

Archive a customer

Patch customer

List payment methods

Get payment method by ID

Restore a customer

List customer users

Create a customer user