POS API
Warning: As a third party connected to nearpay APIs, upon usage, you agree to uphold the upmost security standards in accessing and using these APIs. These APIs share information that is confidential to you as a third party connected to nearpay. This information must be stored and used in a secure manner.
Authentication
NearPay uses API key as an authentication method.
Your own api key can be retrieved from your NearPay dashboard, the api key is needed in all requests as a header. Please follow this path to get your api key: NearPay Dashboard -> Credentials -> Find the api key below -> Copy it.
Base URL
https://sandbox-api.nearpay.io/v1/clients-sdk/pos/
Pagination
Please find the guide here in how to use pagination.
Messages
In this endpoint you will be able to create or list messages.
GET/messages
List Messages
Request
GET
/messages{}
Response 200
{
"messages": [
{
"id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"ip_address": "",
"system_trace_audit_number": "111111",
"transaction_type": "00",
"action_code": "000",
"mti": "1210",
"card_acceptor_terminal_id": "11111111",
"card_acceptor_id": "11111111 ",
"retrival_reference_number": "527309006786",
"request_id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"created_at": "2025-09-25T13:20:59.895Z",
"updated_at": "2025-09-25T13:20:59.978Z",
"region": "jed",
"terminal": {
"id": "e1e913d6-0558-44d6-9f34-ea2f125eeefa",
"trsm": "FF1BCA",
"card_acceptor_id": "11111111 ",
"card_acceptor_terminal_id": "11111111",
"acquirer_institution_identification_code": "111111",
"environment": "1",
"last_transaction": "2025-09-25T13:20:59.970Z",
"lat": null,
"lon": null,
"platform_id": "1825a8ad-e30f-49f5-a64f-a60a68104961",
"client_id": "f5b80833-d1a6-414a-be4c-9f5ae3a9eaca",
"merchant_id": null,
"created_at": "2024-06-26T15:19:05.319Z",
"updated_at": "2025-09-25T13:20:59.971Z"
}
}
],
"pages": {
"current": 1
}
}
GET/messages/{id}
Find Message
Request
GET
/messages/{id}{}
{
"message": {
"id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"ip_address": "",
"system_trace_audit_number": "111111",
"transaction_type": "00",
"action_code": null,
"mti": "1200",
"card_acceptor_terminal_id": "11111111",
"card_acceptor_id": "11111111 ",
"retrival_reference_number": "527309006786",
"request_id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"created_at": "2025-09-25T11:06:25.173Z",
"updated_at": "2025-09-25T11:06:25.337Z",
"region": "jed",
"terminal": {
"id": "e1e913d6-0558-44d6-9f34-ea2f125eeefa",
"trsm": "FF1BCA",
"card_acceptor_id": "11111111 ",
"card_acceptor_terminal_id": "11111111",
"acquirer_institution_identification_code": "111111",
"vendor": {
"id": "e098adba-c31a-448f-8335-e6f34f68c2d4",
"vendor_id": "02",
"name": "Nearpay"
}
}
}
}
Reconciliations
In this endpoint comes creating a reconciliation and listing previous reconciliations.
GET/reconciliations
List Reconciliations
Request
GET
/reconciliations{}
Response 200
{
"reconciliations": [
{
"id": "04299703-aaaf-4220-b967-2417cb65d2f2",
"stan": "111111",
"pos_totals": [
{
"schema_acquirer": "AX",
"schema_sponsor": "AMEX",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "DC",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "DM",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "GN",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "MC",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "P1",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "UP",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "VC",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
}
],
"host_totals": [
{
"schema_acquirer": "AX",
"schema_sponsor": "AMEX",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "DC",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "DM",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "GN",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "MC",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "P1",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "UP",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "VC",
"schema_sponsor": "NCBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
}
],
"action_code": "500",
"is_balanced": true,
"request_id": "04299703-aaaf-4220-b967-2417cb65d2f2",
"region": "jed",
"created_at": "2025-09-25T13:47:34.963Z",
"updated_at": "2025-09-25T13:47:35.397Z",
"terminal": {
"id": "e1e913d6-0558-44d6-9f34-ea2f125eeefa",
"card_acceptor_terminal_id": "111111111111",
"acquirer_institution_identification_code": "111111"
}
}
],
"pages": {
"current": 1
}
}
GET/reconciliations/{id}
Find Reconciliation
Request
GET
/reconciliations/{id}{}
{
"reconciliations": {
"id": "04299703-aaaf-4220-b967-2417cb65d2f2",
"stan": "111111",
"pos_totals": [
{
"schema_acquirer": "GN",
"schema_sponsor": "ANBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "P1",
"schema_sponsor": "ANBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
}
],
"host_totals": [
{
"schema_acquirer": "GN",
"schema_sponsor": "ANBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
},
{
"schema_acquirer": "P1",
"schema_sponsor": "ANBB",
"debit_count": 0,
"debit_amount": 0,
"credit_count": 0,
"credit_amount": 0,
"cash_back_amount": 0,
"cash_advance_amount": 0,
"authorization_count": 0
}
],
"action_code": "500",
"is_balanced": true,
"request_id": "04299703-aaaf-4220-b967-2417cb65d2f2",
"region": "jed",
"created_at": "2025-09-25T11:27:00.492Z",
"updated_at": "2025-09-25T11:27:00.695Z",
"terminal": {
"id": "e1e913d6-0558-44d6-9f34-ea2f125eeefa",
"trsm": "FF1BCA",
"card_acceptor_id": "111111111111",
"card_acceptor_terminal_id": "1111111111",
"acquirer_institution_identification_code": "111111",
"created_at": "2024-06-30T11:22:31.787Z"
},
"receipt": {
"id": "a88f40ad-3f35-445c-915c-dcb4621f77a4",
"data": {
"id": "a88f40ad-3f35-445c-915c-dcb4621f77a4",
"date": "25/09/2025",
"stan": "111111",
"time": "14:27:00",
"details": {
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"refund": {
"count": 0,
"label": {
"arabic": "المستردة",
"english": "Refund"
},
"total": "0.00"
},
"purchase": {
"count": 0,
"label": {
"arabic": "الشراء",
"english": "Purchase"
},
"total": "0.00"
}
},
"qr_code": "https://api.nearpay.io/pos/ui/reconciliation_receipt/a88f40ad-3f35-445c-915c-dcb4621f77a4",
"schemes": [
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "mada",
"arabic": "مدى",
"english": "mada"
},
"value": "P1"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "visa",
"arabic": "فيزا",
"english": "Visa"
},
"value": "VC"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "visadebit",
"arabic": "فيزا مدين",
"english": "Visa Debit"
},
"value": "VD"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "mastercard",
"arabic": "ماستر كارد",
"english": "MasterCard"
},
"value": "MC"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "maestro",
"arabic": "مايسترو",
"english": "Maestro"
},
"value": "DM"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "amex",
"arabic": "امريكان اكسبرس",
"english": "American Express"
},
"value": "AX"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "unionPay",
"arabic": "يونيون باي",
"english": "UnionPay"
},
"value": "UP"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "jcb",
"arabic": "جي سي بي",
"english": "JCB"
},
"value": "JC"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "discover",
"arabic": "ديسكفر",
"english": "Discover"
},
"value": "DC"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"key": "gccnet",
"arabic": "الشبكة الخليجية",
"english": "GCCNET"
},
"value": "GN"
},
"is_balanced": true
}
],
"currency": {
"arabic": "",
"english": "SAR"
},
"end_date": "25/09/2025",
"end_time": "14:27:00",
"merchant": {
"id": "11111111",
"name": {
"arabic": "نيرباي",
"english": "Nearpay"
},
"address": {
"arabic": "حي الملقا",
"english": "almalqa"
},
"category_code": "7011"
},
"terminal": {
"id": "e1e913d6-0558-44d6-9f34-ea2f125eeefa"
},
"start_date": "25/09/2025",
"start_time": "14:27:00",
"is_balanced": {
"value": true
},
"merchant_id": null,
"terminal_type": "pos",
"reconciliation": {
"id": "04299703-aaaf-4220-b967-2417cb65d2f2"
},
"card_scheme_sponsor_id": "111111",
"card_acceptor_terminal_id": "111111111111",
"system_trace_audit_number": "111111",
"pos_software_version_number": "1.0.0"
}
}
}
}
Terminals
In this endpoint comes creating a new terminal, fetching terminals and disconnecting a particular terminal
GET/terminals
List Terminals
Request
GET
/terminals{}
Response 200
{
"terminals": [
{
"id": "e1e913d6-0558-44d6-9f34-ea2f125eeefa",
"trsm": "FF1BCA",
"card_acceptor_id": "111111111111",
"card_acceptor_terminal_id": "111111111111",
"acquirer_institution_identification_code": "111111",
"environment": "1",
"last_transaction": "2025-09-25T13:11:04.765Z",
"lat": null,
"lon": null,
"platform_id": "1825a8ad-e30f-49f5-a64f-a60a68104961",
"client_id": "f5b80833-d1a6-414a-be4c-9f5ae3a9eaca",
"merchant_id": null,
"created_at": "2025-09-25T13:03:00.302Z",
"updated_at": "2025-09-25T13:11:04.766Z",
"vendor": {
"id": "e098adba-c31a-448f-8335-e6f34f68c2d4",
"vendor_id": "02",
"support_emails": null,
"name": "Nearpay",
"logo": "",
"client_id": "f5b80833-d1a6-414a-be4c-9f5ae3a9eaca",
"created_at": "2023-05-22T09:37:09.158Z",
"updated_at": "2023-05-22T09:37:09.158Z"
},
"platform": {
"id": "1825a8ad-e30f-49f5-a64f-a60a68104961",
"name": "NearPay"
},
"is_connected": false
}
],
"pages": {
"current": 1
}
}
GET/terminals/{id}
Find Terminal
Request
GET
/terminals/{id}{}
{
"terminal": {
"id": "e1e913d6-0558-44d6-9f34-ea2f125eeefa",
"trsm": "FF1BCA",
"card_acceptor_id": "11111111111111",
"card_acceptor_terminal_id": "11111111111111",
"acquirer_institution_identification_code": "111111",
"environment": "1",
"last_transaction": "2025-09-25T13:11:04.765Z",
"lat": null,
"lon": null,
"platform_id": "1825a8ad-e30f-49f5-a64f-a60a68104961",
"client_id": "f5b80833-d1a6-414a-be4c-9f5ae3a9eaca",
"merchant_id": null,
"created_at": "2025-09-25T13:03:00.302Z",
"updated_at": "2025-09-25T13:11:04.766Z",
"vendor": {
"vendor_id": "02",
"name": "Nearpay",
"logo": ""
},
"platform": {
"id": "1825a8ad-e30f-49f5-a64f-a60a68104961",
"name": "NearPay",
"vendor_id": "e098adba-c31a-448f-8335-e6f34f68c2d4",
"is_master": false,
"logo": null,
"settings": null
}
}
}
Transactions
In this endpoint comes listing transactions and viewing one transaction full details.
GET/transactions
List Transactions
Request
GET
/transactions{}
Response 200
{
"transactions": [
{
"id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"amount_authorized": "800",
"amount_other": "0",
"local_date_time": "250925170940",
"transaction_type": "00",
"currency_code": "682",
"processing_code": "000000",
"acquirer_institution_identification_code": "000000",
"system_trace_audit_number": "111111",
"retrival_reference_number": "527309006786",
"merchant_catagory_code": "5812",
"pan": "1111 11** **** 1111",
"card_scheme": "P1",
"action_code": "000",
"approval_code": "474747",
"cardholder_verification_method": "000000",
"entry_mode": "7",
"is_approved": true,
"is_reversed": false,
"is_reversal_approved": false,
"client_id": "f5b80833-d1a6-414a-be4c-9f5ae3a9eaca",
"merchant_id": null,
"performance": [
{
"type": "api_start",
"time_stamp": 1758809381815
},
{
"type": "server_start",
"time_stamp": 1758809381815
},
{
"type": "transaction_start",
"time_stamp": 1758809381815
},
{
"type": "network_start",
"time_stamp": 1758809381815
},
{
"type": "send",
"time_stamp": 1758809381816
},
{
"type": "received",
"time_stamp": 1758809381977
},
{
"type": "network_end",
"time_stamp": 1758809381978
},
{
"type": "transaction_end",
"time_stamp": 1758809381978
},
{
"type": "api_end",
"time_stamp": 1758809381978
},
{
"type": "server_end",
"time_stamp": 1758809381978
}
],
"decline_reason": null,
"created_at": "2025-09-25T14:09:41.815Z",
"updated_at": "2025-09-25T14:09:42.023Z",
"region": "jed",
"lat": "21.479444444444443",
"lon": "39.33222222222223",
"tunnel": {
"id": "5c10f000-39eb-4bed-90ec-5d2245e0d3f5",
"name": "Default",
"port": 0,
"platform_id": "1825a8ad-e30f-49f5-a64f-a60a68104961",
"settings": {
"terminal": {
"registration": {
"auto": false
}
}
},
"created_at": "2025-01-29T14:03:29.507Z",
"updated_at": "2025-01-29T14:03:29.507Z",
"is_whitelist": false,
"allow_only_known_vendors": false,
"type": "iso-8583",
"ca": null
},
"terminal": {
"card_acceptor_terminal_id": "1111111111"
},
"messages": [
{
"id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb,
"system_trace_audit_number": "111111",
"action_code": "000",
"mti": "1210",
"card_acceptor_terminal_id": "11111111111111",
"retrival_reference_number": "527309006786"
},
{
"id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"system_trace_audit_number": "111111",
"action_code": null,
"mti": "1200",
"card_acceptor_terminal_id": "11111111111111",
"retrival_reference_number": "527309006786"
}
]
}
],
"pages": {
"current": 1
}
}
GET/transactions/{id}
Find Transaction
Request
GET
/transactions/{id}{}
{
"transaction": {
"id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"amount_authorized": "800",
"amount_other": "0",
"local_date_time": "250925170940",
"transaction_type": "00",
"currency_code": "682",
"processing_code": "000000",
"acquirer_institution_identification_code": "111111",
"system_trace_audit_number": "111111",
"retrival_reference_number": "527309006786",
"merchant_catagory_code": "5812",
"pan": "1111 11** **** 1111",
"card_scheme": "P1",
"action_code": "000",
"approval_code": "474747",
"cardholder_verification_method": "000000",
"entry_mode": "7",
"is_approved": true,
"is_reversed": false,
"is_reversal_approved": false,
"client_id": "f5b80833-d1a6-414a-be4c-9f5ae3a9eaca",
"merchant_id": null,
"performance": [
{
"type": "api_start",
"time_stamp": 1758809381815
},
{
"type": "server_start",
"time_stamp": 1758809381815
},
{
"type": "transaction_start",
"time_stamp": 1758809381815
},
{
"type": "network_start",
"time_stamp": 1758809381815
},
{
"type": "send",
"time_stamp": 1758809381816
},
{
"type": "received",
"time_stamp": 1758809381977
},
{
"type": "network_end",
"time_stamp": 1758809381978
},
{
"type": "transaction_end",
"time_stamp": 1758809381978
},
{
"type": "api_end",
"time_stamp": 1758809381978
},
{
"type": "server_end",
"time_stamp": 1758809381978
}
],
"decline_reason": null,
"created_at": "2025-09-25T14:09:41.815Z",
"updated_at": "2025-09-25T14:09:42.023Z",
"region": "jed",
"lat": "21.479444444444443",
"lon": "39.33222222222223",
"tunnel": {
"id": "5c10f000-39eb-4bed-90ec-5d2245e0d3f5",
"name": "Default",
"port": 0,
"platform_id": "1825a8ad-e30f-49f5-a64f-a60a68104961",
"settings": {
"terminal": {
"registration": {
"auto": false
}
}
},
"created_at": "2025-01-29T14:03:29.507Z",
"updated_at": "2025-01-29T14:03:29.507Z",
"is_whitelist": false,
"allow_only_known_vendors": false,
"type": "iso-8583",
"ca": null
},
"terminal": {
"id": "e1e913d6-0558-44d6-9f34-ea2f125eeefa",
"trsm": "FF1BCA",
"card_acceptor_id": "1111111111111111",
"card_acceptor_terminal_id": "1111111111111111",
"acquirer_institution_identification_code": "111111",
"vendor": {
"id": "e098adba-c31a-448f-8335-e6f34f68c2d4",
"vendor_id": "02",
"name": "Nearpay"
}
},
"messages": [
{
"id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"system_trace_audit_number": "111111",
"action_code": "000",
"mti": "1210",
"card_acceptor_terminal_id": "11111111111111",
"retrival_reference_number": "527309006786",
"created_at": "2025-09-25T14:09:41.978Z"
},
{
"id": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"system_trace_audit_number": "111111",
"action_code": null,
"mti": "1200",
"card_acceptor_terminal_id": "11111111111111",
"retrival_reference_number": "527309006786",
"created_at": "2025-09-25T14:09:41.815Z"
}
],
"receipts": [
{
"id": "48861c15-ac34-4f13-992f-e91b825d8d77",
"data": {
"id": "48861c15-ac34-4f13-992f-e91b825d8d77",
"lat": "21.479444444444443",
"lon": "39.33222222222223",
"pan": "1111 11** **** 1111",
"tid": "1820066901300001",
"type": "purchase",
"qr_code": "https://api.nearpay.io/pos/ui/receipt/48861c15-ac34-4f13-992f-e91b825d8d77",
"currency": {
"arabic": "",
"english": "SAR"
},
"end_date": "25/09/2025",
"end_time": "17:09:41",
"merchant": {
"id": "111111111111",
"name": {
"arabic": "نيرباي",
"english": "Nearpay"
},
"address": {
"arabic": "الملقا",
"english": "Almalqa"
},
"category_code": "5812"
},
"entry_mode": "CONTACTLESS",
"pan_suffix": "",
"start_date": "25/09/2025",
"start_time": "17:09:41",
"action_code": "000",
"card_scheme": {
"id": "P1",
"name": {
"key": "mada",
"arabic": "مدى",
"english": "mada"
}
},
"is_approved": true,
"is_refunded": false,
"is_reversed": false,
"amount_other": {
"label": {
"arabic": "مبلغ النقد",
"english": "NAQD AMOUNT"
},
"value": "0.00"
},
"approval_code": {
"label": {
"arabic": "رمز الموافقة",
"english": "Approval Code"
},
"value": "474747"
},
"terminal_type": "pos",
"status_message": {
"arabic": "مقبولة",
"english": "Approved"
},
"thanks_message": {
"arabic": "شكرا لاستخدامكم مدى",
"english": "Thank you for using mada"
},
"card_expiration": "29/04",
"receipt_line_one": {
"arabic": "",
"english": ""
},
"receipt_line_two": {
"arabic": "",
"english": ""
},
"transaction_type": {
"id": "00",
"name": {
"arabic": "شراء",
"english": "PURCHASE"
}
},
"transaction_uuid": "dfe2ca83-3e7e-4221-a7cf-723cd1dabcdb",
"amount_authorized": {
"label": {
"arabic": "مبلغ الشراء",
"english": "PURCHASE AMOUNT"
},
"value": "8.00"
},
"card_scheme_sponsor": "ANBB",
"verification_method": {
"arabic": "تم التحقق من هوية حامل الجهاز ",
"english": "DEVICE OWNER IDENTITY VERIFIED"
},
"save_receipt_message": {
"arabic": "يرجى الاحتفاظ بالفاتورة",
"english": "please retain receipt"
},
"application_cryptogram": "11111111111111",
"application_identifier": "11111111111111",
"payment_account_reference": "",
"system_trace_audit_number": "111111",
"retrieval_reference_number": "1111111111111",
"cryptogram_information_data": "00",
"pos_software_version_number": "1.0.0",
"terminal_verification_result": "0000000000",
"transaction_state_information": "0000",
"cardholader_verfication_result": "000000"
}
}
]
}
}