Account Credit Request

This endpoint receives a request to close an open credit inquiry by performing the credit transaction. The credit inquiry to be closed is contained in the clientRef field or transactionReference field. The transactionAmount to be credited is also included in the request. The request is processed and routed to the destination institution to effect the credit. The credit request is pushed for processing and a response is sent back to the calling application.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Message Description

FieldField nameDescription
1transactionReferenceUnique transaction reference
2responseCodeThe response code of the transaction see appendix for response code details
3responseMessageThe descriptive response message
4statusThe status of the transaction. See transaction status appendix. Use the status mappings to determine if the transaction succeeded or not.
5clientRefThe transaction client reference
6systemResponseCodeSystem Response code that is sometimes included in response in case of exceptions in the system. This helps with issue resolution.
7settlementStatusSettlement status of the credit transaction
Body Params
int64
required

Amount in minor denomination

string
required

Narration

string

Unique reference per client. If present in inquiry, should be the same. if absent, transaction reference must be present in request

string

Additional Information. Could contain initial debit details (e.g mobile app implementation)

string

Transaction Reference returned from credit inquiry. If absent, credit ref must be present in request

Headers
string
Defaults to Bearer {Passport Access Token}
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json