Update account information. This API allows for updating the contact details for an account, as well as adding an external payment platform User ID (e.g. Steam or Oculus).
When a value for external payment platform is specified, a special 'Pay on Behalf of' (POBO) payment method will be created for the user, which can be used in subsequent transactions. If provided, full name and address details will be associated with the user's POBO payment method. When providing PII state_provice
and country_iso
must be sent in the request together; all other fields can be sent on their own. For more information on this type of interaction, refer to External Payment Platforms.
Account resource
object The email information for the user. | |
object | |
full_name | string Full name of the person associated with the payment method. |
street_address_1 | string Address line 1 of the billing address (e.g., street, P.O. Box, or company name). |
street_address_2 | string Address line 2 of the billing address (e.g., unit, apartment, suite, or building). |
street_address_3 | string Address line 3 of the billing address. |
city | string City of the billing address. |
state_province | string State or Province of the billing address. |
country_iso | string 2-letter ISO 3166 Country code of the billing address. |
zip_postal_code | string Zip or postal code of the billing address. |
Account profile was updated successfully.
Unauthorized access.
Resource not found.
Service unavailable or server error.
{- "email": {
- "address": "user@example.com",
- "requires_verification": true
}, - "external_platforms": {
- "steam": {
- "user_id": "<steam_id>"
}, - "oculus": {
- "user_id": "<oculus_id>"
}, - "apple": {
- "user_id": "<apple_id>"
}, - "google": {
- "user_id": "<google_id>"
}, - "microsoft": {
- "user_id": "<microsoft_id>"
}, - "nintendo": {
- "user_id": "<nintendo_id>"
}, - "sony": {
- "user_id": "<sony_id>"
}
}, - "full_name": "Jessica Pley",
- "street_address_1": "1 Alden Way",
- "street_address_2": "BLDG 13",
- "street_address_3": "APT 6",
- "city": "Atlanta",
- "state_province": "GA",
- "country_iso": "US",
- "zip_postal_code": "30301"
}
{- "status": "Success",
- "message": null,
- "codes": null,
- "payload": {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "email": {
- "email_id": "string",
- "address": "user@example.com",
- "email_types": [
- "string"
], - "is_verified": true
}, - "external_platforms": {
- "steam": {
- "user_id": "<steam_id>"
}, - "oculus": {
- "user_id": "<oculus_id>"
}, - "apple": {
- "user_id": "<apple_id>"
}, - "google": {
- "user_id": "<google_id>"
}, - "microsoft": {
- "user_id": "<microsoft_id>"
}, - "nintendo": {
- "user_id": "<nintendo_id>"
}, - "sony": {
- "user_id": "<sony_id>"
}
}, - "full_name": "Jessica Pley",
- "street_address_1": "1 Alden Way",
- "street_address_2": "BLDG 13",
- "street_address_3": "APT 6",
- "city": "Atlanta",
- "state_province": "GA",
- "country_iso": "US",
- "zip_postal_code": "30301"
}
}