Checkout.com API logo

Reserve rules

View and manage reserve rules for your sub-entities.

Get reserve rule details

Retrieve the details of a specific reserve rule.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
path Parameters
entityId
required
string

The sub-entity's ID.

Example: ent_w4jelhppmfiufdnatam37wrfc4
id
required
string

The reserve rule ID.

Example: rsv_qn4nis4k3ykpzzu7cvtuvhqqga
Responses
200

Reserve rule details.

400

Bad Request

401

Unauthorized

get/accounts/entities/{entityId}/reserve-rules/{id}
Request samples 
Response samples 
application/json
{
  • "id": "rsv_qn4nis4k3ykpzzu7cvtuvhqqga",
  • "type": "rolling",
  • "valid_from": "2001-01-01T13:33:00.000Z",
  • "rolling": {
    }
}
Update reserve rule
Update an upcoming reserve rule. Only reserve rules that have never been active can be updated.


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
entityId
required
string
The sub-entity's ID.


 
 Example:  ent_w4jelhppmfiufdnatam37wrfc4
id
required
string
The reserve rule ID.


 
 Example:  rsv_qn4nis4k3ykpzzu7cvtuvhqqga
header Parameters
If-Match
required
string
Identifies a specific version of a reserve rule to update.


 
 Example:  Y3Y9MCZydj0w
Request Body schema: application/json
required
type
required
string
 Value: "rolling"  
required
object (RollingReserveRule) 
 
Responses 
200
Reserve rule updated successfully.


401
Unauthorized


412
Precondition failed. An invalid ETag value was provided in the If-Match header.


422
Unprocessable entity


428
Precondition required. The If-Match header is required.


put/accounts/entities/{entityId}/reserve-rules/{id}
Request samples 
application/json
{
  • "type": "rolling",
  • "rolling": {
    }
}
Response samples 
application/json
{
  • "id": "rsv_qn4nis4k3ykpzzu7cvtuvhqqga",
  • "_links": {
    }
}
Add a reserve rule
Create a sub-entity reserve rule.


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
id
required
string
The sub-entity's ID.


 
 Example:  ent_w4jelhppmfiufdnatam37wrfc4
Request Body schema: application/json
required
A JSON payload containing the reserve rule details.


type
required
string
 Value: "rolling"  
required
object (RollingReserveRule) 
 
valid_from
required
string <date-time> 
The date and time the reserve rule will come into effect. This must be at least 15 minutes in the future.


 
Responses 
201
Created


400
Bad Request


401
Unauthorized


422
Invalid data was sent


post/accounts/entities/{id}/reserve-rules
Request samples 
application/json
{
  • "type": "rolling",
  • "valid_from": "2001-01-01T13:33:00.000Z",
  • "rolling": {
    }
}
Response samples 
application/json
{
  • "id": "rsv_qn4nis4k3ykpzzu7cvtuvhqqga",
  • "_links": {
    }
}
Query reserve rules
Fetch all of the reserve rules for a sub-entity.


SecurityOAuth2: OAuth or API Key: ApiSecretKey 
Request 
path Parameters
id
required
string
The sub-entity's ID.


 
 Example:  ent_w4jelhppmfiufdnatam37wrfc4
Responses 
200
OK


400
Bad Request


401
Unauthorized


get/accounts/entities/{id}/reserve-rules
Request samples 
Response samples 
application/json
{
  • "data": [
    ]
}
➔ Next to Cardholders