Skip to content
vocapable.Docs

Registered merchant-owned phone payment connections

GET
/v1/phone-payment-connectors
curl --request GET \
  --url https://api.vocapable.com/v1/phone-payment-connectors \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PhonePaymentConnectorDirectory
object
connectors
required
Connectors
Array<object>
PhonePaymentConnectorOut
object
display_name
required
Display Name
string
>= 1 characters <= 100 characters
policy
required
PhonePaymentPolicy
object
version
Version
integer
default: 1
Allowed value: 1
customer_connector_id
required
Customer Connector Id
string
>= 1 characters <= 128 characters
merchant_account_id
required
Merchant Account Id
string
>= 1 characters <= 128 characters
payment_kind
Payment Kind
string
default: full
Allowed values: deposit full
hosted_enabled
Hosted Enabled
boolean
default: true
secure_phone_enabled
Secure Phone Enabled
boolean
secure_connector_name
Any of:
string
>= 1 characters <= 100 characters
max_amount_minor
required
Max Amount Minor
integer
>= 1 <= 10000000
currency
Currency
string
default: usd
Allowed value: usd
authorization_seconds
Authorization Seconds
integer
default: 300 >= 30 <= 600
max_preparations_per_call
Max Preparations Per Call
integer
default: 2 >= 1 <= 3
id
required
Id
string
state
required
State
string
Allowed values: enabled disabled
configuration_sha256
required
Configuration Sha256
string
/^[a-f0-9]{64}$/
created_at
required
Created At
string format: date-time
hosted_ready
required
Hosted Ready
boolean
secure_phone_ready
required
Secure Phone Ready
boolean
reason_codes
required
Reason Codes
Array<string>
runtime_enabled
required
Runtime Enabled
boolean
Example
{
  "connectors": [
    {
      "policy": {
        "version": 1,
        "payment_kind": "deposit",
        "hosted_enabled": true,
        "secure_phone_enabled": false,
        "currency": "usd",
        "authorization_seconds": 300,
        "max_preparations_per_call": 2
      },
      "state": "enabled"
    }
  ]
}