Create External Credential - Worldpay Billing (WIP)
Express PSP Details
Overview
See below for the request and response details for assigning PSP Credentials to a Skipify Merchant Account.
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/v1/merchant-external-credentials
Production: POST https://merchants.skipify.com/v1/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 | Value: billing |
| systemOfOrigin | yes | string | Value: Worldpay_Billing |
| data | yes | object | an object containing the PSP credentials' parameters |
Request Body Example
{
"merchantId": "string",
"credentialType": "billing",
"systemOfOrigin": "Worldpay_Billing",
"data": {
"billingChainId": "string",
"billingMid": "string"
}
}
API Response
Response Body Parameters
| Parameter Name | Type | Description |
|---|---|---|
| merchantId | string | The Skipify Merchant identifier |
| credentialType | string | The type of credential this is for. This will be 'payment' |
| systemOfOrigin | string | The name of the PSP platform the credentials are associated with |
| data | object | Contains the PSP Credentials sent in the request |
| schemaVersion | integer | The Skipify Schema version this account is associated with |
| isDeleted | Boolean | Flag to indicate if the account has been deleted |
| _id | string | The ID of this configuration |
| credentialId | string | The ID of this credential |
| createdAt | string, dateTime | The created date/time for this merchant Ex: `2024-06-02T21:48:02Z |
| updatedAt | string, dateTime | The created date/time for this merchant Ex: `2024-06-02T21:48:02Z |
| __v | integer | Reserved for future use |
Response Body Example
{
"merchantId": "string",
"credentialType": "payment",
"systemOfOrigin": "string",
"data": {
"billingChainId": "string",
"billingMid": "string"
},
"schemaVersion": 1,
"isDeleted": false,
"_id": "string",
"credentialId": "string",
"createdAt": "2024-04-22T20:46:35.288Z",
"updatedAt": "2024-04-22T20:46:35.288Z",
"__v": 0
}
Updated about 1 month ago