SOURCE_IS_CORE_ACCOUNT and nothing is moved; use POST /core/transfer/intrabank-universal for those.POST /transfer/intrabank-universalkind in the answer | From | To |
|---|---|---|
| VirtualToCore | Virtual account | Core banking account |
| VirtualToVirtual | Virtual account | Virtual account of another parent account (another merchant) |
| VirtualToVirtualSameParent | Virtual account | Virtual account of the same parent account |
| Field Name | Type | Required | Description |
|---|---|---|---|
| transactionReference | string | TRUE | Your unique reference for this transfer, at most 64 characters: letters, digits, ., _ and -. It cannot be only digits, and it cannot contain CBVA, SL-TRSF, _REV, _Credit, _Debit, or both CB and VA, or start with SLF- or Rev:. It is the identity of the transfer (see below) |
| fromAccountID | string | TRUE | The account to debit, 10 digits. A virtual account (wallet or static). Never a core banking account, an invoice account or a parent account |
| toAccountID | string | TRUE | The account to credit, 10 digits, different from fromAccountID. Any virtual or core banking account except a parent account |
| amount | decimal | TRUE | Greater than zero, at most 2 decimal places, in naira |
| narration | string | TRUE | At most 150 characters. Cannot start with Rev: |
outcome first: the HTTP status always agrees with it. code says why when the outcome is not Credited.| Field Name | Type | Description |
|---|---|---|
| outcome | string | Credited, Pending, Refused or Reversed |
| code | string | See the codes below. CREDITED when done |
| message | string | A sentence for logs and operators, not for parsing |
| transactionReference | string | As sent |
| kind | string | One of the five kinds. Absent when the request was refused before it was classified |
| fromAccountID, toAccountID, amount | As sent | |
| invoiceReference | string | The invoice paid, when the destination is an invoice account |
| debitReference | string | The reference of the debit leg |
| creditReference | string | The reference of the credit leg |
| creditTransactionId | integer | The core banking transaction of the credit, when the destination is a core banking account |
| outcome | HTTP | Meaning | Money |
|---|---|---|---|
| Credited | 200 | Done: the source was debited and the destination credited | Moved, once |
| Pending | 202 | Not finished. Send the same request again | May be debited, never credited twice |
| Refused | 409 | Refused before any money moved | Nothing moved |
| Reversed | 409 | The source was debited, the destination refused the credit, and the debit was returned | Nothing moved in the end |
| (invalid request) | 400 | A field breaks the rules, or the reference is not acceptable | Nothing recorded |
transactionReference makes every retry safe. Until you hold a final outcome, ask again with the same reference and the same body, never a new reference. To read what happened to a transfer without carrying anything out, call GET /transfer/intrabank-universal/{transactionReference}. To finish a transfer that is still pending, send the same request again.Credited (200): done. Refused or Reversed (409): final, and the customer is not out of pocket. For a new instruction use a new reference.Pending (202), a timeout, a connection error or a 5xx: keep the instruction pending and send the same request again, for example after 30 seconds, 1 minute, 2 minutes, then every 5 minutes. Do not refund or fail the customer yourself. The bank also finishes unfinished transfers on its own every 2 minutes, so a later call usually returns the final outcome straight away.Pending with code HELD: the transfer is stopped for a person and the bank has been alerted. Ask less often (hourly) and contact support with the reference.400 Transaction Reference Already Exists; read the outcome with the GET call instead. The same reference with a different fromAccountID, toAccountID or amount is refused the same way.Pending.| Code | Outcome | Meaning | What to do |
|---|---|---|---|
| CREDITED | Credited | Done | Complete the instruction |
| CREDIT_PENDING | Pending | Debited; the credit is not posted yet | Send the same request again |
| CREDIT_UNCLEAR | Pending | Debited; the credit has no clear answer yet | Send the same request again; it is never credited twice |
| DEBIT_PENDING | Pending | The debit of a virtual account is not posted yet | Send the same request again |
| DEBIT_UNCLEAR | Pending | The debit has no clear answer yet | Send the same request again; after 30 minutes it ends Credited or DEBIT_NOT_MADE |
| REVERSAL_PENDING | Pending | The credit was refused; returning the debit is not finished | Send the same request again |
| IN_PROGRESS | Pending | Another call for this reference is running | Wait, then send the same request again |
| NO_ANSWER | Pending | The call could not be confirmed (timeout or error) | Send the same request again |
| HELD | Pending | Stopped for a person | See Retrying, point 4 |
| CREDIT_REFUSED | Reversed | The destination refused the credit; the debit was returned | Fail the instruction; the customer has their money |
| INVALID_REQUEST | Refused (400) | A field breaks the rules | Fix the request |
| TRANSFER_DISABLED | Refused | Intrabank transfers are not switched on for this bank | Do not offer the transfer |
| TRANSFER_NOT_CONFIGURED | Refused | The bank has not finished setting up transfers | Contact support; nothing moved |
| GL_MISMATCH | Refused | The two sides would be booked differently | Contact support with both account numbers |
| REFERENCE_REUSED | Refused | The reference was used for a different transfer | Use a new reference |
| INVALID_SOURCE_ACCOUNT | Refused | The source is not an account here, or is a parent account | Check the account number |
| INVALID_DESTINATION_ACCOUNT | Refused | The destination is not an account here, or is the source's own parent account | Check the account number |
| SOURCE_IS_INVOICE | Refused | The source is an invoice account, which can only be paid | Choose another source |
| SOURCE_IS_CORE_ACCOUNT | Refused | The source is a core banking account, which this route does not send from | Use POST /core/transfer/intrabank-universal; nothing moved |
| SOURCE_BLOCKED, DESTINATION_BLOCKED | Refused | The virtual account is blocked | Tell the customer |
| DEBIT_REFUSED | Refused | The debit was refused, for example insufficient available balance | Tell the customer; message gives the reason |
| DEBIT_NOT_MADE | Refused | No debit was recorded within 30 minutes of the first call | Fail the instruction; nothing moved |
| TRANSFER_REFUSED | Refused | A transfer between virtual accounts was refused as a whole | Tell the customer; message gives the reason |
| INVOICE_NOT_PAYABLE | Refused | The invoice is for another amount, expired, or not live | Check the invoice |
| INVOICE_CHANGED, INVOICE_NOT_CLAIMED | Refused | The invoice was paid or changed by another payment meanwhile | Check the invoice |
401 and nothing is recorded. Money can be sent to any account of the bank, including the virtual accounts of other merchants.POST /core/transfer/intrabank-universal cannot be used here (400 Transaction Reference Already Exists).