Response Fields of Receive Endpoints

This document outlines the specifications for the response fields associated with the receive endpoints of the IC API. It includes field names, descriptions, and maximum character lengths critical for understanding the data structure returned when receiving transactions through the API.

Response fields for: Get Outstanding Remittance

Field	Data type	MaxLimit
reference	string	9
partnerReference	string	20
payingAgentCorrespondentId	string	6
payingAgentName	string	35
payingAmount	double	14,3
payingCurrency	string	3
commissionAmount	double	18,9
settlementAmount	double	14,3
settlementRate	double	18,9
remittancePurpose	string	100
deliveryMode	string	30
originatingCountry	string	2
destinationCountry	string	2
messagePayeeBranch	string	100
sourceOfFunds	string	50
sentAt	date-time	8
remitter object
cardNo	string	8
firstName	string	50
lastName	string	50
middleName	string	50
phoneNumber	string	25
mobileNumber	string	20
dateOfBirth	date-time	8
countryOfBirth	string	2
nationality	string	2
address object
addressLine1	string	105
addressLine2	string	35
district	string	20
city	string	35
postCode	string	10
state	string	100
country	string	2
idDetails object
type	int32	2
number	string	20
issueDate	date-time	8
expiryDate	date-time	8
placeOfIssue	string	2
beneficiary object
firstName	string	50
lastName	string	50
middleName	string	50
phoneNumber	string	25
mobileNumber	string	15
dateOfBirth	date-time	8
nationality	string	2
expectedId	string	60
relationship	string	50
address object
addressLine1	string	105
addressLine2	string	35
district	string	20
city	string	35
postCode	string	10
state	string	100
country	string	2
idDetails object
type	int32	2
number	string	20
issueDate	date-time	8
expiryDate	date-time	8
placeOfIssue	string	2

Response fields for: Confirm a transaction

Field	Data type	MaxLimit
reference	string	9
status	string	5
statusDescription	string	50

Response fields for: Get ICTC payment status

Field	Data type	MaxLimit
reference	string	9
status	string	1
statusDescription	string	30
payingAgentCorrespondentId	string	6
payingAgentName	string	35
sentAt	date-time	8

Response fields for: Receive Payment

Field	Data type	MaxLimit
reference	string	9
partnerReference	string	20
payingCurrency	string	3
payingAmount	double	14,3
payingAgentCorrespondentId	string	6
payingAgentName	string	35
payingAgentCommShare	double	18,9
settlementCurrency	string	3
settlementAmount	double	14,3
settlementRate	double	18,9
deliveryMode	string	30
originatingCountry	string	20
destinationCountry	string	20
remittancePurpose	string	100
messagePayeeBranch	string	100
sourceOfFunds	string	50
sentAt	date-time	8
remitter object
cardNo	string	8
firstName	string	50
middleName	string	50
lastName	string	50
mobileNumber	string	20
phoneNumber	string	25
dateOfBirth	date-time	8
countryOfBirth	string	2
nationality	string	30
nationalityCountryCode	string	2
address object
addressLine1	string	105
addressLine2	string	35
district	string	20
city	string	35
postCode	string	10
state	string	100
country	string	2
idDetails object
type	int32	2
number	string	20
issueDate	date-time	8
expiryDate	date-time	8
placeOfIssue	string	2
beneficiary object
firstName	string	50
middleName	string	50
lastName	string	50
phoneNumber	string	25
mobileNumber	string	15
dateOfBirth	date-time	8
nationality	string	30
nationalityCountryCode	string	2
relationship	string	50
expectedBenefId	string	60
address object
addressLine1	string	105
addressLine2	string	35
district	string	20
city	string	35
postCode	string	10
state	string	100
country	string	2
idDetails object
type	int32	2
number	string	20
issueDate	date-time	8
expiryDate	date-time	8
placeOfIssue	string	2

Response fields for: Unlock a transaction

Field	Data type	MaxLimit
reference	string	9

Response fields for: Get Transaction Report

Field	Data type	MaxLimit
reference	string	9
partnerReference	string	20
customerPrincAmount	double	14,3
foreignCurrencyAmount	double	14,3
deliveryMode	string	30
payingCurrency	string	3
settlementAmount	double	14,3
settlementRate	double	18,9
receivingAgentCode	string	6
receivingAgentName	string	35
transactionType	string	1
transactionStatus	string	1
transactionStatusDescription	string	30
originatingCountry	string	2
remittancePurpose	string	2
messagePayeeBranch	string	100
payingAgentCommisionShareAmount	double	18,9
percentageRefundCommision	double	14,3
totalCommission	double	18,9
transactionDate	date-time	8
transactionCancelDate	date-time	8
agentExchangeEarning	double	14,3
icExchangeEarning	double	14,3
agent object
agentCorrespondentId	string	6
agentName	string	30
agentUserId	string	15
agentBranchCode	string	20
remitter object
name	string	152
address	string	105
mobileNumber	string	25
phoneNumber	string	20
primaryIdType	int32	2
primaryIdNumber	string	20
beneficiary object
name	string	152
address	string	105
country	string	35
mobileNumber	string	15
phoneNumber	string	25
bankAccountNumber	string	20
bankAddress	string	60
bankName	string	100