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
  • Virtual Card
    • API authenPlatform
    • Error Codes
    • Virtual Card Policy Management
      • API Create Card Policy
      • API Get Detail Card Policy
      • API Get List Card Policies
      • API Set Active Card Policy
      • API Update Card Policy
    • Virtual Card Management
      • Virtual Card APIs
        • API Create Virtual Card
        • API Create List Virtual Cards
        • API Get List Virtual Cards
        • API Get Detail Virtual Card
        • API Get Virtual Card Sensitive Data
        • API Set Active Virtual Card
      • Webhook
      • Decrypting Card Data Algorithm
  • Merchant Portal
    • Onboarding
    • Payment Gateway
      • Reconciliation
      • Withdraw
    • Disbursement
      • Reports
    • Collections
      • Reports
      • Withdraw
Powered by GitBook
On this page
  • Request
  • Example cURL

Was this helpful?

  1. Virtual Card
  2. Virtual Card Policy Management

API Set Active Card Policy

Endpoint: PUT /v2/vc/virtual-card-policies/{requestId}/set-active

Description: Set the active status of a specific virtual card policy by its ID.

Request

Request Body Field Descriptions (JSON)

Field Name
Type
Required
Description

isActive

boolean

Yes

Set to true to activate, false to deactivate the policy.

Request sample

{
  "isActive": true
}

Response

Response Field Descriptions

Field Name
Type
Description

code

number

Response code

state

number

State of the response

data.requestId

string

Unique request identifier

data.merchantCode

string

Merchant code

data.name

string

Name of the policy

data.isActive

boolean

Whether the policy is active

data.createdBy

string

Creator's email

data.createdAt

string

Creation timestamp (ISO 8601)

data.updatedAt

string

Last update timestamp (ISO 8601)

message

string

Response message

neoResponseId

string

Unique Neo response identifier

Response sample

{
  "code": 1,
  "state": 2,
  "data": {
    "requestId": "e424ae34-5c56-45c8-882e-98c4325981d3",
    "merchantCode": "COLRLC",
    "name": "Synchronised reciprocal open architecture",
    "isActive": true,
    "createdBy": "sony@gmail.com",
    "createdAt": "2025-06-04T09:34:25.959Z",
    "updatedAt": "2025-06-05T01:58:03.365Z"
  },
  "message": "Successful",
  "neoResponseId": "48589ad9-009b-4ac9-af10-d7680ea83ca6"
}

Example cURL

curl -X PUT "https://{base_url_openapi}/v2/vc/virtual-card-policies/{requestId}/set-active" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "Content-Type: application/json" \
  -H "Accept-Language: en" \
  -d '{
    "isActive": true
  }'

Notes

  • Requires Bearer token in the Authorization header.

  • The Accept-Language header can be used to specify the response language (Support: "vi", "en").

  • Replace {requestId} with the actual policy request ID.

PreviousAPI Get List Card PoliciesNextAPI Update Card Policy

Last updated 15 days ago

Was this helpful?