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.
| Parameter | Value | Type |
|---|---|---|
| Authorization | {{api_key}} | Bearer Token |
Headers
| Header | Required | Description | Example |
|---|---|---|---|
Content-Type | Yes | Specifies that the request body is JSON. | application/json |
x-merchant-ref | Yes | Unique reference identifying the merchant. | {{vault:x-merchant-ref}} |
Request Body
| Parameter | Required | Description | Example |
|---|---|---|---|
user_ref | Yes | Unique reference identifying the user initiating the collection. | {{merchant_user_ref}} |
txn_merchant_ref | Yes | Unique merchant-generated reference for the collection transaction. | DUMMY_LBUSD_001 |
amount | Yes | Amount to be collected. | 100 |
currency | Yes | Currency identifier for the collection. | FUSD |
notification_url | Yes | Webhook 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
| Field | Description |
|---|---|
status | Indicates whether the collection request was successful. |
message | Provides information about the collection request. |
data.payment_ref | Unique reference assigned to the collection by LedgerBlock. |
data.txn_merchant_ref | Merchant-generated reference associated with the collection. |
data.amount | Amount requested for collection. |
data.currency | Currency 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.
Updated about 1 month ago
Did this page help you?
