API Overview

Onerway Issuing Merchant API documentation covering card management, cardholder management, transaction queries, and event webhooks.

The Onerway Issuing API enables merchants to create and manage cards, manage cardholders, query transactions, and receive real-time webhook notifications for card operations and transaction events.

API Version: v1.0 | Base Path: /api/v1/merchant | Method: POST
Card Management
Create cards, freeze/unfreeze, and deposit operations
Card Queries
Query operation records, basic info, balance, and sensitive information
Cardholders
Create, update, and query cardholder information
Common
Region/city lists and mobile area codes
Transactions
Transaction record queries
Webhooks
Card operation and transaction event push mechanism with signature verification

Common Specifications

Request Headers

HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json;charset=UTF-8
ApiKeyStringYesMerchant identity key

Response Structure

FieldTypeDescription
respCodeStringResponse code, 20000 indicates success
respMsgStringResponse message
dataObject/ArrayBusiness data, null on failure

Currency

ISO 4217 international standard.

Timezone

All Long type timestamps are in UTC (timezone 0), in seconds.

Response Codes

When the HTTP status code is not 200:

HTTP Status CodeDescription
401 UnauthorizedInvalid API KEY
403 ForbiddenIP whitelist restriction or insufficient API permissions

When the HTTP status code is 200, the business response codes and descriptions are as follows:

CodeDescription
20000Success
40000Param error
80000Internal service error. Please contact ONERWAY
80001Cardholder not found
80002Cardholder email already exists
80003Incorrect cardholder merchant number
80004Merchant status is invalid
80005Merchant no issuing business
80006Merchant account not found
80007Merchant balance not enough
80008The recharge amount exceeds the maximum limit
80009The recharge amount is less than the minimum limit
80010Duplicate data
80011Cardholder card count limit
81000Unauthorized Merchant
81001Business does not exist
40004System exception NoHandlerFoundException
40005System exception HttpRequestMethodNotSupportedException
40013System exception HttpMessageNotReadableException
40015System exception HttpMediaTypeNotSupportedException

Integration Guide

Onerway issuing integration workflow covering preparation, business overview, environment setup, card creation, card transaction queries, and event notifications.

Management

Card operation APIs including card creation, freeze/unfreeze, and deposit.