Onboard the option's processor account
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/PaymentOptions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/onboarding"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"returnUrl\": \"example\", \"refreshUrl\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/PaymentOptions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/onboarding';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"returnUrl":"example","refreshUrl":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/PaymentOptions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/onboarding \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "returnUrl": "example", "refreshUrl": "example" }'Connects the option’s processor account (e.g. a shop’s Stripe account): creates the account the first time, records it, and returns the processor’s onboarding page until the owner has completed it. Call again after onboarding to record that the account can take payments.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The payment option.
Your tenant id.
Request Body
Section titled “Request Body”Where the processor sends the owner back to.
object
Example generated
{ "returnUrl": "example", "refreshUrl": "example"}Responses
Section titled “Responses”OK
object
object
object
Example generated
{ "data": { "connected": true, "onboardingUrl": "example" }}Unauthorized: no bearer token, or one that is expired or not for this API.
Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.
An RFC 9457 problem.
object
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Not found: no such item in the tenant.
An RFC 9457 problem.
object
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Conflict: the item kept changing under concurrent writes; read it again and retry.
An RFC 9457 problem.
object
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Unprocessable: the body or the change is invalid. The errors are keyed by member.
A validation problem: the messages by member (or by JSON Pointer for a patch).
object
object
Example generated
{ "errors": { "additionalProperty": [ "example" ] }, "status": 1, "title": "example", "type": "example"}