Initiate Terminal Transfers

This endpoint allows registered businesses initiate transfers via the external API endpoint

HTTP Method : POST
API Endpoint : {{base_url}}/api/v1/transfer

Sample JSON Request

{
    "amount": 254,
    "source_currency": "USD",
    "destination_currency": "NGN",
    "beneficiary_id": "d7847677-dcce-4481-86e2-14d77cc57480",
    "note": "this is the first note here",
    "reason": "some reason for the transfer"
}

{
    "status": 201,
    "data": {
        "amount": {
            "amount": 0,
            "currency": "",
            "symbol": ""
        },
        "beneficiary_details": {
            "bank_details": {
                "account_name": "OLAWALE V",
                "account_number": "201148503",
                "bank_address": "",
                "bank_branch": "",
                "bank_code": "058",
                "bank_name": "Guaranty Trust Bank",
                "city": "",
                "country": "NG",
                "district": "",
                "is_mobile_money": "no",
                "is_within_us": "no",
                "postal_code": "",
                "routing_number": "",
                "swift_code": ""
            },
            "funds_transfer_method": null,
            "intermediary_bank": null,
            "personal_details": null,
            "wallet_details": null
        },
        "business_id": "923b2df5-4a89-4ceb-b148-c2e5ac52d04e",
        "cancel_reason": null,
        "completed_at": null,
        "compliance_notes": null,
        "compliance_status": "no_action",
        "created_at": "2024-05-06T15:10:33.986512009+01:00",
        "deposited_amount": {
            "amount": 254,
            "currency": "USD",
            "symbol": "$"
        },
        "fee": {
            "amount": 0,
            "currency": "USD",
            "symbol": "$"
        },
        "fee_flat": 0,
        "fee_percentage": 0,
        "id": "83cf4332-fac2-4065-9ea1-2e236ae10a64",
        "is_date_updated": false,
        "markup_value": 0,
        "modified": false,
        "need_document_upload": false,
        "note": "this is the first note here",
        "reason": "some reason for the transfer",
        "reference": null,
        "source_currency": "",
        "status": "pending",
        "transferred_amount": {
            "amount": 0,
            "currency": "NGN",
            "symbol": "₦"
        },
        "type": "fiat",
        "updated_at": "2024-05-06T15:10:33.987075468+01:00"
    },
    "message": "Transfer initiated successfully",
    "error": null
}