PATCH /storefront/payment-instruments/{id}
Updates the values of a payment instrument with a specified ID.
Use the FramePay payment token ID to update values. For more information, see FramePay.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
customFields |
Object | No |
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields. |
token |
String | No |
Token ID of the payment instrument. |
billingAddress |
Object | No |
Billing address. If this field is supplied, it overrides the billing address obtained from the token. |
billingAddress.region |
String | No |
Contact's region of residence. |
billingAddress.phoneNumbers[] |
Array | No |
List of phone numbers associated with the contact. |
billingAddress.phoneNumbers[].label |
String | Yes |
Phone number label or name. |
billingAddress.phoneNumbers[].value |
String | Yes |
Phone number value. |
billingAddress.phoneNumbers[].primary |
Boolean | No |
Specifies if the phone number is the contact's primary phone number. |
billingAddress.address2 |
String | No |
Second line of the contact's street address. |
billingAddress.emails[] |
Array | No |
List of email addresses associated with the contact. |
billingAddress.emails[].label |
String | Yes |
Email label or name. |
billingAddress.emails[].value |
String | Yes |
Email address value. |
billingAddress.emails[].primary |
Boolean | No |
Specifies if the email address is the contact's primary email address. |
billingAddress.organization |
String | No |
Contact's organization. |
billingAddress.jobTitle |
String | No |
Contact's job title. |
billingAddress.dob |
String | No |
Contact's date of birth in ISO-8601 |
billingAddress.city |
String | No |
Contact's city of residence. |
billingAddress.postalCode |
String | No |
Contact's postal code. |
billingAddress.hash |
String | No |
Hash value for the contact. Use this value to compare contacts for identical attribute values. |
billingAddress.lastName |
String | No |
Contact's last name. |
billingAddress.firstName |
String | No |
Contact's first name. |
billingAddress.country |
String | No |
Contact's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org. |
billingAddress.address |
String | No |
First line of the contact's street address. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.