Modify the prepaid condition for the prepaid card

1 min

POST

https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/prepaid-condition

Body Parameters

bodypayment.pricing.prepaid.PrepaidModificationPrepaidConditionInput.in
- customerIdstringrequired
  Description
  CustomerId
- prepaidUristringrequired
  Description
  Original PrepaidUri
- prepaidConditionpayment.billing.prepaid_to_product.PrepaidCondition.inrequired
  Description
  Prepaid condition for the new prepaid card
  - payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in
    - typestring
      Default
      DimensionValueMapPrepaidCondition
    - dimensionMapValuemap<string, string>
  - payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in
    - typestring
      Default
      ProductItemDimensionPrepaidCondition
    - productItemIdstring
      Description
      The product item associated with the prepaid.
    - dimensionsmap<string, string>
      Description
      The dimensions associated with the prepaid.
  - payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in
    - typestring
      Default
      ProductItemPrepaidCondition
    - productItemIdstring

Responses

200Successful request

payment.billing.prepaid_to_product.PrepaidCard.out
- objectpayment.billing.prepaid_to_product.PrepaidCardByPrice.out
  - prepaidUristring
  - paymentStatuspayment.payment.PaymentStatus.out
  - pricenumber
  - worthnumber
  - sourceUristring
  - paymentSystemNamestring
  - paymentIdstring
  - startTimeInSecondsinteger<int64>
  - expirationTimeInSecondsinteger<int64>
  - productInvoicespayment.billing.detailed.EntityProductInvoice.out[]
    - invoiceUristring
    - createdTimeInSecondsinteger<int64>
    - amountnumber
    - invoiceAmountnumber
  - transferInvoicespayment.billing.detailed.PrepaidTransferInvoice.out[]
    - requestIdstring
    - destinationPrepaidUristring
    - createdTimeInSecondsinteger<int64>
    - amountnumber
  - usedAmountnumber
  - amountLeftnumber
  - cardTypepayment.billing.prepaid_to_product.PrepaidCardType.out
  - paymentCurrencyInfopayment.billing.PaymentCurrencyInfo.out
    - basePlanCurrencystring
      Example
      USD
      Description
      Currency code in ISO 4217 format.
    - paymentCurrencystring
      Example
      USD
      Description
      Currency code in ISO 4217 format.
    - exchangeRatenumber
  - prepaidConditionspayment.billing.prepaid_to_product.PrepaidConditions.out
    - prepaidConditionsListpayment.billing.prepaid_to_product.PrepaidCondition.out[]
      - payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out
        typestring
        Default
        DimensionValueMapPrepaidCondition
        dimensionMapValuemap<string, string>
      - payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out
        typestring
        Default
        ProductItemDimensionPrepaidCondition
        productItemIdstring
        Description
        The product item associated with the prepaid.
        dimensionsmap<string, string>
        Description
        The dimensions associated with the prepaid.
      - payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out
        typestring
        Default
        ProductItemPrepaidCondition
        productItemIdstring
    - prepaidConditionsHistorymap<string, payment.billing.prepaid_to_product.PrepaidCondition.out[]>
  - labelstring
  - commitmentIdstring
  - customPrioritynumber
  - startAtMidCycleboolean
  - orderIdstring
  - orderItemIdstring
  - realTimePricingboolean
  - typestring
    Default
    prepaid_card_by_price
  - purchaseTypepayment.billing.prepaid_to_product.PrepaidPurchaseType.out
  - actualPrepaidChargePricenumber
    Description
    The actual absolute charge amount for the prepaid card, in base currency.
- objectpayment.billing.prepaid_to_product.PrepaidCardByUsage.out
  - prepaidUristring
  - paymentStatuspayment.payment.PaymentStatus.out
  - pricenumber
  - worthnumber
  - sourceUristring
  - paymentSystemNamestring
  - paymentIdstring
  - startTimeInSecondsinteger<int64>
  - expirationTimeInSecondsinteger<int64>
  - productInvoicespayment.billing.detailed.EntityProductInvoice.out[]
    - invoiceUristring
    - createdTimeInSecondsinteger<int64>
    - amountnumber
    - invoiceAmountnumber
  - transferInvoicespayment.billing.detailed.PrepaidTransferInvoice.out[]
    - requestIdstring
    - destinationPrepaidUristring
    - createdTimeInSecondsinteger<int64>
    - amountnumber
  - usedAmountnumber
  - amountLeftnumber
  - cardTypepayment.billing.prepaid_to_product.PrepaidCardType.out
  - paymentCurrencyInfopayment.billing.PaymentCurrencyInfo.out
    - basePlanCurrencystring
      Example
      USD
      Description
      Currency code in ISO 4217 format.
    - paymentCurrencystring
      Example
      USD
      Description
      Currency code in ISO 4217 format.
    - exchangeRatenumber
  - prepaidConditionspayment.billing.prepaid_to_product.PrepaidConditions.out
    - prepaidConditionsListpayment.billing.prepaid_to_product.PrepaidCondition.out[]
      - payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out
        typestring
        Default
        DimensionValueMapPrepaidCondition
        dimensionMapValuemap<string, string>
      - payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out
        typestring
        Default
        ProductItemDimensionPrepaidCondition
        productItemIdstring
        Description
        The product item associated with the prepaid.
        dimensionsmap<string, string>
        Description
        The dimensions associated with the prepaid.
      - payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out
        typestring
        Default
        ProductItemPrepaidCondition
        productItemIdstring
    - prepaidConditionsHistorymap<string, payment.billing.prepaid_to_product.PrepaidCondition.out[]>
  - labelstring
  - commitmentIdstring
  - customPrioritynumber
  - startAtMidCycleboolean
  - orderIdstring
  - orderItemIdstring
  - realTimePricingboolean
  - typestring
    Default
    prepaid_card_by_usage
  - prepaidUsagenumber
  - prepaidFullPricenumber
  - purchaseTypepayment.billing.prepaid_to_product.PrepaidPurchaseType.out

curl

curl --request POST \
     --url https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/prepaid-condition \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "customerId": "",
     "prepaidUri": "",
     "prepaidCondition": {
     "type": "DimensionValueMapPrepaidCondition"
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "customerId": "",
   "prepaidUri": "",
   "prepaidCondition": {
      "type": "DimensionValueMapPrepaidCondition"
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/prepaid-condition", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/prepaid-condition")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "customerId": "",
   "prepaidUri": "",
   "prepaidCondition": {
      "type": "DimensionValueMapPrepaidCondition"
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/prepaid-condition"

payload = json.dumps({
   "customerId": "",
   "prepaidUri": "",
   "prepaidCondition": {
      "type": "DimensionValueMapPrepaidCondition"
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{}