Update account

PATCHhttps://api.omise.co/account

Updates and returns account information. Use this endpoint to configure webhook endpoints, metadata export settings, and marketplace parameters.

---

🔑API Credentials

▼

---

Request Parameters

Recommended - 4 fieldsRecommended Parameters

▼

`webhook_uri`STRING(optional)

Primary webhook endpoint URL for receiving event notifications. Must be HTTPS in live mode.

Example:"https://example.com/webhooks/omise"

`chain_enabled`BOOLEAN(optional)

Whether account chaining (marketplace features) is enabled.

Example:false

Default:false

`chain_return_uri`STRING(optional)

Default return URI for marketplace transactions after customer authorization.

Example:"https://marketplace.example.com/return"

`zero_interest_installments`BOOLEAN(optional)

Whether merchant absorbs installment interest costs (0% installments for customers).

Example:false

Default:false

Additional - 1 fieldAdditional Parameters

▼

---

Responses

200

Successful update

Returns the updated account object with all configuration details.

Updated account object contains:

• id - Account identifier
• webhook_uri - Updated webhook URL
• chain_enabled - Updated marketplace enabled status
• chain_return_uri - Updated marketplace return URI
• zero_interest_installments - Updated installment setting
• metadata_export_keys - Updated metadata export configuration
• All other account fields (email, country, currency, etc.)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid webhook URL format
• HTTP webhook URL in live mode (must be HTTPS)
• Invalid metadata_export_keys structure
• Invalid parameter types

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

---

Code samples

cURL

curl https://api.omise.co/account \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "webhook_uri=https://example.com/webhooks/omise"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = Omise::Account.update(
  webhook_uri: 'https://example.com/webhooks/omise'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = omise.Account.update(
    webhook_uri='https://example.com/webhooks/omise'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const account = await omise.account.update({
  webhook_uri: 'https://example.com/webhooks/omise'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$account = OmiseAccount::update([
    'webhook_uri' => 'https://example.com/webhooks/omise'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Account account = client.account().update()
    .webhookUri("https://example.com/webhooks/omise")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var account = await client.Account.Update(new UpdateAccountRequest
{
    WebhookUri = "https://example.com/webhooks/omise"
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

account, _ := client.Account().Update(&operations.UpdateAccount{
    WebhookURI: "https://example.com/webhooks/omise",
})

---

Try it out

Recommended - 4 fields

▼

Additional - 1 fields

▼