Patch Aggregator

The Aggregator Information Update Endpoint enables you to efficiently update and maintain the details associated with an aggregator in your platform.

Log in to see full request history
Path Params
uuid
required

Unique identifier for an aggregator in the platform

Body Params
string

The external_id field allows you to provide an external identifier that can link the newly created aggregator to an external system or entity.

string

The display_name is the name to be displayed in portals, including the admin portal and merchant pane

string

The short_name is a concise aggregator identifier used for filtering in certain portal tables.

string

The business_name refers to the legal name of the company if it is a business.

string

The conglomerate_name should be provided if the business is part of a conglomerate.

string

The mcc is the Merchant Category Code, a unique 4-digit identifier used to recognize the aggregator.

string

The national_id is a unique identifier such as RUT or NIT, identifying the aggregator.

string

The national_id_type specifies the type of national ID, e.g., RUT, NIT, etc., depending on the country.

string

The billing_address refers to the company's address.

contact_numbers
array of strings

The contact_numbers are the contact numbers for communication purposes.

contact_numbers
string

The contact_email is the email address for contacting the company.

uri

The online_store is the URL of the online store.

Headers
string
required

Use the x-api-key header to include the API key generated previously for authentication purposes. The API key serves as a secret token that identifies the client or application making the request and is used to determine whether the client has the necessary permissions to access the requested resource.

string
required

Use the x-aggregator-id header to identify the aggregator for a particular request. An aggregator is the entity that is involved in the processing of transactions or data. By including the id in the header, the server can identify which aggregator the request owns and handle the request accordingly.

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json