Retrieve a credential

Retrieves a credential with a specified ID.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

get
/credentials/{id}
Request samples
$customerCredential = $client->customerCredentials()->load('credentialId');
Responses

200

Credential retrieved.

Response Schema: application/json
id
string <= 50 characters

ID of the credential.

username
required
string

Username associated with the credential.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

expiredTime
string or null <date-time>

Date and time when the credential expires.

Array of objects

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{ "id": "cus_crd_0YV9Y706QGCB39FQD380G1ZHZH", "username": "string", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "expiredTime": "2019-08-24T14:15:22Z", "_links": [ ] }