SMsmallcase

Fetch SIP details

The API provides the SIP details for a given iscid. The API provides details like smallcase id (scid), sip active status, frequency, sip amount, sip type, scheduledDate for the next sip etc.

<<apiUseCaseTerm>>: This API is ideal when you want to display SIP related details to the user for an iscid.

get/{gatewayname}/engine/user/sip

Request

  • Base URL
    https://gatewayapi.smallcase.com/v1
  • URL
    https://gatewayapi.smallcase.com/v1/{gatewayname}/engine/user/sip
  • Auth
    none required

Path parameters

gatewaynamestring required

Query parameters

iscidstring required

Required | iscid associated with the user for fetching the SIP details

Headers

x-gateway-secretstring required

Required | apiSecret shared for authentication

x-gateway-authtokenstring required

Required | JWT signed with shared secret & payload for connected user

Response

200

OR

Example response

{
  "success": true,
  "data": {
    "iscid": "5f925629803158cbd206a6aa",
    "scid": "SCET_0010",
    "sipActive": true,
    "scheduledDate": "2021-07-02T00:00:00.000Z",
    "frequency": "1m",
    "amount": 739.52,
    "sipType": "MANUAL",
    "smallcaseAuthToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFsbGNhc2VBdXRoSWQiOiI1ZjkyNTYyMDgwMzE1OGNiZDIwNmE2YTkiLCJpYXQiOjE2MjQ4NjI0MTQsImV4cCI6MTYyNTQ5MjQxNH0.SJpuzpChBGTgLGoamK8oV9uxUNL4B6rjYXyClo5JB3Y"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.