Send Accounts

πŸ“‚ Accounts API

Endpoint

POST {job_base_url}/lenders/{lenderPublicId}/accounts
  • Prod: https://job-prod.cleargrid.ae/api/v1/lenders/{lenderPublicId}/accounts

  • Dev: https://job-dev.cleargrid.ae/api/v1/lenders/{lenderPublicId}/accounts

Headers

Authorization: Bearer <access_token>
Content-Type: application/json

Example Request

{
  "accounts": [
    {
      "status": 1,
      "accountId": "unique_account_id",
      "subAccountId": "unique_sub_account_id",
      "firstName": "John",
      "lastName": "Doe",
      "principal": 1000,
      "loanType": 3
    }
  ]
}

Dynamic Sub-Accounts

  • Add/update/remove anytime

  • Aggregates update automatically

Response

{
  "code": 200,
  "message": "success",
  "body": "Processing started successfully",
  "errors": []
}

❌ Error Codes

Code
Message
Meaning

200

success

Request accepted

400

validation errors

Input error

401

unauthorized

Invalid/missing token

500

server error

Internal issue


πŸ›  Best Practices

  • Always test first on dev environment before production.

  • Use dd/MM/yyyy for dates.

  • Pass en for English and ar for Arabic.

  • Use subAccountId for installments or charges.

  • Securely store your API credentials.

Last updated