v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB

Credits

Grant credit

post/credits

Request body

Example request

{
  "creditRequests": [
    {
      "accountId": "ACC001",
      "purpose": "PREPAID_CREDIT",
      "effectiveFrom": "2020-07-04",
      "effectiveUntil": "2021-07-04",
      "creditAmount": 1000,
      "priority": 1
    }
  ]
}

Response

Response for List credits request

Example response

{
  "credits": [
    {
      "accountId": "ACC001",
      "purpose": "PREPAID_CREDIT",
      "effectiveFrom": "2020-07-04",
      "effectiveUntil": "2021-07-04",
      "creditAmount": 1000,
      "priority": 1,
      "id": "cred.1znqBOVcai0.0tBFz",
      "customerId": "7VcRw9xZDIqsC5E",
      "status": "ACTIVE",
      "creditUnit": "USD",
      "holdAmount": 500,
      "consumedAmount": 400
    }
  ]
}