Recipient Token Documentation

General Information

• To utilize the Split Feature of SecPaid, you need to obtain the recipient tokens of the receivers.
• These must be SecPad User Accounts.
• In Development: You can set them yourself in the user settings.
• In Production: Contact compute@spaepitch.org to obtain the recipient token of a specific user.

Usage

• The recipient token is required to create Splitlinks via the v2 API.
• Your own token is used in the header for authentication.
• The recipient's token is included in the recipients field within the request body.
• Set the recipient's share (relative in %) in the same recipients field.

Schema

json { "recipients": [ { "token": "recipient_token", "share": 50 } ], "amount": 1, "recipient_note": "demo" }

Example

Here's an example of how to use the recipient token in a cURL request:

bash curl --location 'https://app.dev.ecpaid.com/api/v2/createSplitLink'
--header 'token: YOUR_OWN_TOKEN'
--header 'Content-Type: application/json'
--data '{ "recipients": [ { "token": "RECIPIENT_TOKEN", "share": 50 } ], "amount": 1, "recipient_note": "demo" }'

Replace YOUR_OWN_TOKEN with your actual authentication token and RECIPIENT_TOKEN with the recipient's token.

Important Notes

• Your own token is used in the header for authentication.
• The recipient's token is placed in the recipients field within the request body.
• The share value represents the percentage of the total amount the recipient will receive.
• You can add multiple recipients to the recipients array if needed.
• Always keep both your own token and recipient tokens secure and never expose them publicly.