Management

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

Create Card

Create a card for a specified cardholder with a designated card product and initial deposit amount.

Item	Details
Endpoint	`POST /api/v1/merchant/card/createCard`

Field	Type	Required	Description
`clientRequestId`	String(64)	✅	Idempotent request ID, must be unique per operation
`cardholderId`	Long	✅	Cardholder ID
`productId`	Long	✅	Card product ID
`amount`	BigDecimal	✅	Initial deposit amount, must be greater than 0, up to 2 decimal places

{
  "clientRequestId": "REQ_20260101_001",
  "cardholderId": 300001,
  "productId": 1,
  "amount": 100.00
}

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "cardId": 100001
  }
}

Perform status operations on a card, such as freeze, unfreeze, or termination.

Item	Details
Endpoint	`POST /api/v1/merchant/card/operate`

Field	Type	Required	Description
`clientRequestId`	String(64)	✅	Idempotent request ID
`cardId`	Long	✅	Card ID
`type`	String(20)	✅	Operation type: `FREEZE` freeze / `UNFREEZE` unfreeze / `TERMINATE` terminate

{
  "clientRequestId": "REQ_20260101_002",
  "cardId": 100001,
  "type": "FREEZE"
}

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "operateRecordId": 200001
  }
}

Deposit a specified amount to a card.

Item	Details
Endpoint	`POST /api/v1/merchant/card/deposit`

Field	Type	Required	Description
`clientRequestId`	String(64)	✅	Idempotent request ID
`cardId`	Long	✅	Card ID
`amount`	BigDecimal	✅	Deposit amount, must be greater than 0, up to 2 decimal places

{
  "clientRequestId": "REQ_20260101_003",
  "cardId": 100001,
  "amount": 50.00
}

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "operateRecordId": 200002
  }
}

Return the card's available balance to the Onerway account.

Item	Details
Endpoint	`POST /api/v1/merchant/card/returnCardBalance`

Field	Type	Required	Description
`clientRequestId`	String(64)	✅	Idempotent request ID
`cardId`	Long	✅	Card ID
`amount`	BigDecimal	✅	Withdrawal amount, must be greater than 0, up to 2 decimal places

{
  "clientRequestId": "REQ_20260101_004",
  "cardId": 100001,
  "amount": 50.00
}

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "operateRecordId": 200003
  }
}

API Overview

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

Queries

Card query APIs including operation records, basic info, balance, and sensitive information.