Update Billing Address

patch

https://sandbox.nmi.com/api/v5/customers/{customer_id}/billing/{billing_id}

Update an existing billing address for a customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customer_id

string

required

The customer vault ID.

billing_id

string

required

The billing address ID to update.

Body Params

Billing address and information

method

string

enum

Recurring or installment classification for the processor.

initial_recurring: First transaction in a recurring sequence only.
recurring: Later charges in that sequence.
installment: Installment transactions; use number and total on supported processors.

Which values apply depends on the processor.

Allowed:

number

integer

0 to 99

Specify installment billing number, on supported processors. For use when billing.method is set to "installment"

total

number

≥ 0

Specify installment billing total on supported processors. For use when billing.method is set to "installment"

first_name

string

length ≤ 50

Cardholder's first name

last_name

string

length ≤ 50

Cardholder's last name

company

string

length ≤ 100

Cardholder's company

address1

string

length ≤ 100

Card billing address

address2

string

length ≤ 100

Card billing address, line 2

city

string

length ≤ 50

Card billing city

state

string

length ≤ 50

Card billing state. Format: CC

zip

string

length ≤ 20

Card billing zip code

country

string

length ≤ 2

Card billing country. Country codes are as shown in ISO 3166-1 alpha-2. Format: CC

phone

string

Billing phone number

string

Billing email address

fax

string

length ≤ 50

Billing fax number

cell_phone

string

Billing cell phone number

website

string

length ≤ 255

Website (invoice-specific field)

drivers_license_number

string

length ≤ 20

Driver's license number

drivers_license_dob

string

Driver's license date of birth. Format: YYYY-MM-DD

drivers_license_state

string

length ≤ 2

Driver's license state. Format: CC

payment_details

Payment method details. Exactly one variant: raw card data, ACH (check) data, payment_token, Apple Pay encrypted payload, or Google Pay encrypted payload. Do not combine fields from different variants.

cardholder_auth

Cardholder authentication data. Use the 3-D Secure variant for EMV authentication results. Use the Decrypted wallet variant for merchant-decrypted Apple Pay or Google Pay, which relays the cryptogram and ECI to the 3-D Secure fields.

Responses

401

Unauthorized

200Billing address updated successfully

400Bad Request - Validation Error

404Customer or billing address not found