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

EncryptedAPI Key

Payload encryption required. Encrypt the request JSON and send { "payload": "<iv>:<ciphertext>" }. Decrypt the response payload field. Encryption guide →. Do not share your API key or Encryption Key with anyone.

Creates a reconciliation transfer to a beneficiary.

Important

All payment API requests must be encrypted on your server before sending. Build the JSON below, encrypt it with your Encryption Key, and POST {"payload": "<iv_hex>:<ciphertext_hex>"}. Do not share your API key or Encryption Key with anyone — use them only on your backend. See the Encryption guide for code examples.

Request structure (encrypt this JSON)

{
  "merchantOrderId": "RECON-12345",

  "payment": {
    "amount": 500.00,
    "currency": "USD"
  },

  "beneficiaryId": "BEN-123"
}

Wire format (send this to the API)

Encrypted request body

{
  "payload": "3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a:8e4f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0"
}

Request Parameters

Single reference table grouped by JSON object. Nested fields use dot notation (e.g. payment.amount).

Field	Type	Required	Description
Order
merchantOrderId	string	Required	Unique reconciliation order identifier
beneficiaryId	string	Required	Beneficiary ID receiving the transfer
merchantProfileId	number	Optional	Merchant profile ID. Defaults to PRIMARY if omitted
description	string	Optional	Reconciliation description
metadata	string	Optional	Additional data as a JSON string
Paymentpayment
payment.amount	number	Required	Reconciliation amount (minimum 0.01)
payment.currency	string	Required	Currency code (3 letters)

Important

All payment API responses — including success, declined, failed, and validation errors — are returned encrypted when you are authenticated. The wire body is {"success": true|false, "payload": "<iv_hex>:<ciphertext_hex>"}. Decrypt payload with your Encryption Key to read the standard JSON documented below. Outer success mirrors the decrypted outcome (false for declines and errors). Do not share your Encryption Key or API key — keep both on your server only.

Wire format (from API)

{
  "success": true,
  "payload": "7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7:4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8"
}

After decryption

Success Response

200

{
  "success": true,
  "data": {
    "reconciliationId": "RECON-12345",
    "merchantOrderId": "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

EncryptedAPI Key

Payload encryption required. Responses are returned as { "success": true, "payload": "<iv>:<ciphertext>" }. Decrypt payload on your server. Encryption guide →. Do not share your API key or Encryption Key with anyone.

Returns the current status of a reconciliation transfer.

Important

This endpoint has no request body. Responses are returned encrypted — decrypt the payload field using your Encryption Key. See the Encryption guide.

Path Parameters

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

Important

Wire format (from API)

{
  "success": true,
  "payload": "7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7:4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8"
}

After decryption

Success Response

200

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