Credit Account - Core Banking Services

This endpoint allows the crediting an account with a specified amount. The request requires the NUBAN of the account to be credited, the payment type, the amount, and any notes to attach to the transaction.

Request Body:

Field Name	Type	Required	Description
`nuban`	string	TRUE	The NUBAN (Nigerian Uniform Bank Account Number) of the account to be credited.
`paymentTypeId`	integer	TRUE	Unique identifier representing the selected payment type for the transaction.
`amount`	decimal	TRUE	The amount to be credited to the account.
`notes`	string	TRUE	Any additional notes or details about the transaction.

Response Body:

Field	Type	Description
`transactionID`	integer	A unique identifier for the credit transaction.
`nuban`	string	The NUBAN of the account that was credited.
`amount`	decimal	The amount that was credited to the account.
`paymentTypeId`	integer	The ID representing the payment type used for the transaction.
`notes`	string	The notes provided in the request.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Body Params application/json

Example

{
  "nuban": "0000000244",
  "paymentTypeId": 1,
  "amount": 500.5,
  "notes": "Hi"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "transactionID": 464,
  "nuban": "0000000244",
  "amount": 500.5,
  "paymentTypeId": 1,
  "notes": "Hi"
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |