Overview

Use this method if you did not assign credentials to a merchant account when you created it, or if you need to Update External Credentials on a merchant account.

*The request will have different parameters in the request body for each PSP. Please work with your Skipify Implementation Engineer to review the documentation for the specific PSP for your accounts.

👍
This endpoint uses HMAC with SHA-256
Check out our API Authentication section to learn more

To Add External Credentials to a Skipify Merchant Account, send an API call to:

Staging: POST https://stage-merchants.skipify.com/merchant-external-credentials

Production: POST[ https://merchants.skipify.com/merchant-external-credentials](** https://merchants.skipify.com/merchant-external-credentials)

Request Body Parameters

Parameter Name	Required	Type	Description
merchantId	yes	string	The MerchantId for the merchant you are assigning credentials to
credentialType	yes	string	The type of credential being assigned, for this use case the value is Payment
systemOfOrigin	yes	string	The PSP system of Origin the credentials belong to. i.e. - Express
data	yes	object	an object containing the PSP credentials' parameters

Request Body Example

{
    "merchantId": "string",
    "credentialType": "payment",
    "systemOfOrigin": "string",
    "data": {
        "credentialName1": "string",
        "credentialName2": "string",
        "...": "string",
        "...": "string"
    }
}

API Response

Response Body Parameters

Parameter Name	Type	Description/Value
merchantId	string	The Skipify Merchant identifier
credentialType	string	payment
systemOfOrigin	string	The PSP platform for these credentials
data	object	An object containing the credentials set
schemaVersion	integer	The version of this schema
isDeleted	string, nullable	This message will be populated if there was an error processing the capture
_id	string	The ID of this request
credentialId	string	The ID of this Credential
createdAt	string, dateTime	The created date/time for this credential Ex: `2024-06-02T21:48:02Z
updatedAt	string, dateTime	The update date/time for this credential Ex: `2024-06-02T21:48:02Z
_v	integer	Version

Response Body Example

{
    "merchantId": "string",
    "credentialType": "payment",
    "systemOfOrigin": "string",
    "data": {
			  "credentialName1": "string",
        "credentialName2": "string",
        "...": "string",
        "...": "string"
    },
    "schemaVersion": 1,
    "isDeleted": false,
    "_id": "string",
    "credentialId": "string",
    "createdAt": "2024-05-03T16:32:07.425Z",
    "updatedAt": "2024-05-03T16:32:07.425Z",
    "__v": 0
}

Update Default Credential **Important - this is required if you have are updating to new External Credentials

👍
This endpoint uses HMAC with SHA-256
Check out our API Authentication section to learn more

To Activate External Payment Credentials to a Skipify Merchant Account, send an API call to:

Staging: PATCH https://stage-merchants.skipify.com/merchants/{merchantId}/external-credentials

Production: PATCHhttps://merchants.skipify.com/merchants/{merchantId}/external-credentials

Request Body Parameters

Parameter Name	Required	Type	Description
payment	yes	string	The CredentialID of the payment credential you just created

Request Body Example

{
"payment": "string"
}

API Response

Response Body Parameters

Parameter Name	Type	Description/Value
payment	string	The Credential ID that was updated to the default

Response Body Example

{
    "payment": "string"
}