Create an onboarding link

POST

/payment_onboarding_links

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

This endpoint expects an object.

recipientobjectRequired

refresh_urlstringRequired>=1 character<=2083 characters

return_urlstringRequired>=1 character<=2083 characters

Successful Response

idstring

created_atdatetime

expires_atdatetime

recipientobject

refresh_urlstring>=1 character<=2083 characters

return_urlstring>=1 character<=2083 characters

urlstring>=1 character<=2083 characters

1	curl -X POST https://api.sandbox.monite.com/v1/payment_onboarding_links \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"recipient": {
8	"id": "id",
9	"type": "entity"
10	},
11	"refresh_url": "refresh_url",
12	"return_url": "return_url"
13	}'