--- title: Get the customer credits wallet slug: amberflo-api/get-the-customer-credits-wallet docTags: createdAt: 2024-11-07T15:10:16.975Z --- { "id": "V6_ql5DOBQwBRbcQyYxDg", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://app.amberflo.io/payments/billing/customer-prepaid-wallet", "servers": [ { "url": "https://app.amberflo.io/payments/billing/customer-prepaid-wallet" } ], "name": "Get the customer credits wallet", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "payment.billing.prepaid_to_product.detailed.DetailedCustomerPrepaidWallet.out", "schema": [ { "name": "key", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.CustomerPrepaidWalletKey.out", "customType": "payment.billing.prepaid_to_product.CustomerPrepaidWalletKey.out", "schema": [ { "name": "accountId", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "prepaidCards", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.detailed.DetailedPrepaidCard.out", "customType": "payment.billing.prepaid_to_product.detailed.DetailedPrepaidCard.out[]", "schema": [ { "name": "prepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "sourceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentSystemName", "kind": "optional", "type": "string", "example": "" }, { "name": "cardType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardType.out", "customType": "payment.billing.prepaid_to_product.PrepaidCardType.out", "schema": [] }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "price", "kind": "optional", "type": "number", "example": "" }, { "name": "priceInBaseCurrency", "kind": "optional", "type": "number", "example": "" }, { "name": "paymentCurrencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.out", "customType": "payment.billing.PaymentCurrencyInfo.out", "schema": [ { "name": "basePlanCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "paymentCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "exchangeRate", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "worth", "kind": "optional", "type": "number", "example": "" }, { "name": "startTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "expirationTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.detailed.DetailedPrepaidProductInvoice.out", "customType": "payment.billing.prepaid_to_product.detailed.DetailedPrepaidProductInvoice.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "amountInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "usedAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "amountLeft", "kind": "optional", "type": "number", "example": "" }, { "name": "priceInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "worthInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemDimensionPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "The product item associated with the prepaid.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "The dimensions associated with the prepaid.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "creditUnit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.CreditUnit.out", "customType": "payment.pricing.CreditUnit.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "shortName", "kind": "optional", "type": "string", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "example": "" }, { "name": "ratioToCurrency", "kind": "optional", "type": "number", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "active", "kind": "optional", "type": "boolean", "example": "" }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 } ] } ], "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.detailed.DetailedCustomerPrepaidWallet.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "ul-AyRiJRNtWkMyk2cL-w", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/payments/billing/customer-prepaid-wallet \\\n --header 'accept: application/json'" }, { "id": "Ivap7sL2CdJHn75X78sFN", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/billing/customer-prepaid-wallet\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "K8M8gv5Hk7o3kKpclXKWe", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/billing/customer-prepaid-wallet\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "1tUAvgxy-_9DTw-K5nMpI", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/billing/customer-prepaid-wallet\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "ul-AyRiJRNtWkMyk2cL-w" }, "results": { "languages": [ { "id": "UtHP2PtTyHWHLHoZfuGio", "language": "200", "code": "// Successful request\n{\n \"key\": {\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"productId\": \"\"\n },\n \"prepaidCards\": [\n {\n \"prepaidUri\": \"\",\n \"sourceUri\": \"\",\n \"paymentId\": \"\",\n \"paymentSystemName\": \"\",\n \"cardType\": \"\",\n \"paymentStatus\": \"\",\n \"price\": 0,\n \"priceInBaseCurrency\": 0,\n \"paymentCurrencyInfo\": {\n \"basePlanCurrency\": \"USD\",\n \"paymentCurrency\": \"USD\",\n \"exchangeRate\": 0\n },\n \"worth\": 0,\n \"startTimeInMillis\": \"\",\n \"expirationTimeInMillis\": \"\",\n \"productInvoices\": [\n {\n \"invoiceUri\": \"\",\n \"createdTimeInSeconds\": \"\",\n \"amount\": 0,\n \"amountInCredits\": 0,\n \"invoiceAmount\": 0\n }\n ],\n \"usedAmount\": 0,\n \"amountLeft\": 0,\n \"priceInCredits\": 0,\n \"worthInCredits\": 0,\n \"prepaidConditions\": {\n \"prepaidConditionsList\": {},\n \"prepaidConditionsHistory\": \"\"\n },\n \"label\": \"\",\n \"orderId\": \"\"\n }\n ],\n \"creditUnit\": {\n \"id\": \"\",\n \"shortName\": \"\",\n \"name\": \"\",\n \"ratioToCurrency\": 0,\n \"description\": \"\",\n \"active\": false,\n \"lastUpdateTimeInMillis\": \"\"\n }\n}" } ], "selectedLanguageId": "UtHP2PtTyHWHLHoZfuGio" } }, "children": [ { "text": "" } ] }