Primus Documentation

Initiate Transer Request

Welcome to the documentation for the Initiate Transfer Request API. This API facilitates the initiation of a fund transfer request.

Base URL

{baseURL}/v1/transaction/initiate_transfer_request | POST

Authorization

Include the following Authorization header in your HTTP requests using a Bearer token:

Authorization: Bearer YOUR_ACCESS_TOKEN

Request Payload

Field	Type	Source	Required	Description
narration	string	body	✅ Yes	Description of the transfer
amount	number	body	✅ Yes	Amount to transfer
destination_bank_code	string	body	✅ Yes	Destination bank code
destination_account_name	string	body	✅ Yes	Name of the account holder
destination_account_type	string	body	✅ Yes	Type of the destination account
destination_bank_name	string	body	✅ Yes	Name of the destination bank
destination_account_number	string	body	✅ Yes	Destination account number
provider_id	string	body	✅ Yes	Provider ID
session_id	string	body	✅ Yes	Session ID
transfer_type	string	body	✅ Yes	Type of transfer

Sample Request

curl -X POST {baseURL}/v1/transaction/initiate_transfer_request \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "narration": "string",
    "amount": 20000,
    "destination_bank_code": "056",
    "destination_account_name": "prince",
    "destination_account_type": "savings",
    "destination_bank_name": "GTB",
    "destination_account_number": "0354882788",
    "provider_id": "64dfdf50c013a4fc3828678a",
    "session_id": "1234566",
    "transfer_type": "intra"
}'

Sample 201 Response

{
    "message": "Transaction initiated successfully",
    "data": {
        "transfer_request_id": "6874c2d3-df20-48c0-bb95-56ed421a2eba",
        "tsq_requery_count": 0,
        "status": "pending",
        "transfer_status": "pending",
        "narration": "string",
        "amount": "20000",
        "destination_bank_code": "056",
        "destination_account_name": "prince",
        "destination_account_type": "savings",
        "destination_bank_name": "GTB",
        "destination_account_number": "0354882788",
        "provider_id": "64dfdf50c013a4fc3828678a",
        "session_id": "1234566",
        "transfer_type": "intra",
        "account_id": "65db5b5041a636af9ee5feb2",
        "organization_id": "65db532d41a636af9ee5feaf",
        "originating_account_number": "00510011011003213",
        "originating_account_name": "Jolaoso",
        "updated_at": "2024-02-25T15:26:35.017Z",
        "created_at": "2024-02-25T15:26:35.017Z",
        "transaction_reference": "3GYCFBFAJHL1",
        "provider_response_id": null,
        "transfer_status_id": null,
        "transfer_request_decision_id": null,
        "mandate_rule_id": null
    },
    "success": true
}

Get Transactions by Account Id Transaction by Id