Edit Billing Address
This API allows a payment method’s billing address to be changed after the payment case has been created.
The .json address above can be used to access the schema within Postman. An example use of the Edit Billing Address API follows below, or view the schema or the sample Postman Collection.
The example case will make the following address change:
- Order ID 543210 and Payment ID 012345
- Set to a shipping address in California
Unlike changing the shipping address of an order, the full address details must be provided instead of merely an Address ID. All required address parameters must be included, even if they are not all being updated.
The orderID and paymentID must be provided to identify which payment case is being updated.
|orderID||integer||A unique identifier for the order. The minimum value is “1”.|
|paymentID||integer||A unique identifier for the payment case. The minimum value is “0”.|
|billingAddress||object||The address information being applied to this payment case.|
Billing Address Parameters
The required and optional parameters for the billingAddress object are:
|firstName||Optional||string||The first name of the contact at this address. The maximum length is 300 characters.|
|lastName||Optional||string||The last name of the contact at this address. The maximum length is 300 characters.|
|phone||Required||string||The phone number of the contact. The minimum length is 1 character and the maximum length is 20 characters.|
|addressLine1||Required||string||The first line of the street address. The minimum length is 1 character and the maximum length is 250 characters.|
|addressLine2||Optional||string||The second line of the street address. The maximum length is 250 characters.|
|addressLine3||Optional||string||The third line of the street address. The maximum length is 250 characters.|
|city||Required||string||The city that the street address is located in. The minimum length is 1 character and the maximum length is 50 characters.|
|state||Optional||string||The state that the street address is located in. |
|postalCode||Optional||string||The postal or zip code that the street address is located in. The minimum length is 1 character and the maximum length is 35 characters. |
|countryCode||Required||string||The two-letter code for the country that the street address is located in.|
|latitude||Optional||number||The latitude of the address location. This parameter is read-only and should be manually changed.|
|longitude||Optional||number||The longitude of the address location. This parameter is read-only and should be manually changed.|
|company||Optional||string||The company or organization that the contact at this address is associated with. The maximum length is 100 characters.|
|taxId||Optional||string||A tax identifier primarily used for shipping abroad. The maximum length is 50 characters.|
The Full Request
This is the entire request that will update a billing address.
"addressLine1": "123 San Luis Obispo Ln.",
"city": "San Luis Obispo",
The returned response follows the same structure as the Get Payment API, providing information about the payment that was edited.