Initiate Remittance
POST
/payment-service/api/v1/transfer/remittance
Request
Body Params application/json
sourceAccountNumber
string
required
currencyIso3Code
string
required
amount
number <double>
required
narration
string
required
uniqueRequestId
string
required
sender
object
required
firstName
string
required
lastName
string
required
middleName
string
optional
phoneNumber
string
optional
emailAddress
string
optional
address
string
optional
addressLine1
string
optional
addressLine2
string
optional
city
string
optional
state
string
optional
countryIso3Code
string
optional
bvn
string
optional
beneficiary
object
required
accountNumber
string
required
accountName
string
required
bankName
string
optional
bankBicOrCode
string
required
firstName
string
optional
lastName
string
optional
middleName
string
optional
phoneNumber
string
optional
emailAddress
string
optional
addressLine1
string
optional
addressLine2
string
optional
city
string
optional
state
string
optional
countryIso3Code
string
required
bvn
string
optional
Example
{
"sourceAccountNumber": "string",
"currencyIso3Code": "string",
"amount": 0,
"narration": "string",
"uniqueRequestId": "string",
"sender": {
"firstName": "string",
"lastName": "string",
"middleName": "string",
"phoneNumber": "string",
"emailAddress": "string",
"address": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"countryIso3Code": "string",
"bvn": "string"
},
"beneficiary": {
"accountNumber": "string",
"accountName": "string",
"bankName": "string",
"bankBicOrCode": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"phoneNumber": "string",
"emailAddress": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"countryIso3Code": "string",
"bvn": "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/remittance' \
--header 'Content-Type: application/json' \
--data-raw '{
"sourceAccountNumber": "string",
"currencyIso3Code": "string",
"amount": 0,
"narration": "string",
"uniqueRequestId": "string",
"sender": {
"firstName": "string",
"lastName": "string",
"middleName": "string",
"phoneNumber": "string",
"emailAddress": "string",
"address": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"countryIso3Code": "string",
"bvn": "string"
},
"beneficiary": {
"accountNumber": "string",
"accountName": "string",
"bankName": "string",
"bankBicOrCode": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"phoneNumber": "string",
"emailAddress": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"countryIso3Code": "string",
"bvn": "string"
}
}'Responses
🟢200OK
application/json
Body
message
string
required
data
object
required
status
string
optional
sourceAccountNumber
string
optional
currencyIso3Code
string
optional
amount
string
optional
narration
string
optional
uniqueRequestId
string
optional
transactionId
string
optional
sender
object
optional
beneficiary
object
optional
session
object
optional
Example
{
"message": "string",
"data": {
"status": "string",
"sourceAccountNumber": "string",
"currencyIso3Code": "string",
"amount": "string",
"narration": "string",
"uniqueRequestId": "string",
"transactionId": "string",
"sender": {
"firstName": "string",
"lastName": "string",
"middleName": "string",
"phoneNumber": "string",
"emailAddress": "string",
"address": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"countryIso3Code": "string",
"bvn": "string"
},
"beneficiary": {
"accountNumber": "string",
"accountName": "string",
"bankName": "string",
"bankBicOrCode": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"phoneNumber": "string",
"emailAddress": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"countryIso3Code": "string",
"bvn": "string",
"currencyIso3Code": "string"
},
"session": {
"id": "string",
"provider": "string"
}
}
}🟠400Bad Request
🟠401Unauthorized
Modified at 2025-05-28 10:04:00