API Reference
GuidesAPI ReferenceChangelogHelp CenterGet API Keys

Accounts

Each card issued has a corresponding account that hold it's funds. Naira accounts can receive funds from other banks via NIP.

Endpoints

MethodUrl
POST /accounts
GET /accounts
GET /accounts/:id
GET /accounts/:id/balance
GET /accounts/:id/transactions
GET /accounts/:id/transactions/export
POST /accounts/transfer

Account Object 

{
    "_id": "61d48b0000dfcdd1184ef93d",
    "business": "61d4140e00c7cdd1184ef455",
    "type": "account",
    "currency": "USD",
    "accountName": "Sudo Settlement Account",
    "accountType": "Current",
    "currentBalance": 540,
    "availableBalance": 540,
    "provider": "Sudo",
    "providerReference": "acc_1641319168742",
    "referenceCode": "acc_1641319168742",
    "isDefault": true,
}

Account Transaction Object 

{
    "_id": "61d48b0e00c7cdd1184ef9e2",
    "business": "61d4150e30c7cdd1184ef455",
    "customer": null,
    "account": {
        "_id": "61d48b0000c7cdd1184ef93d",
        "business": "61d4150b00c7cdd1184ef455",
        "type": "account",
        "currency": "USD",
        "accountName": "Sudo Settlement Account",
        "accountType": "Current",
        "currentBalance": 540,
        "availableBalance": 540,
        "provider": "Sudo",
        "providerReference": "acc_1641319168742",
        "referenceCode": "acc_1641319168742",
        "isDefault": true,
        "isDeleted": false,
        "createdAt": "2022-01-04T17:59:28.742Z",
        "updatedAt": "2022-01-04T17:59:28.742Z",
        "__v": 0
    },
    "paymentReference": "FUND_ACC_1641319182915",
    "type": "Credit",
    "provider": "Sudo",
    "providerChannel": "Internal",
    "amount": 540,
    "runningBalance": 540,
    "narration": "Sudo Simulator Account Funding",
}