Get Remitter

Retrieve remitter details by ID

GET /v1/remitters/{remitter_id}

Get remitter detail.

cURL

curl --request GET \
  --url https://api.hit-pay.com/v1/remitters/{remitter_id} \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'

200

{
  "id": "9f0092ca-4b7d-4e33-b503-9dd27b0807ba",
  "status": "pending",
  "entity_type": "individual",
  "full_name": "Hilda Ferry",
  "email": "[e-mail]",
  "address": {
    "city": "Singapore",
    "state": "Singapore",
    "country": "sg",
    "postal_code": "238888",
    "street_address": "123 Orchard Rd"
  },
  "id_type": "national_id",
  "id_number": "A1748248115",
  "nationality": "sg",
  "company_name": "Abernathy Inc",
  "date_of_birth": "1990-01-01",
  "contact_number": "[phone]",
  "place_of_birth": "Singapore",
  "created_by": {
    "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
    "display_name": "TestingSG",
    "first_name": "QA",
    "last_name": "SG"
  },
  "created_at": "2025-05-26T16:28:35+08:00",
  "updated_at": "2025-05-26T16:28:35+08:00"
}

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

remitter_id · string<uuid> · required

Remitter id

Response

200 - application/json

200

id · string · required

status · string · required

entity_type · enum<string> · required

Available options: individual, company

full_name · string · required

id_number · string · required

id_type · enum<string> · required

Available options: national_id, passport, driving_license

date_of_birth · string · required

place_of_birth · string · required

nationality · string · required

contact_number · string · required

email · string · required

address · object · required

Show child attributes

company_name · string · required

created_by · object · required

Show child attributes

created_at · string · required

updated_at · string · required