getFeeQuote

Returns the fee that will be charged to the customer for the transfer.

SecurityhttpBasic or oauth2

Request

Request Body schema: application/json

Details necessary to provide a quote.

required	object (Originator) The Originator object encapsulates data relating to the originator of the transaction
required	object (Institution) Originating, acquiring, processing, or receiving institution details
	object (Institution) Originating, acquiring, processing, or receiving institution details
	object (PersonalDetails) Personal details of a customer.
	object (PersonalDetails) Personal details of a customer.
required	object (LedgerAmount) An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
amountIncludesFees required	boolean Default: false Indicates whether the amount in this MoneyTransferQuoteRequest is the amount the sender is willing to pay (false) or the amount the recipient is to receive (true).

Responses

200

400

Bad request

500

Internal Server Error

501

Not implemented

503

Service Unavailable

504

Gateway Timeout

post/admin/fees

Request samples

Payload
curl
Java
Node.js

application/json

{"originator": {"institution": {"id": "string",
"name": "string"
},
"terminalId": "stringst",
"merchant": {"merchantType": "string",
"merchantId": "stringstringstr",
"merchantName": {"name": "string",
"city": "string",
"region": "st",
"country": "st"
}
},
"operatorId": "string",
"channelId": "string"
},
"receiver": {"id": "string",
"name": "string"
},
"settlementEntity": {"id": "string",
"name": "string"
},
"senderDetails": {"firstName": "string",
"lastName": "string",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"province": "string",
"country": "st",
"postCode": "string"
},
"idNumber": "string",
"idType": "NATIONAL_ID",
"idCountryCode": "st",
"nationality": "st",
"countryOfBirth": "st",
"dateOfBirth": "string",
"contactNumber": "string",
"altContactWork": "string",
"altContactHome": "string",
"email": "string",
"accountDetails": {"accountId": "string",
"type": "ACCOUNT"
},
"idIssuedDate": "2019-08-24T14:15:22Z",
"idExpiryDate": "2019-08-24T14:15:22Z",
"culturalName": "string",
"sourceOfIncome": "SALARIED",
"occupation": "BUSINESSMAN"
},
"recipientDetails": {"firstName": "string",
"lastName": "string",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"province": "string",
"country": "st",
"postCode": "string"
},
"idNumber": "string",
"idType": "NATIONAL_ID",
"idCountryCode": "st",
"nationality": "st",
"countryOfBirth": "st",
"dateOfBirth": "string",
"contactNumber": "string",
"altContactWork": "string",
"altContactHome": "string",
"email": "string",
"accountDetails": {"accountId": "string",
"type": "ACCOUNT"
},
"idIssuedDate": "2019-08-24T14:15:22Z",
"idExpiryDate": "2019-08-24T14:15:22Z",
"culturalName": "string",
"sourceOfIncome": "SALARIED",
"occupation": "BUSINESSMAN"
},
"amount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"amountIncludesFees": false
}

Response samples

application/json

{"originator": {"institution": {"id": "string",
"name": "string"
},
"terminalId": "stringst",
"merchant": {"merchantType": "string",
"merchantId": "stringstringstr",
"merchantName": {"name": "string",
"city": "string",
"region": "st",
"country": "st"
}
},
"operatorId": "string",
"channelId": "string"
},
"receiver": {"id": "string",
"name": "string"
},
"settlementEntity": {"id": "string",
"name": "string"
},
"feeQuote": {"feeAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"transferAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"senderAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"recipientAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"exchangeRate": {"rate": 0,
"fromCurrency": "string",
"toCurrency": "string"
},
"totalAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
}
},
"senderDetails": {"firstName": "string",
"lastName": "string",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"province": "string",
"country": "st",
"postCode": "string"
},
"idNumber": "string",
"idType": "NATIONAL_ID",
"idCountryCode": "st",
"nationality": "st",
"countryOfBirth": "st",
"dateOfBirth": "string",
"contactNumber": "string",
"altContactWork": "string",
"altContactHome": "string",
"email": "string",
"accountDetails": {"accountId": "string",
"type": "ACCOUNT"
},
"idIssuedDate": "2019-08-24T14:15:22Z",
"idExpiryDate": "2019-08-24T14:15:22Z",
"culturalName": "string",
"sourceOfIncome": "SALARIED",
"occupation": "BUSINESSMAN"
},
"recipientDetails": {"firstName": "string",
"lastName": "string",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"province": "string",
"country": "st",
"postCode": "string"
},
"idNumber": "string",
"idType": "NATIONAL_ID",
"idCountryCode": "st",
"nationality": "st",
"countryOfBirth": "st",
"dateOfBirth": "string",
"contactNumber": "string",
"altContactWork": "string",
"altContactHome": "string",
"email": "string",
"accountDetails": {"accountId": "string",
"type": "ACCOUNT"
},
"idIssuedDate": "2019-08-24T14:15:22Z",
"idExpiryDate": "2019-08-24T14:15:22Z",
"culturalName": "string",
"sourceOfIncome": "SALARIED",
"occupation": "BUSINESSMAN"
},
"quoteId": "string",
"expiryDateTime": "2019-08-24T14:15:22Z"
}