Withdraw a seller's balance

• Sandbox: POST https://sandbox.payme.io/api/withdraw-balance
• Production: POST https://live.payme.io/api/withdraw-balance

Credentials

• Request body field payme_client_key (optional): Your partner key. A seller calling for itself doesn't send it.
• Request body field seller_payme_id (required): The seller's MPL.

Requests a payout of a seller's released balance in one currency to the seller's bank account. By default it withdraws the whole released balance. To withdraw a set amount, send withdrawal_amount. To withdraw specific transactions, send transaction_ids. A partner sends payme_client_key and the seller's seller_payme_id. A seller sends its own seller_payme_id.

The seller must be on the manual withdrawal plan (seller_withdrawal_plan 1 on List sellers), approved by PayMe (seller_approved), and have bank details on file. Approval needs the seller's documents: see File types. The amount must be at least the minimum: 100.00 per currency (10000 in minor units), unless PayMe set another value for your account.

PayMe records the withdrawal, sends a withdrawal-complete callback, and transfers the money later. If the response has no items, no withdrawal was created. If the call times out, check List withdrawals before you retry. For plans, timing and reconciliation, see Withdrawals.

Errors

Every error returns status_code 1 with the code in status_error_code.

The full list is on Errors.

Callback

When the withdrawal is recorded, before the bank transfer, PayMe sends a withdrawal-complete callback (POST, x-www-form-urlencoded) to your default callback URL. See Callbacks.

Parameters

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

Request example

{
  "payme_client_key": "XXXXXXXX",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "withdrawal_currency": "ILS",
  "language": "en"
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/withdraw-balance' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "payme_client_key": "XXXXXXXX",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "withdrawal_currency": "ILS",
  "language": "en"
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/withdraw-balance", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "payme_client_key": "XXXXXXXX",
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "withdrawal_currency": "ILS",
    "language": "en"
  }),
});

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

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/withdraw-balance",
    json={
        "payme_client_key": "XXXXXXXX",
        "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
        "withdrawal_currency": "ILS",
        "language": "en",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "payme_client_key": "XXXXXXXX",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "withdrawal_currency": "ILS",
  "language": "en"
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/withdraw-balance');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

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

echo $response;

Responses

200 — OK (success)

{
  "status_code": 0,
  "session": "a1B2c3D4",
  "page": 1,
  "items_per_page": 1,
  "items_total": 1,
  "items": [
    {
      "withdrawal_id": 10001,
      "withdrawal_currency": "ILS",
      "withdrawal_total": 600000
    }
  ]
}

500 — Error, for example error 171: no released balance to withdraw (error)

{
  "status_code": 1,
  "status_error_details": "No available funds for withdrawal",
  "status_additional_info": null,
  "status_error_code": 171,
  "session": "a1B2c3D4"
}