--- title: "Update Customer" source_url: https://docs.rapyd.net/en/update-customer.html lang: en --- # Update Customer Change one or more fields in a customer profile. To clear a field, set it to an empty string. > **Note:** > > - For information on the customer in an account funding transaction (AFT), see [Creating an AFT Payment](https://docs.rapyd.net/en/creating-an-aft-payment.md "Creating an AFT Payment"). > - The code samples include successful requests (200) and bad requests (400). > > - For error messages that appear due to bad requests (400), see: > > - [General Errors](https://docs.rapyd.net/en/general-errors.md "General Errors") > - [Customer Errors](https://docs.rapyd.net/en/customer-errors.md "Customer Errors") > - For information about unauthorized request (401) and other authentication errors, see [Troubleshooting Authentication and Authorization Errors](https://docs.rapyd.net/en/troubleshooting-authentication-and-authorization-errors.md "Troubleshooting Authentication and Authorization Errors"). This method triggers the [Customer Created Webhook](https://docs.rapyd.net/en/customer-created-webhook.md "Customer Created Webhook"). This webhook contains the same information as the response. ### Parameters ### Request Path Parameters - - - customer - ID of the customer profile. String starting with **cus_**. ### Request Header Parameters - - access_key - Unique access key provided by Rapyd for each authorized user. See [Developers](https://docs.rapyd.net/en/developers.md "Developers"). - - Content-Type - Indicates that the data appears in JSON format. Set to **application/json**. - - idempotency - A unique key that prevents the platform from creating the same object twice. See [Idempotency](https://docs.rapyd.net/en/idempotency.md "Idempotency"). - - salt - Random string. Recommended length: 8-16 characters. - - signature - Signature calculated for each request individually. See [Request Signatures](https://docs.rapyd.net/en/request-signatures.md "Request Signatures"). - - timestamp - Timestamp for the request, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds). ### Request Body Parameters - - addresses - Array of 'address' objects associated with this customer. For details of the 'address' object, see [Create Address](https://docs.rapyd.net/en/create-address.md "Create Address"). - - canton - Name of the canton administrative subdivision, as used in banking. - - city - City portion of the address. Required for issuance of a card to the wallet contact. Required for creating a Visa card payment that requires 3DS. - - country - The two-letter ISO 3166-1 ALPHA-2 code for the country. Required for creating a Visa card payment that requires 3DS. - - district - Name of the district administrative subdivision, as used in banking. - - line_1 - Line 1 of the address, such as a building number and street name. Required for creating a Visa card payment that requires 3DS. - - line_2 - Line 2 of the address, such as a suite or apartment number, or the name of a named building. - - line_3 - Line 3 of the address. - - metadata - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata"). - - name - The name of a contact person or an "in care of" person at this address. For a **personal** wallet contact type, alphabetic characters and spaces. Required for creating a Visa card payment that requires 3DS. - - phone_number - Phone number associated with this specific address in E.164 format. Must be unique. Required for creating a Visa card payment that requires 3DS. - - state - State or province portion of the address. Required for creating a Visa card payment that requires 3DS. - - zip - Postal code portion of the address. Required for creating a Visa card payment that requires 3DS. - - birth_country - Country where the customer was born. Two-letter ISO 3166-1 ALPHA-2 code for the country. To determine the code for a country, see [List Countries](https://docs.rapyd.net/en/list-countries.md "List Countries"). English characters only. Relevant to an account funding transaction (AFT). - - business_vat_id - The tax ID number of the customer. - - coupon - The ID of a coupon that is assigned to this customer. - - date_of_birth - Date of birth of the customer. Format: **DD/MM/YYYY** Required for an account funding transaction (AFT). - - default_payment_method - The payment method that is used when the transaction does not specify a payment method. String starting with **card_** or **other_**. - - description - A text description of the customer. - - email - Customer's email address. Recommended for an account funding transaction (AFT). - - ewallet - ID of the wallet that is linked to the customer. String starting with **ewallet_**. - - invoice_prefix - A custom string that is prefixed to all invoices for this customer. - - metadata - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata"). - - name - The name of the individual customer or the business name. - - nationality - The citizenship of the customer. Two-letter ISO 3166-1 ALPHA-2 code for the country. To determine the code for a country, see [List Countries](https://docs.rapyd.net/en/list-countries.md "List Countries"). English characters only. Relevant to an account funding transaction (AFT). - - occupation - Occupation of the customer. Maximum: 35 characters. Relevant to an account funding transaction (AFT). - - phone_number - Customer's primary phone number in E.164 format. ### Response Parameters - - addresses - Describes the addresses associated with this customer. For details of the fields in the 'address' object, see [Create Address](https://docs.rapyd.net/en/create-address.md "Create Address"). - - birth_country - Country where the customer was born. Two-letter ISO 3166-1 ALPHA-2 code for the country. - - business_vat_id - The tax ID number of the customer. Relevant when the customer is a business. - - category - Category of payment method. One of the following: - **bank_redirect** - **bank_transfer** - **card** - **card_redirect** - **cash** - **ewallet** - **ewallet_redirect** - - coupon - The ID of a discount coupon that is assigned to this customer. The coupon must use the same currency as the customer's default payment method. - - created_at - Time of creation of this customer, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). - - customer - ID of the customer profile, a string starting with **cus_**. - - date_of_birth - Date of birth of the customer. Format: **DD/MM/YYYY** - - default_payment_method - The payment method that is used when the `payment` object or subscription does not specify a payment method. The value must also appear in the `payment_methods` list. The payment method is referenced by its `name` field. - - delinquent - Indicates whether there is currently a failure of an automatic payment that is part of a subscription, or an invoice that was not paid when due. - - description - A text description of the customer. - - discount - Contains information about the coupon that applies to the customer. To add a discount to a customer, see [Update Customer](https://docs.rapyd.net/en/update-customer.md "Update Customer"). - - email - Customer's email address. - - ewallet - ID of the wallet that is linked to the customer. String starting with **ewallet_**. Each wallet can be associated with only one customer. - - fields - Contains the fields that are for the specific payment method. To determine what fields are required for the payment method, see [Get Payment Method Required Fields](https://docs.rapyd.net/en/get-payment-method-required-fields.md "Get Payment Method Required Fields"). - - holder_id - A generic identifier for the account holder associated with this customer. - - id - ID of the customer profile. String starting with **cus_**. - - invoice_prefix - A custom string that is prefixed to all invoices for this customer. - - metadata - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata"). - - name - The name of the customer. - - nationality - The citizenship of the customer. Two-letter ISO 3166-1 ALPHA-2 code for the country. - - next_action - Indicates the next action for completing the payment. One of the following values: - **3d_verification** - The next action is 3DS authentication. Relevant only to card payments. - **pending_capture** - The next action is pending the capture of the amount. Relevant only to card payments when the amount is not zero. - **pending_confirmation** - The next action is pending the confirmation for the payment. Relevant to all payment methods excluding card payment. - **pending_offline_capture** - The next action is pending an offline capture, where the payment settles to a **closed** (**CLO**) status via the clearing process. A payment in this state can be successfully refunded, **but cannot be canceled**. Currently, relevant only to Shva Arena card payments. - **not_applicable** - The payment has completed or the next action is not relevant. - - occupation - Occupation of the customer. - - payment_methods - An object containing the following fields: - - data - A list of up to three payment methods. - - acs_check - Results of the Access Control Server (ACS) check. Possible values: - **pass** - **fail** - **unavailable** - **unchecked** Relevant to cards. - - address - Address of the customer. - - canton - Name of the canton administrative subdivision, as used in banking. - - city - City portion of the address. - - country - The two-letter ISO 3166-1 ALPHA-2 code for the country. - - created_at - Time of creation of the object, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). - - district - Name of the district administrative subdivision, as used in banking. - - id - ID of the `address` object. - - line_1 - Line 1 of the address, such as a building number and street name. - - line_2 - Line 2 of the address, such as a suite or apartment number, or the name of a named building. - - line_3 - Line 3 of the address. - - metadata - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata"). - - name - The name of a contact person or an "in care of" person at this address. For a **personal** wallet contact, alphabetic characters and spaces. - - phone_number - Phone number associated with this specific address in E.164 format. Must be unique. - - state - State or province portion of the address. - - zip - Postal code portion of the address. - - bin_details - Bank identification details. Includes the following fields: - - bin_number - BIN number of the bank. - - brand - The brand of the card. For example, **Visa**. - - country - Country of the bank that issued the card. - - issuer - Business name of the bank that issued the card. - - level - Type of card as categorized by the issuer. - - type - The type of the card: - **credit** - **debit** - **prepaid** - - category - Category of payment method. One of the following: - **bank_redirect** - **bank_transfer** - **card** - **card_redirect** - **cash** - **ewallet** - **ewallet_redirect** - - cvv_check - Verification of the card’s CVV. Valid values: - **pass** - **fail** - **unavailable** - **unchecked** - - fingerprint_token - Hash of the card number, expiration date and CVV. Relevant to cards. - - id - ID of the Payment Method object. String starting with **card_** or **other_**. - - image - A URL to the image of the icon for the type of payment method. - - last4 - Last 4 digits of the card. Relevant to card payment methods. - - metadata - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata"). - - name - Full name of the customer. - - next_action - Indicates the next action for completing the payment. One of the following values: - **3d_verification** - The next action is 3DS authentication. Relevant only to card payments. - **pending_capture** - The next action is pending the capture of the amount. Relevant only to card payments when the amount is not zero. - **pending_confirmation** - The next action is pending the confirmation for the payment. Relevant to all payment methods excluding card payment. - **pending_offline_capture** - The next action is pending an offline capture, where the payment settles to a **closed** (**CLO**) status via the clearing process. A payment in this state can be successfully refunded, **but cannot be canceled**. Currently, relevant only to Shva Arena card payments. - **not_applicable** - The payment has completed or the next action is not relevant. - - supporting_documentation - Reserved. - - type - Name of the payment method type. For example, **us_mastercard_card**. To get a list of payment methods for a country, use [List Payment Methods by Country](https://docs.rapyd.net/en/list-payment-methods-by-country.md "List Payment Methods by Country"). - - webhook_url - Reserved. - - has_more - Indicates whether there are more than three payment methods for this customer. - - total_count - Total number of payment methods for this customer. - - url - URL for requesting all of the payment methods for this customer. - - phone_number - Customer's primary phone number in E.164 format. The merchant is responsible for verifying that the number is correct. - - subscriptions - Describes the subscriptions associated with this customer. Array of objects. For details of the fields in the 'subscriptions' object, see [Create Subscription](https://docs.rapyd.net/en/create-subscription.md "Create Subscription"). ### Code Samples - - .NET - ```csharp using System; using System.Text.Json; namespace RapydApiRequestSample { class Program { static void Main(string[] args) { try { string customerId = "cus_d3ed65d5091a8398cc3651bcedec1201"; var requestObj = new { default_payment_method = "card_0ef22c3b9fa5991a4da957d3dcee2e7b" }; string request = JsonSerializer.Serialize(requestObj); string result = RapydApiRequestSample.Utilities.MakeRequest("POST", $"/v1/customers/{customerId}", request); Console.WriteLine(result); } catch (Exception e) { Console.WriteLine("Error completing request: " + e.Message); } } } } ``` - - JavaScript - ```javascript const makeRequest = require('/utilities').makeRequest; async function main() { try { const body = { default_payment_method: 'card_0ef22c3b9fa5991a4da957d3dcee2e7b' }; const result = await makeRequest( 'POST', '/v1/customers/cus_d3ed65d5091a8398cc3651bcedec1201', body ); console.log(result); } catch (error) { console.error('Error completing request', error); } } ``` - - PHP - ```php /utilities.php"; include($path); $body = [ "default_payment_method"=> "card_0ef22c3b9fa5991a4da957d3dcee2e7b" ]; try { $object = make_request('post', "/v1/customers/cus_d3ed65d5091a8398cc3651bcedec1201", $body); var_dump($object); } catch (Exception $e) { echo "Error: $e"; } ?> ``` - - Python - ```python from pprint import pprint from utilities import make_request customer_data = { "default_payment_method": "card_0ef22c3b9fa5991a4da957d3dcee2e7b", } result = make_request(method='post', path='/v1/customers/cus_d3ed65d5091a8398cc3651bcedec1201', body=customer_data) pprint(result) ``` - /v1/customers/:customer - Add Default Payment Method - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/customers/cus_4e25112ac20e144ad073a614dc46934b' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ --data-raw '{ "default_payment_method": "card_b9548d9b53a565b2315fecdc6c87f158" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "f460eec5-2c72-4fc8-9594-17c58e9bca8c" }, "data": { "id": "cus_4e25112ac20e144ad073a614dc46934b", "delinquent": false, "discount": null, "name": "John Doe", "default_payment_method": "card_b9548d9b53a565b2315fecdc6c87f158", "description": "", "email": "", "phone_number": "", "invoice_prefix": "", "addresses": [], "payment_methods": { "data": [ { "id": "other_330f2c3586e670b72aab45f5c12195c0", "type": "in_jiomoney_ewallet", "category": "ewallet_redirect", "metadata": {}, "image": "https://iconslib.rapyd.net/checkout/in_jiomoney_ewallet.png", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable" }, { "id": "other_9a1fa177940e16c09f161cfa55ec108a", "type": "sg_grabpay_ewallet", "category": "ewallet", "metadata": {}, "image": "https://iconslib.rapyd.net/checkout/sg_grabpay_ewallet.png", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable", "bic_swift": "", "account_last4": "" }, { "id": "other_0bfa8ede2535263dab8da20a384d5c2f", "type": "pe_banco_ripley_cash", "category": "cash", "metadata": {}, "image": "https://iconslib.rapyd.net/checkout/pe_banco_ripley_cash.png", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable" }, { "id": "other_9162cf0e8ba033a39833b89b289b2581", "type": "kr_localcards_redirect_card", "category": "card_redirect", "metadata": {}, "image": "https://iconslib.rapyd.net/checkout/kr_localcards_redirect_card.png", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable" }, { "id": "other_618d6e098d0ea74fd73ad9e91930df6d", "type": "at_sofort_bank", "category": "bank_redirect", "metadata": {}, "image": "https://iconslib.rapyd.net/checkout/at_sofort_bank.png", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable", "bic_swift": "", "account_last4": "" }, { "id": "card_b9548d9b53a565b2315fecdc6c87f158", "type": "gb_visa_card", "category": "card", "metadata": {}, "image": "https://iconslib.rapyd.net/checkout/gb_visa_card.png", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable", "name": "John Doe", "last4": "1111", "acs_check": "unchecked", "cvv_check": "unchecked", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "expiration_year": "35", "expiration_month": "12", "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467", "network_reference_id": "507150", "payment_account_reference": "V001B26QCDPY3T7O4GGA9D6AL8QSH" }, { "id": "other_e4cd3a4bdcc26ab661420b306d2224ab", "type": "mx_spei_bank", "category": "bank_transfer", "metadata": {}, "image": "https://iconslib.rapyd.net/checkout/mx_spei_bank.png", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable", "bic_swift": "", "account_last4": "" } ], "has_more": false, "total_count": 7, "url": "/v1/customers/cus_4e25112ac20e144ad073a614dc46934b/payment_methods" }, "subscriptions": null, "created_at": 1755769161, "metadata": {}, "business_vat_id": "", "ewallet": "", "occupation": "", "birth_country": "", "date_of_birth": "", "nationality": "" } } ``` - Add Discount - ```bash curl -X post 'https://sandboxapi.rapyd.net/v1/customers/cus_9f4965b9807bc1aeae67b47a0ae5b081' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ --data-raw '{ "coupon": "coupon_4ab30530e8a7352ffe715deecfab57b9" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "9966881a-1b22-4c4b-81c0-5a4ee8e4ff36" }, "data": { "id": "cus_9f4965b9807bc1aeae67b47a0ae5b081", "delinquent": false, "discount": { "id": "dis_d41d8cd98f00b204e9800998ecf8427e", "coupon": { "id": "coupon_f7c2c630d01a8effe46da9df3d271ad4", "amount_off": 0, "created": 1764590120, "currency": "", "duration": "repeating", "duration_in_months": 3, "max_redemptions": 10, "metadata": { "coupon_type": "Holiday promotional" }, "percent_off": 10, "redeem_by": 0, "times_redeemed": 0, "discount_valid_until": 0, "discount_validity_in_months": 0, "discount_duration_in_uses": 0, "description": "", "valid": true }, "end": -1, "start": 1764590995, "subscription": "", "number_of_uses": 0, "valid": true }, "name": "John Doe", "default_payment_method": "", "description": "", "email": "", "phone_number": "", "invoice_prefix": "", "addresses": [], "payment_methods": null, "subscriptions": null, "created_at": 1761819126, "metadata": {}, "business_vat_id": "", "ewallet": "", "occupation": "", "birth_country": "", "date_of_birth": "", "nationality": "" } } ``` - Update Address - ```bash curl -X post 'https://sandboxapi.rapyd.net/v1/customers/cus_3df54f96c9c5c6523ae266781eeef3dc' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ --data-raw '{ "addresses": [ { "line_1": "123 Second Street", "name": "John Doe", "email": "johndoe@rapyd.net" } ] }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "7f00aa8c-05cc-44cf-bd89-6720f83d9c96" }, "data": { "id": "cus_3df54f96c9c5c6523ae266781eeef3dc", "delinquent": false, "discount": null, "name": "John Doe", "default_payment_method": "other_37d1033bc4431f88d15437f5da27b427", "description": "", "email": "johndoe@rapyd.net", "phone_number": "", "invoice_prefix": "", "addresses": [ { "id": "address_ad1edd67a9577f0e23886f6aeb3090cd", "name": "John Doe", "line_1": "123 Second Street", "line_2": "", "line_3": "", "city": "", "state": "", "country": "", "zip": "", "phone_number": "", "metadata": {}, "canton": "", "district": "", "created_at": 1768831620 } ], "payment_methods": { "data": [ { "id": "other_37d1033bc4431f88d15437f5da27b427", "type": "sg_fast_bank", "category": "bank_transfer", "metadata": {}, "image": "https://iconslib.rapyd.net/checkout/sg_fast_bank.png", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable", "bic_swift": "", "account_last4": "" } ], "has_more": false, "total_count": 1, "url": "/v1/customers/cus_3df54f96c9c5c6523ae266781eeef3dc/payment_methods" }, "subscriptions": null, "created_at": 1768831499, "metadata": {}, "business_vat_id": "", "ewallet": "", "occupation": "", "birth_country": "", "date_of_birth": "", "nationality": "" } } ``` - Bad Request - Invalid Phone Number - ```bash curl -X post 'https://sandboxapi.rapyd.net/v1/customers/cus_4e25112ac20e144ad073a614dc46934b' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ --data-raw '{ "phone_number": "2125552341" }' ``` - ```json { "status": { "error_code": "INVALID_CUSTOMER_PHONE_NUMBER", "status": "ERROR", "message": "The request tried to create a customer, but the phone number was not recognized. The request was rejected. Corrective action: Provide the customer's phone number in proper E.164 format.", "response_code": "INVALID_CUSTOMER_PHONE_NUMBER", "operation_id": "f2c4a14f-2b54-482e-985b-87b52de48577" } } ``` - Bad Request - Coupon Not Found - ```bash curl -X post 'https://sandboxapi.rapyd.net/v1/customers/cus_c62e8561f1f9217676819dce60accc08' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ --data-raw '{ "coupon": "coupon_4ab30530e8a7352ffe715deecfab57b9" }' ``` - ```json { "status": { "error_code": "ERROR_GET_COUPON", "status": "ERROR", "message": "The request attempted an operation that requires the ID of a coupon, but the coupon was not found. The request was rejected. Corrective action: Use the ID of a valid coupon.", "response_code": "ERROR_GET_COUPON", "operation_id": "7f8d6ffb-72ae-4834-bf9a-1bc7b7000073" } } ```