Returns the fee that will be charged to the customer for the transfer.
amount required | integer <int64> The amount the customer wishes to transfer. |
amountIncludesFee required | boolean Whether or not the amount is inclusive of the fee. |
idNumber | string National identity number of the customer. |
merchantId | string The assigned merchant identifier. Also known as card acceptor ID. |
originatorInstId required | string Identifies the institution from which the transaction originates. Value to be assigned by Electrum. |
receiverId required | string Identifies the service provider to whom this request must be directed. |
senderCell | string The cellphone number of the sender of the funds. This field is required by some providers. This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South Africa number. |
recipientCell | string The cellphone number of the recipient of the funds. This field is required by some providers. This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South Africa number. |
OK
Bad request
Internal Server Error
Not implemented
Service Unavailable
Gateway Timeout
{- "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"
}