LBUSD

LBUSD (LedgerBlock USD) Collection

Creates a collection request for receiving LedgerBlock USD (LBUSD). When payment is successful, LedgerBlock sends a notification to the configured notification_url.

Request

POST {{base_url}}/api/v1/collection/ledgerblock

Authentication

LedgerBlock uses Bearer Token authentication. Include your API key in the Authorization header.

ParameterValueType
Authorization{{api_key}}Bearer Token

Headers

HeaderRequiredDescriptionExample
Content-TypeYesSpecifies that the request body is JSON.application/json
x-merchant-refYesUnique reference identifying the merchant.{{vault:x-merchant-ref}}

Request Body

ParameterRequiredDescriptionExample
user_refYesUnique reference identifying the user initiating the collection.{{merchant_user_ref}}
txn_merchant_refYesUnique merchant-generated reference for the collection transaction.DUMMY_LBUSD_001
amountYesAmount to be collected.100
currencyYesCurrency identifier for the collection.FUSD
notification_urlYesWebhook URL that receives payment notifications.https://example.com/webhooks/collection

Example Request

{
  "user_ref": "{{merchant_user_ref}}",
  "txn_merchant_ref": "DUMMY_LBUSD_001",
  "amount": 100,
  "currency": "FUSD",
  "notification_url": "https://example.com/webhooks/collection"
}

Example Response


{
  "status": "success",
  "message": "Please complete payment",
  "data": {
    "payment_ref": "DUMMY-PAYMENT-REF-001",
    "txn_merchant_ref": "DUMMY_LBUSD_001",
    "amount": 100,
    "currency": "FUSD",
    "pay_data": {
      "address": "DUMMY_WALLET_ADDRESS",
      "chain": "POL"
    }
  }
}

Response

FieldDescription
statusIndicates whether the collection request was successful.
messageProvides information about the collection request.
data.payment_refUnique reference assigned to the collection by LedgerBlock.
data.txn_merchant_refMerchant-generated reference associated with the collection.
data.amountAmount requested for collection.
data.currencyCurrency identifier used for the collection.

Payment Notification

LedgerBlock sends a notification to the configured notification_url when the payment succeeds. Your application should process the notification to update the collection status.


Did this page help you?