Transaction

New Transaction

caution

• HTTP CODE 500 should be marked as Pending transaction.
• NETWORK TIMEOUT should be marked as Pending transaction.
• If the transaction is accepted by the system, data.status will always started as PENDING
• If you want to check transaction status, please refer to e Transaction Status section below or just wait for an update from our Callback system.
• Possible transaction status: PENDING, REFUND, SUCCESS.

API Request

Type	Value
HTTP Method	POST or GET
API Endpoint	https://api.neropass.com/partner/v1/order

Request Body

{
    "refId": "TEST1",
    "productCode": "GFFD5",
    "dest": "123456789",
    "maxPrice": 1000
}

Parameter	Type	Mandatory	Description
refId	String	No	Unique Transaction ID from your server.
productCode	String	Yes	Product Code, you can get it from Product endpoint.
dest	String	Yes	Destination Format should be match with destFormat on Product endpoint.
maxPrice	Integer	No	Your transaction will be automatically rejected if the product price above maxPrice.

Response Body

Success Response

{
    "success": true,
    "data": {
        "trxId": "TR646FB1F411AE7NHBHFPSM",
        "refId": "TEST2",
        "productCode": "GFFD5",
        "productPrice": 855,
        "userId": "1234567890",
        "serverId": null,
        "username": "LoremImpsum",
        "voucher": null,
        "phone": null,
        "reference": null,
        "status": "PENDING",
        "message": "PROCESSING",
        "balance": 329382123,
        "createdAt": "2023-05-26 02:07:33"
    },
    "errors": null
}

info

• Data userId, serverId, username, voucher, phone, reference are nullable, make sure to handle it properly on your side.
• Possible transaction status: PENDING, REFUND, SUCCESS.

Error Response

{
    "success": false,
    "data": null,
    "errors": {
        "code": 400,
        "message": "PRODUCT_OVERPRICE",
        "attributes": null
    }
}

Error Codes

Message	HTTP	Transaction Created?	Description
INVALID_REQUEST_PARAMETERS	400	No	Check your request parameter, maybe something is missing.
PRODUCT_NOT_FOUND	400	No	Product not found or invalid product code.
PRODUCT_UNAVAILABLE	400	No	Product currently not available, please try again later.
PRODUCT_OVERPRICE	400	No	Product price are above maxPrice.
INSUFFICIENT_BALANCE	400	No	Insufficient balance, please reload your account balance.
INVALID_DESTINATION_FORMAT	400	No	Invalid User ID or destination format.
INVALID_DESTINATION	400	No	Invalid User ID or destination.
INVALID_OPTIONS	400	No	Invalid option value (mainly are serverId).
GENERAL_ERROR	400	No	General Error.

Transaction Status

API Request

Type	Value
HTTP Method	GET
API Endpoint	https://api.neropass.com/partner/v1/status

Request Parameters

Parameter	Type	Description
trxId	String	trxId that you get after hitting Order endpoint.
refId	String	refId is Unique ID from your system that you send to us on Order endpoint.

info

• You can choose to check order status with trxId or refId.

Response Body

Success Response

{
    "success": true,
    "data": {
        "trxId": "TR646FB1F411AE7NHBHFPSM",
        "refId": "TEST2",
        "productCode": "GFFD5",
        "productPrice": 855,
        "userId": "1234567890",
        "serverId": null,
        "username": "LoremImpsum",
        "voucher": null,
        "phone": null,
        "reference": "S1234567890123456",
        "status": "SUCCESS",
        "message": "COMPLETED",
        "balance": 329382123,
        "createdAt": "2023-05-26 02:07:33"
    },
    "errors": null
}

info

• Data userId, serverId, username, voucher, phone, reference are nullable, make sure to handle it properly on your side.
• Possible transaction status: PENDING, REFUND, SUCCESS.

Error Response

{
    "success": false,
    "data": null,
    "errors": {
        "code": 400,
        "message": "TRANSACTION_NOT_FOUND",
        "attributes": null
    }
}