API Documentation
NeoX documents
NeoX documents
  • Introduction
  • NeoX App
    • E-Wallet
    • eKYC
    • Functionality
  • Payment Gateway
    • Payment Methods
    • Integrations
      • Hosted Checkout
        • Plugin/Extenstion
        • iOS SDK
        • Android SDK
        • React Native SDK
        • Web SDK
        • APIs
      • Direct API
        • Tokenization
      • Refund
        • APIs
        • IPN
    • Transaction Management
      • Query DR
      • Cancel
      • IPN
      • Error Codes
      • Refund on portal
    • Reconciliation
    • Settlement
  • Disbursement
    • Integration
      • Introduction
      • How To Register
      • Security Method
      • Generate token API
      • Get merchant profile API
      • Request disbursement API
      • Get disbursement transaction API
      • Get exchange rate API
      • Inquiry bank account API
      • Currency conversion API
      • Event Notification
      • Response Data Structure
      • Error codes
    • Disbursement Account
    • Disbursement request
    • Transaction Management
      • Query Request/Transaction
      • Webhook
      • Error Codes
    • Reconciliation
  • Collections
    • Integration
      • Introduction
      • How To Register
      • Security Method
      • API authenPlatform
      • API upload file
      • APIs for virtual accounts management
        • API create list of virtual accounts
        • API update KYC virtual account information
        • API update Virtual Account transaction data from merchant
        • API set active/inactive Virtual Account
        • API get list virtual accounts
        • API get detail virtual account
      • APIs for transactions management
        • API update transaction documents
        • API get list transactions
        • API get detail transaction
      • APIs for refund requests management
        • API create refund request
        • API get list refund requests
        • API get detail refund request
      • APIs for withdraw requests management
        • API get list withdraw banks
        • API create withdraw request
        • API get list withdraw requests
        • API get detail withdraw request
      • Event Notification
      • SFTP upload document file of collection transaction
      • Error Codes
    • Virtual Account Management
      • Virtual Account
      • Virtual Account Status
      • Webhook
    • Transaction Management
      • Webhook
    • Transaction Status Management
      • Webhook
    • Refund Request Management
      • Webhook
    • Withdraw Request Management
      • Webhook
    • Reconciliation
    • Settlement
  • Merchant Portal
    • Onboarding
    • Payment Gateway
      • Reconciliation
      • Withdraw
    • Disbursement
      • Reports
    • Collections
      • Reports
      • Withdraw
Powered by GitBook
On this page
  • Instant Payment Notification
  • NeoX's IPN data
  • Merchant response

Was this helpful?

  1. Payment Gateway
  2. Integrations
  3. Refund

IPN

PreviousAPIsNextTransaction Management

Last updated 7 months ago

Was this helpful?

Instant Payment Notification

Merchant receive refund result. Similar to IPN

Merchant has to respond to NeoX following the structure when receiving IPN.

IPN verification

Merchant needs to build a hashed string follow above guide and compare to received neo_SecureHash parameter

Method: POST

NeoX's IPN data

Parameter
Data type
Description

neo_MerchantCode

String

The merchant code is provided by NeoX.

neo_Command

String

"REFUND"

neo_OrderID

String

Order ID

neo_PaymentID

String

ID of payment record

neo_RequestID

String

Request ID sent to NeoX in refund request

neo_TransactionID

String

Unique - Transaction ID is generated by NeoX.

neo_Amount

Number

Refund amount.

neo_Fee

Number

Refund fee

neo_Version

String

Payment gateway version, “1” as default

neo_ResponseCode

Number

neo_ResponseMsg

String

Error description.

neo_SecureHash

String

Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (is provided by NeoX after actual integrating).

{
  "neo_MerchantCode": "UFLIYL",
  "neo_Command": "REFUND",
  "neo_OrderID": "DH7255715767",
  "neo_PaymentID": "1439211",
  "neo_RequestID": "a68de39f-ea76-43fb-848f-b605b4aaf44e",
  "neo_TransactionID": "XBSKM1OELUDU",
  "neo_Amount": 10000,
  "neo_Fee": 3300,
  "neo_Version": "1",
  "neo_ResponseCode": 0,
  "neo_ResponseMsg": "Success",
  "neo_SecureHash": "3C97E508CBED7561759D049C5FA58BE2DE455EA4E7EE07B1DFDF2AFC4783E144"
}

Merchant response

Parameter
Data type
Description

respcode

Number

  • 0: Successful, merchant received IPN.

  • 1: Failed, NeoX will retry the IPN.

respmsg

String

Error message. Default is “received”

Result of transaction: 0: transaction success != 0: transaction failed, refer to

merchant response
table of error code