SP Encryption Certificate

SP Encryption Certificate in the Paycux API: the endpoints, the fields they accept and return, and a working request in three languages.

Overview

The SP Encryption Certificate resource is part of the Paycux API. Every field below is returned on every representation of the object, so you can rely on its shape across list, read and write calls.

Field	Type	Notes
id	string	Stable identifier, prefixed per resource type.
object	string	The resource name, useful when handling webhook payloads.
created_at	timestamp	ISO 8601, always UTC.
updated_at	timestamp	ISO 8601, always UTC.

Endpoints

Every endpoint is authenticated with a bearer token and scoped to the environment the key belongs to.

Method	Path	What it does
GET	/connections/:connectionId/saml_sp_encryption_certs	List SP encryption certificates
DELETE	/connections/:connectionId/saml_sp_encryption_certs/:certificateId	Delete an SP encryption certificate

List SP encryption certificates

GET /connections/:connectionId/saml_sp_encryption_certs — list SP encryption certificates.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.list_sp_encryption_certificates();
6console.log(result);

Delete an SP encryption certificate

DELETE /connections/:connectionId/saml_sp_encryption_certs/:certificateId — delete an SP encryption certificate.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.delete_an_sp_encryption_certificate();
6console.log(result);

Errors

Errors return a JSON body with a machine-readable code, a human-readable message and, for validation failures, the offending field.

Status	Code	Meaning
400	invalid_request	A required field is missing or malformed.
401	unauthorized	The API key is missing, revoked, or from another environment.
404	not_found	No record with that ID in this environment.
429	rate_limit_exceeded	Back off and retry after the interval in Retry-After.