Update card
Update a card
Authentication from public API requests
Explicitly set this value to null to remove the card from a group. Omitting this field entirely will not affect the group the card belongs to.
Explicitly set this value to null to remove all card level spending constraints.
IANA timezone string. Limits always reset at midnight of the timezone specified. If no timezone is specified, then UTC time is used.
Represents a monetary value
The amount in cents
Format ISO-8601. A day that equals today or the past. This is optional.If the preset
is "daily", this value is ignored. If the preset
is "weekly", "monthly" or "yearly", then the this value is used to compute when the limit should start limit.
Represents a monetary value
The amount in cents
Represents a monetary value
The amount in cents
Explicitly set this value to null to remove the attached avs address.
ISO region code recommended.
Postal code.
2-character ISO country code.
Arbitrary information that can be attached to the card. This should be a JSON object and cannot exceed 4kb.
curl --request PATCH \
--url https://api.joinslash.com/card/{cardId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"name": "<string>",
"status": "active",
"cardGroupId": "<string>",
"spendingConstraint": {
"merchantCategoryRule": {
"merchantCategories": [
"<string>"
],
"restriction": "allowlist"
},
"merchantRule": {
"merchants": [
"<string>"
],
"restriction": "allowlist"
},
"spendingRule": {
"utilizationLimit": {
"timezone": "<string>",
"limitAmount": {
"amountCents": 123
},
"preset": "daily",
"startDate": "<string>"
},
"utilizationLimitV2": [
{
"timezone": "<string>",
"limitAmount": {
"amountCents": 123
},
"preset": "daily",
"startDate": "<string>"
}
],
"transactionSizeLimit": {
"minimum": {
"amountCents": 123
},
"maximum": {
"amountCents": 123
}
}
}
},
"avsAddress": {
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>"
},
"userData": {}
}'
{
"id": "<string>",
"accountId": "<string>",
"last4": "<string>",
"name": "<string>",
"expiryMonth": "<string>",
"expiryYear": "<string>",
"status": "active",
"isPhysical": true,
"pan": "<string>",
"cvv": "<string>",
"cardGroupId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"spendingConstraint": {
"merchantCategoryRule": {
"merchantCategories": [
"<string>"
],
"restriction": "allowlist"
},
"merchantRule": {
"merchants": [
"<string>"
],
"restriction": "allowlist"
},
"spendingRule": {
"utilizationLimit": {
"timezone": "<string>",
"limitAmount": {
"amountCents": 123
},
"preset": "daily",
"startDate": "<string>"
},
"utilizationLimitV2": [
{
"timezone": "<string>",
"limitAmount": {
"amountCents": 123
},
"preset": "daily",
"startDate": "<string>"
}
],
"transactionSizeLimit": {
"minimum": {
"amountCents": 123
},
"maximum": {
"amountCents": 123
}
}
}
},
"avsAddress": {
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>"
},
"userData": {}
}
Authorizations
Authentication from public API requests
Path Parameters
Body
active
, paused
, inactive
, closed
Explicitly set this value to null to remove the card from a group. Omitting this field entirely will not affect the group the card belongs to.
Explicitly set this value to null to remove all card level spending constraints.
allowlist
, blacklist
allowlist
, blacklist
IANA timezone string. Limits always reset at midnight of the timezone specified. If no timezone is specified, then UTC time is used.
Represents a monetary value
The amount in cents
daily
, weekly
, monthly
, yearly
, collective
Format ISO-8601. A day that equals today or the past. This is optional.If the preset
is "daily", this value is ignored. If the preset
is "weekly", "monthly" or "yearly", then the this value is used to compute when the limit should start limit.
IANA timezone string. Limits always reset at midnight of the timezone specified. If no timezone is specified, then UTC time is used.
Represents a monetary value
The amount in cents
daily
, weekly
, monthly
, yearly
, collective
Format ISO-8601. A day that equals today or the past. This is optional.If the preset
is "daily", this value is ignored. If the preset
is "weekly", "monthly" or "yearly", then the this value is used to compute when the limit should start limit.
Represents a monetary value
The amount in cents
Represents a monetary value
The amount in cents
Explicitly set this value to null to remove the attached avs address.
ISO region code recommended.
Postal code.
2-character ISO country code.
Arbitrary information that can be attached to the card. This should be a JSON object and cannot exceed 4kb.
Response
The account that this card is associated with
The last 4 digits of the card number
The name assigned to the card that appears on the user dashboard
The month the card expires formatted as MM (01, 02, ..., 12)
The year the card expires formatted as YYYY (2024, 2025, ...)
The status of the card
active
, paused
, inactive
, closed
When true, a physical card has been issued. Otherwise, this is a virtual card.
This field contains the full PAN which will only be sent on a request for a single card when you set the query param "include_pan" to "true"
This field will contain full CVV which will only be sent on a request for a single card when you set the query param "include_pan" to "true"
The card group the card belongs to.
The spending constraint applied to the card
allowlist
, blacklist
allowlist
, blacklist
IANA timezone string. Limits always reset at midnight of the timezone specified. If no timezone is specified, then UTC time is used.
Represents a monetary value
The amount in cents
daily
, weekly
, monthly
, yearly
, collective
Format ISO-8601. A day that equals today or the past. This is optional.If the preset
is "daily", this value is ignored. If the preset
is "weekly", "monthly" or "yearly", then the this value is used to compute when the limit should start limit.
IANA timezone string. Limits always reset at midnight of the timezone specified. If no timezone is specified, then UTC time is used.
Represents a monetary value
The amount in cents
daily
, weekly
, monthly
, yearly
, collective
Format ISO-8601. A day that equals today or the past. This is optional.If the preset
is "daily", this value is ignored. If the preset
is "weekly", "monthly" or "yearly", then the this value is used to compute when the limit should start limit.
Represents a monetary value
The amount in cents
Represents a monetary value
The amount in cents
The avs address locked applied to this card
ISO region code recommended.
Postal code.
2-character ISO country code.
Arbitrary information that can be attached to the card. See the PATCH /card/{cardId}
endpoint for more details on how to add user data.
curl --request PATCH \
--url https://api.joinslash.com/card/{cardId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"name": "<string>",
"status": "active",
"cardGroupId": "<string>",
"spendingConstraint": {
"merchantCategoryRule": {
"merchantCategories": [
"<string>"
],
"restriction": "allowlist"
},
"merchantRule": {
"merchants": [
"<string>"
],
"restriction": "allowlist"
},
"spendingRule": {
"utilizationLimit": {
"timezone": "<string>",
"limitAmount": {
"amountCents": 123
},
"preset": "daily",
"startDate": "<string>"
},
"utilizationLimitV2": [
{
"timezone": "<string>",
"limitAmount": {
"amountCents": 123
},
"preset": "daily",
"startDate": "<string>"
}
],
"transactionSizeLimit": {
"minimum": {
"amountCents": 123
},
"maximum": {
"amountCents": 123
}
}
}
},
"avsAddress": {
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>"
},
"userData": {}
}'
{
"id": "<string>",
"accountId": "<string>",
"last4": "<string>",
"name": "<string>",
"expiryMonth": "<string>",
"expiryYear": "<string>",
"status": "active",
"isPhysical": true,
"pan": "<string>",
"cvv": "<string>",
"cardGroupId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"spendingConstraint": {
"merchantCategoryRule": {
"merchantCategories": [
"<string>"
],
"restriction": "allowlist"
},
"merchantRule": {
"merchants": [
"<string>"
],
"restriction": "allowlist"
},
"spendingRule": {
"utilizationLimit": {
"timezone": "<string>",
"limitAmount": {
"amountCents": 123
},
"preset": "daily",
"startDate": "<string>"
},
"utilizationLimitV2": [
{
"timezone": "<string>",
"limitAmount": {
"amountCents": 123
},
"preset": "daily",
"startDate": "<string>"
}
],
"transactionSizeLimit": {
"minimum": {
"amountCents": 123
},
"maximum": {
"amountCents": 123
}
}
}
},
"avsAddress": {
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>"
},
"userData": {}
}