Skip to main content
Version: 1.0.2

Credit Transfer Inbound

The CreditTransferInbound method enables to process the Inbound Transactions (CCT_IN)

Method: InboundServiceClient:CreditTransferInbound

Metadata

NameValue
Credential"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature"{{signature}}"

Example

Payload Parameters
ParameterDescription

creditorAccount

Mandatory

Object

accountNumber

Mandatory

String

Account number of the beneficiary

Example – "123457890"

address

Optional

(Applicable only for FedNow)

Object

streetName

Optional

String

Street name of the sender address

Example – "Lakeland Terrace"

buildingNo

Optional

String

Building number of the sender address

Example – "1294"

postBox

Optional

String

Post box number of the sender address

Example – "48185"

postalCode

Optional

String

Postal code of the sender address

Example – "48185"

room

Optional

String

Room number of the sender address

Example – "1055"

townName

Optional

String

Town name of the sender address

Example – "Michigan"

countrySubDiv

Optional

String

Code of a subdivision which can be a state, province, or region

Example – "WL"

country

Optional

String

Country code of the sender address

Example – "US"

memberId

Mandatory

String

Routing numer of the beneficiary bank/financial institution

Example – "101115315"

name

Mandatory

String

Name of the beneficiary

Example – "John"

debtorAccount

Mandatory

Object

accountNumber

Mandatory

String

Account number of the sender

Example – "123457890"

address

Optional

(Applicable only for FedNow)

Object

streetName

Optional

String

Street name of the sender address

Example – "Lakeland Terrace"

buildingNo

Optional

String

Building number of the sender address

Example – "1294"

postBox

Optional

String

Post box number of the sender address

Example – "48185"

postalCode

Optional

String

Postal code of the sender address

Example – "48185"

room

Optional

String

Room number of the sender address

Example – "1055"

townName

Optional

String

Town name of the sender address

Example – "Michigan"

countrySubDiv

Optional

String

Code of a subdivision which can be a state, province, or region

Example – "WL"

country

Optional

String

Country code of the sender address

Example – "US"

memberId

Mandatory

String

Routing numer of the sender bank/financial institution

Example – "987654321"

name

Mandatory

String

Name of the sender

Example – "Steve"

endToEndId

Mandatory

String

ID that enables to trace the transaction at any time during the process

Example – "EOTS"

instructedAmount

Mandatory

Object

amount

Mandatory

Number

Amount of transaction

Example – 20100

currency

Mandatory

String

Currency code in which the transaction happens

Example – "USD"

instructingID

Mandatory

String

Payment reference ID of the transaction

Example – "20231026990000001T1BTTST57395911389"

instrumentProp

Mandatory

(Applicable only for TCH)

String

Proprietary code of Instant payment

Example – "STANDARD"

msgID

Mandatory

String

Unique message identifier to identify the pacs.008 message

Example – "M20231026990000001T1BTST57395911389"

processor

Mandatory

String

Payment channel through which the transaction happens

Example – "TCH"

rawMessage

Mandatory

String

Raw response message encoded in Base64

Example – "Base64 encoded data for received xml message"

referenceNumber

Mandatory

String

Reference number of the transaction

Example – "M202311099876665149078836456"

settlementDate

Mandatory

(Applicable only for FedNow)

String

Date and time of the transaction was completed

Example – "2024-04-01"

SenderType

Mandatory

(Applicable only for TCH)

String

Type of customer

Example – "CONSUMER"

transactionID

Mandatory

String

Unique ID generated for the transaction

Example – "20231026101115315T1BTTST74395911389"

transactionType

Mandatory

String

Type of the transaction

Example – "TCH_CCT_IN" or "FED_CCT_IN"

uuid

Mandatory

String

Unique ID present in the message

Example – "ca974bcb-50f7-4791-b2c5-884303933ebc"

Request Body (Applicable for both FedNow and TCH)


{
"creditorAccount": {
"accountNumber": "123457890",
"address": { //applicable only for FedNow
"streetName": "Barnes Street",
"buildingNo": "4518",
"postBox": "328221111",
"postalCode": "32822",
"room": "5444",
"townName": "Florida",
"countrySubDiv": "OL",
"country": "US"
},
"memberId": "101115315",
"name": "John"
},
"debtorAccount": {
"accountNumber": "123457890",
"address": { //applicable only for FedNow
"streetName": "Barnes Street",
"buildingNo": "4518",
"postBox": "328221111",
"postalCode": "32822",
"room": "5444",
"townName": "Florida",
"countrySubDiv": "OL",
"country": "US"
},
"memberId": "987654321",
"name": "Steve"
},
"endToEndID": "EOTS",
"instructedAmount": {
"amount": 20100,
"currency": "USD"
},
"instructingID": "20231026990000001T1BTTST57395911389",
"instrumentProp": "STANDARD", //applicable only for TCH
"msgID": "M20231026990000001T1BTST57395911389",
"processor": "TCH",
"rawMessage": "Base64 encoded data for received xml message",
"referenceNumber": "M20231026990000001T1BTST57395911389",
"settlementDate": "2024-04-01", //applicable only for FedNow
"senderType": "CONSUMER", //applicable only for TCH
"transactionID": "20231026101115315T1BTTST74395911389",
"transactionType": "TCH_CCT_IN",
"uuid": "ca974bcb-50f7-4791-b2c5-884303933ebc"
}

Response

Response Parameters
ParameterDescription

referenceNumber

String

Reference number of the transaction

Example – "M20231026990000001T1BTST57395911389"

reason

String

Reason code for rejection

Example – "AC03"

status

String

Status of the transaction

Example – "ACTC"

Possible values: "ACTC", "ACWP", "RJCT"

transactionType

String

Type of the transaction

Example – "TCH_CCT_IN" or "FED_CCT_IN"

Response Body (Applicable for both FedNow and TCH)


//Response for Status "Accepted"
{
"referenceNumber": "M20231026990000001T1BTST57395911389",
"status": "ACTC",
"transactionType": "TCH_CCT_IN"
}
//Response for Status "Accepted with Pending"
{
"referenceNumber": "202404010000000059MEWR6U78Oi3oPx",
"status": "ACWP",
"transactionType": "TCH_CCT_IN"
}
//Response for Status "Rejected"
{
"reason": "AC03",
"referenceNumber": "M20231026990000001T1BTST57395911389",
"status": "RJCT",
"transactionType": "TCH_CCT_IN"
}