HTTP Request Header Parameter

These are commonly used fields ​​in HTTP Request Headers to use the User API.

• Authorization [Required] : String
  • The token obtained through the Token Issue API
  • Format : “Bearer xxxxxx…”
  • It is mandatory for all APIs requiring authentication, excluding token issue and token refresh APIs.
• merchant_id [Required] : String
  • Required if token key_type is CHANNEL
  • It is not used in token issue and token refresh APIs.
• trace_id : String
  • Transaction ID for API issue tracking.
  • Random string within 100 characters (UUID)

Response Body Format

{
    "status": {
        "code": "SUCCESS",
        "message": "success",
        "extra_message": null,
        "trace_id": "5aa2ca3f-0685-4a61-9b29-756636fce6c3"
    },
    "data": {
    }
}

• status : Contains the processing results (statuses) of the request.
  • code : Request result code
    • Ex. Success - SUCCESS / Failure - INVALID_PARAMETER
  • message : Message according to the request result code
    • Ex. invalid parameter
  • extra_message : Additional message that couldn't be expressed in the message field
    • It can be developer-entered, failure messages from external integration agencies, invalid field names, etc.
    • Ex. amount is required
  • trace_id : An Id to trace processing details (logs, etc.) for a single request.
    • Used for issue tracking purposes.
• data : Contains the data related to the request.
  • For List queries with Pagination, the data object includes a pagination object (pagination).
    • offset: Starting position of the list
    • limit: Maximum number of data per list
    • total: Total number of items in the data list
    • count: Number of items returned on the current page

⭕ SUCCESS

// Case 1
{
    "status": {
        "code": "SUCCESS", 
        "message": "success",  
        "extra_message": null,
        "trace_id": "798fe30d-e3a6-4b1a-8fd6-3210aa6f8001"
    },
    "data": null
}

// Case 2
{
    "status": {
        "code": "SUCCESS", 
        "message": "success",  
        "extra_message": null,
        "trace_id": "798fe30d-e3a6-4b1a-8fd6-3210aa6f8002"
    },
    "data": {
      ...
    }
}

// Case 3
{ 
  "status": {
          "code": "SUCCESS", 
          "message": "success",  
          "extra_message": null,
          "trace_id": "798fe30d-e3a6-4b1a-8fd6-3210aa6f8002"
  },
  "data": {
      "xxxx": [],
      "pagination": {
            "offset": 0,
            "limit": 10,
            "total": 41,
            "count": 10
      }
  }
}

❌ Failure

{
    "status": {
        "code": "INVALID_PARAMETER",
        "message": "invalid parameter.",
        "extra_message":"parameter: id",
        "trace_id": "798fe30d-e3a6-4b1a-8fd6-3210aa6f8003"
    },
    "data": null
}