Spend Limits

These APIs help you manage spend limits that are applied on your profile.

Endpoints
GET/v4/spend/profiles/{{profileId}}/spend-limits
PATCH/v4/spend/profiles/{{profileId}}/spend-limits

The Limits resource

typetext

The type of transaction. One of PURCHASE, ATM_WITHDRAWAL. PURCHASE is a combined limit that applies to Contactless, Magnetic, Online purchase, Chip and PIN/mobile wallet transactions

valuemoney

The current configured daily or monthly limit. The value can be between 0 and the max allowed

usagemoney

The total authorised amount till date

maxmoney

The max allowed limit for daily or monthly

resetAttext

The time when the limit get reset. ISO-8601 timestamp with timezone (Z)

Limits Resource
{
  "type": "PURCHASE",
  "aggregateWindow": {
    "daily": {
      "value": {
        "amount": 20000.00,
        "currency": "GBP"
      },
      "usage": {
        "amount": 0.00,
        "currency": "GBP"
      },
      "max": {
        "amount": 25700.10,
        "currency": "GBP"
      },
      "resetAt": "2023-07-31T22:59:59.999999999Z"
    },
    "monthly": {
      "value": {
        "amount": 20000.00,
        "currency": "GBP"
      },
      "usage": {
        "amount": 0.00,
        "currency": "GBP"
      },
      "max": {
        "amount": 25700.10,
        "currency": "GBP"
      },
      "resetAt": "2023-07-31T22:59:59.999999999Z"
    }
  }
}

Retrieve profile limits

GET /v4/spend/profiles/{{profileId}}/spend-limits

Retrieves the spending limits that are configured for a profileId.

Example Request
curl -X GET 'https://api.sandbox.transferwise.tech/v4/spend/profiles/{{profileId}}/spend-limits' \
     -H 'Authorization: Bearer {{API token}}'

Response

Returns a list of spend limits object

Example Response
{
  "spendLimits": [
    {
      "type": "PURCHASE",
      "aggregateWindow": {
        "daily": {
          "value": {
            "amount": 20000.00,
            "currency": "GBP"
          },
          "usage": {
            "amount": 0.00,
            "currency": "GBP"
          },
          "max": {
            "amount": 25700.10,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z"
        },
        "monthly": {
          "value": {
            "amount": 20000.00,
            "currency": "GBP"
          },
          "usage": {
            "amount": 0.00,
            "currency": "GBP"
          },
          "max": {
            "amount": 25700.10,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z"
        }
      }
    },
    {
      "type": "ATM_WITHDRAWAL",
      "aggregateWindow": {
        "daily": {
          "value": {
            "amount": 20000.00,
            "currency": "GBP"
          },
          "usage": {
            "amount": 0.00,
            "currency": "GBP"
          },
          "max": {
            "amount": 25700.10,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z"
        },
        "monthly": {
          "value": {
            "amount": 20000.00,
            "currency": "GBP"
          },
          "usage": {
            "amount": 0.00,
            "currency": "GBP"
          },
          "max": {
            "amount": 25700.10,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z"
        }
      }
    }
  ]
}

Update profile limits

PATCH /v4/spend/profiles/{{profileId}}/spend-limits

Update profile daily and monthly spending limits for PURCHASE or ATM_WITHDRAWAL.

typetext

The type of transaction. One of PURCHASE, ATM_WITHDRAWAL

valuemoney

The amount allowed to be spent for the chosen type, both daily and monthly must be set

Example Request
curl -X PATCH https://api.sandbox.transferwise.tech/v3/spend/profiles/{{profileId}}/cards/{{cardToken}}/spending-limits \
     -H 'Authorization: Bearer <your api token>' \
     -H 'Content-Type: application/json' \
     -d '{
          "type": "PURCHASE",
          "aggregateWindow": {
            "daily": {
              "value": {
                "amount": 20000.00,
                "currency": "GBP"
              }
            },
            "monthly": {
              "value": {
                "amount": 20000.00,
                "currency": "GBP"
              }
            }
          }
        }'

Response

See Retrieve profile limits