Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
{
    "amount": 10,
    "reference":"reference12934",
    "narration":"911 Transaction",
    "destinationBankCode": "035",
    "destinationAccountNumber": "5000143115",
    "destinationAccountName": "Benjamin Wilson",
    "currency": "NGN",
    "sourceAccountNumber": "9624937372"
} 

...

Code Block
languagejson
{
    "amount": 10,
    "reference":"reference12934",
    "narration":"911 Transaction",
    "destinationBankCode": "044",
    "destinationAccountNumber": "0035785417",
    "destinationAccountName": "Shola Adebayo",
    "currency": "NGN",
    "sourceAccountNumber": "9624937372"
}

...

Code Block
languagejson
{
	"title" : "Game of Batches",
    "batchReference":"batchreference12934",
    "narration":"911 Transaction",
    "sourceAccountNumber": "9624937372",
    "onValidationFailure" : "CONTINUE",
    "notificationInterval": 10,
    "transactionList" : [
    	{
	    	"amount": 1300,
	    	"reference":"Final-Reference-1a",
	    	"narration":"911 Transaction",
	    	"destinationBankCode": "058",
			"destinationAccountName": "Benjamin Wilson",
	    	"destinationAccountNumber": "0111946768",
	    	"currency": "NGN"
    	},
		{
    		"amount": 570,
	    	"reference":"Final-Reference-2a",
	    	"narration":"911 Transaction",
	    	"destinationBankCode": "058",
			"destinationAccountName": "Benjamin Wilson",
	    	"destinationAccountNumber": "0111946768",
	    	"currency": "NGN"
    	},
		{
    		"amount": 230,
	    	"reference":"Final-Reference-3a",
	    	"narration":"911 Transaction",
			"destinationAccountName": "Benjamin Wilson",
	    	"destinationBankCode": "058",
	    	"destinationAccountNumber": "0111946768",
	    	"currency": "NGN"
    	}

   	]
} 

...

Field

Description

amount (M)

The amount to be disbursed to the beneficiary

reference (M)

The unique reference for a transaction. Also to be specified for each transaction in a bulk transaction request.

batchReference (M)

The unique reference for the entire batch of transactions being sent.

narration (M)

The Narration for the transactions being processed

bankCode (M)

The 3 digit bank code representing the destination bank

accountNumber destinationAcountNumber (M)

The beneficiary account number

destinationAccountName

The beneficiary account name. This will be used if provided,
otherwise it will gotten via account number lookup

currency (M)

The currency of the transaction being initialised - "NGN"

sourceAccountNumber (M)

Unique identifier of your wallet. Can be obtained on the disbursements page on the web portal and is represented as WALLET ACCOUNT NUMBER.

onValidationFailure

Used to determine how Monnify should handle failed transaction validations in a batch. The two options are BREAK & CONTINUE. Use Break to tell Monnify to reject the entire batch and use CONTINUE to tell Monnify to process the valid transactions.

notificationInterval

Used to determine how often Monnify should notify the merchant of progress when processing a batch transfer. The options are 10, 20, 50 and 100 and they represent percentages. i.e. 20 means notify me at intervals of 20% (20%, 40%, 60%, 80% ,100%).

status

The status  of a single transfer request. (SUCCESS, FAILED, PENDING, IN_PROGRESS, OTP_EMAIL_DISPATCH_FAILED, PENDING_AUTHORIZATION).

A status of PENDING or IN_PROGRESS should NOT be treated as FAILED nor SUCCESS. Kindly do a requery to get the final status of the transfer.

batchStatus

The status of the processing of the entire Batch. (FAILED_ON_ACCOUNTS_VALIDATION, OTP_EMAIL_DISPATCH_FAILED, PENDING, IN_PROGRESS, PENDING_AUTHORIZATION, AWAITING_PROCESSING, IN_PROGRESS ,COMPLETED)

totalTransactions

The total number of transactions in the batch.

totalAmount

The total amount deducted for all the transactions in the batch

totalFee

The total transaction fees deducted for all the transactions in the batch.

...