Interlace API Resources
List of resources used by Interlace APIs.
Core Resource
Account Object
Example Account Object
{
"id": "cae9efe2-b577-4632-8c57-8822ddb8542a",
"type": "SubAccount",
"status": "Active",
"name": "wangwu0213",
"displayId": "251759",
"kycStatus": "Na",
"cardKybStatus": "Passed",
"createTime": "2023-03-06T07:51:59.391Z"
}
Account Attributes
id string
A UUID for the account.
type string
The type of account object. Possible values: SubAccount, MasterAccount.
status string
The status of account object. Possible values: Active, Frozen, Inactive.
name string
Account name
displayId string
The unique ID assigned
kycStatus string
The kycStatus of account object. Possible values: Pending, Request, Passed, Canceled, Na.
cardKybStatus string
The cardKybStatus of account object. Possible values: Pending, Request, Passed, Canceled, Na.
message string
KYC rejected the reason.
createTime string
ISO-8601 UTC date/time format.
User Object
Example User Object
{
"id": "7d09c531-dd0b-4027-aa65-4e6f63416fae",
"createTime": "2023-03-07T07:09:45.949Z",
"status": "Active",
"phone": "+8619923338445",
"email": null,
"name": "Macey.Mosciski科技有限公司"
}
User Attributes
id string
A UUID for the account.
status string
The status of account object. Possible values: Active, Frozen, Inactive.
phone string
User's phone number
email string
User's email
name string
User's name
createTime string
ISO-8601 UTC date/time format.
FaceAuthentication Object
Example FaceAuthentication Object
{
"accountId": "38bd10c0-ac62-4bd3-93cc-b189e260d31d",
"status": "Na",
"reason": ""
}
FaceAuthentication Attributes
accountId string
The UUID of the Account.
status string
The status of transfer object. Possible values: Na, Pending, Success, Fail.
reason string
Cause of face authentication failure
Transfer Object
Example Transfer Object
{
"id": "c32e92cb-49fe-4f2c-9598-492d31ea3b19",
"accountId": "d37deed7-f0e7-4635-a43a-781af0cb59f0",
"source": {
"type": "crypto_assets",
"currency": "USDC"
},
"destination": {
"type": "master_account"
},
"amount": {
"amount": "30",
"currency": "USDC"
},
"fee": {
"amount": "0.6",
"currency": "USD"
},
"status": "Closed",
"createTime": "2023-03-01T08:23:03.096Z",
"updateTime": "2023-03-01T08:23:05.033Z"
}
Transfer Attributes
id string
A UUID for the transfer.
accountId string
The UUID of the Account.
source object
A Source object representing the source of the transfer.
destination object
A Destination object representing the destination of the transfer.
amount object
A Money object representing the amount transferred between source and destination.
fee object
A Money object representing fee associated with this payment.
status string
The status of transfer object. Possible values: Pending, Closed, Fail.
createTime string
ISO-8601 UTC date/time format.
updateTime string
ISO-8601 UTC date/time format.
Balance Object
Example Balance Object
{
"id": "5abd4512-073f-43a0-a6e9-8378464f4e2f",
"accountId": "c110e2aa-322b-4f3f-a795-f441955844ed",
"available": 100,
"pending": 50,
"frozen": 0,
"currency": "USD",
"createTime": "2021-07-14T09:27:39.174Z",
"walletType": "Card"
}
Balance Attributes
id string
A UUID for the balance.
accountId string
The UUID of the Account.
available double
Available balance
frozen double
Frozen balance
walletType string
The walletType of balance object. Possible values: Card, Budget, QuantumAccount, GlobalAccount, CryptoAsset.
createTime string
ISO-8601 UTC date/time format.
Infinity Card Resources
Budget Object
Example Budget Object
{
"id": "08971715-b7b4-4916-ad98-c1719ea2035f",
"accountId": "88c5610d-2bb3-4a8e-a506-9e00f69bae37",
"name": "Kole.Little",
"balanceId": "46ed0562-48d9-4460-b534-b3c35e96bedc",
"expiryDate": "2099-12-31T15:59:59.000Z",
"status": "Active",
"createTime": "2022-01-18T03:08:56.779Z"
}
Budget Attributes
id string
A UUID for the Budget.
accountId string
The UUID of the Account.
name string
Budget name
balanceId string
The UUID of the Balance.
expiryDate string
ISO-8601 UTC date/time format.
status string
The status of budget object. Possible values: Active, Frozen, Inactive.
createTime string
ISO-8601 UTC date/time format.
Card Object
Example Card Object
{
"id": "ce04331f-d2f3-42de-8d65-f66c69aa3888",
"accountId": "e8b0d02e-5f70-4baa-b824-b4f87e34716d",
"token": "3d9bbdf1-3c93-4fbe-80bc-a3bfe25bd6ce",
"status": "Inactive",
"currency": "USD",
"provider": "PrepaidCard_493193",
"userName": "as aa",
"createTime": "2021-08-30T11:59:32.935Z",
"cardNoLastFour": "9990",
"cardAddress": null,
"label": "默认",
"balanceId": "7eddcfcc-f6a3-4875-8aab-2c7a0f639023"
}
Card Attributes
id string
A UUID for the Card.
accountId string
The UUID of the Account.
balanceId string
The UUID of the Balance
budgetId string
The UUID of the Budget
token string
The three-party unique identification id of the card
currencystring
Currency code
provider string
Card provider
userName string
Card holder
cardNoLastFour string
Last four digits of the card number
label string
Custom label
createTime string
ISO-8601 UTC date/time format.
CardTransaction Object
Example CardTransaction Object
{
"id": "302b17cf-b56a-4f86-bc7f-32ae6dd71550",
"accountId": "2040791b-9132-4621-86a7-3e5476db9dab",
"cardId": "de61fa0f-c6b2-4dfe-b411-873fd43fbd51",
"currency": "USD",
"amount": 10,
"fee": 0,
"type": "TransferIn",
"clientTransactionId": "595f83f6-9b28-464d-be77-e9e7319d2951",
"status": "Closed",
"transactionTime": "2021-10-28T11:07:31.019Z"
}
CardTransaction Attributes
id string
A UUID for the CardTransaction.
accountId string
The UUID of the Account.
cardId string
The UUID of the Card
currencystring
Currency code
amount double
Transaction amount
fee double
Transaction fee
type string
The type of CardTransaction object. Possible values: Consumption, TransferIn, TransferOut, Credit, Reversal, Frozen, UnFrozen.
clientTransactionId string
Custom transaction id
status string
The status of CardTransaction object. Possible values: Pending, Closed, Fail.
transactionTime string
ISO-8601 UTC date/time format.
BudgetTransaction Object
Example BudgetTransaction Object
{
"id": "b4e61edc-63d0-44b9-9251-d1b10fcfb4bb",
"accountId": "88c5610d-2bb3-4a8e-a506-9e00f69bae37",
"budgetId": "00f0012e-ce96-4135-8cf8-e6eb51463040",
"cardId": null,
"amount": 0.11,
"fee": 0,
"type": "TransferIn",
"clientTransactionId": "5dce475f-4950-4961-9977-0dad80d318e4",
"status": "Closed",
"transactionTime": "2022-01-19T08:44:38.599Z"
}
BudgetTransaction Attributes
id string
A UUID for the BudgetTransaction.
accountId string
The UUID of the Account.
budgetId string
The UUID of the Budget.
cardId string
The UUID of the Card
currencystring
Currency code
amount double
Transaction amount
fee double
Transaction fee
type string
The type of CardTransaction object. Possible values: Consumption, TransferIn, TransferOut, Credit, Reversal, CreateCardFee.
clientTransactionId string
Custom transaction id
status string
The status of CardTransaction object. Possible values: Pending, Closed, Fail.
transactionTime string
ISO-8601 UTC date/time format.
Global Account Resource
BankAccount Object
Example BankAccount Object
{
"id": "f3f1855d-0942-4e9c-bbf8-e97db721103e",
"status": "Active",
"currency": "USD",
"accountNo": "GB49TCCL12345614818413",
"accountId": "d37deed7-f0e7-4635-a43a-781af0cb59f0",
"createTime": "2023-02-24T03:29:42.241Z",
"bankName": "The Currency Cloud Limited",
"routingType": "BIC_SWIFT",
"routingNumber": "TCCLGB3L",
"bankAddress": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
"accountName": "API TEST"
}
BankAccount Attributes
id string
A UUID for the BankAccount.
accountId string
The UUID of the Account.
accountName string
Name of account holder
accountNo string
Account number
currency string
Currency
bankName string
Bank name
bankAddress string
Bank address
swift string
SWIFT/BIC
routingNumber string
Routing number
routingType string
Routing type
branchName string
Branch name
branchCode string
Branch code
status string
The status of BankAccount object. Possible values: Active, Frozen, Inactive.
createTime string
ISO-8601 UTC date/time format.
GlobalAccountTransaction Object
Example Object
{
"id": "2e3cbb16-a420-4080-9094-e19f45371fee",
"code": null,
"codeMessage": null,
"accountId": "285fd3d0-d8d1-4b42-91ba-31ca6c100639",
"counterparty": "USD-US-25-Swift",
"amount": "120",
"transactionDisplayId": "2502241017134475",
"businessType": "PAYMENT",
"status": null,
"payeeId": null,
"reference": "memo",
"memo": null,
"balanceId": "d4d1b32c-6b72-466e-9b30-c595c0095c32",
"currency": "USD",
"clientTransactionId": "f2388319-1116-4769-9a41-c60b96ca1e7c",
"relationId": "",
"fees": [
{
"amount": 25,
"currency": "USD",
"feeType": "HANDLING"
}
]
}
GlobalAccountTransaction Attributes
id string
Transaction ID
messageCode string
Message code
code string
Code
accountId string
Account Id
counterparty string
Counterparty currency
amount double
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
reference 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 string
Fee details Object
Crypto Asset Resources
Deposit And Withdrawal Objects
Example Deposit And Withdrawal Object
{
"id": "8ea4d70d-6c49-43fd-ba0d-cd0b66aed212",
"createTime": "2022-09-21T08:03:45.000Z",
"updateTime": "2022-09-21T08:03:45.000Z",
"accountId": "0a059b05-d63c-4782-b981-836ea9e6beb9",
"balanceId": "2fab8c69-81e9-4752-9cad-9769463f42bf",
"chain": "AVAX",
"currency": "USDC",
"amount": "1.0",
"fee": "0",
"to": "0x35c183dac2a7c58bba78a500a18571cda0a9daa4",
"status": "Closed",
"transactionHash": "0xeacc3d50de29d22209fc0c94a6fc8e09e24e473a4cbfee4830f0d495275e7b8e"
}
Deposit And Withdrawal Attributes
id string
A UUID.
accountId string
The UUID of the Account.
balanceId string
The UUID of the Balance.
chain string
API Chain Code
currency string
API Currency Code
amount string
Deposit or Withdrawal the amount
fee string
Deposit or Withdrawal the fee
to string
Arrival address.
status string
The status of Deposit And Withdrawal object. Possible values: Pending, Closed, Fail.
transactionHash string
A hash that uniquely identifies an on-chain transaction.
updateTime string
ISO-8601 UTC date/time format.
createTime string
ISO-8601 UTC date/time format.
Nested Resources
Source and Destination Objects
transfers reference source and destination objects, which as the names suggest, tell you where the funds are coming from and where they're going.
Sources and destinations can have the following types:
quantum_accountfor transfers to/from quantum accountquantum_sub_accountfor transfers to/from SubAccount quantum accountcrypto_assetsfor transfers to/from crypto asset account
// quantum_account
{
"type": "quantum_account"
}
// quantum_sub_account
// The "id" represents the UUID of the Account object.
{
"type": "quantum_sub_account",
"id": "4c888d1b-21cf-4e59-8e81-449f16f9a79e"
}
// crypto_assets
// The "currency" Represents the currency of the crypto asset.
{
"type": "crypto_assets",
"currency": "USDC"
}
Money Object
Monetary amounts across our APIs are represented as Money objects, which consist of an amount and a currency. The only supported currency at the moment is USD, and the amount is denominated in dollars as a string with fractional cents. In the example below, the amount being represented is $3.14.
{
"amount": "3.14",
"currency": "USD"
}
Payment
Payment
Example
{
"clientTransactionId": "27085007-8f33-4d1b-b775-71452008eeca",
"businessId": "1e661454-82e5-4e75-876a-b909cb3e4df9",
"businessType": "GLOBAL_ACCOUNT",
"balanceId": "d644d1ee-4dc0-42f2-8f01-3e142a06d4bc",
"payeeId": "1892884241312153602",
"fromAmount": 2000,
"fromCurrency": "USD",
"toAmount": 267.92,
"toCurrency": "USD",
"status": "CLOSED",
"message": "Success",
"createTime": 1739155110365,
"fees": {
"amount": 2,
"currency": "USD",
"feeType": "HANDLING"
}
}
Attribute
clientTransactionId string
This is the unique identifier for the transaction from the merchant's perspective.
businessId string
Business ID: Depending on the payment type, this field returns the corresponding business ID.
If the payment type is Global Account Payment, this will return the global account ID.
If the payment type is Crypto Asset Payment, this will return the crypto asset ID.
businessType string
The businessType field is used to indicate the type of payment. The value of this field can be one of the following:
GlobalAccountPayment: Represents a global account payment type.
CryptoAssetPayment: Represents a crypto asset payment type.
balanceId string
This is the unique identifier for the wallet involved in the transaction.
payeeId string
This is the unique identifier for the beneficiary (recipient) of the payment.
fromCurrency string
The currency from which the payment is being made.
fromAmount double
The amount of the payment in the source currency.
toCurrency string
The currency in which the payment is being made.
toAmount double
The amount of the payment in the payment currency.
status string
The status of the transaction. Possible values are:
PENDING: The transaction is pending.
CLOSED: The transaction is completed.
FAIL: The transaction has failed.
message string
Additional information or details about the transaction (e.g., error messages or status descriptions).
createTime long
The timestamp (in milliseconds) when the transaction was created.
fees string
This field contains details about the fees associated with the transaction. Refer to the Fee Resource for more information.
Refund Example
{
"clientTransactionId": "27085007-8f33-4d1b-b775-71452008eeca",
"businessId": "1e661454-82e5-4e75-876a-b909cb3e4df9",
"businessType": "GLOBAL_ACCOUNT",
"balanceId": "d644d1ee-4dc0-42f2-8f01-3e142a06d4bc",
"payeeId": "1892884241312153602",
"fromAmount": 2000,
"fromCurrency": "USD",
"toAmount": 267.92,
"toCurrency": "USD",
"status": "CLOSED",
"message": "Success",
"refund": {
"amount": "239.92",
"currency": "USD"
},
"createTime": 1739155110365,
"fees": {
"amount": 2,
"currency": "USD",
"feeType": "HANDLING"
}
}
Field Descriptions
clientTransactionId string
This is the unique identifier for the transaction from the merchant's perspective.
businessId string
Business ID: Depending on the payment type, this field returns the corresponding business ID.
If the payment type is Global Account Payment, this will return the global account ID.
If the payment type is Crypto Asset Payment, this will return the crypto asset ID.
businessType string
The businessType field is used to indicate the type of payment. The value of this field can be one of the following:
GlobalAccountPayment: Represents a global account payment type.
CryptoAssetPayment: Represents a crypto asset payment type.
balanceId string
This is the unique identifier for the wallet involved in the transaction.
payeeId string
This is the unique identifier for the beneficiary (recipient) of the payment.
fromCurrency string
The currency from which the payment is being made.
fromAmount double
The amount of the payment in the source currency.
toCurrency string
The currency in which the payment is being made.
toAmount double
The amount of the payment in the payment currency.
status string
The status of the transaction. Possible values are:
PENDING: The transaction is pending.
CLOSED: The transaction is completed.
FAIL: The transaction has failed.
message string
Additional information or details about the transaction (e.g., error messages or status descriptions).
refund
Refund info Refund Info
createTime long
The timestamp (in milliseconds) when the transaction was created.
fees string
This field contains details about the fees associated with the transaction. Refer to the Fee Resource for more information.
Refund Object
Example
{
"refundAmount": 2,
"refundCurrency": "USD"
}
Field Descriptions
refundAmount double
The amount of money to be refunded.
refundCurrency double
The currency in which the refund is being processed.种
Fee Resources
Fee Objects
Example
{
"amount": 2,
"currency": "USD",
"feeType": "HANDLING"
}
Attributes
amount string
Magnitude of the amount, in units of the currency, with a . .
currency string
Currency code for the amount.
feeType string
Specifies the handling fee charged for the transaction. HANDLING This field represents the handling fee charged by the platform for processing the transaction. Specifies the handling fee charged for the transaction.
Payin
Acquiring
Example
{
"tradeNo": "202502241827138193879602322",
"merchantTradeNo": "aaa64a7c49b-703f-44c9-a4ae-f1e0bd3f4e7c",
"currency": "USD",
"amount": "28.11",
"status": "PAID",
"transactionType": "PAYMENT",
"createTime": "1740392833835",
"completeTime": "1740394320039",
"channelId": "100003",
"merchantCustomerId": "testa577fb5c-cfa7-4c25-8a9b-5dd403b0f800",
"subMerchantId": "1772818881448554498",
"description": "description"
}
Attribute
tradeNo string
This is the unique identifier for the transaction from interlace's perspective.
merchantTradeNo string
This is the unique identifier for the transaction from the merchant's perspective.
currency string
Order currency
amount string
Order amount in string format.up to 2 decimal places
status string
order status
PENDING: Order Creation in Progress,
READY: Waiting for Customer Payment,
PAID: Order Paid,
FAILED: Order Failed,
CANCELED: Order Canceled by Customer,
REFUNDING: Order Refunding,
REFUNDED: Order Refunded,
CANCELING: Order Canceling,
AUTHORIZED: Order Authorized,
REVOKING: Order Revoking,
REVOKED: Order Revoked,
SENT_CAPTURE: Payment Capture Requested,
CAPTURED: Payment Captured,
CLOSED: Order Closed (Typically due to Expiration)
transactionType string
Order types;
PAYMENT - for making a payment
REFUND - for requesting a refund
createTime string
Order creation time
completeTime string
Order completion time.
channelId string
Actually, it's the payment method ID
merchantCustomerId string
Merchant terminal customer ID
subMerchantId string
Sub-merchant ID
description string
The information transmitted by the merchant will be returned as it is
Updated 3 days ago