# Payoneer

> Pay contractors and sellers worldwide through your Payoneer partner program: invite payees, check their status, send and cancel payouts, and watch your program balance.

App · 9 actions. Web page: https://docs.lodol.com/docs/integrations/payoneer

## Actions

### Cancel payout

Ask Payoneer to cancel a payout it hasn't paid yet; the money returns to the program balance. Payoneer confirms with the Payout canceled notification.

**Inputs**

- Payout reference (`client_reference_id`, text, required): Your own reference for the payout, given when it was sent.

**Outputs**

- `cancel_requested` (true/false): Always true once Payoneer accepts the request
- `client_reference_id` (text): Your reference for the payout
- `message` (text): Payoneer's answer: the request was received, or the payout was already cancelled

**Example output**

```json
{
  "cancel_requested": true,
  "client_reference_id": "invoice-2026-0042",
  "message": "The request was received successfully. The cancel action has not yet been performed."
}
```

### Create payee sign-up link

Get a one-time link that invites a person or company to sign up with Payoneer (or link their existing account) so your program can pay them. Details you fill in are pre-filled on the page.

**Inputs**

- Payee ID (`payee_id`, text, required): Your own ID for the person or company, such as their ID in your system. Up to 50 characters. You pay them by it later.
- Return address (`redirect_url`, text, required): The web page Payoneer sends the payee to once they finish signing up.
- Seconds before returning (`redirect_time`, number): How long the finished page shows before the payee is sent to the return address. 0 sends them at once. From 0 to 600.
- Session ID (`client_session_id`, text): Your own ID for this invitation, which Payoneer's notifications about the payee repeat. Up to 50 characters.
- Payee already has a Payoneer account (`already_has_account`, true/false): Open the page as a sign-in, so someone with a Payoneer account links it to your program instead of making a new one.
- Page language (`language`, text): The sign-up page's language. Leave empty to follow the payee's. One of: `1` (English), `19` (Arabic), `18` (Danish), `26` (Dutch), `9` (French), `13` (German), `11` (Greek), `8` (Hungarian), `25` (Indonesian), `20` (Italian), and 14 more.
- Details the payee can't change (`lock_type`, text): Which of the details filled in here the payee can't edit. Defaults to none. One of: `NONE` (Nothing locked (default)), `ALL` (Everything pre-filled), `ADDRESS`, `NAMES`, `EMAIL`, `DATE_OF_BIRTH` (Date of birth), `NAME_ADDRESS_EMAIL` (Names, address and email), `ALL_NAMES` (All names), `ALL_NAMES_ADDRESS_EMAIL` (All names, address and email), `ENTITY_NAME_COUNTRY_ID` (Names, address, country and ID document), and 4 more.
- Payee type (`payee_type`, text): Whether the payee is a person or a company. One of: `INDIVIDUAL`, `COMPANY`.
- First name (`first_name`, text): The payee's (or company contact's) first name, filled in for them.
- Last name (`last_name`, text): The payee's (or company contact's) last name.
- Email (`email`, text): The payee's email address.
- Date of birth (`date_of_birth`, date): The payee's (or company contact's) date of birth.
- Mobile number (`mobile`, text): The payee's mobile phone number.
- Company name (`company_name`, text): For a company payee: its name.
- Company type (`company_legal_type`, text): For a company payee: its kind of legal entity. One of: `PUBLIC` (Public company), `PRIVATE` (Private company), `SOLE PROPRIETORSHIP`, `LLC`, `LLP`, `LTD`, `INC`, `NON PROFIT` (Non-profit), `TRUST`.
- Company website (`company_url`, text): For a company payee: its website.
- Country of incorporation (`incorporated_country`, text): For a company payee: where it is incorporated. One of: `AF` (Afghanistan (AF)), `AX` (Åland Islands (AX)), `AL` (Albania (AL)), `DZ` (Algeria (DZ)), `AD` (Andorra (AD)), `AO` (Angola (AO)), `AI` (Anguilla (AI)), `AQ` (Antarctica (AQ)), `AG` (Antigua & Barbuda (AG)), `AR` (Argentina (AR)), and 239 more.
- State of incorporation (`incorporated_state`, text): For a company payee: the state it is incorporated in, such as NY.
- Address line 1 (`address_line_1`, text): The payee's street address.
- Address line 2 (`address_line_2`, text): Apartment, suite or floor.
- City (`city`, text): The payee's city.
- State (`state`, text): The payee's two-letter state code, such as NY.
- Country (`country`, text): The payee's country of residence. One of: `AF` (Afghanistan (AF)), `AX` (Åland Islands (AX)), `AL` (Albania (AL)), `DZ` (Algeria (DZ)), `AD` (Andorra (AD)), `AO` (Angola (AO)), `AI` (Anguilla (AI)), `AQ` (Antarctica (AQ)), `AG` (Antigua & Barbuda (AG)), `AR` (Argentina (AR)), and 239 more.
- Postal code (`zip_code`, text): The payee's zip or postal code.

**Outputs**

- `payee_id` (text): Your ID for the payee, as sent
- `registration_link` (text): The one-time sign-up page to send the payee. It works for one sign-up
- `token` (text): The sign-up session's token, the end of the link
- `warnings` (list): Pre-filled details Payoneer refused. The link still works; the payee fills them in themselves

**Example output**

```json
{
  "payee_id": "contractor-1042",
  "registration_link": "https://payouts.payoneer.com/partners/lp.aspx?token=7293f06a1d524e6f80af0f414b0f0962010B7745A",
  "token": "7293f06a1d524e6f80af0f414b0f0962010B7745A",
  "warnings": []
}
```

### Get payee status

Get whether a payee is active, pending or inactive, why, their payout method and whether they can be paid now.

**Inputs**

- Payee ID (`payee_id`, text, required): Your own ID for the payee, the one used when they were invited (up to 50 characters).

**Outputs**

- `account_id` (text): The payee's Payoneer ID (their account ID)
- `eligibility_reasons` (list): Why the payee can't be paid yet, such as Pending KYC Review
- `eligible_for_payouts` (true/false): Whether the payee can be paid now
- `payee_id` (text): Your ID for the payee
- `payout_method_currency` (text): The currency of the payee's payout method
- `payout_method_type` (text): How the payee is paid: ACCOUNT, BANK, PREPAID_CARD...
- `registration_date` (text): The date the payee signed up, YYYY-MM-DD
- `status` (text): Active, Pending or InActive
- `status_code` (number): 1 active, 0 pending, 99 inactive
- `status_reasons` (list): Why the payee is pending or inactive, and what's needed

**Example output**

```json
{
  "account_id": "3743793",
  "eligibility_reasons": [
    "Pending KYC Review"
  ],
  "eligible_for_payouts": false,
  "payee_id": "contractor-1042",
  "payout_method_currency": "USD",
  "payout_method_type": "BANK",
  "registration_date": "2026-07-09",
  "status": "Pending",
  "status_code": 0,
  "status_reasons": [
    {
      "reason_description": "It looks like you are living in a country that is not your country of nationality",
      "reason_id": 21,
      "requirement_description": "Submit a document that clearly shows your full name and address",
      "requirement_id": 113
    }
  ]
}
```

### Get payout status

Get where a payout is (pending, transferred, cancelled), its amounts and dates, and why a bank refused or Payoneer cancelled it.

**Inputs**

- Payout reference (`client_reference_id`, text, required): Your own reference for the payout, given when it was sent.

**Outputs**

- `amount` (number): The payout amount
- `cancel_reason_code` (number): Payoneer's code when it was cancelled
- `cancel_reason_description` (text): Why it was cancelled
- `client_reference_id` (text): Your reference for the payout
- `currency` (text): The payout currency
- `load_date` (text): When the payout reached the payee
- `payee_id` (text): Your ID for the payee
- `payout_date` (text): When the payout was sent to Payoneer
- `payout_id` (text): Payoneer's ID for the payout
- `reason_code` (number): Payoneer's code when a bank refused it
- `reason_description` (text): Why a bank refused it
- `scheduled_payout_date` (text): When a scheduled payout is due to load
- `status` (text): Where the payout is, such as Pending, Transferred or Cancelled
- `target_amount` (number): The amount in the payee's currency, when it differs
- `target_currency` (text): The payee's currency, when it differs

**Example output**

```json
{
  "amount": 5.1,
  "cancel_reason_code": null,
  "cancel_reason_description": "",
  "client_reference_id": "invoice-2026-0042",
  "currency": "USD",
  "load_date": "2026-03-17T14:09:39.54-04:00",
  "payee_id": "contractor-1042",
  "payout_date": "2026-03-17T10:47:00-04:00",
  "payout_id": "1636595702",
  "reason_code": null,
  "reason_description": "",
  "scheduled_payout_date": "2026-04-30T00:00:00-04:00",
  "status": "Transferred",
  "target_amount": 4.2,
  "target_currency": "EUR"
}
```

### Get program balance

Get your program's balance, its currency and the fees it owes Payoneer.

**Inputs**: None.

**Outputs**

- `balance` (number): The program's balance
- `currency` (text): The balance's currency
- `fees_due` (number): Fees the program owes Payoneer
- `program_id` (text): The program the balance is for

**Example output**

```json
{
  "balance": 9325627.69,
  "currency": "USD",
  "fees_due": 65283.48,
  "program_id": "100012345"
}
```

### Get required bank details

List the bank details a payee must give to be paid to a bank account in a country and currency, with each field's label, limits and pattern.

**Inputs**

- Account holder (`payee_type`, text, required): Whether the bank account belongs to a person or a company. One of: `INDIVIDUAL`, `COMPANY`.
- Bank country (`country`, text, required): The country the bank account is in. One of: `AF` (Afghanistan (AF)), `AX` (Åland Islands (AX)), `AL` (Albania (AL)), `DZ` (Algeria (DZ)), `AD` (Andorra (AD)), `AO` (Angola (AO)), `AI` (Anguilla (AI)), `AQ` (Antarctica (AQ)), `AG` (Antigua & Barbuda (AG)), `AR` (Argentina (AR)), and 239 more.
- Account currency (`currency`, text, required): The bank account's currency. One of: `USD` (USD (US Dollar)), `EUR` (EUR (Euro)), `GBP` (GBP (Pound Sterling)), `CAD` (CAD (Canadian Dollar)), `AUD` (AUD (Australian Dollar)), `NZD` (NZD (New Zealand Dollar)), `JPY` (JPY (Yen)), `CNY` (CNY (Yuan Renminbi)), `CHF` (CHF (Swiss Franc)), `SEK` (SEK (Swedish Krona)), and 143 more.
- Label language (`language`, text): The language of the field labels and help. Defaults to English. One of: `en` (English), `ar` (Arabic), `da` (Danish), `nl` (Dutch), `fi` (Finnish), `fr` (French), `de` (German), `el` (Greek), `he` (Hebrew), `hu` (Hungarian), and 15 more.

**Outputs**

- `bank_account_type` (text): Individual or Company
- `count` (number): How many fields there are
- `country` (text): The bank account's country
- `currency` (text): The bank account's currency
- `fields` (list): The bank details the payee must give

**Example output**

```json
{
  "bank_account_type": "Individual",
  "count": 1,
  "country": "AD",
  "currency": "EUR",
  "fields": [
    {
      "description": "IBAN should include 24 characters.",
      "field_id": 7,
      "field_name": "IBAN",
      "field_type": "Text",
      "label": "IBAN",
      "max_length": 70,
      "min_length": 24,
      "regex": "^[A-Z]{2}\\d{2}([ ]?[A-Z0-9]){20}$",
      "required": true,
      "watermark": "e.g. AD12 00012030200359100100"
    }
  ]
}
```

### Send payout

Pay one payee from your program's balance. This sends real money at once (or on the date given, if your program schedules payouts).

**Inputs**

- Payout reference (`client_reference_id`, text, required): Your own unique reference for this payout, such as an invoice number. Payoneer refuses one it has seen before, so a payout is never made twice. Use it later to check or cancel the payout.
- Payee ID (`payee_id`, text, required): Your own ID for the payee, the one used when they were invited (up to 50 characters).
- Amount (`amount`, number, required): How much to pay, such as 125.50.
- Description (`description`, text, required): What the payout is for; the payee sees it. Up to 250 letters, digits, spaces and simple punctuation.
- Currency (`currency`, text): The payout's currency. Leave empty for the program's own. One of: `USD` (USD (US Dollar)), `EUR` (EUR (Euro)), `GBP` (GBP (Pound Sterling)), `CAD` (CAD (Canadian Dollar)), `AUD` (AUD (Australian Dollar)), `NZD` (NZD (New Zealand Dollar)), `JPY` (JPY (Yen)), `CNY` (CNY (Yuan Renminbi)), `CHF` (CHF (Swiss Franc)), `SEK` (SEK (Swedish Krona)), and 143 more.
- Pay on (`payout_date`, date and time): When to pay, up to a year ahead. Only for programs Payoneer has set up for scheduled payouts; others pay at once.
- Group (`group_id`, text): A label that groups payouts in Payoneer's console, such as a department. Letters, digits and spaces.

**Outputs**

- `client_reference_ids` (list): Your reference for each payout, to check its status or cancel it
- `result` (text): Payoneer's answer, such as Payments Created
- `submitted_count` (number): How many payouts were sent to Payoneer
- `total_amount` (number): The sum of their amounts

**Example output**

```json
{
  "client_reference_ids": [
    "invoice-2026-0042"
  ],
  "result": "Payments Created",
  "submitted_count": 1,
  "total_amount": 125.5
}
```

### Send payouts

Pay several payees in one request, from your program's balance. This sends real money.

**Inputs**

- Payouts (`payments`, list, required): The payouts to send, each with client_reference_id (your unique reference), payee_id, amount and description, and optionally currency, payout_date and group_id.

**Outputs**

- `client_reference_ids` (list): Your reference for each payout, to check its status or cancel it
- `result` (text): Payoneer's answer, such as Payments Created
- `submitted_count` (number): How many payouts were sent to Payoneer
- `total_amount` (number): The sum of their amounts

**Example output**

```json
{
  "client_reference_ids": [
    "payment_1",
    "payment_2"
  ],
  "result": "Payments Created",
  "submitted_count": 2,
  "total_amount": 12.0
}
```

### Transfer funds to another program

Move money from this program's balance to another of your Payoneer programs in the same transfer group. This moves real money; Payoneer completes it shortly after.

**Inputs**

- Target program ID (`target_program_id`, text, required): The Program ID of your other program, digits only. Payoneer's integration team links programs for transfers.
- Amount (`amount`, number, required): How much to move, in this program's currency, such as 1000.
- Description (`description`, text, required): What the transfer is for.

**Outputs**

- `base_rate` (number): The exchange rate, when the currencies differ
- `funding_request_id` (text): Payoneer's ID for the transfer; the Account funded notification names it
- `quote` (text): Payoneer's quote ID, when the currencies differ
- `received_at` (text): When Payoneer received the request (not when it completes)
- `source_amount` (number): The amount taken from this program
- `source_currency` (text): This program's currency
- `target_amount` (number): The amount the other program receives
- `target_currency` (text): The other program's currency

**Example output**

```json
{
  "base_rate": 0.860636,
  "funding_request_id": "20679",
  "quote": "5899134",
  "received_at": "2026-02-16T19:50:29.3145816Z",
  "source_amount": 1000.0,
  "source_currency": "USD",
  "target_amount": 860.64,
  "target_currency": "EUR"
}
```
