logo

Retrieve a gateway account limit

Retrieves a gateway account limit with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

limitId
required
string

ID of the gateway account limit.

Enum: "daily-money" "monthly-money" "daily-count" "monthly-count"
Responses
200

Gateway account limit retrieved.

Response Schema: application/json
cap
required
integer

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.

id
string <= 50 characters

ID of the gateway account limit.

status
string

Status of the gateway account limit.

Enum: "monitoring" "reached"
startTime
string <date-time>

Date and time when the gateway account limit starts.

endTime
string <date-time>

Date and time when the gateway account limit ends. When a gateway account limit ends the limit resets.

frequency
string

Frequency at which the gateway account limit period resets.

Enum: "daily" "monthly"
type
string

Type of gateway account limit.

Enum: Description
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.

usage
integer

Usage of the gateway account limit during this period.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/gateway-accounts/{id}/limits/{limitId}
Request samples 
Response samples 
application/json
{
  • "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": [
    ]
}
➔ Next to Update a gateway account limit