Register payee with token

Overview

The Register Payee with token API on-boards new users to the Payoneer platform for receiving payouts. You pass a payee ID that your system defines; Payoneer stores it and uses it to identify the recipient when you submit payout instructions.

Purpose

Call this API when on-boarding a new user so payees can choose how they wish to receive payments from your platform. The request carries customer identification, KYC, and banking details needed for fund transfers. Payoneer reviews submitted data for accuracy and compliance; when the process completes successfully, a payee entity is created in Payoneer's system.

Flowchart

Partner, Payees, and Payoneer: collect profile details, register payee with token, payout funding, payout instructions, then account funding to payees.

Bank fields and registration token

Payments via bank transfer require fields that differ by target country and currency; you are expected to collect the right profile detail from the payee. The Register Payee response returns a token your client uses to redirect the user to Payoneer's registration page to complete bank details.

Register Payee with token (API)

Example request shape (sandbox). Replace {program_id} with your program ID and use a valid OAuth2 bearer token.

curl -X POST \
https://api.sandbox.payoneer.com/v4/programs/{program_id}/payees/register-payee-with-token \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer MXVNd2NTcTBlTi94NkZC…' \
-d @register-payee-with-token-body.json

Example body (register-payee-with-token-body.json):

{
  "payee_id": "testWLCompany_123",
  "payee": {
    "type": "company",
    "company": {
      "name": "Rainbow Inc",
      "url": "https://www.payoneer.com",
      "legal_type": "INC",
      "incorporated_address_1": "8742 Main St.",
      "incorporated_address_2": "",
      "incorporated_city": "New York",
      "incorporated_state": "NY",
      "incorporated_zipcode": "10001",
      "incorporated_country": "US"
    }
  },
  "payout_method": {
    "type": "BANKTRANSFER",
    "bank_account_type": "company",
    "country": "US",
    "currency": "USD"
  }
}