API Documentation
NeoX documents v.2
NeoX documents v.2
  • 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
      • 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
  • Generate token
  • Next payment

Was this helpful?

  1. Payment Gateway
  2. Integrations
  3. Direct API

Tokenization

A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.

PreviousDirect APINextRefund

Was this helpful?

Generate token

  1. Contact NeoX to register the service.

  1. Create bill with enabled neo_TokenCreate field.

Next payment

  1. Authentication

Using scope = payment

  1. Pay by token API

  • URL: https://api.neopay.vn/oapi/v2/payment/payByToken

  • Method: POST

  • Request: Content-Type: application/json

Request Parameter

Parameter
Data type
Required
Description

orderId

String

Y

Order ID

orderInfo

String

Y

Order description

merchantTxnId

String

Y

Merchant's transaction ID (unique)

currency

String

Y

Currency (default VND)

amount

Number

Y

Bill amount

payToken

String

Y

neo_PayToken NeoX returned

Example:

{
    "orderId": "DH123232234",
    "orderInfo": "Thanh toan DH123232234",
    "merchantTxnId": "323123221434",
    "currency": "VND",
    "amount": 100000,
    "payToken": "c9291339613c4e4a80818c87cbedb483"
}

Response Data

Field name
Data type
Description

code

Number

message

String

Response message

data

Object

  • orderId: String

  • merchantTxnId: String

Example:

{
    "code": 99,
    "message": "Order is processing",
    "data": {
        "orderId": "DH12323234234",
        "merchantTxnId": "323123221434"
    }
}

Payment result

The bill created with field neo_TokenCreate = true will return the token (neo_PayToken) after payment success via . The token can be used for the next payment.

Reference to .

Last result of the request will be sent via .

IPN
How to create a bill?
Platform Authentication
IPN
Error code
Check registration status at Account information page