Get Outlet Information

By using this method, you can get detailed information about an outlet or merchant. It returns details such as name of the outlet, mode of payment used by the outlet, and so on.

GET /integrations/partner/outlets/{outlet_id}/v1

Sample Request

Sample Request

curl -X GET https://api.partner-sandbox.gobiz.co.id/integrations/partner/outlets/{outlet_id}/v1 \
  -H 'Authorization: Bearer {access-token}'

Path Parameters

Name	Description	Type	Required
outlet_id	ID of the outlet for which you want to get the detailed information.	String	Required

Sample Response - 200 Success

Sample Response

{
  "success": true,
  "data": {
    "outlet": {
      "id": "G916309315",
      "merchant_name": "Merchant name",
      "name": "Name",
      "status": "active",
      "email": "[email protected]",
      "payment_settings": {
        "gopay": {
          "active": true
        },
        "qris": {
          "active": true
        }
      },
      "applications": {
        "midtrans": {
          "active": true
        },
        "gopay": {
          "active": true
        }
      }
    }
  }
}

Response Parameters - 200 Success

JSON Attribute	Description	Type
success	Status of the request. Value true indicates successful submission of the request.	Boolean
data	Details of the outlet to be linked.	Object
» outlet	Outlet object.	Object

Sample Response - 404 Outlet Not Found

Sample Response

{
  "success": false,
  "errors": [
    {
      "message_title": "Not found",
      "message": "Outlet with id: de829e5b-72a5-49bc-a5f3-f0d83edb9daf is not found"
    }
  ]
}

Response Parameters - 404 Outlet Not Found

JSON Attribute	Description	Type
success	Status of the request. Value false indicates an error.	Boolean
errors	Details of the error.	Array(Object)

note

• To perform this operation, you must be authenticated using go_auth_client_credentials(partner:outlet:read).
• Possible error responses are 401, 404, 406, and 415. Please refer Error Glossary.