Skip to content
Switch to light mode

Authorizations

Authorizations

Payblr supports an External Host Interface integration for real-time transaction authorization and transaction event delivery. Through this integration, Payblr forwards EHI transaction messages to your configured endpoint. Your system validates the request, processes the EHI JSON payload, and returns the required response based on the message type.

On this page

Overview

The Authorizations page provides a summary of Payblr’s EHI authorization and transaction event delivery model. It explains how Payblr sends real-time EHI messages to the endpoint configured for your system.

Authorization messages may require your system to return an approve, decline, or partial approval decision. Other transaction lifecycle messages generally require an acknowledgement or cut-off result.

How it works

The high-level EHI transaction flow follows this pattern.

1

Transaction message received

Payblr receives a transaction-related message that must be delivered through the EHI flow.

2

Payblr forwards the EHI message

Payblr forwards the EHI transaction message to the external host URL configured for your system.

3

Your system handles the request

Your system receives the message, applies its processing rules, and prepares the required response.

4

Your system returns the response

Your system returns an authorization decision, acknowledgement, or cut-off result depending on the message type.

What your system is responsible for

After Payblr forwards an EHI message, your system owns the receive, validate, process, and respond steps.

  • Receive the EHI payload

    Receive the EHI JSON payload forwarded by Payblr at your configured endpoint.

  • Validate the request

    Validate Payblr’s request signature and timestamp before processing the message.

  • Identify the message type

    Identify the message type using fields such as MTID, Txn_Type, or CutOffId.

  • Return the required response

    Return the required JSON response for the message type.

  • Apply processing logic

    Apply matching, duplicate handling, balance, ledger, and reconciliation logic according to your internal rules.

  • Store support identifiers

    Store key identifiers and x-correlation-id for support and troubleshooting.

Authorizations Sequence Diagram

Recommended EHI transaction message sequence

Transaction

Transaction Flow

Platform

Payblr EHI

System

Client Endpoint

1. Transaction message received

EHI flow

A transaction-related message enters the Payblr transaction flow.

Transaction FlowPayblr EHI

2. Forward EHI message

EHI flow

Endpoint

Client external host URL

Method

POST [CLIENT_EHI_ENDPOINT_URL]

Payblr forwards the original EHI transaction payload to the configured client endpoint.

Payblr EHIClient Endpoint

3. Validate and process payload

Client system validates the request and processes the EHI JSON payload based on the message type.

Client EndpointprocessesClient Endpoint

4. Return required response

EHI flow

Endpoint

EHI response contract

Method

HTTP 200 response with required JSON body

Client system returns an authorization decision, acknowledgement, or cut-off result depending on the message type.

Client EndpointPayblr EHI

5. Continue transaction flow

Payblr relays the client response through the transaction flow.

Payblr EHITransaction Flow
Sequence diagram showing how Payblr forwards EHI transaction messages to the configured client endpoint and receives the required response.

Message behavior

The required response depends on the EHI message type.

Message typeExpected behavior
Authorization messagesYour system generally returns an approve, decline, or partial approval decision.
Advice messagesYour system generally returns an acknowledgement after processing the message.
Reversal messagesYour system generally acknowledges the reversal message after processing it.
Financial / presentment messagesYour system generally returns an acknowledgement after processing the lifecycle message.
Chargeback and chargeback reversal messagesYour system generally acknowledges the message based on the applicable lifecycle behavior.
Cut-off messagesYour system generally returns the required cut-off result.

Full EHI Integration Guide

For complete implementation details, including message types, response examples, matching criteria, duplicate handling, logging, and go-live readiness, review the full External Host Interface Integration Guide.

Open EHI Integration Guide

Implementation notes

Use these notes for go-live readiness. Day-to-day processing duties are covered in What your system is responsible for, and response expectations are covered in Message behavior.

  • Configure and maintain the external host URL endpoint that receives EHI messages from Payblr.
  • Confirm timeout, retry, and duplicate-handling behavior before go-live.
  • Use the full EHI Integration Guide for message-type details, response examples, matching criteria, logging, and readiness checks.

Next steps

After reviewing this summary, continue to the full EHI Integration Guide for detailed implementation behavior, response examples, matching criteria, duplicate handling, logging, and go-live readiness.