Payments

Email tokenization request to customer

Sends an email to the customer with a link to authorize the source's tokenization.

post/sources/{id}/send_inscription_request/

Request

Base URL
https://api.piriod.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/piriod/apis/piriod-api/docs/sources/:id/send_inscription_request/post.ts
A function with typed inputs. Its response is checked against the schema.

recipientsstring[] required

Inscription request sent.

idinteger

customerstring nullable

Customer ID. Required for reusable sources.

gatewaystring required

Gateway ID (e.g. transbank, stripe, ach_transfer).

usage'single' | 'reusable'

amountnumber nullable

descriptionstring nullable

return_urlstring uri nullable

URL the payer is sent to after a redirect-flow tokenization.

gateway_dataobject

Gateway-specific payload (e.g. redirect form fields, token).

clientobject

Client metadata captured at creation time (IP, user agent, etc.).

metadataobject

test_modeboolean

createdstring date-time

updatedstring date-time

No recorded changes to this operation across all 1 revision of this API.