billing

POST `/v1/payment-methods/paypal`

Begin saving a PayPal account as a payment method.

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение billing.payment.manage; ключ без него отклоняется с кодом 403, а не 404.

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве поля в теле JSON.

Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X POST https://api.zinndigital.com/v1/payment-methods/paypal \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

Opens a PayPal vault setup token and returns the approval_url the buyer must visit to consent. No payment method is created by this call — a mandate is consent, and the row is written only once PayPal confirms it, either through POST /v1/payment-methods/paypal/confirm when the buyer returns or through PayPal's own VAULT.PAYMENT-TOKEN.CREATED webhook (ADR 0011 §3). Requires billing.payment.manage in the target organization. A saved PayPal mandate is chargeable off-session, so it may be nominated as the account's primary or its backup — including as the backup behind a card primary, which the platform charges on PayPal's rail when the card declines.

Тело запроса

Имя	Тип	Обязательно	Что это
`org_id`	`string`	Нет	Organization to attach the mandate to. The caller must hold `billing.payment.manage` in that organization.

Ответ

Имя	Тип	Обязательно	Что это
`setup_token_id`	`string`	Да	—
`approval_url`	`string`	Да	Where to send the buyer to approve the mandate. `null` when PayPal returned no approval link, in which case the setup cannot be completed and the customer should try again.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 409 · 422 · 429 · 503