🏦Bank Payouts

Transfer directly to bank account using our payouts APIs

Introduction

The amount collected in your Lazerpay account from all the incoming transactions can also be withdrawn directly to your bank account. In order to make bank payouts, you can use our payouts API endpoint or our official NodeJS SDK

Currently, only some banks and currencies are supported. To list all the countries, banks, and supported currencies, use our get APIs listed below.

Currently we only support USDTs for bank payouts, if you have any other token in your account use our SWAP API to first convert it to USDT before initiating a bank payout.

Create Bank Payout

Add a new bank account to receive payouts

POST https://api.lazerpay.engineering/api/v1/bank/payouts

Request Body

NameTypeDescription

bank_name*

String

Name of the bank, you can use Get Banks API to list all the supported banks

bank_code*

String

Bank code

account_name*

String

Account holder name of the account where you want payout

account_number*

String

Account holder number of the account where you want payout

currency*

String

Currency of Payout, use get supported currencies API to list supported currency

country*

String

Country where bank is located, use Get Supported Countries API to list all the supported nations

default

boolean

{
    // Response
}

Sample Request payload for different currencies

// USD Payload
{
    "bank_name": "bank name",
    "account_name": "account name",
    "account_number": "account number",
    "currency": "USD",
    "country": "united states",
    "account_type": "personal",
    "routing_number": "routing number",
    "city": "city",
    "state": "state",
    "address": "address",
    "postal_code": "postal code"
}

// NGN Payload
{
    "bank_name": "bank name",
    "bank_code": "bank code",
    "account_name": "account name",
    "account_number": "account number",
    "currency": "NGN",
    "country": "nigeria",
    "state": "state"
}

// GHS Payload
{
    "bank_name": "bank name",
    "bank_code": "bank code",
    "account_name": "account name",
    "account_number": "account number",
    "currency": "GHS",
    "address": "address",
    "country": "ghana",
    "street": "Street",
    "city": "city",
    "postal_code": "postal code"
}

Get all Bank Payouts

Retrieve all the bank payouts associated with your account as Payout IDs

GET https://api.lazerpay.engineering/api/v1/bank/payouts

{
    "message": "Bank Payouts retrieved successfully",
    "status": "success",
    "statusCode": 200,
    "data": [
        {
            "id": "b406677c-c028-475f-b029-XXXXXXXXX",
            "bankName": "kuda bank",
            "bankCode": "XXXXX",
            "accountName": "XXXX XXXX",
            "accountNumber": "XXXXXX",
            "accountType": null,
            "routingNumber": null,
            "currency": "NGN",
            "country": "nigeria",
            "state": null,
            "city": null,
            "address": null,
            "street": null,
            "postalCode": null,
            "network": "testnet",
            "status": "approved",
            "default": true,
            "deleted": false,
            "createdAt": "2022-08-31T20:55:01.801Z",
            "updatedAt": "2022-08-31T20:55:01.801Z",
            "deletedAt": null
        }
    ],
    "count": 1,
    "currentPage": 1,
    "nextPage": null,
    "prevPage": null,
    "lastPage": 1
}

Example: NodeJS - Request

var request = require('request');

var options = {
  'method': 'POST',
  'url': 'https://api.lazerpay.engineering/api/v1/bank/payouts',
  'headers': {
  },
  body: '{\n    "bank_name": "Kuda Bank",\n    "bank_code": "090267",\n    "account_name": "suleiman abdulfatai",\n    "account_number": "2001670835",\n    "currency": "NGN",\n    "country": "Nigeria",\n    "default": true\n}'

};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example: cURL

curl --location --request GET 'https://api.lazerpay.engineering/api/v1/bank/payouts'

Get Bank Payout By Id

This is to get Bank payout by id

GET https://api.lazerpay.engineering/api/v1/bank/payouts/:id

Path Parameters

NameTypeDescription

String

Bank payout id you want to retrieve

{
    // Response
}

Delete Bank Payout

Delete one or more existing bank payout using payout ids

DELETE https://api.lazerpay.engineering/api/v1/bank/payouts

Delete one or multiple Bank Payouts by passing Payout Ids as string array to payout end-point

Request Body

NameTypeDescription

ids*

String Array

example : { "ids": ["b406677c-c028-475f-b029-0df0d39c9321"] }

{
    "status": "success",
    "message": "Bank Payout deleted successfully",
    "statusCode": 200
}

Update Bank Payout

Update an existing bank payout associated with your account

PATCH https://api.lazerpay.engineering/api/v1/bank/payouts/<bank_payout_id>

{
    "status": "success",
    "message": "Bank Payout updated successfully",
    "data": {
        "id": "2e7fa635-b495-4788-a4ac-XXXXXX",
        "bankName": "kuda bank",
        "bankCode": "XXXX",
        "accountName": "XXXX XXXX",
        "accountNumber": "XXXXX",
        "accountType": null,
        "routingNumber": null,
        "currency": "NGN",
        "country": "nigeria",
        "state": null,
        "city": null,
        "address": null,
        "street": null,
        "postalCode": null,
        "network": "mainnet",
        "status": "approved",
        "default": true,
        "deleted": false,
        "createdAt": "2022-08-29T17:59:43.449Z",
        "updatedAt": "2022-08-31T21:21:54.900Z",
        "deletedAt": null
    },
    "statusCode": 200
}

Get Supported Payout Countries

Get a list of all the supported countries that supports bank payouts and respective currencies

GET https://api.lazerpay.engineering/api/v1/bank/payouts/countries

Get list of already supported countries that supports bank payouts

{
    "message": "Bank Payout Countries retrieved successfully",
    "data": [
        {
            "id": "3fc390d2-95be-4e66-a825-ef31164a5b12",
            "name": "United States",
            "code": "US",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/usd-logo_jelgoj.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.211Z",
            "updatedAt": "2022-08-24T18:40:29.211Z",
            "currencies": [
                {
                    "id": "df389189-0ff2-4189-b5b1-0f0127009dd7",
                    "name": "United States Dollar",
                    "code": "USD",
                    "symbol": "$",
                    "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/usd-logo_jelgoj.svg",
                    "network": "testnet",
                    "status": "active",
                    "createdAt": "2022-08-24T18:40:29.264Z",
                    "updatedAt": "2022-08-24T18:40:29.264Z"
                }
            ]
        },
        {
            "id": "477a477c-30e7-485a-9cc3-5ae54f4e492d",
            "name": "Nigeria",
            "code": "NG",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/ngn-logo_tazf8g.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.213Z",
            "updatedAt": "2022-08-24T18:40:29.213Z",
            "currencies": [
                {
                    "id": "2581c366-5a31-4250-9fee-ee078c8712e2",
                    "name": "Nigierian Naira",
                    "code": "NGN",
                    "symbol": "₦",
                    "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/ngn-logo_tazf8g.svg",
                    "network": "testnet",
                    "status": "active",
                    "createdAt": "2022-08-24T18:40:29.282Z",
                    "updatedAt": "2022-08-24T18:40:29.282Z"
                }
            ]
        },
        {
            "id": "63b1004e-0dc9-45b9-8525-499cbbd15854",
            "name": "Kenya",
            "code": "KE",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/kes.logo_gnkj7t.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.215Z",
            "updatedAt": "2022-08-24T18:40:29.215Z",
            "currencies": [
                {
                    "id": "dba6414c-60c1-4df4-a350-e32b2ae19602",
                    "name": "Kenyan Shilling",
                    "code": "KES",
                    "symbol": "Ksh",
                    "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/kes.logo_gnkj7t.svg",
                    "network": "testnet",
                    "status": "active",
                    "createdAt": "2022-08-24T18:40:29.285Z",
                    "updatedAt": "2022-08-24T18:40:29.285Z"
                }
            ]
        },
        {
            "id": "70c5ef66-8c39-4ceb-a6b7-862e6dfa8632",
            "name": "Ghana",
            "code": "GH",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832484/Countries%20Logo/ghs-logo_exdieo.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.235Z",
            "updatedAt": "2022-08-24T18:40:29.235Z",
            "currencies": [
                {
                    "id": "d4c38b3a-efa0-475d-96a7-ac905f4583a1",
                    "name": "Ghanaian Cedi",
                    "code": "GHS",
                    "symbol": "GH₵",
                    "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832484/Countries%20Logo/ghs-logo_exdieo.svg",
                    "network": "testnet",
                    "status": "active",
                    "createdAt": "2022-08-24T18:40:29.286Z",
                    "updatedAt": "2022-08-24T18:40:29.286Z"
                }
            ]
        },
        {
            "id": "c4aca94b-274a-4617-a3a1-ef07e22cd754",
            "name": "India",
            "code": "IN",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832840/Countries%20Logo/inr-logo_iohchm.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.237Z",
            "updatedAt": "2022-08-24T18:40:29.237Z",
            "currencies": [
                {
                    "id": "9e89e682-7abb-4670-bae5-04e62fddf0b6",
                    "name": "United States Dollar",
                    "code": "USD",
                    "symbol": "$",
                    "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/usd-logo_jelgoj.svg",
                    "network": "mainnet",
                    "status": "active",
                    "createdAt": "2022-08-24T18:40:29.248Z",
                    "updatedAt": "2022-08-24T18:40:29.248Z"
                }
            ]
        },
        {
            "id": "2b2266d9-cbfb-47f3-9150-ec96a4c54d71",
            "name": "United Kingdom",
            "code": "GB",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832840/Countries%20Logo/uk-logo_msrcza.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.239Z",
            "updatedAt": "2022-08-24T18:40:29.239Z",
            "currencies": [
                {
                    "id": "9e89e682-7abb-4670-bae5-04e62fddf0b6",
                    "name": "United States Dollar",
                    "code": "USD",
                    "symbol": "$",
                    "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/usd-logo_jelgoj.svg",
                    "network": "mainnet",
                    "status": "active",
                    "createdAt": "2022-08-24T18:40:29.248Z",
                    "updatedAt": "2022-08-24T18:40:29.248Z"
                }
            ]
        },
        {
            "id": "b37a936a-af8c-4087-b4ad-e36f650051bd",
            "name": "China",
            "code": "CN",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832840/Countries%20Logo/cny.static.b5710fca4cc33e583970ae4944a552f1_wjzbri.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.241Z",
            "updatedAt": "2022-08-24T18:40:29.241Z",
            "currencies": [
                {
                    "id": "9e89e682-7abb-4670-bae5-04e62fddf0b6",
                    "name": "United States Dollar",
                    "code": "USD",
                    "symbol": "$",
                    "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/usd-logo_jelgoj.svg",
                    "network": "mainnet",
                    "status": "active",
                    "createdAt": "2022-08-24T18:40:29.248Z",
                    "updatedAt": "2022-08-24T18:40:29.248Z"
                }
            ]
        },
        {
            "id": "159b5320-147d-4371-8388-2ef96698ecbb",
            "name": "United Arab Emirates",
            "code": "UAE",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1659516032/Countries%20Logo/aed.static.93a2e850c3b1ada8d436ede89073d8ac_v4odwo.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.243Z",
            "updatedAt": "2022-08-24T18:40:29.243Z",
            "currencies": [
                {
                    "id": "9e89e682-7abb-4670-bae5-04e62fddf0b6",
                    "name": "United States Dollar",
                    "code": "USD",
                    "symbol": "$",
                    "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/usd-logo_jelgoj.svg",
                    "network": "mainnet",
                    "status": "active",
                    "createdAt": "2022-08-24T18:40:29.248Z",
                    "updatedAt": "2022-08-24T18:40:29.248Z"
                }
            ]
        },
        {
            "id": "fc42a3ed-0e19-46c4-8041-257dc2e0d7e5",
            "name": "Ugandan",
            "code": "UG",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1660211804/Countries%20Logo/ugx.static.f92faf2ecc0220912b33175d69b6dabb_chj98b.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.245Z",
            "updatedAt": "2022-08-24T18:40:29.245Z",
            "currencies": [
                {
                    "id": "88c3baed-26dd-4f76-9e57-40dbb01d5e45",
                    "name": "Ugandan Shilling",
                    "code": "UGX",
                    "symbol": "USh",
                    "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1660211804/Countries%20Logo/ugx.static.f92faf2ecc0220912b33175d69b6dabb_chj98b.svg",
                    "network": "testnet",
                    "status": "active",
                    "createdAt": "2022-08-24T18:40:29.289Z",
                    "updatedAt": "2022-08-24T18:40:29.289Z"
                }
            ]
        }
    ],
    "statusCode": 200,
    "status": "success"
}

Get Supported Payout Currencies

Get a list of all the supported currencies for bank payouts

GET https://api.lazerpay.engineering/api/v1/bank/payouts/currencies

{
    "message": "Bank Payout Currencies retrieved successfully",
    "data": [
        {
            "id": "df389189-0ff2-4189-b5b1-0f0127009dd7",
            "name": "United States Dollar",
            "code": "USD",
            "symbol": "$",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/usd-logo_jelgoj.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.264Z",
            "updatedAt": "2022-08-24T18:40:29.264Z"
        },
        {
            "id": "2581c366-5a31-4250-9fee-ee078c8712e2",
            "name": "Nigierian Naira",
            "code": "NGN",
            "symbol": "₦",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/ngn-logo_tazf8g.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.282Z",
            "updatedAt": "2022-08-24T18:40:29.282Z"
        },
        {
            "id": "dba6414c-60c1-4df4-a350-e32b2ae19602",
            "name": "Kenyan Shilling",
            "code": "KES",
            "symbol": "Ksh",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832428/Countries%20Logo/kes.logo_gnkj7t.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.285Z",
            "updatedAt": "2022-08-24T18:40:29.285Z"
        },
        {
            "id": "d4c38b3a-efa0-475d-96a7-ac905f4583a1",
            "name": "Ghanaian Cedi",
            "code": "GHS",
            "symbol": "GH₵",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1655832484/Countries%20Logo/ghs-logo_exdieo.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.286Z",
            "updatedAt": "2022-08-24T18:40:29.286Z"
        },
        {
            "id": "33119d59-d169-46a1-a075-e92e8f59a803",
            "name": "United Arab Emirates Dirham",
            "code": "AED",
            "symbol": "د.إ",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1659516032/Countries%20Logo/aed.static.93a2e850c3b1ada8d436ede89073d8ac_v4odwo.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.288Z",
            "updatedAt": "2022-08-24T18:40:29.288Z"
        },
        {
            "id": "88c3baed-26dd-4f76-9e57-40dbb01d5e45",
            "name": "Ugandan Shilling",
            "code": "UGX",
            "symbol": "USh",
            "logoUrl": "https://res.cloudinary.com/lazer/image/upload/v1660211804/Countries%20Logo/ugx.static.f92faf2ecc0220912b33175d69b6dabb_chj98b.svg",
            "network": "testnet",
            "status": "active",
            "createdAt": "2022-08-24T18:40:29.289Z",
            "updatedAt": "2022-08-24T18:40:29.289Z"
        }
    ],
    "statusCode": 200,
    "status": "success"
}

Get Banks

Get a list of supported banks in a country

GET https://api.lazerpay.engineering/api/v1/bank?country=<supported_country_name>

Path Parameters

NameTypeDescription

country*

String

Supported Countries: nigeria, ghana, kenya

{
    "status": "success",
    "message": "Banks retrieved successfully",
    "data": [
        {
            "name": "UNION BANK OF NIGERIA PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:15:26.521Z",
            "updated_at": "2022-02-01T20:33:24.109Z",
            "code": "000032"
        },
        {
            "name": "GTBANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:14:06.161Z",
            "updated_at": "2022-02-01T20:31:06.214Z",
            "code": "000058"
        },
        {
            "name": "WEMA BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:15:54.494Z",
            "updated_at": "2022-02-01T20:34:08.022Z",
            "code": "000035"
        },
        {
            "name": "STANDARD CHARTERED BANK NIGERIA LIMITED",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:15:11.196Z",
            "updated_at": "2022-02-01T20:32:46.123Z",
            "code": "000068"
        },
        {
            "name": "SUNTRUST BANK",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:17:11.339Z",
            "updated_at": "2022-02-01T20:33:11.744Z",
            "code": "000100"
        },
        {
            "name": "KEYSTONE BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:14:38.850Z",
            "updated_at": "2022-02-01T20:31:56.728Z",
            "code": "000082"
        },
        {
            "name": "DIAMOND BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:12:55.132Z",
            "updated_at": "2022-02-01T20:29:58.702Z",
            "code": "000063"
        },
        {
            "name": "CITI BANK",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:16:56.851Z",
            "updated_at": "2022-02-01T20:29:44.245Z",
            "code": "000023"
        },
        {
            "name": "ECOBANK NIGERIA PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T13:41:51.177Z",
            "updated_at": "2022-02-01T20:30:15.799Z",
            "code": "000050"
        },
        {
            "name": "FIDELITY BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:13:32.974Z",
            "updated_at": "2022-02-01T20:30:28.641Z",
            "code": "000070"
        },
        {
            "name": "FIRST BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:13:50.380Z",
            "updated_at": "2022-02-01T20:30:40.783Z",
            "code": "000011"
        },
        {
            "name": "FIRST CITY MONUMENT BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:10:10.889Z",
            "updated_at": "2022-02-01T20:30:53.229Z",
            "code": "000214"
        },
        {
            "name": "HERITAGE BANK",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:14:21.738Z",
            "updated_at": "2022-02-01T20:31:27.608Z",
            "code": "000030"
        },
        {
            "name": "JAIZ BANK",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:11:20.299Z",
            "updated_at": "2022-02-01T20:31:42.997Z",
            "code": "000301"
        },
        {
            "name": "PROVIDUS BANK",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:16:43.898Z",
            "updated_at": "2022-02-01T20:32:07.178Z",
            "code": "000101"
        },
        {
            "name": "STANBIC IBTC BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:10:45.169Z",
            "updated_at": "2022-02-01T20:32:34.261Z",
            "code": "000221"
        },
        {
            "name": "UNITED BANK FOR AFRICA PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:15:40.382Z",
            "updated_at": "2022-02-01T20:33:41.243Z",
            "code": "000033"
        },
        {
            "name": "UNITY BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:10:28.866Z",
            "updated_at": "2022-02-01T20:33:55.308Z",
            "code": "000215"
        },
        {
            "name": "ZENITH BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:16:29.962Z",
            "updated_at": "2022-02-01T20:34:21.155Z",
            "code": "000057"
        },
        {
            "name": "STERLING BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:10:59.499Z",
            "updated_at": "2022-02-01T20:33:01.038Z",
            "code": "000232"
        },
        {
            "name": "SKYE BANK PLC",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:14:56.361Z",
            "updated_at": "2022-02-01T20:32:19.361Z",
            "code": "000076"
        },
        {
            "name": "ASO SAVINGS AND LOANS",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:12:21.114Z",
            "updated_at": "2022-02-01T20:29:32.090Z",
            "code": "000401"
        },
        {
            "name": "ACCESS BANK NIGERIA",
            "country": "Nigeria",
            "created_at": "2021-12-05T16:12:38.829Z",
            "updated_at": "2022-02-01T20:29:19.631Z",
            "code": "000044"
        }
    ],
    "statusCode": 200
}

Get a Payout Exchange Rate

Get current Exchange rates

GET https://api.lazerpay.engineering/api/v1/bank/payouts/rate?coin={coin_name}&currency={supported_currency}

Path Parameters

NameTypeDescription

coin*

String

supported coin = USDT, DAI, USDC, BUSD

currency*

String

a supported currency, ex : NGN

{
    "message": "Bank payout exchange rate retrieved",
    "status": "success",
    "data": {
        "coin": "DAI",
        "currency": "NGN",
        "rate": 690.07
    },
    "statusCode": 200
}

Initiate Bank Payout

Initiate a bank payout

POST https://api.lazerpay.engineering/api/v1/bank/payouts/initiate

Request Body

NameTypeDescription

bank_payout_id*

String

bank payout id

coin*

String

ex : USDT

amount*

float

ex: 0.1

metadata

object

Stringified JSON object of custom data.

reference

String

Unique case sensitive transaction reference. If you do not pass this parameter, Lazerpay will generate a unique reference for you.

{
    "message": "Bank Payout initiated successfully",
    "status": "success",
    "statusCode": 200
}

Example: cURL

curl --location --request POST 'https://api.lazerpay.engineering/api/v1/bank/payouts/initiate' \
--data-raw '{
    "payout_bank_id": "2e7fa635-XXX-4788-a4ac-XXXXX",
    "coin": "USDT",
    "amount": 100,
    "reference": "<string optional>",
    "metadata": "<object optional>"
}'

Last updated