Just Wallet provides a simple and convenient payout flow via Rest API. It can be integrated in few easy steps, making it the easiest way to start processing bank payouts.

Create a User/Recipient

Just Wallet needs to validate every recipient data, you'll need to pass information such as email, first name, last name, and address. Click here for more details on this. Here is the full list of parameters you can pass:

Parameter Type Required Description
first_name String Yes This is the first_name of your payee.
last_name String Yes This is the last_name of your payee.
email String Yes This is the email address of your payee, must be unique for every recipient.
entityType String Yes Must be INDIVIDUAL OR BUSINESS.
payment_reason String Yes Purpose of remittance.
address Array Yes Contains payee address information.
{
"street":"3422 Old Capitol Trail",
"country":"US",
"state":"DE"
"city":"Wilmington"
"postal_code":"19808"
}		 

{
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "address": {
        "country": "US",
        "street": "3422 Old Capitol Trail",
        "city": "Wilmington",
        "state": "DE",
        "postal_code": "19808"
    },
    "entityType": "INDIVIDUAL",
    "payment_reason": "Salary"
}

Add a Bank account to User/Recipient

Just Wallet needs to validate every recipient data, as this will ensure we don't send payouts to a wrong bank, you'll need to pass correct bank details. Click here for more details on this. Here is the full list of parameters you can pass:

Parameter Type Required Description
routingCodeType String Yes must be any of the options; SWIFT, IFSC, ACH CODE, BSB CODE, SORT CODE, BANK CODE, LOCATION ID,
BRANCH CODE, TRANSIT NUMBER. Routing code type must be swift for EUR, GBP and for countries with the following iso2;
NG, MX, ZA, GH, BF, BJ, CI, SN, NE, TG, CM, GA, CG, GQ, TD, KE
routingCodeValue String Yes Routing code of payee bank.
bankName String Yes Bank name of payee
bankCountry String Yes Bank country of payee, must be in iso2 format
accountNumber String Yes Account Number of payee
accountName String Yes Account Name of payee.
accountType String Yes Type of account, must be either Savings, Checking, Current.

Request


{
        "routingCodeType": "BANK CODE",
        "routingCodeValue": "003",
        "bankName": "ROYAL",
        "bankCountry": "CA",
        "accountNumber": 1234567890,
        "accountName": "John Doe",
        "accountType": "INDIVIDUAL"
}

Response


{
    "message": "Bank added to user",
    "status": "success",
    "data": {
        "id": "17c6aaa7-2d44-468e-a0a5-2899f27a47e2",
        "name": "Royal Bank of Canada",
        "country": "CA",
        "account_number": 1234567890,
        "account_name": "John Doe",
        "routing_type": "BANK CODE",
        "routing_value": "003",
        "created_at": "2024-01-25T01:30:57.000000Z",
    }
}

Create a Quote

Just Wallet can send payouts to multiple recipients. All you need to do is pass all recipient or user ids as an array to create quote endpoint, our sysem will validate every recipient and a quote will be generated with fees grouped into different currencies you are sending to recipients. Click here for more details on this.

Request


{
    "recipients": [
        {
            "id": "5387ee80-1139-4653-8f31-b8ba495920d8",
            "amount": 10000,
            "currency": "CAD"
        },
        {
            "id": "17c6aaa7-2d44-468e-a0a5-2899f27a47e2",
            "amount": 1500,
            "currency": "USD"
        }
    ]
}

Response


{
    "message": {
        "id": "cb1b8c27-6aba-49ee-a0de-b9330bc7a43c",
        "funded": false,
        "quote": [
            {
                "currency": "CAD",
                "amount": "100.00",
                "charge": "1.00",
                "total": "101.00"
            },
            {
                "currency": "USD",
                "amount": "15.00",
                "charge": "5.15",
                "total": "20.15"
            }
        ]
    },
    "status": "success",
    "data": null
}

Fund a Quote

To submit payout request, you need to fund your quote from your account and your Just Wallet Balance will be debited with payout initiated. Click here for more details on this.