Overview

This page provides an overview of the payouts in the BridgerPay system: what they are, which methods are available, and how these methods can be integrated in your ecosystem.

A payout has multiple definitions in the payments industry, but in general and here it means a significant amount of money paid to either an individual or a business entity (shopper) by a merchant according to their mutual agreement. This can be benefits transferred when an event covered by the insurance occurs, a profit withdrawn by a trader from their broker, a prize won in competition, etc.

What do these payments have in common? They are not associated with any previous transaction. And thus neither PSP nor BridgerPay has information on the amount to be transferred. The process is initiated by the merchant, and the shopper is not involved in it.

Under "Payouts" on the left, you will find the payout methods we provide, and here is a flow diagram to show how these methods can be used together.

Payout flow diagram

i. A merchant and a shopper agree that the former should pay a particular amount of money according to their mutual agreement: an insurance compensation, trading profit, cash prize, etc.

ii. The merchant gets authorized in the BridgerPay system by using the "POST Login" method. The response of this method contains an access token.

1. The merchant requests a list of available payout providersby using the "GET Get Payout Metadata" method. The response contains a list of "fields" associated with each provider (e.g. "bankCode", "bankName", "bankBranch", etc.)

2. The merchant forms a payout request for a chosen PSP by using the "POST Create Payout" method; the "fields" associated with this PSP are carefully specified as the "metadata" body parameter.

BridgerPay receives the response, forwards it to the merchant, and continues getting updated on the request in asynchronous mode ("callbacks") until the status becomes "approved" or "declined". As soon as the final status is received, BridgerPay notifies the merchant of it (see "2*" in the diagram). (The information on whether this notification was sent and whether it was received is available in the response to either of the following methods: "GET Get Payout transaction by entity id" and "GET Check payout status".)

3, 4. Meanwhile, the merchant can request the current status in synchronous mode by getting a payout by its ID ("GET Get Payout transaction by entity id") or by getting a payout with the updated status by its ID ("GET Check payout status"). The former method receives this information from BridgerPay's database, which might be slightly outdated, whereas the other sends the request to the PSP and thus returns the most actual information.