Get payments onboarding URL

• Sandbox: GET https://sandbox.payme.io/api/partner/api/sellers/external-payments-onboarding
• Production: GET https://live.payme.io/api/partner/api/sellers/external-payments-onboarding

Credentials

No credentials are documented for this endpoint.

Retrieve the external payments onboarding URL for a seller.

Parameters

Name	In	Type	Required	Description
id	query	string	no	Seller UUID
email	query	string	no	Seller email address
socialId	query	string	no	Seller Israeli ID number

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/partner/api/sellers/external-payments-onboarding'

Node.js

const response = await fetch("https://sandbox.payme.io/api/partner/api/sellers/external-payments-onboarding", {
  method: "GET",
});

console.log(await response.text());

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/partner/api/sellers/external-payments-onboarding",
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/partner/api/sellers/external-payments-onboarding');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — Payments onboarding URL retrieved successfully (success)

Field	Type	Description
externalPaymentsOnboardingUrl	string

{
  "externalPaymentsOnboardingUrl": "https://app.keep.co.il/seller/payments/abc123"
}

400 — Bad Request - Validation failed (error)

Field	Type	Description
statusCode	integer
message	string
error	string

{
  "statusCode": 400,
  "message": [
    "Validation failed"
  ],
  "error": "Bad Request"
}

401 — Unauthorized - Invalid or missing authentication (error)

Field	Type	Description
statusCode	integer
message	string
error	string

{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}