Initiate Remittance

POST

/payment-service/api/v1/transfer/remittance

Initiate a remittance by transferring funds from a source account to a beneficiary.

Request

Body Params application/json

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Successful

Body

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

Get Client Configuration

Get Remittance