API Reference
Start typing to search…

Get External Connected Payment Application

get
https://api.vcita.biz/client/payments/v1/apps/primary_provider_connected_application

Overview

Get External Connected Payment Application.

Authentication

Available for Client Tokens only.

Prerequisites

Requires a payment application (app_type=payments) to be installed and fully connected for the business. Returns 422 if no connected payment app exists.

What "Fully Connected" Means

A payment app is considered fully connected when:

  1. The app is assigned to the business via POST /v3/apps/app_assignments
  2. The business has external_[app_name]_connected=true flag set
  3. The app is not in pending/setup mode
  4. For vcitaPayments: Terms and conditions must be accepted
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!