Custom Gateway API Endpoint
Paths
/v1/paymentInitiation/repeatingPayments
This API makes an inquiry of SI of specific payement transfer type
This API makes an inquiry of SI of specific payement transfer type
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
This defines the type of payment made by customer for which SI needs to be enabled.This is a reference data field. Please use /v1/utilities/referenceData/{paymentType} resource to get valid value of this field with description.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
No content
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| error | resourceNotFound | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
Definitions
{
"properties": {
"transactionReferenceId": {
"description": "The unique SI reference Id used to identify the payee type/ transfer from all the other transfers",
"type": "string",
"example": "BIMI51807310002051"
},
"displayAccountNumber": {
"description": "A masked account number that can be displayed to the customer",
"type": "string",
"example": "XXXXXX2391"
},
"accountId": {
"description": "The account identifier in encrypted format.Typically, this is not displayed to the customer.",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"transactionAmount": {
"description": "Transaction amount in local currency.",
"type": "number",
"format": "float",
"example": 4500.25
},
"payee": {
"description": "The payee name with which this transfer was made with",
"type": "string",
"example": "John Smith"
},
"futureDatedTransaction": {
"$ref": "#/definitions/FutureDatedTransaction"
},
"standingInstruction": {
"$ref": "#/definitions/StandingInstruction"
},
"nextPaymentDate": {
"description": "Next Transfer transaction date in ISO 8601 date format YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": 1483228800000
},
"nextStartIndex": {
"description": "In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data.",
"type": "string",
"example": 11
},
"paymentType": {
"description": "This defines the type of payment made by customer for which SI needs to be enabled.",
"type": "string",
"example": "ALL"
},
"remarks": {
"description": "Bill payment notes. Free text from screen.",
"type": "string",
"example": "Free Text"
}
},
"required": [
"transactionReferenceId",
"displayAccountNumber",
"accountId",
"transactionAmount",
"payee"
]
}
{
"properties": {
"scheduleDate": {
"description": "Date on which the set amount will be transferred . Date in ISO 8601 date format YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": 1483228800000
}
},
"required": [
"scheduleDate"
]
}
{
"properties": {
"standingInstructionStartDate": {
"description": "Standing instruction start date in ISO 8601 format YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": 1483228800000
},
"paymentFrequency": {
"description": "The frequency of payment. This is a reference data.Please use /v1/utilities/referenceData/{paymentFrequency} resource to get valid value of this field.",
"type": "string",
"example": "MONTHLY"
},
"standingInstructionEndDate": {
"description": "Standing instruction end date in ISO 8601 date format YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": 1483228800000
},
"perpetualFlag": {
"description": "Flag to indicate if the standing instruction will be continued until cancellation.",
"type": "boolean",
"example": true
}
},
"required": [
"standingInstructionStartDate",
"paymentFrequency"
]
}
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}