production
development
https://emea.sit.api.citi.com/gcb
Custom Gateway API Endpoint
Paths
/v1/paymentInitiation/multipleTransfers/async
post /v1/paymentInitiation/multipleTransfers/async
Payments
Execute Multiple Transfers
This API will accept multiple transfers and process them in async mode
To use this operation you must use one of the following sets of security requirements.
API Key
X-IBM-Client-Id
(apiKey located in header)
API Key (Query)
client_id
(apiKey located in query)
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
ExecutePaymentInitiationTransactionMultipleTransfersAsyncRequest
Required in body
object
ExecutePaymentInitiationTransactionMultipleTransfersAsyncRequest
200
Successful operation.
201
| Type | Code | Details |
| Created |
400
| error | InvalidRequest | Missing or invalid Parameters |
| error | InvalidRequest | Invalid source account |
| error | InvalidRequest | Invalid payee id |
401
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| error | accessNotConfigured | The request operation is not configured to access this resource |
404
| Type | Code | Details |
| error | resourceNotFound | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
500
| fatal | serverUnavailable | The request failed due to an internal error |
| 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/multipleTransfers/async
Definitions
{
"properties": {
"bundleId": {
"description": "This is bundle id or unique identifier for bulk transfers",
"type": "string",
"example": 89789789
},
"totalTransferAmount": {
"description": "This is total transfer amount",
"type": "number",
"format": "double",
"example": 100
},
"transferType": {
"description": "This is type of transfers",
"type": "string",
"example": "INTERNAL"
},
"internalDomesticPayments": {
"type": "array",
"items": {
"$ref": "#/definitions/InternalDomesticPayments"
}
},
"externalDomesticPayments": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalDomesticPayments"
}
}
}
}
{
"properties": {
"sourceAccountId": {
"description": "The source account identifier in encrypted format.Typically, this is not displayed to the customer.",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"transactionAmount": {
"description": "Refers to the total amount of the transaction.This includes all the fee and charges.",
"type": "number",
"format": "double",
"example": 4500.25
},
"transferCurrencyIndicator": {
"description": "Indicator to specify whether the transfer is in source or destination account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/apac/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. You can use transferCurrencyIndicator as the referenceCode parameter to retrieve the values",
"type": "string",
"example": "SOURCE_ACCOUNT_CURRENCY"
},
"payeeId": {
"description": "The payee identifier in encrypted format.Typically, this is not displayed to the customer.",
"type": "string",
"example": "C$0003019202$AU$XX$01000540000001"
},
"chargeBearer": {
"description": "Field to identify charge bearer.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/apac/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. You can use chargeBearer as the referenceCode parameter to retrieve the values",
"type": "string",
"example": "BENEFICIARY"
},
"foreignExchangeReferenceNumber": {
"description": "Fx deal reference number",
"type": "string",
"example": 12345678
},
"remarks": {
"description": "Payment notes. Free text from screen$$O",
"type": "string"
},
"transferPurpose": {
"description": "Purpose of transfer. Applicable if paymentMethod is GIRO, FAST. This is a reference data field.This is a reference data field. Please use /v1/apac/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. You can use transferPurpose as the referenceCode parameter to retrieve the values.",
"type": "string",
"example": "CASH_DISBURSEMENT"
},
"futureDatedTransaction": {
"$ref": "#/definitions/FutureDatedTransaction"
},
"standingInstruction": {
"$ref": "#/definitions/StandingInstruction"
},
"paymentScheduleType": {
"description": "From various Option Support - CVT table. - Immediate - FutureDated ( Date Selection ) - Future Dated Recurring ( Date Selection and Frequency - Last Date ) for Poland only Immediate and One Time Future Dated",
"type": "string",
"example": "IMMEDIATE"
},
"anticipatoryPaymentFlag": {
"description": "This indicator will be sent by channel and help differentiate if payment is normal or anticipatory",
"type": "boolean",
"example": "True, False"
}
},
"required": [
"sourceAccountId",
"transferCurrencyIndicator",
"payeeId"
]
}
{
"properties": {
"scheduleDate": {
"description": "Date on which the future transaction is scheduled in ISO 8601 format YYYY-MM-DD.$$M",
"type": "string",
"format": "date"
}
},
"required": [
"scheduleDate"
]
}
{
"properties": {
"standingInstructionStartDate": {
"description": "Date on which Future transaction will be executed / Initiated",
"type": "string",
"format": "date",
"example": 43084
},
"paymentFrequency": {
"type": "string",
"format": "date",
"example": 43084
},
"perpetualFlag": {
"description": "standingInstruction This will be mandatory when Payment Schedule Type is Future Dated Recurring.$$O",
"type": "boolean"
},
"standingInstructionEndDate": {
"description": "Standing instruction start date in ISO 8601 format YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": 43084
},
"standingInstructionCount": {
"description": "This is no of payments instructed to be made by customer from start Date",
"type": "number",
"format": "double",
"example": 8
}
},
"required": [
"standingInstructionEndDate"
]
}
{
"properties": {
"sourceAccountId": {
"description": "The source account identifier in encrypted format.Typically, this is not displayed to the customer.",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"transactionAmount": {
"description": "Transaction Amount",
"type": "number",
"format": "double",
"example": 10
},
"transferCurrencyIndicator": {
"description": "Indicator to specify whether the transfer is in source or destination account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description.\",",
"type": "string",
"example": "F"
},
"payeeId": {
"description": "The payee identifier in encrypted format.Typically, this is not displayed to the customer.",
"type": "string"
},
"chargeBearer": {
"description": "Field to identify charge bearer.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description.\",",
"type": "string",
"example": "BENEFICIARY"
},
"paymentMethod": {
"description": "The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{paymentMethod} resource to get valid value of this field with description.\",",
"type": "string",
"example": "GIRO"
},
"foreignExchangeReferenceNumber": {
"description": "Fx deal reference number",
"type": "string",
"example": 123456
},
"remarks": {
"description": "Payment notes. Free text from screen\"",
"type": "string"
},
"transferPurpose": {
"description": "Purpose of transfer. Applicable if paymentMethod is GIRO, FAST. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description.",
"type": "string"
},
"transferSubPurpose": {
"description": "Sub Purpose Of Transfer",
"type": "string",
"example": "REFERENCE"
},
"paymentScheduleType": {
"description": "From various Option Support - CVT table. - Immediate - FutureDated ( Date Selection ) - Future Dated Recurring ( Date Selection and Frequency - Last Date ) for Poland only Immediate and One Time Future Dated",
"type": "string"
},
"futureDatedTransaction": {
"$ref": "#/definitions/FutureDatedTransaction"
},
"standingInstruction": {
"$ref": "#/definitions/StandingInstruction"
},
"anticipatoryPaymentFlag": {
"description": "anticipatory paymentFlag",
"type": "boolean"
},
"paymentId": {
"description": "this is free text unique value. This is end to end identification ID",
"type": "string"
}
},
"required": [
"sourceAccountId",
"transactionAmount",
"transferCurrencyIndicator",
"payeeId",
"chargeBearer",
"paymentMethod"
]
}
{
"properties": {
"transactionStatus": {
"description": "This is transaction status",
"type": "string"
},
"tppBundleId": {
"description": "This is bundle/ bulk id of the transactions from TPP",
"type": "string"
},
"citiBundleId": {
"description": "This is bundle/ bulk id of the transactions from Citi",
"type": "string"
},
"totalTransactionCount": {
"description": "This is total number of transactions",
"type": "string"
}
}
}
{
"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"
]
}