1.4. Server-to-Server Payout

Introduction

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

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 -> "ConnPay": /api/v4/payout/
activate "ConnPay"
"ConnPay" --> cp: Order ID
group Conditional
cp -> "ConnPay": Get status by Order ID\napi/v2/status
"ConnPay" --> cp : Response\nstatus,redirect-to
cp -> R: Provide redirect URL
deactivate "ConnPay"
deactivate cp
activate R
R -> "ConnPay": Redirect by redirect-to
deactivate R
activate "ConnPay"
"ConnPay" -> R: Additional Submit Form
deactivate "ConnPay"
activate R
R -> "ConnPay": Submit Form
deactivate R
activate "ConnPay"
end
"ConnPay" --> "ConnPay": Processing\nPayout
group Get Final Status
== Receive Connecting Party Callback ==
cp <- "ConnPay" : Callback with Final Status
"ConnPay" <-- cp: HTTP 200
deactivate "ConnPay"
== Order Status request ==
cp -> "ConnPay": Get status by Order ID\napi/v2/status
activate "ConnPay"
"ConnPay" --> cp : Response\nstatus,order-stage
deactivate "ConnPay"
end
group Optional
cp --> R: Show result
deactivate cp
end
@enduml

(1) Payout can be initiated by Connecting Party based on internal business model or Receiver’s request.
(2) To implement payout transaction see /api/v4/payout.
(5) Some payout methods require the Receiver to fill the additional data on the form. The form to redirect the customer will return in status response in redirect-to parameter.
(8) The Receiver submits the payout form.
(9) The Receiver gets redirected back to Connecting Party. See Final redirect.
(11) 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.
(13) To implement callback with final status handling see Connecting Party Callback.
(15) Final Status can be sent by Connecting Party based on internal business model or by Receiver’s request.