Returns the amount to acquire for 'BASED_ON_BENEFICIARY_ID' products

Check acquire amount for products with amountSource 'BASED_ON_BENEFICIARY_ID'.

Query Parameters

sku ProductSku required
beneficiaryId BeneficiaryId required

Responses

Successful response

application/json

Schema
Example (from schema)
AcquireAmountSuccessResponse
AcquireAmountFailureResponse
AmountSourceNotBasedOnBeneficiaryIdAmountResponse

Schema

status string required
Possible values: [SUCCESS, FAILURE]
error string
Possible values: [UNKNOWN_SKU, INVALID_BENEFICIARY_ID, AMOUNT_SOURCE_NOT_BASED_ON_BENEFICIARY_ID, INTERNAL, UNSPECIFIED]
rawErrorCode string
transactionId string
amount object
value double
Product's amount in Naira
restriction string
Possible values: [EXACT, MINIMUM, MAXIMUM, GREATER_THAN, LESS_THAN]
beneficiaryDetails object
beneficiaryName string
paymentDetails object
productName string

{
  "status": "SUCCESS",
  "amount": {
    "value": 10,
    "restrictions": "EXACT"
  }
}

Successfully fetched amount

{
  "status": "SUCCESS",
  "amount": {
    "value": 10,
    "restrictions": "EXACT"
  },
  "beneficiaryDetails": {
    "beneficiaryName": "Customer Name"
  },
  "paymentDetails": {
    "productName": "Active Product Name"
  }
}

Invalid beneficiary id

{
  "status": "FAILURE",
  "error": "INVALID_BENEFICIARY_ID"
}

Amount source for product is not 'BASED_ON_BENEFICIARY_ID'

{
  "status": "FAILURE",
  "error": "AMOUNT_SOURCE_NOT_BASED_ON_BENEFICIARY_ID"
}