Skip to main content

Class CreditTransferAPIResponse


Successful Response

If successful, the response body contains a newly created instance of CreditTransfer

NameTYPEREQUIREDDescription
IdstringYesUnique EndToEndId generated (which is set in the Pacs008 request), it acts as a reference for the transaction.

CreditTransfer.Id
StatusstringYesStatus of the Transaction

Enum values: Pending

Pending - Successfully submit the RTP transaction to RTP Network. It’s an Ack.

Rule: Intimation of successful posting the transaction to Recipient via EES events.

CreditTransfer.Status
Other fields in the ResponsestringThe remaining fields are replica of request (CreditTransfer) which is received. Refer the field's description in "Request body" section above.

Failure Response

If failure, the response body contains a newly created instance of

NameTYPEREQUIREDDescription
MessagestringYesFree text. Error Message

CreditTransfer.Message
CodeStringYesError code

CreditTransfer.Code
DescriptionstringYesError description

CreditTransfer.Description

Successful Response : JSON representation

{
"CreditTransfer": {
"Id": string,
"Status": string,
"Debtor": {
"AccountNumber": string,
"UltimateDebtor": {
"Name": string
}
},
"Creditor": {
"Name": string,
"RoutingNumber": string,
"AccountNumber": string,
"UltimateCreditor": {
"Name": string
}
},
"CreditTransferDescription": {
"Amount": number,
"OriginatorType": enum (type),
"UserName": string,
"Notes": string
}
}
}

Failure Response : JSON representation

{
"CreditTransfer": {
"Message": string,
"Error": {
"Code": string,
"Description": string
}
}
}

Sample Response : Success Scenario

{
"CreditTransfer": {
"Id": "123456789-RTP-FVSKL13986",
"Status": "Pending",
"Debtor": {
"AccountNumber": "123456798"
},
"Creditor": {
"Name": "Jace Taylor",
"RoutingNumber": "111222333",
"AccountNumber": "987654321"
},
"CreditTransferDescription": {
"Amount": 50.13,
"OriginatorType": "CONSUMER",
"UserName": "RTPUATUser",
"Notes": " This is test transaction"
}
}
}

Sample Response : Error Scenario

{
"CreditTransfer": {
"Message": "Validation failed",
"Error": {
"Code": "70015",
"Description": "Category purpose is either invalid or empty (allowed values are CONSUMER and BUSINESS)"
}
}
}