billing

POST `/v1/payment-methods/paypal`

Begin saving a PayPal account as a payment method.

Authentication

Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a field in the JSON body.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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.

Request body

Name	Type	Required	What it is
`org_id`	`string`	No	Organization to attach the mandate to. The caller must hold `billing.payment.manage` in that organization.

Response

Name	Type	Required	What it is
`setup_token_id`	`string`	Yes	—
`approval_url`	`string`	Yes	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.

Errors this endpoint can return

401 · 403 · 409 · 422 · 429 · 503