Auth Links

1 endpoint. Base URL https://api.paymentsonline.io, sandbox https://api.sandbox-paymentsonline.io.

Every request needs payments-api-key and payments-account.

POST/v1/auth-links

Create an Auth Link

Creates an Auth Link for a User.

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

expirationstringrequired
Expiration of the Auth Link (i.e.. 1d, 7d, 30d). Value must be between 0d and 30d.
metadataobjectoptional
Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value (i.e. '' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.
redirect_urlstringoptional
The console url to redirect the user to after authenticating. Defaults to /dashboard if not provided.
user_idstringrequired
The id of the user.

201AuthLinkDto

account_idstringrequired
The account id of the user that can authenticate with this auth link.
created_atstring date-timerequired
Time at which the auth link was created.
expires_atstring date-timeoptional
The expiration date of this auth link.
idstringrequired
The id of the auth link.
metadataobjectoptional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value (i.e. '' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata."
redeemedbooleanrequired
Indicates whether this auth link has been redeemed.
redirect_urlstringoptional
The console url to redirect the user to after authenticating. Defaults to /dashboard if not provided.
updated_atstring date-timerequired
Time at which the auth link was last updated.
urlstringrequired
The url to use for authenticating via auth link.
user_idstringrequired
The id of the user that can authenticate with this auth link.