Ledger Integration Use Cases

This topic walks through example transaction scenarios to help you understand the message sequences your ledger will receive and how to respond to each one. The use cases cover the full range of Authorisation Request, Transaction Event, and Clearing File message flows, and are intended to complement the implementation instructions in the Authorisation Request API Endpoint, Transaction Event Webhook, and Clearing guides, where the required ledger actions for each message type are specified in detail.

Column Reference

Column	Description
Step	Sequence of the message being sent
Interface	The interface used to deliver the message: Authorisation Request (AR): Enfuce calls the ledger to verify the availability of funds and, if approved, place an account hold for the amount. Transaction Event Webhook (TE): Enfuce asynchronously notifies the ledger of each message it has received and processed from the payment scheme. Clearing File (CF): Enfuce processes the clearing file, received from the payment Scheme, removes sensitive data and changes the format, and then sends it to the ledger. Each clearing file contains multiple clearing messages. TE & CF: Clearing messages (`messageCategory`: `FINANCIAL`) are sent via both the clearing file and the Transaction Event Webhook. The Transaction Event delivery is optional and can be disabled. You might keep it enabled to feed systems such as a data warehouse.
Request Data	Content sent in the request payload to the ledger: `messageCategory`, `messageFunction`, `transactionType` `id`: Unique identifier of the specific Scheme message. `transactionId`: A unique identifier that associates all messages related to the same card transaction. `responseCode`: The response returned to the card Scheme.
Ledger Action	The action that the ledger must take up to adjust the cardholder’s account balance.
Response	Values returned by the ledger in response to the message sent via the AR interface.

transactionId, id, and amount values are illustrative.
All examples use starting values of Reserved = 0 and Booked Balance = 1000.
The Request Data shown for each step represents the key fields relevant to the ledger. Additional fields will be present in the actual messages and may be used optionally.

Basic Retail Authorisation

Case 1.1 — Retail payment transaction, approved by ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	100

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	900

Case 1.2 — Retail payment transaction, declined by ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, decline.

Account state after this message:

reserved:	0
balance:	1000

response:

NOT_SUFFICIENT_FUNDS

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	≠ 00/10/85

No action.

Account state after this message:

reserved:	0
balance:	1000

Case 1.3 — Retail payment transaction, declined by processor

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	≠ 00/10/85

No action.

Account state after this message:

reserved:	0
balance:	1000

Incremental Authorisation

Case 2.1 — Incremental authorisation (+20), approved by ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	120
balance:	1000

response:

APPROVED

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20
responseCode:	00

No action.

Account state after this message:

reserved:	120
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	120

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	880

Case 2.2 — Incremental authorisation, declined by ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20

Check the balance, decline.

Account state after this message:

reserved:	100
balance:	1000

response:

NOT_SUFFICIENT_FUNDS

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20
responseCode:	≠ 00/10/85

No action.

Account state after this message:

reserved:	100
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	100

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	900

Case 2.3 — Incremental authorisation, declined by processor

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20
responseCode:	≠ 00/10/85

No action.

Account state after this message:

reserved:	100
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	100

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	900

Case 2.4 — Two incremental authorisations, both approved

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	120
balance:	1000

response:

APPROVED

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20
responseCode:	00

No action.

Account state after this message:

reserved:	120
balance:	1000

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	15
approvedAmount:	15

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	135
balance:	1000

response:

APPROVED

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	15
approvedAmount:	15
responseCode:	00

No action.

Account state after this message:

reserved:	135
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E004
billingAmount:	135

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	865

Case 2.5 — Incremental authorisation + partial reversal/adjustment (down to 80)

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	120
balance:	1000

response:

APPROVED

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20
responseCode:	00

No action.

Account state after this message:

reserved:	120
balance:	1000

messageCategory:	ADJUSTMENT
messageFunction:	ADVICE
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	120
approvedAmount:	80
responseCode:	00

Adjust the account hold on the linked transaction.

Account state after this message:

reserved:	80
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E004
billingAmount:	80

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	920

Case 2.6 — Incremental authorisation + full reversal

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	120
balance:	1000

response:

APPROVED

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20
responseCode:	00

No action.

Account state after this message:

reserved:	120
balance:	1000

messageCategory:	REVERSAL
messageFunction:	ADVICE
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	120
approvedAmount:	120
responseCode:	00

Remove the account hold on the linked transaction.

Account state after this message:

reserved:	0
balance:	1000

Case 2.7 — Incremental authorisation + purge

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	120
balance:	1000

response:

APPROVED

messageCategory:	INCREMENTAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	20
approvedAmount:	20
responseCode:	00

No action.

Account state after this message:

reserved:	120
balance:	1000

messageCategory:	PURGE_AUTHORIZATION
messageFunction:	ADVICE
transactionType:	RETAIL
transactionId:	T001
id:	E003

Remove the account hold on the linked transaction.

Account state after this message:

reserved:	0
balance:	1000

Partial Approval

Case 3.1 — Retail payment authorisation, partially approved by processor

The partial approval in this case is applied by the processor, for example due to spend control rules that cap the transaction amount below what was originally requested.

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	80
partialApprovalCapable:	TRUE

Check the balance, partially approve and place an account hold for the approved amount.

Account state after this message:

reserved:	80
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	80
partialApprovalCapable:	TRUE
responseCode:	10

No action.

Account state after this message:

reserved:	80
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	80
approvedAmount:	80

Remove the remaining account hold, book the transaction, and update the balance.

Account state after this message:

reserved:	0
balance:	920

Case 3.2 — Retail payment authorisation, partially approved by ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
partialApprovalCapable:	TRUE

Check the balance, partially approve, and place an account hold.

Account state after this message:

reserved:	80
balance:	1000

approvalAmount:	80
response:	PARTIALLY_APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	80
partialApprovalCapable:	TRUE
responseCode:	10

No action.

Account state after this message:

reserved:	80
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	80

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	920

Adjustments and Reversals

Case 4.1 — Acquirer advice (adjustment) from 100 to 80

This case is based on a scheme ISO 8583 MTI 0120 message (acquirer advice).

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	ADJUSTMENT
messageFunction:	ADVICE
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	80
approvedAmount:	80
responseCode:	00

Adjust the account hold on the linked transaction.

Account state after this message:

reserved:	80
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	80
approvedAmount:	80

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	920

Case 4.2 — Partial reversal (removes 20 from the purchase amount, leaving 80)

This case is based on a scheme ISO 8583 MTI 0420 message (reversal).

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	ADJUSTMENT
messageFunction:	ADVICE
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	100
approvedAmount:	80
responseCode:	00

Adjust the account hold on the linked transaction.

Account state after this message:

reserved:	80
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	80
approvedAmount:	80

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	920

Case 4.3 — Full reversal

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	REVERSAL
messageFunction:	ADVICE
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	100
approvedAmount:	100
responseCode:	00

Remove the account hold on the linked transaction.

Account state after this message:

reserved:	0
balance:	1000

Refunds

Case 5.1 — Refund authorisation, approved by ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	CREDIT
transactionId:	T001
id:	E001
billingAmount:	33
approvedAmount:	33

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	0
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	CREDIT
transactionId:	T001
id:	E001
billingAmount:	33
approvedAmount:	33
responseCode:	00

No action.

Account state after this message:

reserved:	0
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	CREDIT
transactionId:	T001
id:	E002
billingAmount:	33

Book the crediting transaction and update the balance.

Account state after this message:

reserved:	0
balance:	1033

Case 5.2 — Refund authorisation, declined by ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	CREDIT
transactionId:	T001
id:	E001
billingAmount:	33
approvedAmount:	33

Decide that it’s not permitted to accept a crediting transaction and decline.

Account state after this message:

reserved:	0
balance:	1000

response:

NOT_PERMITTED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	CREDIT
transactionId:	T001
id:	E001
billingAmount:	33
approvedAmount:	33
responseCode:	≠ 00/10/85

No action.

Account state after this message:

reserved:	0
balance:	1000

Case 5.3 — Refund authorisation, declined by processor

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	CREDIT
transactionId:	T001
id:	E001
billingAmount:	33
approvedAmount:	33
responseCode:	≠ 00/10/85

No action.

Account state after this message:

reserved:	0
balance:	1000

Scheme Advices (STIP)

Case 6.1 — Scheme STIP advice, approved by Scheme

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	ADVICE
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

Place an account hold.

Account state after this message:

reserved:	100
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	900

Case 6.2 — Scheme STIP advice, declined by Scheme

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	DECLINED_AUTHORIZATION
messageFunction:	ADVICE
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	≠ 00/10/85

No action.

Account state after this message:

reserved:	0
balance:	1000

Balance Inquiry

Case 7.1 — Balance inquiry, approved by ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	BALANCE_INQUIRY
messageFunction:	REQUEST
transactionId:	T001
id:	E001

Approve and return the correct balance.

response:	APPROVED
availableAmount:	44

messageCategory:	BALANCE_INQUIRY
messageFunction:	REQUEST
transactionId:	T001
id:	E001

No action.

Case 7.2 — Balance inquiry, declined by ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	BALANCE_INQUIRY
messageFunction:	REQUEST
transactionId:	T001
id:	E001

Check the balance, decline.

response:

NOT_PERMITTED

messageCategory:	BALANCE_INQUIRY
messageFunction:	REQUEST
transactionId:	T001
id:	E001

No action.

Case 7.3 — Balance inquiry, declined by processor

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	BALANCE_INQUIRY
messageFunction:	REQUEST
transactionId:	T001
id:	E001
responseCode:	≠ 00/10/85

No action.

PIN Management

Case 8.1 — Change PIN using ATM, approved by processor

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	PIN_MANAGEMENT
messageFunction:	REQUEST
transactionId:	T001
id:	E001
responseCode:	00

No action.

Case 8.2 — Change PIN using ATM, declined by processor

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	PIN_MANAGEMENT
messageFunction:	REQUEST
transactionId:	T001
id:	E001
responseCode:	≠ 00/10/85

No action.

Case 8.3 — Reverse PIN change using ATM

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	PIN_MANAGEMENT_REVERSAL
messageFunction:	ADVICE
transactionId:	T001
id:	E001

No action.

Purge and Void

Case 9.1 — Purge an authorisation because multiple days have passed

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

messageCategory:	PURGE_AUTHORIZATION
messageFunction:	ADVICE
transactionId:	T001
id:	E002

Remove the account hold on the linked transaction.

Account state after this message:

reserved:	0
balance:	1000

Case 9.2 — Void authorisation due to lost response from the ledger

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	0 or 100
balance:	1000

response:

APPROVED

messageCategory:	VOID_AUTHORIZATION
messageFunction:	ADVICE
transactionId:	T001
id:	E002
referenceTransactionEventId:	E001

Remove the account hold on the linked transaction if it exists.

Account state after this message:

reserved:	0
balance:	1000

Clearing

Case 10.1 — Retail payment transaction, final clearing with lower amount

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve, and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	99

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	901

Case 10.2 — Retail payment transaction, clearing with higher amount

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	101

Remove the remaining account hold, book the transaction, and update the balance.

Account state after this message:

reserved:	0
balance:	899

Case 10.3 — Clearing without any authorisation

Step

Interface

Request Data

Ledger Action

Response

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100

Book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	900

Case 10.4 — Reversal clearing

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	100

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	900

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	REVERSAL
transactionId:	T001
id:	E004
billingAmount:	100

Book the crediting transaction and restore the account balance.

Account state after this message:

reserved:	0
balance:	1000

Case 10.5 — Retail payment transaction, partial clearing, complete

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	75
clearingStatus:	PARTIAL
partialClearingApplied:	TRUE

Remove part of the account hold, book the transaction and update the balance.

Account state after this message:

reserved:	25
balance:	925

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E003
billingAmount:	25
clearingStatus:	CLEARED
partialClearingApplied:	TRUE

Remove the remaining account hold, book the transaction and update the balance.

Account state after this message:

reserved:	0
balance:	900

Case 10.6 — Retail payment transaction, partial clearing, purge

Step

Interface

Request Data

Ledger Action

Response

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100

Check the balance, approve and place an account hold.

Account state after this message:

reserved:	100
balance:	1000

response:

APPROVED

messageCategory:	INITIAL_AUTHORIZATION
messageFunction:	REQUEST
transactionType:	RETAIL
transactionId:	T001
id:	E001
billingAmount:	100
approvedAmount:	100
responseCode:	00

No action.

Account state after this message:

reserved:	100
balance:	1000

TE&CF

messageCategory:	FINANCIAL
messageFunction:	NOTIFICATION
transactionType:	RETAIL
transactionId:	T001
id:	E002
billingAmount:	75
clearingStatus:	PARTIAL
partialClearingApplied:	TRUE

Remove part of the account hold, book the transaction and update the balance.

Account state after this message:

reserved:	25
balance:	925

messageCategory:	PURGE_AUTHORIZATION
messageFunction:	ADVICE
transactionId:	T001
id:	E003

Remove the account hold on the linked transaction.

Account state after this message:

reserved:	0
balance:	925

Getting Started

Cards

Cardholders

PIN

Digital Wallets

Transaction Lifecycle

Spend Controls

Exchange Rates

Ledger Integration Use Cases

Column Reference

Basic Retail Authorisation

Incremental Authorisation

Partial Approval

Adjustments and Reversals

Refunds

Scheme Advices (STIP)

Balance Inquiry

PIN Management

Purge and Void

Clearing

​Column Reference

​Basic Retail Authorisation

​Incremental Authorisation

​Partial Approval

​Adjustments and Reversals

​Refunds

​Scheme Advices (STIP)

​Balance Inquiry

​PIN Management

​Purge and Void

​Clearing

Column Reference

Basic Retail Authorisation

Incremental Authorisation

Partial Approval

Adjustments and Reversals

Refunds

Scheme Advices (STIP)

Balance Inquiry

PIN Management

Purge and Void

Clearing