Skip to main content

Select Payout Account

This page details how the user can connect a payout account to their Symblepay Account if not already done. This flow is the same for websites and iOS and Android apps. It assumes that you already have credentials to successfully call Symblepay APIs and have subscribed to notifications using Webhooks API.

How it works​

Sunshine scenario is expected for the majority of the time.

  • When a user wants to add or change the payout account for trades, request your backend services to create a redirectUri using Symblepay API.
  • Re-direct user to Symblepay Frontend using https uri.
  • Selects bank and signs in to bank and selects bank account in Symblepay Frontend
  • Your backend services receives notification with status for the user payout account change.
  • Meanwhile user returns to your application (using re-direct or switching apps) and sees the success screen.

Select Payout Bank Account Flow

Initiate select payout account flow​

Initiate Flow
curl https://api.symblepay.io/v1/marketplace/connect/{USER_ID}/bankaccount/initiate \
  -X POST \
  -H 'Authorization: Bearer {API_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
        "returnUrl": "{RETURN_URL}"
      }'
Response example
{
    "redirectUrl": "https://api.symblepay.io/initiate-payout-bank-flow"
}

Send your users to the redirectUrl in a browser or In-App browser on Android or iOS

Wait for the flow to be finished​

Wait for the user to be redirected back to your returnUrl.

callback example
https://marketplace.dk/return-url

Receive webhook​

A webhook is also sent when a new bank account is connected to the user's account.

Webhook example
{
    "id": "ed3325d8-b379-444a-9cc1-7d119efefbea",
    "referenceId": "616de408-5f8f-4ef3-ba28-6b4827145070",
    "eventName": "user.bank-account-connected",
    "eventDate": "2024-02-16T10:36:20+01:00",
    "symblepayAccountId": "f6c4a43f-682e-4559-b8d1-11a63afd134a"
}