Cards
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200Success
application/json
get
/api/users/cards200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstring · uuidRead-onlyRequired
userstring · uuidWrite-onlyRequired
last4stringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
numberstring · max: 30Required
cvvstring · max: 4 · nullableOptional
expiration_monthstring · max: 2Required
expiration_yearstring · max: 4Required
holder_namestring · max: 100Required
is_defaultbooleanOptional
tokenstring · max: 50 · nullableOptional
brandstring · max: 50 · nullableOptional
typestring · enumOptionalPossible values:
token- Tokencard- Cardpayment_profile- Payment Profile
is_hiddenbooleanOptional
processorstring · max: 50 · nullableOptional
gueststring · uuid · nullableOptional
Responses
201Success
application/json
post
/api/users/cards201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200Success
application/json
get
/api/users/cards/{id}200Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
idstring · uuidRead-onlyRequired
userstring · uuidWrite-onlyRequired
last4stringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
numberstring · max: 30Required
cvvstring · max: 4 · nullableOptional
expiration_monthstring · max: 2Required
expiration_yearstring · max: 4Required
holder_namestring · max: 100Required
is_defaultbooleanOptional
tokenstring · max: 50 · nullableOptional
brandstring · max: 50 · nullableOptional
typestring · enumOptionalPossible values:
token- Tokencard- Cardpayment_profile- Payment Profile
is_hiddenbooleanOptional
processorstring · max: 50 · nullableOptional
gueststring · uuid · nullableOptional
Responses
200Success
application/json
put
/api/users/cards/{id}200Success
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
204
No response body
delete
/api/users/cards/{id}204
No response body
No content
patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
idstring · uuidRead-onlyOptional
userstring · uuidWrite-onlyOptional
last4stringRead-onlyOptional
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyOptional
numberstring · max: 30Optional
cvvstring · max: 4 · nullableOptional
expiration_monthstring · max: 2Optional
expiration_yearstring · max: 4Optional
holder_namestring · max: 100Optional
is_defaultbooleanOptional
tokenstring · max: 50 · nullableOptional
brandstring · max: 50 · nullableOptional
typestring · enumOptionalPossible values:
token- Tokencard- Cardpayment_profile- Payment Profile
is_hiddenbooleanOptional
processorstring · max: 50 · nullableOptional
gueststring · uuid · nullableOptional
Responses
200Success
application/json
patch
/api/users/cards/{id}200Success