Create a customer

Create a customer

POST /customers

Create a customer

cURL

curl --request POST \
  --url https://developersandbox-api.flutterwave.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "address": {
    "city": "New York",
    "country": "US",
    "line1": "123 Main Street",
    "postal_code": "10001",
    "state": "New York",
    "line2": "Apt 4B"
  },
  "meta": {},
  "name": {
    "first": "King",
    "middle": "Leo",
    "last": "LeBron"
  },
  "phone": {
    "country_code": "234",
    "number": "08012345678"
  }
}
'

201

{
  "status": "success",
  "message": "<string>",
  "data": {
    "id": "cus_3XarBILKQS",
    "address": {
      "city": "New York",
      "country": "US",
      "line1": "123 Main Street",
      "postal_code": "10001",
      "state": "New York",
      "line2": "Apt 4B"
    },
    "email": "[e-mail]",
    "name": {
      "first": "King",
      "middle": "Leo",
      "last": "LeBron"
    },
    "phone": {
      "country_code": "234",
      "number": "08012345678"
    },
    "meta": {},
    "created_datetime": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

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

Headers

X-Trace-Id · string

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Required string length: 12 - 255

X-Idempotency-Key · string

A unique identifier to prevent duplicate requests. It must be between 12 and 255 characters in length.

Required string length: 12 - 255

Body

application/json

email · string · required

The Customer's email address.

Pattern: ^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}$

Example:

"[e-mail]"

address · object

Customer address information.

Show child attributes

meta · object

Show child attributes

name · object

The Customer's full name.

Show child attributes

phone · object

The customer's mobile number.

Show child attributes

Example:

{
  "country_code": "234",
  "number": "08012345678"
}

Response

201

application/json

OK

status · enum<string>

Available options: success, failed

message · string

data · object

Show child attributes