1.9. Payout By Reference

Introduction

Payout-by-ref is a type of transaction which results in funds transfer from Connecting Party banking account to customer (receiver) bank card, banking account or digital wallet. Payout transaction in most cases is used for bank account funding.

Receiver account Card Reference ID (destination-card-ref-id) for Payout By Reference can be obtained on Card registration step, see card-ref-id in v2/create-card-ref or v4/create-card-ref.

Card registration requires a previously made transaction in final status, so Payout-by-ref can be initiated only for already registered Receivers.

See terms definitions in Glossary.

Payout Flow

@startuml
participant Receiver as R
participant "Connecting Party" as cp
autonumber
group Optional
R -> cp : Checkout
activate cp
end
== Payout request ==
cp -> "Billblend": /api/v4/payout-by-ref/
activate "Billblend"
"Billblend" --> cp: Order ID
deactivate cp
== Receive Connecting Party Callback ==
"Billblend" --> "Billblend": Processing\nPayout
group Get Final Status
cp <- "Billblend" : Callback with Final Status
"Billblend" <-- cp: HTTP 200
deactivate "Billblend"
== Order Status request ==
cp -> "Billblend": Get status by Order ID\napi/v2/status
activate "Billblend"
"Billblend" --> cp : Response\nstatus,order-stage
deactivate "Billblend"
end
group Optional
cp --> R: Show result
deactivate cp
end
@enduml

(1) Payout-by-ref can be initiated by Connecting Party based on internal business model or Receiver’s request.

(2) To implement payout-by-ref transaction see /api/v4/payout-by-ref/.

(5) To implement order status request see /api/v2/status/. Status should be requested multiple times with 3-5 seconds interval until final status will be received in response.

(7) To implement callback with final status handling see Connecting Party Callback.

(9) Final Status can be sent by Connecting Party based on internal business model or by Receiver’s request.