Update Status Account

Information

Method	Path	Format	Authentication
PATCH	`api/v1.0/accounts/update-status/{account_id}`	json	OAuth 2.0 with Access Token

Request Details

Headers Structure

Field	Value	Type	Mandatory	Description	Example
X-PARTNER-ID	api_key	Alphanumeric	Mandatory	API key obtained from the merchant dashboard.	b3ed7d4b-a96c-6c08-b3c7-12c3124242d9
Accept	application/json	Alphabetic	Mandatory	Specifies JSON as the expected response format.	application/json
Authorization	Bearer {bearerToken}	Alphanumeric	Mandatory	Bearer token obtained from the get access token endpoint.	Bearer eyJ0eXAiOiJKV1{…}

Body Structure

Field	Type	Mandatory	Length	Description	Example
status	Enum(active, inactive)	Mandatory		Inactive or active	active

Body Example

{
    "status": "active"
}

Response Details

Response Structure

Field	Type	Mandatory	Length	Description	Example
status	Numeric	Mandatory	3	HTTP Status Code	200
success	Boolean	Mandatory	1	2xx is true. 4xx-500 is false.	true
data	Array Object	Conditional		Array of sub account objects
> id	Numeric	Mandatory		Sub account ID	23643
> name	Alphanumeric	Mandatory		Full name of the account holder	John
> email	Alphanumeric	Mandatory		Email address of the account	john.doe@gmail.com
> phone	Numeric	Mandatory		Phone number associated	628339243232
> status	Enum	Mandatory		Account status values	active, inactive

Response Example

Success: Here’s an example of a successful response.

{
  "status": 200,
  "success": true,
  "data": {
    "id": "436546545",
    "name": "Julian Albertus Pratama",
    "email": "julian.pratama@example.com",
    "phone": "62682293427611",
    "status": "active", // active, inactive,
  }
}

Error: This is an example of an unsuccessful request.

{
    "status": 401,
    "success": false,
    "error": {
        "code": 401,
        "message": "Unauthorized partner, please sign in"
    }
}

On this page