Business Account

Business Account Resource

Business Account Object

Example BusinessAccount Object

{
    "id": "3732c2ee-ebb5-466a-9acf-5bc76986b140",
    "accountId": "418b0432-b092-425c-a061-f2486c8efe5c",
    "createTime": "1754547327312",
    "nickname": "InstaPay Wallet",
    "purpose": "",
    "currency": "USD",
    "balanceId": "d72e292f-c762-4d2b-b20a-1157cf818f98",
    "bankAccounts": [
        {
            "status": "ACTIVE",
            "currency": "USD",
            "accountNo": "GB49TCCL12345614818413",
            "accountId": "d37deed7-f0e7-4635-a43a-781af0cb59f0",
            "createTime": "1754475956",
            "bankName": "The Currency Cloud Limited",
            "routingType": "BIC_SWIFT",
            "routingNumber": "TCCLGB3L",
            "bankAddress": {
                "addressLine1": "123 Main St",
                "addressLine2": "Apt 4B",
                "city": "New York",
                "state": "NY",
                "postalCode": "10001",
                "country": "US"
            },
            "accountName": "API TEST"
        }
    ]
}

Business Account Attributes

id string

A UUID for the BusinessAccount.

accountId string

The UUID of the Account.

createTime string

Timestamp.

nickname string

Nickname

currency string

Currency

purpose string

Purpose

balanceId string

bankAccounts array of objects

BankAccounts details BankAccount

Object

Example BankAccount Object

{
    "status": "ACTIVE",
    "currency": "USD",
    "accountNo": "GB49TCCL12345614818413",
    "accountId": "d37deed7-f0e7-4635-a43a-781af0cb59f0",
    "createTime": "1754475956",
    "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

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

Timestamp.

Business Account Transactions Object

Example BusinessAccountTransactions Object

{
    "id": "09469112-d119-4003-b1f9-954b06458690",
    "accountId": "c110126c-cbb2-4306-8977-37c88fb4a47a",
    "currency": "USD",
    "counterparty": "US-USD-3525-Swift",
    "settlementAmount": "200.00",
    "transactionDisplayId": "2507101727000005",
    "fees": [
        {
            "amount": "25.00",
            "currency": "USD",
            "feeType": 0
        }
    ],
    "businessType": "OUTBOUND",
    "businessTypeDetail": "PAYMENT",
    "status": "PENDING",
    "transactionTime": "1752139624544",
    "receiverId": "e9086ad9-363c-47c9-98c9-69a08cb79182",
    "reference": "test",
    "fromBalanceId": "4b7fd05e-b273-4427-8b1c-2d2c7fc2a836",
    "toBalanceId": "4b7fd05e-b273-4427-8b1c-2d2c7fc2a836",
    "clientTransactionId": "22fc8ee2-5afe-4586-b733-17b97ccc870f"
}

Business Account Transactions Attributes

id string

The UUID of the record.

accountId string

The UUID of the Account.

currency string

The transaction currency (e.g. “USD”).

counterparty string

The counterparty identifier or display name involved in the settlement.

settlementAmount string

The total settlement amount.

transactionDisplayId string

The external display identifier for the transaction.

fees array Fee Object

A list of fee details associated with the transaction.

businessType string

Specifies the main category of the business transaction. Possible values include:

Value	Description
OUTBOUND	Outbound transaction — funds flowing out (e.g. payment, transfer out).
INBOUND	Inbound transaction — funds received (e.g. deposit, transfer in).

status string

The transaction status, e.g. CLOSED.

Status	Description
PENDING	The transaction is being processed and is not yet completed.
REFUNDING	The transaction is in the process of being refunded to the payer.
CLOSED	The transaction has been closed and can no longer be processed.
CANCELLED	The transaction was cancelled before completion.
REJECTED	The transaction was rejected and will not be processed.
REQUESTED	The transaction has been requested but not yet processed.
UNKNOWN	The transaction status is unknown or cannot be determined.
PAYMENT_FAILED	The payment attempt failed.
USER_CANCELLED	The transaction was cancelled by the user.
INBOUND_RELATIONSHIP_CONFIRM	Supplementary material approved, inbound relationship confirmed
INBOUND_RELATIONSHIP_CONFIRM_REQUEST	Supplementary material required or rejected

transactionTime string

The timestamp (in milliseconds) when the transaction occurred.

receiverId string

The UUID of the receiver.

reference string

External or internal reference note.

fromBalanceId string

The UUID of the balance from which the transaction originated.

toBalanceId string

The UUID of the destination balance account where the funds are transferred or settled to..

clientTransactionId string

The client-provided transaction identifier.

Legal Entity Object

Example Legal Entity Object

{
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "accountName": "My Business Account",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "message": "Legal entity created successfully",
    "status": "PENDING"
 }

Legal Entity Attributes

id string

The UUID of the record.

accountId string

The UUID of the Account.

accountName string

The account ame.

message string

Legal Entity Message.

status string

PENDING — The application has been submitted and is awaiting processing. PROCESSING — The application is under review or verification. AWAIT_ADDITIONAL — Additional information or documents are required from the applicant. REVIEW_ADDITIONAL — The additional documents submitted are being reviewed. REQUEST — The entity has requested activation or modification. FROZEN — The account or entity has been temporarily frozen due to compliance or risk reasons. FAILED — The onboarding or verification process failed. DELETED — The entity record has been deleted or permanently deactivated. INACTIVE — The entity or account exists but is not yet active. ACTIVE — The entity or account is fully active and operational.

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.