Update a customer

PATCH

customers

{customerId}

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "customerId": "cus_01hxyz",
    "balances": {
      "available": 0,
      "held": 0
    },
    "email": "[email protected]",
    "firstName": "Jane",
    "lastName": "Doe",
    "phone": "+2348012345678",
    "walletId": "wal_01hxyz",
    "account": {
      "currency": "NGN",
      "accountNumber": "0123456789",
      "accountName": "Jane Doe",
      "bankName": "Wema Bank",
      "bankCode": "035",
      "provider": "<string>"
    }
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

Authorizations

Authorization

string

header

required

Secret API key. Use sk_test_... for sandbox data or sk_live_... for live data (after verification and live mode). Do not use pk_ keys.

Path Parameters

customerId

string

required

Body

application/json

Any of firstName, lastName, phone. Do not send email.

firstName

string

Given name. Email cannot be changed.

Example:

"Jane"

lastName

string

Family name. Email cannot be changed.

Example:

"Doe"

phone

string

Phone must be 10 to 15 digits, optionally starting with +

Example:

"+2348012345678"

Response

Request succeeded

success

boolean

Example:

true

data

object

Show child attributes

meta

object

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "customerId": "cus_01hxyz",
    "balances": {
      "available": 0,
      "held": 0
    },
    "email": "[email protected]",
    "firstName": "Jane",
    "lastName": "Doe",
    "phone": "+2348012345678",
    "walletId": "wal_01hxyz",
    "account": {
      "currency": "NGN",
      "accountNumber": "0123456789",
      "accountName": "Jane Doe",
      "bankName": "Wema Bank",
      "bankCode": "035",
      "provider": "<string>"
    }
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

customers

escrows

checkout

transactions

wallets

payouts

fees

identity

Authorizations

Path Parameters

Body

Response