Business Transfer

Payment Resources

Payment Object

Example Object
{
    "id": "2e3cbb16-a420-4080-9094-e19f45371fee",
    "code": null,
    "codeMessage": null,
    "accountId": "285fd3d0-d8d1-4b42-91ba-31ca6c100639",
    "amount": "120",
    "transactionDisplayId": "2502241017134475",
    "businessType": "PAYMENT",
    "status": null,
    "payeeId": null,
    "reason": "memo",
    "memo": null,
    "balanceId": "d4d1b32c-6b72-466e-9b30-c595c0095c32",
    "currency": "USD",
    "clientTransactionId": "f2388319-1116-4769-9a41-c60b96ca1e7c",
    "relationId": "",
    "fees": [
        {
            "amount": "25",
            "currency": "USD",
            "feeType": 0
        }
    ]
}
Payment Attributes

id string

Transaction ID


codeMessage string

Code Message


code string

Code


accountId string

Account Id


amount string

Transaction amount


transactionDisplayId string

Transaction ID


businessType string

Business type Possible values: PAYMENT, REFUND, DEPOSIT


status string

Business status Possible values: PENDING, CLOSED, FAIL


payeeId string

Payee ID


reason string

Transaction purpose


memo string

Transaction note/memo


balanceId string

Wallet ID


currency string

Transaction currency


clientTransactionId string

Client-side transaction ID


relationId string

Original transaction ID (used for refunds)


fees array of objects

Fee details Object


Business Transfer Resources

BusinessTransfer Object

Example Object


{
  "clientTransactionId": "348acd00-fce5-4902-a84e-f6d1bdab665a",
  "id": "1966063701651173377",
  "status": "CLOSED",
  "accountTransferType": "NOT_SAME_ACCOUNT",
  "from": {
    "id": "59d7bf52-c021-453a-be79-c7fe972a9832",
    "transferId": "f2c439fc-f772-4aeb-b833-2642cbd2691a",
    "accountId": "a78b8771-5329-4829-88ce-7db14b3b1d0b",
    "amount": "100",
    "currency": "USD",
    "businessType": 0,
    "fees": [
      {
        "feeType": 0,
        "amount": "0",
        "currency": "USD"
      }
    ]
  },
  "to": {
    "id": "57f96493-9bd5-4b0b-b53a-810789ec8736",
    "transferId": "8ea0d261-53d9-42e0-9a76-81c3a412c37f",
    "accountId": "c110126c-cbb2-4306-8977-37c88fb4a47a",
    "amount": "771.16937089",
    "currency": "HKD",
    "businessType": 1
  }
}

Transfer Attributes


clientTransactionId string
Client-side transaction ID, used for idempotency.



id string
Transfer record ID.



status string
Transfer status. Possible values:

  • CLOSED Completed
  • FAILED Failed
  • CANCELED Canceled
  • PROCESSING Processing

accountTransferType string
Transfer type. Possible values:

  • SAME_ACCOUNT Transfer within same account
  • NOT_SAME_ACCOUNT Transfer across different accounts

from object
Source account information. See From Object for details.


to object
Destination account information. See To Object for details.


From Object

id string
Source transfer record ID.


transferId string
Source transfer unique ID.


accountId string
Source account ID.


amount string
Amount to debit.


currency string
Currency of the debit (ISO 4217).


businessType integer
Source business type.


fees array of objects
Fee details. See Fee Object for details.


To Object

id string
Destination transfer record ID.


transferId string
Destination transfer unique ID.


accountId string
Destination account ID.


amount string
Amount to credit.


currency string
Currency of the credit (ISO 4217).


businessType integer
Destination business type.


Fee Objects

Example

{
  "amount": 2,
  "currency": "USD",
  "feeType": 0
}

Attributes

amount string

Magnitude of the amount, in units of the currency, with a . .


currency string

Currency code for the amount.


feeType integer

Specifies the handling fee charged for the transaction.

0 : This field represents the handling fee charged by the platform for processing the transaction. Specifies the handling fee charged for the transaction.