Multigate
  1. 💸 Payments
Multigate
  • 🚀 Getting Started
  • 🔓 Authentication
    • Get Token
    • Refresh Token
    • Logout User
  • 👋 Onboarding
    • Create Subclient
    • Get All Subclients
    • Get Subclient
    • Update Subclient
    • Create Subclient Shareholder
    • Get Subclient Shareholders
    • Update Subclient Shareholder
    • Upload Subclient Documents
    • Get Subclient Documents
    • Delete Subclient
    • Submit Subclient
  • 💰 Accounts
    • 📄 Statements
      • Get Statement
    • Create Virtual Account
    • Get Account
    • Get Accounts By
    • Get All Accounts
    • Simulate Inflow (UAT only)
  • 🔃 Conversions
    • Get Quote
    • Lock Rate
    • Get Trade
    • Get All Trades
  • 💸 Payments
    • 🏦 Banks
      • Get Bank Details
    • 👤 Beneficiaries
      • Create Beneficiary
      • Get All Beneficiaries
      • Get Beneficiary
      • Update Beneficiary
      • Validate Beneficiary Account (NGN only)
    • Create Single Transfer
      POST
    • Get Purpose Codes
      GET
    • Get Transfer Fields & Fees
      POST
    • Find Transfers
      GET
  • 📩 Webhooks / Push Notifications
    • Add a New Client Configuration
    • Update Client Configuration Current Mode
    • Get Client Configuration
  1. 💸 Payments

Get Transfer Fields & Fees

POST
/payment-service/api/v1/transfer/get-transfer-fee
Transfer
Get required fields and estimated transfer fees for a particular combination of source account, beneficiary, amount and currency.

Request

Body Params application/json
onBehalfOf
string  | null 
optional
sourceBankBicOrCode
string 
required
sourceAccountNumber
string 
required
sourceCurrencyIso3Code
string 
required
sourceCountryIso3Code
string 
required
beneficiaryId
string  | null 
required
Example
{
  "onBehalfOf": "string",
  "sourceBankBicOrCode": "string",
  "sourceAccountNumber": "string",
  "sourceCurrencyIso3Code": "string",
  "sourceCountryIso3Code": "string",
  "beneficiaryId": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-gateway-uat.mmacs.io/platform/payment-service/api/v1/transfer/get-transfer-fee' \
--header 'Content-Type: application/json' \
--data-raw '{
    "onBehalfOf": "string",
    "sourceBankBicOrCode": "string",
    "sourceAccountNumber": "string",
    "sourceCurrencyIso3Code": "string",
    "sourceCountryIso3Code": "string",
    "beneficiaryId": "string"
}'

Responses

🟢200OK
application/json
get fees successfully
Body
data
object 
FeeConfiguredResponse
optional
The actual response data
feeCurrency
string 
required
feeAmount
number 
required
isFeePercentage
boolean 
required
fields
array[object (PaymentMethodFieldMetadata) {4}] 
required
error
object  | null 
optional
Error message if the request failed
Example
{
  "data": {
    "feeCurrency": "string",
    "feeAmount": 0,
    "isFeePercentage": true,
    "fields": [
      {
        "name": "string",
        "isMandatory": true,
        "type": "NUMBER",
        "options": [
          "string"
        ]
      }
    ]
  },
  "error": {}
}
🟠400Bad Request
🟠404Record Not Found
Previous
Get Purpose Codes
Next
Find Transfers
Built with