WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Customers
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
  • Customers
    • Create a customer
      POST
    • Retrieve a customer
      GET
    • Update a customer
      POST
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Customers

Update a customer

POST
/v1/customers/{id}

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params
id
string 
required
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json
Body Params application/json
address
object (Address) 
optional
The customer’s address.
city
string 
optional
City, district, suburb, town, or village.
country
string 
optional
Two-letter country code (ISO 3166-1 alpha-2 ).
line1
string 
optional
Address line 1 (e.g., street, PO Box, or company name).
line2
string 
optional
Address line 2 (e.g., apartment, suite, unit, or building).
postal_code
string 
optional
ZIP or postal code.
state
string 
optional
State, county, province, or region.
description
string 
optional
An arbitrary string attached to the object. Often useful for displaying to users.
email
string 
optional
The customer’s email address.
metadata
object 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
name
string 
optional
The customer’s full name or business name.
phone
string 
optional
The customer’s phone number.
shipping
object 
optional
Mailing and shipping address for the customer.
address
object (Address) 
optional
name
string 
optional
Recipient name.
phone
string 
optional
Recipient phone (including extension).
Example
{
    "address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string"
    },
    "description": "string",
    "email": "string",
    "metadata": {},
    "name": "string",
    "phone": "string",
    "shipping": {
        "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string"
        },
        "name": "string",
        "phone": "string"
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://apitest.wooshpay.com/v1/customers/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string"
    },
    "description": "string",
    "email": "string",
    "metadata": {},
    "name": "string",
    "phone": "string",
    "shipping": {
        "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string"
        },
        "name": "string",
        "phone": "string"
    }
}'

Responses

🟢200OK
application/json
Body
id
string 
optional
Unique identifier for the object, like "cus_XXX".
object
string 
optional
'customer'
address
object (Address) 
optional
The customer’s address.
city
string 
optional
City, district, suburb, town, or village.
country
string 
optional
Two-letter country code (ISO 3166-1 alpha-2 ).
line1
string 
optional
Address line 1 (e.g., street, PO Box, or company name).
line2
string 
optional
Address line 2 (e.g., apartment, suite, unit, or building).
postal_code
string 
optional
ZIP or postal code.
state
string 
optional
State, county, province, or region.
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
currency
string 
optional
Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.
description
string 
optional
An arbitrary string attached to the object. Often useful for displaying to users.
email
string 
optional
The customer’s email address.
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata
object 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
name
string 
optional
The customer’s full name or business name.
phone
string 
optional
The customer’s phone number.
preferred_locales
array[string]
optional
The customer’s preferred locales (languages), ordered by preference.
shipping
object 
optional
Mailing and shipping address for the customer.
address
object (Address) 
optional
name
string 
optional
Recipient name.
phone
string 
optional
Recipient phone (including extension).
Example
{
    "id": "string",
    "object": "string",
    "address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string"
    },
    "created": 0,
    "currency": "string",
    "description": "string",
    "email": "string",
    "livemode": true,
    "metadata": {},
    "name": "string",
    "phone": "string",
    "preferred_locales": [
        "string"
    ],
    "shipping": {
        "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string"
        },
        "name": "string",
        "phone": "string"
    }
}
Previous
Retrieve a customer
Next
Create a SetupIntent
Built with