Get Card Daily Spending Limit

Returns the daily spending limit configured on a card. amount is in the currency’s smallest unit — for USD that means cents (e.g. 1000 = $10.00, `1000000` =$10,000.00). The card must belong to the authenticated user.

GET /cards/{cardId}/limit

Get Card Daily Spending Limit

JavaScript

const options = {method: 'GET'};

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

curl --request GET \
  --url https://gp-auth-module.prod.gnosispay.com/cards/{cardId}/limit

import requests

url = "https://gp-auth-module.prod.gnosispay.com/cards/{cardId}/limit"

response = requests.get(url)

print(response.text)

package main

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

func main() {

	url := "https://gp-auth-module.prod.gnosispay.com/cards/{cardId}/limit"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://gp-auth-module.prod.gnosispay.com/cards/{cardId}/limit")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gp-auth-module.prod.gnosispay.com/cards/{cardId}/limit")

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

request = Net::HTTP::Get.new(url)

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>"
}

Path Parameters

cardId · string<uuid> · required

Response

200

application/json

Card limit retrieved successfully

Currently configured daily spending limit. Null if no limit has been set for this card. Call GET /cards/{id}/limit for today's spend and remaining headroom.

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 card's 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).