HomeRecipesAPI ReferenceGuides
API Reference

Convert balance to an IPP

post
https://apicenter-uat.network.global/api/v1/cards//instalments/balance/convert

IPP Balance Conversion

Applicable Products: Credit

Applicable Client Types: Any

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 20 and 20
Body Params
string
required
length between 0 and 5

Plan number

string

IPP Plan Description

string
enum
required
  • IPP_BAL-NP-TOF-BR01: IPP Balance Conversion Advice Tibco Online ModeFin BR01
  • IPP_BAL-NP-TOF-BR02: IPP Balance Conversion Advice Tibco Online ModeFin BR02
  • IPP_BAL-NP-TOF-BR03: IPP Balance Conversion Advice Tibco Online ModeFin BR03
  • IPP_BAL-NP-TOF-BR04: IPP Balance Conversion Advice Tibco Online ModeFin BR04
  • IPP_BAL-NQ-TOF-BR01: IPP Balance Conversion Request Tibco Online ModeFin BR01
  • IPP_BAL-NQ-TOF-BR02: IPP Balance Conversion Request Tibco Online ModeFin BR02
  • IPP_BAL-NQ-TOF-BR03: IPP Balance Conversion Request Tibco Online ModeFin BR03
  • IPP_BAL-NQ-TOF-BR04: IPP Balance Conversion Request Tibco Online ModeFin BR04
string
required
length between 0 and 12

RRN - It is a unique reference number used in transaction processing to identify and track specific transactions

string

Transaction Date

string

Booking type

string
enum

Balance to be checked.

Allowed:
transaction
object
required

Transaction Monetary Amount

boolean

Allows skipping the contract's auth status check and only checks if posting is allowed for the respective transaction direction (dr/cr).

int32

Number of portions.

int32

Instalment fee rate (for the currently available PEI and NIC instalment schemes it's annual fee rate, usually called interest rate).

boolean

Processing Fee Waiver.

adHocFee
object

Fee that's applied on a case-by-case basis for a specific purpose

int32

Number of cycles to shift before billing the first portion.

int32

Number of portions to apply zero fee rate to. The period starts with the first portion.

double

Desired maximum amount on the portion, system will create number of portions that achieves this condition.

boolean

Deduct the transactions locked in the progress of transaction conversion from the available balance CONV_BAL_TYPE, when it's checked.

boolean

Mark transactions as converted, for the amount of balance conversion.

Headers
string

The W3C Trace Context traceparent header for distributed tracing.
It helps propagate trace information across services.
For more details, refer to the official Trace Context documentation.

string

A unique identifier to ensure the request is processed only once, preventing duplicate operations (e.g. retries).

string

A unique ID for each API request. When the same ID is reused, the API returns the original response and skips duplicate processing. Useful for retrying failed or timed-out requests.

Responses
204

Balance conversion was accepted for processing

Updated 2 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 2 months ago