v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB

Credits

Get credit details

get/credits/{credit_id}

Path parameters

credit_idstring required

Example:creds.1znQx9jiIXw.r44fc

Response

Response for Fetch Credit Details request. This contains Credit Transactions

accountIdstring required

purposestring required

applicableEntityIdsstring[]

List of entity ids for which the credit is applicable. If null or empty, the credit is applicable to all ids. This list can accept special values like: - ALL_USAGE_METER_RATE_CARDS: To apply the credit to all usage meter rate cards - ALL_FIXED_FEE_RATE_CARDS: To apply the credit to all fixed fee rate cards

effectiveFromstring date required

effectiveUntilstring date

creditAmountnumber

priorityinteger required

grantorIdstring

The entity through which the credit has been granted

idempotencyKeystring

The idempotency key for uniqueness of the credit record

idstring required

Identifier of credits

customerIdstring required

status'ACTIVE' | 'CONSUMED' | 'EXPIRED' | 'VOIDED' required

creditUnitstring

holdAmountnumber

consumedAmountnumber

createdAtstring date-time required

updatedAtstring date-time

Example response

{
  "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,
  "transactions": [
    {
      "transactionType": "CREDITED",
      "amount": 200
    }
  ]
}