Update Customer - API Documentation

This API is used to update one or more fields in a customer profile by customer_id. To clear a field, set it to an empty string.

Each POST/PATCH Request requires a Signature in the header, you can follow the following code to create the Signature:
const crypto = require('crypto');

const signature = crypto.createHmac('sha256', signatureKey)
  .update(JSON.stringify(data)).digest('hex');

Request

Header Params

Body Params application/json

Example

{
    "customer_id": "string",
    "description": "string",
    "type": {},
    "organization_reference_id": "string",
    "metadata": {},
    "company": {
        "name": "string",
        "registration_number": "string",
        "incorporation_country": "string",
        "company_email": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_city": "string",
        "address_state": "string",
        "address_country": "string",
        "address_zip_code": "string",
        "phone_country_code": "string",
        "phone_number": "string",
        "authorized_user": {
            "first_name": "string",
            "email": "string",
            "last_name": "string",
            "dob": "string",
            "identification_type": "string",
            "identification_value": "string",
            "nationality": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_city": "string",
            "address_country": "string",
            "address_zip_code": "string",
            "country_of_residence": "string",
            "phone_country_code": "string",
            "phone_number": "string"
        }
    },
    "individual": {
        "first_name": "string",
        "last_name": "string",
        "dob": "string",
        "email": "string",
        "identification_type": "string",
        "identification_value": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_city": "string",
        "address_state": "string",
        "address_country": "string",
        "address_zip_code": "string",
        "country_of_residence": "string",
        "nationality": "string",
        "phone_country_code": "string",
        "phone_number": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.paycombat.com/api/v1/customer/update' \
--header 'X-token;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_id": "string",
    "description": "string",
    "type": {},
    "organization_reference_id": "string",
    "metadata": {},
    "company": {
        "name": "string",
        "registration_number": "string",
        "incorporation_country": "string",
        "company_email": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_city": "string",
        "address_state": "string",
        "address_country": "string",
        "address_zip_code": "string",
        "phone_country_code": "string",
        "phone_number": "string",
        "authorized_user": {
            "first_name": "string",
            "email": "string",
            "last_name": "string",
            "dob": "string",
            "identification_type": "string",
            "identification_value": "string",
            "nationality": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_city": "string",
            "address_country": "string",
            "address_zip_code": "string",
            "country_of_residence": "string",
            "phone_country_code": "string",
            "phone_number": "string"
        }
    },
    "individual": {
        "first_name": "string",
        "last_name": "string",
        "dob": "string",
        "email": "string",
        "identification_type": "string",
        "identification_value": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_city": "string",
        "address_state": "string",
        "address_country": "string",
        "address_zip_code": "string",
        "country_of_residence": "string",
        "nationality": "string",
        "phone_country_code": "string",
        "phone_number": "string"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "data": {
        "company": {
            "company_domain": {},
            "name": "string",
            "registration_number": "string",
            "incorporation_country": "string",
            "address_country": "string",
            "address_state": "string",
            "address_city": "string",
            "address_line1": "string",
            "address_line2": {},
            "address_zip_code": "string",
            "phone_number": "string",
            "phone_country_code": "string",
            "phone_number_e164": "string",
            "email": "string",
            "authorized_user": {
                "first_name": "string",
                "last_name": "string",
                "dob": "string",
                "email": "string",
                "nationality": "string",
                "address_country": "string",
                "address_state": "string",
                "address_city": "string",
                "address_line1": "string",
                "address_line2": {},
                "address_zip_code": "string",
                "country_of_residence": "string",
                "phone_number": "string",
                "phone_country_code": "string",
                "phone_number_e164": "string",
                "identification_type": "string",
                "identification_custom_type": {},
                "identification_value": "string"
            }
        },
        "created_at": "string",
        "created_by": "string",
        "customer_id": "string",
        "description": "string",
        "gca_activated_at": "string",
        "gca_activation_status": "string",
        "is_active": true,
        "is_gca_enabled": true,
        "is_wallet_ready": true,
        "metadata": {},
        "org_id": "string",
        "organization_reference_id": "string",
        "type": "string",
        "updated_at": "string",
        "webhook_url": "string"
    },
    "request_id": "string",
    "request_time": "string",
    "status_code": 0,
    "status_text": "string",
    "success": true
}

🟠400Bad Request