Update a gateway account limit

Request

Updates a gateway account limit with a specified ID.
Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
limitIdstringrequired
ID of the gateway account limit.
Enum:"daily-money""monthly-money""daily-count""monthly-count"
Bodyapplication/json
capintegerrequired

Limits the maximum allowed value. If type is set to money, the currency is the report currency. cap only applies to approved transactions of type authorize or sale.

Example:1000
curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/gateway-accounts/{id}/limits/{limitId}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "cap": 1000
  }'

Responses

Gateway account limit updated.
Bodyapplication/json
idstring, <= 50 characters(ResourceId)read-only
ID of the gateway account limit.
Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
statusstringread-only
Status of the gateway account limit.
Enum:"monitoring""reached"
startTimestring, (date-time)read-only
Date and time when the gateway account limit starts.
endTimestring, (date-time)read-only
Date and time when the gateway account limit ends. When a gateway account limit ends the limit resets.
frequencystringread-only
Frequency at which the gateway account limit period resets.
Enum:"daily""monthly"
typestringread-only
Type of gateway account limit.
Enum ValueDescription
money

Limits the amount of money that a transaction can process on a gateway account. If money is chosen, the currency is the report currency.

count
Limits the total number of transaction can be processed on a gateway account.
capintegerrequired

Limits the maximum allowed value. If type is set to money, the currency is the report currency. cap only applies to approved transactions of type authorize or sale.

Example:1000
usageintegerread-only
Usage of the gateway account limit during this period.
Example:375
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
_linksArray of objects(SelfLink)read-only
Related links.
Response
{
  "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "status": "monitoring",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "frequency": "daily",
  "type": "money",
  "cap": 1000,
  "usage": 375,
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}