Get all external URLs for seller

This is a variant of GET /partner/api/sellers/external-urls — Get external URLs for seller; the request and responses below are the ones documented for Internal API.

Credentials

No credentials are documented for this endpoint.

Retrieve all external URLs for a seller including form, documents, card, finance profile, and payments onboarding URLs.

Parameters

Name In Type Required Description
id query string no Seller UUID (mutually exclusive with email and socialId)
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-urls'

Node.js

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

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

Python

import requests

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

print(response.text)

PHP

<?php

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

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

echo $response;

Responses

200 — External URLs retrieved successfully (success)

Field Type Description
formUrl string Post sign-up form URL
documentsUrl string Documents upload URL
cardUrl string Credit card management URL
financeProfileUrl string Finance profile URL
externalPaymentsOnboardingUrl string Payments onboarding URL 
{
  "formUrl": "https://app.keep.co.il/seller/form/abc123",
  "documentsUrl": "https://app.keep.co.il/seller/documents/abc123",
  "cardUrl": "https://app.keep.co.il/seller/card/abc123",
  "financeProfileUrl": "https://app.keep.co.il/seller/finance/abc123",
  "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"
}

404 — Not Found - Resource not found (error)

Field Type Description
statusCode integer
message string
error string 
{
  "statusCode": 404,
  "message": "Seller not found",
  "error": "Not Found"
}