Live API

Reconciliation

Create live reconciliation transfers to beneficiaries and check reconciliation status. Use your live API key with /api/live/reconciliation endpoints.

Important

Live reconciliation moves real funds. Ensure beneficiary details and amounts are verified before submitting requests.

Create Reconciliation

POST/api/live/reconciliation

API Key

Creates a reconciliation transfer to a beneficiary.

Request Body

{
  "orderId": "RECON-12345",
  "amount": 500.00,
  "currency": "USD",
  "beneficiaryId": "BEN-123"
}

Request Parameters

Parameter	Type	Required	Description
orderId	string	Yes	Unique order identifier
amount	number	Yes	Reconciliation amount (minimum 0.01)
currency	string	Yes	Currency code (3 letters)
merchantProfileId	number	No	Merchant Profile ID. Defaults to PRIMARY if not provided
beneficiaryId	string	Yes	Beneficiary ID
description	string	No	Reconciliation description
metadata	object	No	Key-value data returned in webhooks and in the payment object

Success Response

200

{
  "success": true,
  "data": {
    "reconciliationId": "RECON-12345",
    "orderId": "RECON-12345",
    "status": "PENDING",
    "amount": 500,
    "currency": "USD",
    "beneficiaryId": "BEN-123",
    "createdAt": "2024-01-01T12:00:00Z"
  }
}

Get Reconciliation Status

GET/api/live/reconciliation/:id/status

API Key

Returns the current status of a reconciliation transfer.

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Reconciliation ID or Order ID

Success Response

200

{
  "success": true,
  "data": {
    "reconciliationId": "RECON-12345",
    "orderId": "RECON-12345",
    "status": "SUCCESS",
    "amount": 500,
    "currency": "USD",
    "beneficiaryId": "BEN-123",
    "completedAt": "2024-01-01T12:05:00Z"
  }
}