Get Recipient

Sandbox: GET https://sandbox.payme.io/api/payment-contracts/recipients
Production: GET https://live.payme.io/api/payment-contracts/recipients

Credentials

No credentials are documented for this endpoint.

That endpoint will return recipients that were already paid by the payment contract initiator.

**Only recipients that received the payment will return in the response. If the recipient doesn't approve the payment, his data won't return.

Parameters

Name	In	Type	Required	Description
`PayMe-Merchant-Key`	header	string	no	Seller's MPL

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/payment-contracts/recipients'

Node.js

const response = await fetch("https://sandbox.payme.io/api/payment-contracts/recipients", {
  method: "GET",
});

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

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/payment-contracts/recipients",
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/payment-contracts/recipients');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

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

echo $response;

Responses

200 — OK (success)

Field	Type	Description
`status_code`	integer
`page`	integer
`items_per_page`	integer
`items_total`	integer
`items`	array
`items[].name`	string
`items[].phone`	string
`items[].business_code`	integer
`items[].email`	string
`items[].seller_payme_id_checksum`	string	Use that value when creating a new contract. Use it in the recipient.payme_id

{
  "status_code": 0,
  "page": 1,
  "items_per_page": 8,
  "items_total": 8,
  "items": [
    {
      "name": "ghkjy",
      "phone": "+972522998220",
      "business_code": 123456,
      "email": "yardenco@gmail.com",
      "seller_payme_id_checksum": "eyJpdiI6ImNqUEYzR3M5S051Q2tqeGdVYnJlb3c9PSIsInZhbHVlIjoiVFQ2Zit3bzhaU2JHWnJyUzRtYnNwWUhvT1hTTGJRUXhnWC9kTUxKQ0JwV3NrY1RDQ3M4aGFvZ3BNVXUyU0tOMyIsIm1hYyI6IjcwNDgxZWJmZGEzYThlN2E3MDFhMmUyOTU5YzFkNmEzODc0YjJiNDE2OTExMDY2YjU0ZjEzYTM2NTk4MTJlODIiLCJ0YWciOiIifQ=="
    },
    {
      "name": "ohad dabush",
      "phone": "+972546545945",
      "business_code": 123123,
      "email": "ohad@paymeservice.com",
      "seller_payme_id_checksum": "eyJpdiI6Iks1SStGRmJtbnNSQUp3a0dydEdyZ2c9PSIsInZhbHVlIjoiNFo0RWRmT25FS0E3SHo2UXZjb296eU5FSEoyblFscHlBOUZWaGJFUWpLdTNIR1VRUEcyOUlxWWtYdnV5NGVYbSIsIm1hYyI6ImI4ODY5NjFjNDIxYjU5NTc2OWQ4ZWUyNDU0ZjdiZmI3YzFhZTJmYWNjNzZjNzYwYzQ5MTQ1ZjU5ZjFjMDFlZDciLCJ0YWciOiIifQ=="
    },
    {
      "name": "Yarden Cohen",
      "phone": "+972546548888",
      "business_code": 123123123,
      "email": "adam.kima@paymeservice.com",
      "seller_payme_id_checksum": "eyJpdiI6IjY3M0hDSVhzVDh3NlA2aENxWUNObXc9PSIsInZhbHVlIjoiWHdRUVVGN2Y2aFJ0Nlo1cDREUzRkWVR0WXhOVHZIUXN6QTJsdHFrdUx3dUpzckQwVm1iWkoyajZ4ZFlUK1pCRSIsIm1hYyI6IjY1ZmY2Y2EwNzA0YTNlNDhlN2M2ZTdkYTNkMzQ3Njk3Nzc4MTg0ZjQwOGE4MTBjZTI5NDQxZjdlZDUyMjZmMDIiLCJ0YWciOiIifQ=="
    },
    {
      "name": "אדם קימה",
      "phone": "+972528331779",
      "business_code": 516438207,
      "email": "Adam.kima@paymeservice.com",
      "seller_payme_id_checksum": "eyJpdiI6Iis0UUN1TEZVblBpSzlrUlBEN3VRWnc9PSIsInZhbHVlIjoiT2RUTjZ3dy90ZUdGZzVwdmNKMGZ5QXYzUlg4ejZNeU1HZ1F4WCtVZkQ4Q2JZbFZKZzNkL1FHRnR3QXI1WWZBeCIsIm1hYyI6IjExMzZlN2Y0ZDkzMjZhZDIzNDA2ZWJkYjcxZjViZDEwYjk2OTNiNDZjNzE1NTg2NGY4NTg2ZDM5ZWI3YjdlMDgiLCJ0YWciOiIifQ=="
    },
    {
      "name": null,
      "phone": null,
      "business_code": 123456,
      "email": null,
      "seller_payme_id_checksum": "eyJpdiI6ImFvMmtRSVJud1V3bzllUmhVSC9TS3c9PSIsInZhbHVlIjoiQjFIekMzS3hJamNRSGtsMk93VG1xZ0J2cFdzcDl4S0xnaXluZVZRSW9wZGNvNzNtYkhzNjE4TEhqa3Q0UWN3cSIsIm1hYyI6IjNkMDRhMjU3ODc3ZDY2MjJhMzc0Njg4M2MxNjQ3Mzg1MmJmY2NmY2IwMmVlOGVlZjA2YzVjOTc5NzUwYWVkYzkiLCJ0YWciOiIifQ=="
    },
    {
      "name": null,
      "phone": "+972523385355",
      "business_code": 123456,
      "email": "amitnili10+1@gmail.com",
      "seller_payme_id_checksum": "eyJpdiI6IndwUEZScVRMZlZOVHc1dDJLSnlralE9PSIsInZhbHVlIjoieUlucWNWN3NYRWZBbEVnbVdKMnpxdStGRitBcVFPY3l3cTNCUDN5cjZqVW9wcmlLa0hOSUhOQloySDFLZ1VrWSIsIm1hYyI6Ijc4ZWQ1NDkyNDAwN2I5ZThiNjNiMGVjZjFiZjU4NTdiZDYzODE1MjZhNzdjMjkxMTZjMTBhMWEzNTRmMzgwMGQiLCJ0YWciOiIifQ=="
    },
    {
      "name": "Maayan Bauman",
      "phone": "+972542340157",
      "business_code": 123123,
      "email": "maayan.bauman@payme.io",
      "seller_payme_id_checksum": "eyJpdiI6IkxjUTJjWTRsaUFLY1ZRUzRUY3BQdWc9PSIsInZhbHVlIjoiOE4veUkvdUZUSjAvaGp4VkJ5U3RUUUtodE5iY2U3WWgxNFZ1UlZNcUpYQmtqQkNEb21VVU5KNFRxci9KcmlYTSIsIm1hYyI6IjkyMTNmZjllNjZkY2MxYjdmZDNiYTNjYWVmY2NhMzAxMGJmMTM5N2UzZDkzZjI1NDU3ZWY4Y2IwYjRiZThmOTMiLCJ0YWciOiIifQ=="
    },
    {
      "name": "מעיין ספלייר",
      "phone": "+972541234567",
      "business_code": 123456798,
      "email": "maayan.bauman@payme.io",
      "seller_payme_id_checksum": "eyJpdiI6InNhMUVjR1hmeXV1bC9DQnh4OWhVOVE9PSIsInZhbHVlIjoiQVg5YkNWTi9uVGZxc21STEduUmpnR3Jlbm9IeUNnTFJDMzJmTnVNRXJXRmtNS1JZN0hXb2dEYnJqd3YvMzArcSIsIm1hYyI6ImExYjg2NGJlOTM2ZmQ4ODg1OTE1N2I5NmJjNjdmNTYzZThlYzE1NzJhYjY3MmJkYmQ0ZDIwNzE1NmIxYmJkMmMiLCJ0YWciOiIifQ=="
    }
  ]
}