This page is intended for authenticated users.

Transactions

You may tag the originator or beneficiary as a Case or a Non-Case, but every transaction must include at least one Case. A transaction cannot exist with only Non-Cases.

Retrieve Transactions

Retrieve all transactions

Request:

curl -X 'GET' \
  'https://api.onehypernet.com/v1/kyc/transactions' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {token}'

JSON Response for One Transaction:

{
  "data": [
        {
            "fx_rate": "1.2234",
            "created_at": "2025-11-17T13:48:18.384Z",
            "updated_at": "2025-11-17T13:48:18.384Z",
            "originator": {
                "originator_id": "90f995ce-a7b9-4e06-bd3b-edd4e66df0ad",
                "originator_type": "case",
                "originator_custom_id": "C8652460405",
                "originator_name": "William Lee Soon Heng",
                "originator_entity_type": "individual"
            },
            "beneficiary": {
                "beneficiary_id": "8f1c0275-0fde-453b-bc02-0b9cf1ba8585",
                "beneficiary_type": "non-case",
                "beneficiary_custom_id": "S8904555065",
                "beneficiary_name": "Maggie Smith",
                "beneficiary_entity_type": "individual"
            },
            "transaction_date": "2024-10-20T06:29:29.000Z",
            "lcy_currency": "SGD",
            "total_lcy_amount": "25234.23",
            "fcy_currency": "USD",
            "total_fcy_amount": "20626.31",
            "transaction_status": "pending",
            "transaction_id": "85999593-2dd5-4637-ad46-9909fe8f88b3",
            "custom_transaction_id": "T85999593",
            "transaction_type": "TY6"
        },
        {
            "fx_rate": null,
            "created_at": "2025-11-17T13:47:59.755Z",
            "updated_at": null,
            "originator": {
                "originator_id": "90f995ce-a7b9-4e06-bd3b-edd4e66df0ad",
                "originator_type": "case",
                "originator_custom_id": "C8652460405",
                "originator_name": "William Lee Soon Heng",
                "originator_entity_type": "individual"
            },
            "beneficiary": null,
            "transaction_date": "2024-10-20T06:29:29.000Z",
            "lcy_currency": "SGD",
            "total_lcy_amount": "200",
            "fcy_currency": null,
            "total_fcy_amount": "0.00000000",
            "transaction_status": "cleared",
            "transaction_id": "a7e303bd-b608-41e1-a29f-0c34d488b34a",
            "custom_transaction_id": "TA7E303BD",
            "transaction_type": "TY6"
        }
    ],
  "metadata": {
    "total": 2
  }
}

GET /kyc/transactions

This endpoint retrieves all transactions. Add a limit to improve loading times.

Parameter	Type	Description
`limit`	Integer	Number of results for pagination.
`offset`	Integer	Starting point of the results for pagination.
`sort`	String	ASC or DESC.

Filter Parameters

You can filter search results with these parameters using the $in operator.

Parameter	Type	Description
`transaction_id`	String	Unique system reference ID of the transaction.
`custom_transaction_id`	String	Unique custom reference ID of the transaction.
`transaction_status`	String	Status of the transaction.
`originator_id`	String	case_id or non-case_id of the originator.
`beneficiary_id`	String	case_id or non-case_id of the beneficiary. .
`transaction_type`	String	Type of transaction.
`lcy_currency`	String	Local currency of the transaction in ISO 4217 format.
`fcy_currency`	String	Local currency of the transaction in ISO 4217 format.
`transaction_mode`	String	Mode of the transaction.
`purpose_of_transaction`	String	Purpose of the transaction.
`transaction_behavior`	String	Behavior of the client during the transaction.
`transaction_beneficial_owner`	Boolean	Whether the client is the beneficial owner of the transaction.

You can also filter search results based on range parameters using the $lte and $gte operators.

Range Parameter	Type	Description
`total_lcy_amount`	String	Total amount of the transaction in local currency.
`total_fcy_amount`	String	Total amount of the transaction in foreign currency.
`transaction_date`	String	Date of the transaction.
`created_at`	String	Date created.
`updated_at`	String	Date updated.

Sort Parameters

You can sort search results with these parameters.

Parameter	Type	Description
`transaction_date`	String	ASC or DESC.
`created_at`	String	ASC or DESC.
`updated_at`	String	ASC or DESC.
`total_lcy_amount`	String	ASC or DESC.
`total_fcy_amount`	String	ASC or DESC.

Retrieve a transaction

Request:

curl -X 'GET' \
  'https://api.onehypernet.com/v1/kyc/transactions/{transaction_id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {token}'

JSON Response:

{
    "created_at": "2025-11-24T15:20:34.014Z",
    "updated_at": "2025-11-24T15:20:34.014Z",
    "custom_transaction_id": "TX12232343",
    "fx_rate": "1.23234000",
    "payment_mode": "PY2",
    "payment_bank": "JP Morgan Chase",
    "payment_account_number": "0293458233",
    "payment_card": "VISA",
    "payment_card_hash": "a94af1b3c9f4d50e8c9bb776b81234fe",
    "payment_card_bin": "412345",
    "session_ip_address": "203.0.113.45",
    "session_device": "iPhone 16 Max Pro",
    "session_ip_country": "SG",
    "session_device_hash": "devicehash_49f0b12a88c5448e9d90",
    "session_vpn": false,
    "originator": {
        "originator_id": "4e0ef1a1-5e6c-4c6d-95d9-634323bdd4eb",
        "originator_type": "case",
        "originator_custom_id": "C8735519284",
        "originator_name": "Zachariah Valentine",
        "originator_entity_type": "individual"
    },
    "beneficiary": {
        "beneficiary_id": "66e64993-9845-466c-bdad-ffc47da6e4be",
        "beneficiary_type": "case",
        "beneficiary_custom_id": "C1296117358",
        "beneficiary_name": "Rayden Williamson",
        "beneficiary_entity_type": "individual"
    },
    "items": [
        {
            "item_id": "e981d646-70c1-4838-b3bb-18d33a22c2cf",
            "item": "Steel Components",
            "category": "Industrial",
            "quantity": "120.00000000",
            "rate": "50.00000000",
            "lcy_amount": "6000.00000000",
            "fcy_amount": null
        },
        {
            "item_id": "4328125f-15bc-4685-b133-b11d2f669c22",
            "item": "Packaging Materials",
            "category": "Manufacturing",
            "quantity": "200.00000000",
            "rate": "15.50000000",
            "lcy_amount": "3100.00000000",
            "fcy_amount": null
        }
    ],
    "agent": true,
    "relationship": "R1",
    "fcy_currency": "USD",
    "lcy_currency": "SGD",
    "total_lcy_amount": "9100.00000000",
    "total_fcy_amount": "0.00000000",
    "transaction_date": "2025-11-11T09:35:58.000Z",
    "transaction_status": "cleared",
    "transaction_id": "858035f7-ae70-43ea-aa68-b57bd0b26df6",
    "transaction_mode": "T2",
    "purpose_of_transaction": "PT2",
    "transaction_remarks": "Urgent processing requested",
    "transaction_behavior": "B2",
    "transaction_beneficial_owner": true,
    "transaction_type": "TY6",
    "transaction_description": "Payment for industrial materials under Invoice #INV-2045",
    "transaction_source_of_funds": "SF3"
}

GET /kyc/transactions/{transaction_id}

This endpoint retrieves a specific transaction.

Create Transaction

Create a transaction

Request:

curl -X 'POST' \
  'https://api.onehypernet.com/v1/kyc/transactions' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
    -d '{
{
"custom_transaction_id": "TX12345",
"originator_id": "4e0ef1a1-5e6c-4c6d-95d9-634323bdd4eb",
"originator_type": "case",
"beneficiary_id": "66e64993-9845-466c-bdad-ffc47da6e4be",
"beneficiary_type": "case",
"transaction_type": "TY6",
"transaction_description": "Payment for industrial materials under Invoice #INV-2045",
"lcy_currency": "SGD",
"fcy_currency": "USD",
"fx_rate": "1.23234",
"payment_mode": "PY2",
"transaction_source_of_funds": "SF3",
"purpose_of_transaction": "PT2",
"transaction_remarks": "Urgent processing requested",
"transaction_behavior": "B2",
"transaction_beneficial_owner": true,
"payment_bank": "JP Morgan Chase",
"payment_account_number": "0293458233",
"payment_card": "VISA",
"payment_card_hash": "a94af1b3c9f4d50e8c9bb776b81234fe",
"payment_card_bin": "412345",
"session_ip_address": "203.0.113.45",
"session_device": "iPhone 16 Max Pro",
"session_ip_country": "SG",
"session_device_hash": "devicehash_49f0b12a88c5448e9d90",
"session_vpn": false,
  "items": [
        {
            "item": "Steel Components",
            "category": "Industrial",
            "quantity": "120.00000000",
            "rate": "50.00000000",
            "lcy_amount": "6000.00000000",
            "fyc_amount": "0.00000000"
        },
        {
            "item": "Packaging Materials",
            "category": "Manufacturing",
            "quantity": "200.00000000",
            "rate": "15.50000000",
            "lcy_amount": "3100.00000000",
            "fyc_amount": "0.00000000"
        }
  ],
    "transaction_date": "2025-11-11T09:35:58.000Z",
  "lcy_amount": 220,
  "transaction_mode": "T2"
}
  '

JSON Response:

{
    "transaction_id": "d2bc00b3-7b93-416f-a666-7f927ac834d5"
}

POST /kyc/transactions

This endpoint creates a single transaction.

Code tables

Use these codes for transaction_status, transaction_type, transaction_mode, purpose_of_transaction, payment_mode, transaction_source_of_funds, transaction_behavior. Any values not found in the code table will be stored as a custom value.

Transaction Status

Parameter	Code
`Pending`	Pending
`Cleared`	Cleared
`Suspended`	Suspended
`Declined`	Declined
`Refunded`	Refunded

Transaction Type

Parameter	Code
`Buy`	TY1
`Sell`	TY2
`Deposit`	TY3
`Withdraw`	TY4
`Transfer - Local`	TY5
`Transfer - Overseas`	TY6
`Payment`	TY7
`Refunded`	TY8
`Cancelled`	TY9

Transaction Mode

Parameter	Code
`In person`	T1
`Video call`	T2
`Phone call`	T3
`Mobile app`	T4
`Web app`	T5
`Email`	T6

Purpose of Transaction

Parameter	Code
`Medical`	PT1
`Debt repayment`	PT2
`Education`	PT3
`Renovation`	PT4
`Travel`	PT5
`Wedding`	PT6
`Consumer goods`	PT7
`Utilities`	PT8
`Vehicle`	PT9
`Legal fees`	PT10

Payment Mode

Parameter	Code
`Bank Transfer (Self)`	PY1
`Bank Transfer (Domestic)`	PY2
`Bank Transfer (International)`	PY3
`Credit Card`	PY4
`Debit Card`	PY5
`E-Wallet (Regulated)`	PY6
`E-Wallet (Unregulated)`	PY7
`Cryptocurrency (Regulated)`	PY8
`Cryptocurrency (Unregulated)`	PY9
`Cash`	PY10
`Cheqeue`	PY11
`Prepaid Cards (Identified)`	PY12
`Prepaid Card (Annoymous)`	PY13

Source of Funds

Parameter	Code
`Revenue`	SF1
`Loan`	SF2
`Equity`	SF3
`Grant`	SF4
`Donation`	SF55
`Recurring Salary`	SF6
`Freelance Salary`	SF7
`Rent Income`	SF8
`Investment`	SF9
`Pension`	SF10
`Inheritance`	SF11
`Family`	SF12
`Commissions`	SF13
`Gambling winnings`	SF14

Behavior of Client

Parameter	Code
`Friendly`	B1
`Relaxed`	B2
`Arrogant`	B3
`Emotional`	B4
`Shy`	B5
`Sad`	B6
`Courteous`	B7
`Rough`	B8
`Abnormal`	B9

Update Transactions

Update a transaction

Request:

curl -X 'PATCH' \
  'https://api.onehypernet.com/v1/kyc/transactions/{transaction_id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
    -d '{
  "custom_transaction_id": "TX123345",
  "originator_id": "4e0ef1a1-5e6c-4c6d-95d9-634323bdd4eb",
  "originator_type": "case",
  "beneficiary_id": "66e64993-9845-466c-bdad-ffc47da6e4be",
  "beneficiary_type": "case",
  "transaction_type": "TY6",
  "transaction_description": "Payment for industrial materials under Invoice #INV-2045",
  "lcy_currency": "SGD",
  "fcy_currency": "USD",
  "fx_rate": "1.23234",
  "payment_mode": "PY2",
  "transaction_source_of_funds": "SF3",
  "purpose_of_transaction": "PT2",
  "transaction_remarks": "Urgent processing requested",
  "transaction_behavior": "B2",
  "transaction_beneficial_owner": true,
  "payment_bank": "JP Morgan Chase",
  "payment_account_number": "0293458233",
  "payment_card": "VISA",
  "payment_card_hash": "a94af1b3c9f4d50e8c9bb776b81234fe",
  "payment_card_bin": "412345",
  "session_ip_address": "203.0.113.45",
  "session_device": "iPhone 16 Max Pro",
  "session_ip_country": "SG",
  "session_device_hash": "devicehash_49f0b12a88c5448e9d90",
  "session_vpn": false,
  "items": [
        {
            "item": "Steel Components",
            "category": "Industrial",
            "quantity": "120.00000000",
            "rate": "50.00000000",
            "lcy_amount": "6000.00000000",
            "fyc_amount": "0.00000000"
        },
        {
            "item": "Packaging Materials",
            "category": "Manufacturing",
            "quantity": "200.00000000",
            "rate": "15.50000000",
            "lcy_amount": "3100.00000000",
            "fyc_amount": "0.00000000"
        }
  ],
    "transaction_date": "2025-11-11T09:35:58.000Z",
  "lcy_amount": 220,
  "transaction_mode": "T2"
}'

PATCH /kyc/transactions/{transaction_id}

This endpoint updates a single transaction.

Delete Transactions

Delete a transaction

Request:

curl -X 'DELETE' \
  'https://api.onehypernet.com/v1/kyc/transactions/{transaction_id}' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {token}'

DELETE /cases/kyc/transactions/{transaction_id}

This endpoint deletes a transaction and all its data.

Retrieve Transactions

Retrieve all transactions​

Filter Parameters​

Sort Parameters​

Retrieve a transaction​

Create Transaction

Create a transaction​

Code tables​

Transaction Status​

Transaction Type​

Transaction Mode​

Purpose of Transaction​

Payment Mode​

Source of Funds​

Behavior of Client​

Update Transactions

Update a transaction​

Delete Transactions

Delete a transaction​

Retrieve all transactions

Filter Parameters

Sort Parameters

Retrieve a transaction

Create a transaction

Code tables

Transaction Status

Transaction Type

Transaction Mode

Purpose of Transaction

Payment Mode

Source of Funds

Behavior of Client

Update a transaction

Delete a transaction