v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Create a customer

Create a PowerBoard customer entity

post/v1/customers

Headers

x-user-secret-keystring required

Your API private/secret key. This can be found in the powerboard dashboard.

Content-Typestring required

Content-Type will always be application/json

Request body

referencestring

A manually defined reference for the customer creation request

first_namestring

The customer's first name

last_namestring

The customer's last name

emailstring

The customer's email address.

phonestring

The customer's phone number

descriptionstring

Manually defined reference for customer in payment systems

tokenstring required

One-time token returned from the PowerBoard widget

Response

200

statusinteger

{"stackTrail":"paths:/v1/customers:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "status": 201,
  "resource": {
    "type": "customer",
    "data": {
      "created_at": "2020-05-27T12:11:13.634Z",
      "updated_at": "2020-05-27T12:11:13.634Z",
      "default_source": "5ece58d4aab8f8579dc10ddc",
      "_id": "5ece58e1aab8f8579dc10ddd",
      "payment_sources": [
        {
          "_id": "5ece58d4aab8f8579dc10ddc",
          "updated_at": "2020-05-27T12:11:13.633Z",
          "vault_token": "c7704378-2092-49b3-b362-9e4a8fa4c249",
          "expire_month": 9,
          "expire_year": 2021,
          "card_name": "Wanda Mertz",
          "card_number_last4": "4242",
          "card_number_bin": "42424242",
          "card_scheme": "visa",
          "ref_token": "cus_HM6IU9TqcV9qTm",
          "status": "active",
          "created_at": "2020-05-27T12:11:00.643Z",
          "gateway_id": "5cbede1f151b842653e987be",
          "type": "card"
        }
      ],
      "_service": {
        "default_gateway_id": "5cbede1f151b842653e987be"
      }
    }
  }
}