production
development
https://emea.sit.api.citi.com/gcb
Custom Gateway API Endpoint
Paths
/v1/paymentInitiation/repeatingPayments/preprocess
post /v1/paymentInitiation/repeatingPayments/preprocess
Payments
This API shows the pre process page for customer to update Standing instructions for a specific transfer type/ payee type
This API shows the pre process page for customer to update Standing instructions for a specific transfer type/ payee type
Authorization
Required in header
string
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
Required in header
string
128 bit random UUID generated uniquely for every request.
Accept
Required in header
string
Content-Type that are acceptable for the response.
client_id
Required in header
string
Client ID generated during application registration.
Content-Type
Required in header
string
application/json
clientDetails
Optional in header
string
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
UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocessRequest
Required in body
object
UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocessRequest
200
Successful operation.
400
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters | invalid | invalidTransactionAmount | Transaction amount is invalid |
| invalid | invalidSourceAccount | Source account is invalid |
| invalid | invalidAccountTransactionReferenceCombination | Invalid Account and reference id combination |
| invalid | invalidDateRange | Date range is invalid |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | mfaRequired | MFA is required |
404
| Type | Code | Details |
| error | resourceNotFound | Empty resource/resource not found |
422
| Type | Code | Details | error | buzinessValidationFailed | Buziness Validation Failed |
| error | transactionPendingReview | Transaction pending under review |
| error | transactionDenied | Transaction is denied |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
Example Request
Example Response
POST https://emea.sit.api.citi.com/gcb/api/v1/paymentInitiation/repeatingPayments/preprocess
Definitions
{
"properties": {
"accountId": {
"description": "The account identifier in encrypted format.Typically, this is not displayed to the customer.",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"paymentMethod": {
"description": "The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use \t /v1/utilities/referenceData/{paymentMethod} resource to get valid value of this field with description",
"type": "string",
"example": "FasterPayments"
},
"bankSortCode": {
"description": "This is specific to UK",
"type": "string",
"example": "30-00-81"
},
"transactionReferenceId": {
"description": "The unique SI reference Id used to identify the payee type/ transfer from all the other transfers",
"type": "string",
"example": "BIMI51807310002051"
},
"transactionAmount": {
"description": "Transaction amount in local currency.",
"type": "number",
"format": "double",
"example": "4500.25"
},
"futureDatedTransaction": {
"$ref": "#/definitions/FutureDatedTransaction"
},
"standingInstruction": {
"$ref": "#/definitions/StandingInstruction"
},
"remarks": {
"description": "Bill payment notes. Free text from screen.",
"type": "string",
"example": "Free text"
}
},
"required": [
"accountId",
"paymentMethod",
"transactionReferenceId"
]
}
{
"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": "2020-12-22"
}
},
"required": [
"scheduleDate"
]
}
{
"properties": {
"standingInstructionStartDate": {
"description": "Standing instruction start date in ISO 8601 format YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2020-12-22"
},
"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"
},
"perpetualFlag": {
"description": "Flag to indicate if the standing instruction will be continued until cancellation.",
"type": "boolean",
"example": "True"
},
"standingInstructionEndDate": {
"description": "Standing instruction end date in ISO 8601 date format YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2020-12-22"
}
}
}
{
"properties": {
"controlFlowId": {
"description": "This is control Flow id for next API",
"type": "string"
},
"debitDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/DebitDetails"
}
},
"creditDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/CreditDetails"
}
},
"foreignExchangeRate": {
"description": "Exchange rate",
"type": "number",
"format": "double",
"example": "1.1021"
},
"transactionFee": {
"description": "Transaction fee",
"type": "number",
"format": "double",
"example": "500.25"
},
"feeCurrencyCode": {
"description": "This is fee currency code in ISO 4217 format.",
"type": "string",
"example": "USD"
}
},
"required": [
"controlFlowId"
]
}
{
"properties": {
"transactionDebitAmount": {
"description": "The transaction debit amount.",
"type": "number",
"format": "double",
"example": "4500.25"
},
"currencyCode": {
"description": "The currency code for the debit amount in ISO 4217",
"type": "string",
"example": "EUR"
}
}
}
{
"properties": {
"transactionCreditAmount": {
"description": "The transaction credit amount",
"type": "number",
"format": "double",
"example": "19178.72"
},
"currencyCode": {
"description": "The currency code for the credit amount in ISO 4217",
"type": "string",
"example": "PLN"
}
}
}
{
"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"
]
}