Set Account Daily Spending Limit

Sets the daily spending limit for the authenticated user’s account. amount is in the currency’s smallest unit — for USD that means cents, so to set a $10.00 limit send `1000`, and the maximum allowed value `1000000` corresponds to$10,000.00. Must be in (0, 1,000,000]. Only USD is currently accepted. The response returns the new limit immediately with syncStatus: pending and transitions to synced once the change has been applied downstream.

PUT /user/account/limit

Set Account Daily Spending Limit

JavaScript

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({amount: 500000, currency: '<string>'})
};

fetch('https://gp-auth-module.prod.gnosispay.com/user/account/limit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PUT \
  --url https://gp-auth-module.prod.gnosispay.com/user/account/limit \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 500000,
  "currency": "<string>"
}
'

import requests

url = "https://gp-auth-module.prod.gnosispay.com/user/account/limit"

payload = {
    "amount": 500000,
    "currency": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

package main

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

func main() {

	url := "https://gp-auth-module.prod.gnosispay.com/user/account/limit"

	payload := strings.NewReader("{\n  \"amount\": 500000,\n  \"currency\": \"<string>\"\n}")

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

	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.put("https://gp-auth-module.prod.gnosispay.com/user/account/limit")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 500000,\n  \"currency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gp-auth-module.prod.gnosispay.com/user/account/limit")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 500000,\n  \"currency\": \"<string>\"\n}"

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

200

{
  "amount": 123,
  "currency": "<string>",
  "decimals": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "spentToday": 123,
  "remaining": 123
}

{
  "success": false,
  "error": {
    "name": "ValidationError",
    "message": "<string>"
  }
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

Body

application/json

amount · integer · required

Daily limit in the currency's smallest unit (e.g. cents for USD). For USD: send 1000 to set a $10.00 limit, send 1000000 to set the $10,000.00 cap. Must be in (0, 1,000,000].

Required range: 1 <= x <= 1000000

currency · string · required

ISO-4217 currency code. Only USD is currently accepted; other values return 400.

Response

200

application/json

Account limit updated successfully

amount · integer · required

Daily limit in the currency's smallest unit (e.g. cents for USD). Divide by 10^decimals to get the major-unit value. For USD (decimals=2): amount=1000 means $10.00, amount=1000000 means $10,000.00.

currency · string · required

ISO-4217 currency code, e.g. USD.

decimals · integer · required

Number of decimal places for this currency (e.g. 2 for USD).

syncStatus · enum<string> · required

Replication state of the limit. 'pending' immediately after an update, 'synced' once the change has been applied downstream, 'failed' if the change could not be applied after retries.

Available options: pending, synced, failed

updatedAt · string<date-time> · required

Last time this limit was modified.

spentToday · integer · required

Amount spent today against this limit, in the currency's smallest unit (e.g. cents for USD). Resets at the start of each calendar day.

remaining · integer · required

Remaining headroom today, in the currency's smallest unit. Equals max(0, amount - spentToday).