Singapay Home Page
Logo Icon
  1. Accounts
  2. Update Status

Information

MethodPathFormatAuthentication
PATCH/api/v1.0/accounts/update-status/{account_id}jsonOAuth 2.0 with Access Token

Request Details

Headers Structure

FieldValueTypeMandatoryLengthDescriptionExample
X-PARTNER-IDapi_keyAlphanumericMandatoryAPI key obtained from the merchant dashboard.b3ed7d4b-a96c-6c08-b3c7-12c3124242d9
Acceptapplication/jsonAlphabeticMandatorySpecifies JSON as the expected response format.application/json
AuthorizationBearer {bearerToken}AlphanumericMandatoryBearer token obtained from the get access token endpoint.Bearer eyJ0eXAiOiJKV1{…}

Body Structure

FieldTypeMandatoryLengthDescriptionExample
statusEnum(active, inactive)MandatoryInactive or activeactive

Body Example

{
    "status": "active"
}

Response Details

Response Structure

FieldTypeMandatoryLengthDescriptionExample
statusNumericMandatory3HTTP Status Code200
successBooleanMandatory12xx is true. 4xx-500 is false.true
dataObjectConditionalSub account object
> idAlphanumericMandatorySub account ID01K7ZTFRF7TC0XB1PFHC9CM80N
> nameAlphanumericMandatoryFull name of the account holderpentest 1
> emailAlphanumericMandatoryEmail address of the accountpentest1@gmail.com
> phoneAlphanumericMandatoryPhone number associated082125202019
> statusEnumMandatoryAccount status values: active, inactiveactive

Response Example

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

{
    "status": 200,
    "success": true,
    "data": {
        "id": "01K7ZTFRF7TC0XB1PFHC9CM80N",
        "name": "pentest 1",
        "email": "pentest1@gmail.com",
        "phone": "082125202019",
        "status": "active"
    }
}