API Reference
Update a customer
Introduction
Core Resources
Additional Resources
API Specification
- API Reference
- GETList all payments
- POSTInitialize a payment
- GETRetrieve a payment
- PUTProcess a payment
- POSTProcess a payment
- DELCancel a payment
- GETList all transfers
- POSTInitiate a transfer
- GETRetrieve a transfer
- GETList all beneficiaries
- POSTCreate a beneficiary
- GETRetrieve a beneficiary
- DELDelete a beneficiary
- GETList all customers
- POSTCreate a customer
- GETRetrieve a customer
- POSTUpdate a customer
- DELDelete a customer
- GETList customer's payment methods
- GETList customer's payments
- POSTBlock a customer
- POSTUnblock a customer
- GETList all webhooks
- POSTCreate a webhook
- GETRetrieve a webhook
- PUTUpdate a webhook
- DELDelete a webhook
- GETRetrieve account balance
- GETList all payment channels
- GETList all countries
- GETList all currencies
- GET
API Reference
Update a customer
POST
/
customers
/
{id}
curl --request POST \
--url https://api.notchpay.co/customers/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"email": "john@example.com",
"phone": 237600000000,
"name": "John Doe",
"company_name": "ACME Inc",
"metadata": {},
"address": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
},
"billing": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
}
}'
{
"code": 202,
"status": "Accepted",
"message": "Customer updated successfully",
"customer": {
"id": "cus_123456789",
"name": "John Doe",
"email": "john@example.com",
"phone": 237600000000,
"company_name": "ACME Inc",
"address": {
"country": "CM",
"city": "Douala",
"address_line1": "123 Main St"
},
"created_at": "2023-01-01T12:00:00.000Z",
"updated_at": "2023-01-02T12:00:00.000Z",
"blocked": false
}
}
Authorizations
Path Parameters
Unique identifier of the customer
Body
application/json
Response
202
application/json
Customer updated
The response is of type object
.
curl --request POST \
--url https://api.notchpay.co/customers/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"email": "john@example.com",
"phone": 237600000000,
"name": "John Doe",
"company_name": "ACME Inc",
"metadata": {},
"address": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
},
"billing": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
}
}'
{
"code": 202,
"status": "Accepted",
"message": "Customer updated successfully",
"customer": {
"id": "cus_123456789",
"name": "John Doe",
"email": "john@example.com",
"phone": 237600000000,
"company_name": "ACME Inc",
"address": {
"country": "CM",
"city": "Douala",
"address_line1": "123 Main St"
},
"created_at": "2023-01-01T12:00:00.000Z",
"updated_at": "2023-01-02T12:00:00.000Z",
"blocked": false
}
}