Get Recipient

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

Credentials

• Header PayMe-Merchant-Key (API key)

That endpoint will check if the recipient exists in the system, and if the balance in the seller's wallet is >= the contract's amount.

Parameters

Name	In	Type	Required	Description
PayMe-Merchant-Key	header	string	no
amount	query	number	yes	Decimal - 2 dots
currency	query	string	yes
email	query	string	no
business code	query	string	no
phone	query	string	no

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/payment-contracts/recipients/has-matching-balance?amount=<amount>&currency=<currency>' \
  -H 'PayMe-Merchant-Key: <PayMe-Merchant-Key>'

Node.js

const response = await fetch("https://sandbox.payme.io/api/payment-contracts/recipients/has-matching-balance?amount=<amount>&currency=<currency>", {
  method: "GET",
  headers: {
    "PayMe-Merchant-Key": "<PayMe-Merchant-Key>",
  },
});

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

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/payment-contracts/recipients/has-matching-balance?amount=<amount>&currency=<currency>",
    headers={
        "PayMe-Merchant-Key": "<PayMe-Merchant-Key>",
    },
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/payment-contracts/recipients/has-matching-balance?amount=<amount>&currency=<currency>');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'PayMe-Merchant-Key: <PayMe-Merchant-Key>',
    ],
]);

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

echo $response;

Responses

No responses are documented for this endpoint.