GET
/
v1
/
remitters
Get list of remitters
curl --request GET \
  --url https://api.sandbox.hit-pay.com/v1/remitters \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
  "data": [
    {
      "id": "9f0083d4-7794-4c83-98a2-754244f0db85",
      "status": "pending",
      "entity_type": "individual",
      "full_name": "Keith Abbott",
      "email": null,
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "238888",
        "street_address": "123 Orchard Rd"
      },
      "id_type": "driving_license",
      "id_number": "A1748245605",
      "nationality": "sg",
      "company_name": "Cartwright Group",
      "date_of_birth": "1990-01-01",
      "contact_number": "+6591234567",
      "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-26T15:46:45+08:00",
      "updated_at": "2025-05-26T15:46:45+08:00"
    },
    {
      "id": "9f0083c8-6670-4421-8cde-bc770389b27a",
      "status": "pending",
      "entity_type": "individual",
      "full_name": "Sharon Feil",
      "email": null,
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "238888",
        "street_address": "123 Orchard Rd"
      },
      "id_type": "passport",
      "id_number": "A1748245597",
      "nationality": "sg",
      "company_name": "Zboncak - Windler",
      "date_of_birth": "1990-01-01",
      "contact_number": "+6591234567",
      "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-26T15:46:37+08:00",
      "updated_at": "2025-05-26T15:46:37+08:00"
    },
    {
      "id": "9f0083c0-2313-4a55-a2a1-ffd9de7f54b4",
      "status": "pending",
      "entity_type": "individual",
      "full_name": "Guadalupe Prohaska",
      "email": null,
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "238888",
        "street_address": "123 Orchard Rd"
      },
      "id_type": "national_id",
      "id_number": "A1748245592",
      "nationality": "sg",
      "company_name": "Robel LLC",
      "date_of_birth": "1990-01-01",
      "contact_number": "+6591234567",
      "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-26T15:46:32+08:00",
      "updated_at": "2025-05-26T15:46:32+08:00"
    },
    {
      "id": "9eba1413-09be-4893-a0f0-9acbbdf5ba6e",
      "status": "pending",
      "entity_type": "company",
      "full_name": "Ms. Dana Abbott",
      "email": null,
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "238888",
        "street_address": "123 Orchard Rd"
      },
      "id_type": "national_id",
      "id_number": "A1745220378",
      "nationality": "sg",
      "company_name": "Acme Corporation",
      "date_of_birth": "1990-01-01",
      "contact_number": "+6591234567",
      "place_of_birth": "Singapore",
      "created_by": {
        "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
        "display_name": "TestingSG",
        "first_name": "QA",
        "last_name": "SG"
      },
      "created_at": "2025-04-21T15:26:18+08:00",
      "updated_at": "2025-04-21T15:26:18+08:00"
    },
    {
      "id": "9eb9b915-d16c-4458-b13a-b836693c55e2",
      "status": "pending",
      "entity_type": "individual",
      "full_name": "Lyle Greenholt",
      "email": null,
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "238888",
        "street_address": "123 Orchard Rd"
      },
      "id_type": "national_id",
      "id_number": "A1745205113",
      "nationality": "sg",
      "company_name": "Acme Corporation",
      "date_of_birth": "1990-01-01",
      "contact_number": "+6591234567",
      "place_of_birth": "Singapore",
      "created_by": {
        "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
        "display_name": "TestingSG",
        "first_name": "QA",
        "last_name": "SG"
      },
      "created_at": "2025-04-21T11:11:53+08:00",
      "updated_at": "2025-04-21T11:11:53+08:00"
    },
    {
      "id": "9e74249c-5831-4f06-b5bf-bd466d85aeb6",
      "status": "pending",
      "entity_type": "company",
      "full_name": "Emilio Yundt",
      "email": "email@gmail.com",
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "089109",
        "street_address": "1 Keong Saik Road"
      },
      "id_type": "passport",
      "id_number": "FB123456",
      "nationality": "sg",
      "company_name": "HitPay",
      "date_of_birth": "1990-10-28",
      "contact_number": "+6598644718",
      "place_of_birth": "Singapore",
      "created_by": {
        "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
        "display_name": "TestingSG",
        "first_name": "QA",
        "last_name": "SG"
      },
      "created_at": "2025-03-17T21:04:36+08:00",
      "updated_at": "2025-03-17T21:04:36+08:00"
    },
    {
      "id": "9e742406-edfd-4ba9-afc4-3f14f3abd41b",
      "status": "pending",
      "entity_type": "company",
      "full_name": "Carolyn Barrows",
      "email": "email@gmail.com",
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "089109111111111",
        "street_address": "1 Keong Saik Road"
      },
      "id_type": "passport",
      "id_number": "FB123456",
      "nationality": "sg",
      "company_name": "HitPay",
      "date_of_birth": "1990-10-28",
      "contact_number": "+6598644718",
      "place_of_birth": "Singapore",
      "created_by": {
        "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
        "display_name": "TestingSG",
        "first_name": "QA",
        "last_name": "SG"
      },
      "created_at": "2025-03-17T21:02:58+08:00",
      "updated_at": "2025-03-17T21:02:58+08:00"
    },
    {
      "id": "9e7423d8-4304-447b-87a6-9c195a7cf443",
      "status": "pending",
      "entity_type": "company",
      "full_name": "Connie Fahey",
      "email": "email@gmail.com",
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "089109",
        "street_address": "1 Keong Saik Road"
      },
      "id_type": "passport",
      "id_number": "FB123456",
      "nationality": "sg",
      "company_name": "HitPay",
      "date_of_birth": "1990-10-28",
      "contact_number": "+659864471812444444",
      "place_of_birth": "Singapore",
      "created_by": {
        "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
        "display_name": "TestingSG",
        "first_name": "QA",
        "last_name": "SG"
      },
      "created_at": "2025-03-17T21:02:27+08:00",
      "updated_at": "2025-03-17T21:02:27+08:00"
    },
    {
      "id": "9e7423b7-3650-4a78-a150-449735e435bf",
      "status": "pending",
      "entity_type": "company",
      "full_name": "Phyllis Hessel Sr.",
      "email": "email@gmail.com",
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "089109",
        "street_address": "1 Keong Saik Road"
      },
      "id_type": "passport",
      "id_number": "FB123456FB123456FB123456FB123456FB123456FB123456FB123456FB123456FB123456FB123456",
      "nationality": "sg",
      "company_name": "HitPay",
      "date_of_birth": "1990-10-28",
      "contact_number": "+6598644718",
      "place_of_birth": "Singapore",
      "created_by": {
        "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
        "display_name": "TestingSG",
        "first_name": "QA",
        "last_name": "SG"
      },
      "created_at": "2025-03-17T21:02:06+08:00",
      "updated_at": "2025-03-17T21:02:06+08:00"
    },
    {
      "id": "9e7420f7-55f2-400d-ae8f-3db9f75b1f8f",
      "status": "pending",
      "entity_type": "company",
      "full_name": "Test Sender",
      "email": "email@gmail.com",
      "address": {
        "city": "Singapore",
        "state": "Singapore",
        "country": "sg",
        "postal_code": "089109",
        "street_address": "1 Keong Saik Road"
      },
      "id_type": "passport",
      "id_number": "FB123456",
      "nationality": "sg",
      "company_name": "HitPay",
      "date_of_birth": "1990-10-28",
      "contact_number": "+6598644718",
      "place_of_birth": "Singapore",
      "created_by": {
        "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
        "display_name": "TestingSG",
        "first_name": "QA",
        "last_name": "SG"
      },
      "created_at": "2025-03-17T20:54:24+08:00",
      "updated_at": "2025-03-17T20:54:24+08:00"
    }
  ],
  "links": {
    "first": "https://api.sandbox.hit-pay.com/v1/remitters?page=1",
    "last": "https://api.sandbox.hit-pay.com/v1/remitters?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&larr; Previous",
        "active": false
      },
      {
        "url": "https://api.sandbox.hit-pay.com/v1/remitters?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &rarr;",
        "active": false
      }
    ],
    "path": "https://api.sandbox.hit-pay.com/v1/remitters",
    "per_page": 10,
    "to": 10,
    "total": 10
  }
}

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Query Parameters

​
per_page
integer
default:10
Required range: x <= 100

Response

200 - application/json

200

The response is of type object.