Merchant Onboarding

Creating a merchant account establishes your business on LedgerBlock and gives you the credentials and wallet required to use LedgerBlock's financial services.

Why create a merchant account?	What businesses need it for
Identify your business	Establishes your business as a recognized merchant on LedgerBlock.
Access LedgerBlock APIs	Allows your business to integrate with LedgerBlock's payment and financial services.
Receive API credentials	Provides the `api_key` and `x_merchant_ref` required to make authenticated API requests.
Create and manage users	Allows the merchant to create users associated with the merchant account.
Get a default wallet	Provides a wallet for managing supported funds and transactions.
Process transactions	Links API activity and transactions to the correct merchant account.
Enable secure access	Allows LedgerBlock to verify and authorize requests made on behalf of the business.

Once the merchant account is created and approved, LedgerBlock provides the merchant's API Key, X-Merchant-Ref, Default Wallet, and User Ref, which are required for subsequent integration steps.
Merchant onboarding is the first step in setting up your LedgerBlock integration. It creates your merchant account and generates the credentials and default wallet required to interact with the LedgerBlock API.

Sample Request ; Create Merchant

This endpoint creates a new merchant account and generates the credentials required for API integration.

POST {{base_url}}/api/v1/merchant/account

Request Body

Name	Type	Description
`merchant_name`	String	The name of the merchant.
`merchant_email`	String	The merchant's email address.
`notification_url`	String	The webhook URL where LedgerBlock will send transaction notifications.

Sample Request

{
  "merchant_name": "Teslim Test",
  "merchant_email": "[email protected]",
  "notification_url": "https://webhook.site/77bd3efa-24e0-49db-a39c-a9e8a6e9f528"
}

Response

`200 OK`

{
  "status": "success",
  "message": "Successfully created API Key. Please save in a secure place. You may need to contact support to reset API Key",
  "data": {
    "x_merchant_ref": "MREFCA1B89FC66464E6BA82756AE96DF484C000N7",
    "api_key": "APILBX336B754C0C26474DBD56CB042E1D852C007V2",
    "default_wallet": {
      "wallet_id": "LBWNGN81C4801EE29D43F8A0B2231E367B74550063J",
      "user_ref": "UREF52EAF03D45714E47A65BF451969A22FB00CHN",
      "currency": "NGN"
    }
  }
}

Response Fields

Key	Type	Description
`status`	String	Indicates the outcome of the request, such as `success`.
`message`	String	Provides a description of the result.
`x_merchant_ref`	String	Unique reference assigned to the merchant. Store it securely.
`api_key`	String	Merchant API key used for authentication. Store it securely.

`default_wallet`

Key	Type	Description
`wallet_id`	String	Unique identifier of the merchant's default wallet.
`user_ref`	String	Unique user reference associated with the wallet.
`currency`	String	Currency of the default wallet, such as `NGN`.

Updated 16 days ago

Did this page help you?