Skip to main content
POST
/
wallets
/
{id}
/
top-up
Top up wallet
curl --request POST \
  --url https://us.api.flexprice.io/v1/wallets/{id}/top-up \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": "<string>",
  "credits_to_add": "<string>",
  "description": "<string>",
  "expiry_date_utc": "<string>",
  "idempotency_key": "<string>",
  "metadata": {},
  "priority": 123
}
'
import requests

url = "https://us.api.flexprice.io/v1/wallets/{id}/top-up"

payload = {
    "amount": "<string>",
    "credits_to_add": "<string>",
    "description": "<string>",
    "expiry_date_utc": "<string>",
    "idempotency_key": "<string>",
    "metadata": {},
    "priority": 123
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '<string>',
    credits_to_add: '<string>',
    description: '<string>',
    expiry_date_utc: '<string>',
    idempotency_key: '<string>',
    metadata: {},
    priority: 123
  })
};

fetch('https://us.api.flexprice.io/v1/wallets/{id}/top-up', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/wallets/{id}/top-up",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => '<string>',
    'credits_to_add' => '<string>',
    'description' => '<string>',
    'expiry_date_utc' => '<string>',
    'idempotency_key' => '<string>',
    'metadata' => [
        
    ],
    'priority' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/wallets/{id}/top-up"

	payload := strings.NewReader("{\n  \"amount\": \"<string>\",\n  \"credits_to_add\": \"<string>\",\n  \"description\": \"<string>\",\n  \"expiry_date_utc\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"metadata\": {},\n  \"priority\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://us.api.flexprice.io/v1/wallets/{id}/top-up")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"<string>\",\n  \"credits_to_add\": \"<string>\",\n  \"description\": \"<string>\",\n  \"expiry_date_utc\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"metadata\": {},\n  \"priority\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/wallets/{id}/top-up")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"<string>\",\n  \"credits_to_add\": \"<string>\",\n  \"description\": \"<string>\",\n  \"expiry_date_utc\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"metadata\": {},\n  \"priority\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "invoice_id": "<string>",
  "wallet": {
    "alert_settings": {
      "alert_enabled": true,
      "critical": {
        "threshold": 123
      },
      "info": {
        "threshold": 123
      },
      "warning": {
        "threshold": 123
      }
    },
    "auto_topup": {
      "amount": 123,
      "enabled": true,
      "invoicing": true,
      "threshold": 123
    },
    "balance": "<string>",
    "config": {
      "allowed_price_types": []
    },
    "conversion_rate": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "credit_balance": "<string>",
    "credits_available_breakdown": {
      "free": "<string>",
      "purchased": "<string>"
    },
    "currency": "<string>",
    "customer_id": "<string>",
    "description": "<string>",
    "environment_id": "<string>",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "tenant_id": "<string>",
    "topup_conversion_rate": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>"
  },
  "wallet_transaction": {
    "amount": "<string>",
    "conversion_rate": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "created_by_user": {
      "email": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "roles": [
        "<string>"
      ],
      "tenant": {
        "billing_details": {
          "address": {
            "address_city": "<string>",
            "address_country": "<string>",
            "address_line1": "<string>",
            "address_line2": "<string>",
            "address_postal_code": "<string>",
            "address_state": "<string>"
          },
          "email": "<string>",
          "help_email": "<string>",
          "phone": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "metadata": {},
        "name": "<string>",
        "status": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    },
    "credit_amount": "<string>",
    "credit_balance_after": "<string>",
    "credit_balance_before": "<string>",
    "credits_available": "<string>",
    "currency": "<string>",
    "customer": {
      "address_city": "<string>",
      "address_country": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "address_postal_code": "<string>",
      "address_state": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "email": "<string>",
      "environment_id": "<string>",
      "external_id": "<string>",
      "id": "<string>",
      "integrations": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "entity_id": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "provider_entity_id": "<string>",
          "provider_type": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "metadata": {},
      "name": "<string>",
      "tenant_id": "<string>",
      "timezone": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    },
    "customer_id": "<string>",
    "description": "<string>",
    "environment_id": "<string>",
    "expiry_date": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "idempotency_key": "<string>",
    "metadata": {},
    "priority": 123,
    "reference_id": "<string>",
    "tenant_id": "<string>",
    "topup_conversion_rate": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "wallet": {
      "alert_settings": {
        "alert_enabled": true,
        "critical": {
          "threshold": 123
        },
        "info": {
          "threshold": 123
        },
        "warning": {
          "threshold": 123
        }
      },
      "auto_topup": {
        "amount": 123,
        "enabled": true,
        "invoicing": true,
        "threshold": 123
      },
      "balance": "<string>",
      "config": {
        "allowed_price_types": []
      },
      "conversion_rate": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "credit_balance": "<string>",
      "credits_available_breakdown": {
        "free": "<string>",
        "purchased": "<string>"
      },
      "currency": "<string>",
      "customer_id": "<string>",
      "description": "<string>",
      "environment_id": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "tenant_id": "<string>",
      "topup_conversion_rate": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    },
    "wallet_id": "<string>"
  }
}
{
  "http_status_code": 123,
  "message": "<string>"
}
{
  "http_status_code": 123,
  "message": "<string>"
}
{
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

​
id
string
required

Wallet ID

Body

application/json

Top up request

​
transaction_reason
enum<string>
required
Available options:
INVOICE_PAYMENT,
FREE_CREDIT_GRANT,
SUBSCRIPTION_CREDIT_GRANT,
PURCHASED_CREDIT_INVOICED,
PURCHASED_CREDIT_DIRECT,
CREDIT_NOTE,
CREDIT_EXPIRED,
WALLET_TERMINATION,
MANUAL_BALANCE_DEBIT,
CREDIT_ADJUSTMENT,
INVOICE_VOID_REFUND
​
amount
string

amount is the amount in the currency of the wallet to be added NOTE: this is not the number of credits to add, but the amount in the currency amount = credits_to_add * conversion_rate if both amount and credits_to_add are provided, amount will be ignored ex if the wallet has a conversion_rate of 2 then adding an amount of 10 USD in the wallet wil add 5 credits in the wallet

​
credits_to_add
string

credits_to_add is the number of credits to add to the wallet

​
description
string

description to add any specific details about the transaction

​
expiry_date_utc
string

expiry_date_utc is the expiry date in UTC timezone ex 2025-01-01 00:00:00 UTC

​
idempotency_key
string

idempotency_key is a unique key for the transaction

​
metadata
object
​
priority
integer

priority is the priority of the transaction lower number means higher priority default is nil which means no priority at all

Response

OK

​
invoice_id
string

Invoice ID if an invoice was created (only for PURCHASED_CREDIT_INVOICED)

​
wallet
object
​
wallet_transaction
object