Jump to Content
Guides
API Reference
API Reference
Log In
Jump to Content
Guides
API Reference
Disconnect Payoneer from account
Search
Log In
All
Pages
Start typing to search…
JUMP TO
Authentication
Get auth0 token
post
Authenticate a user by totp
post
Authenticate a user by phone number
post
Get MFA token
post
Log out a user
post
Recipients Portal API (Beta)
Payouts
Create a new payout
post
List payouts
get
Get payout details
get
Cancel a payout
post
Usage
Get API usage statistics
get
Authentication
Test API authentication
post
🆕
Payout Management
Approve a payout
post
Decline a payout
post
Get all pending payouts
get
API Key based endpoints
Wire Transfers
Validate transfer
post
Create a transfer
post
Global Accounts
Get a list of global accounts
get
Open a global account
post
Close a global account
post
Update a global account
post
Generate global account statement
post
Plaid
Create link token
post
Verify account
post
List supported countries
post
Connector API
Health
Check connector health
get
Validation
Validate bank code
post
Validate BIC/SWIFT
post
Validate iban
post
Invoice
Create an invoice
post
Create multiple invoices
post
Get a list of invoices
get
Get an invoice
get
Update an invoice
patch
Delete an invoice
del
Get an invoice by external id
get
Generate invoice by id
get
Calculate an invoice
patch
Get an invoice document
get
Get an original invoice document
get
Upload original invoice
post
Upload an invoice document
post
Make an invoice pending
put
Make an invoice approved
put
Make an invoice draft
put
Make failed invoice draft
put
Make all failed invoice draft
put
Make an invoice rejected
put
Make an invoice archived
put
User
Get user by id
get
Get user by email
get
Vendor
Create a vendor
post
Create vendors for a connector in bulk
post
Get vendors
get
Get vendor by id
get
Get vendor by external id
get
Get vendor invoice settings
get
Update vendor account
put
Update vendor account profile
put
Update contact information
put
Update vendor invoice settings
post
Update profile type
patch
Update tax information
put
Import vendors from CSV file
post
Activate vendor
post
Delete vendor
del
Vendor TAX
Get vendor tax form type
get
Create vendor tax form W9
post
Create vendor tax form W8 BEN
post
Create vendor tax form W8 BEN E
post
Vendor Billing Detalis
Get payment types supported by the connector
get
Get vendor billing details
get
Get wire form schema
post
Upsert Wire billing details
put
Upsert Crypto billing details
put
Upsert PayPal billing details
put
Upsert Payoneer billing details
put
Delete vendor billing details
del
Prepaid Cards API
Products
Get available products
get
Get product by code
get
Transfers
Estimate transfer
post
Get distribution link
post
Create transfer
post
Get transfers
get
Get transfer by id
get
Make transfer archive
put
Update transfer
patch
Resend a notification for a transfer
post
Reloadable
Get all prepaid reloadable cards with pagination
get
Get a reloadable card by ID
get
PayPal Transfers API
Balance
Get a paypal balances
get
Transfers
Create a transfer
post
Create batch transfers
post
Get transfers
get
Get transfer by id
get
Make an transfer archive
put
Make an transfer approved
put
Update transfer
patch
Cancellation
Create a paypal transfer cancellation
post
List paypal transfer cancellations
get
Get a paypal transfer cancellation
get
Gift Cards API
Products
Get all gift card products
get
Transfers
Find gift card transfers
get
Get a gift card transfer
get
Initializing a gift card transfer.
post
Update a gift card transfer.
put
Venmo Transfers
Create a venmo transfer
post
Get list of payments
get
Find transfer by id
get
Push to Card Transfers
Create a push to card transfer
post
Get list of payments
get
Find payment by id
get
Wire Transfers API
Get the API schema
post
Validate transfer
post
Create a payment
post
Get list of payments
get
Find payment by id
get
Retrieve a current rate
post
Get Payment commission
post
Crypto Payment API
Verify that the end-user’s entered crypto address is not problematic policy-wise.
post
Request crypto rates.
post
Initializing a crypto transaction.
post
Preserving crypto beneficiaries.
post
Getting crypto recipients.
get
Update crypto beneficiaries.
patch
Delete crypto beneficiaries.
del
Reloadable API
Reloadable Transfers
Estimate transfer costs and fees
post
Create a new reloadable card transfer
post
Get all reloadable transfers for the account
get
Get a specific reloadable transfer by ID
get
Update a reloadable transfer
put
Archive a reloadable transfer
del
Reloadable Cards
Create a new reloadable card
post
Get all reloadable cards for the account
get
Get a specific reloadable card by ID
get
Get secure card details including PIN and CVV
get
Get reloadable card details (unmasked card number and CVV) by ID
post
Get reloadable card portal access URLs and tokens by ID
post
Webhook Registry API
Get the API schema
get
Register webhook
post
Get registered webhooks for connector
get
Get registered webhooks
get
Update webhook
patch
Delete webhook
del
Reveal secret for webhook
get
Tax Forms Utility
Ping the tax forms utility
get
Create a W-9, W-8BEN or W-8BEN-E tax form
post
Get a tax form
get
Create a 1099 MISC form
post
Transmit a 1099 MISC form
post
Get the status of a 1099 MISC form
get
Download a draft PDF for a 1099 MISC form
get
Download a PDF for a 1099 MISC form
post
Create a 1099 NEC form
post
Transmit a 1099 NEC form
post
Get the status of a 1099 NEC form
get
Download a draft PDF for a 1099 NEC form
get
Download a PDF for a 1099 NEC form
post
Create a W2G form
post
Transmit a W2G form
post
Get the status of a W2G form
get
Download a draft PDF for a W2G form
get
Download a PDF for a W2G form
post
Download a tax form
get
Create a business
post
Validation
Phone validate
post
Validate iban
post
Validate bank code
post
Validate BIC/SWIFT
post
Account balance
Get balances
get
Get total balances
get
Get a list of global accounts
get
Prepaid Card Portal
Prepaid card portal
Get prepaid card portal branding
get
Get prepaid card transfer
get
Verify address
post
Send verification SMS
post
Verify phone number
post
Complete verification
post
Vendor Portal
Get vendor info
Get vendor info
get
Get vendor identities
get
Authenticate by SMS
post
Onboardings
Get the current vendor onboarding
get
Update the current vendor onboarding
patch
Verify email
post
Verify phone number
post
Finish the current onboarding and register an account
post
Invite a vendor
post
Get vendor onboarding wizard
get
Update vendor onboarding wizard
put
Finish vendor onboarding
put
Send sms to a phone number
post
Send verification email
post
Account Profile
Validate account vat address
post
Update vat information
patch
Update TAX information for vendor
put
Get information about vendor account profile
get
Update vendor account profile
put
Update vendor onboarding wizard
put
Billing details
Get an vendor billing details
get
Get active vendor billing details
get
Create or update a wire billing details for account
put
Create or update a crypto billing details for account
put
Create or update a PayPal billing details for account
put
Create or update a Payoneer billing details for account
put
Delete a billing details by id
del
Get authorization url
get
Upload a bank statement for account
put
Get original vendor bank statement
get
Set invoice currency
patch
Beneficiaries
Validate beneficiary
post
Get the form schema
post
Plaid
Create link token
post
Verify account
post
List supported countries for verification
post
TAX Form Submission
Get required tax form type
get
Get tax codes
get
Create W9 tax form
post
Create W8-BEN tax form
post
Create W8-BEN-E tax form
post
Get tax forms
get
Get tax withholding for account
get
Vendor VAT
Get vat address
get
Update vat information
patch
Validate account vat address
post
Dashboard
Get a list of vendor invoices
get
Get a list of vendor transactions
get
Invoice
Get a list of vendor invoices
get
Get an vendor invoice document
get
Get an vendor invoice
get
Update an invoice
patch
Upload original invoice
post
Get original vendor invoice document
get
Get connector invoice settings
get
Marketing data
Get a vendor performance data
get
Get a vendor performance summary data
get
Get a vendor performance data filter values
get
Get a vendor commission data
get
Get a vendor commission summary data
get
Get a vendor commission data filter values
get
System roles
Get a list of system roles
get
Get a system role by id
get
Users
Get information about the currently authenticated user
get
Update the currently authenticated user
patch
Get a list of users
get
Assign roles to a user
put
Remove roles from a user
post
Accept invitation
post
Invite a new user
post
Client side endpoints
API keys management
Create api key
post
Get registered api keys for connector
get
Get registered api keys
get
Reveal api key
post
Update api key
patch
Delete api key
del
Dashboard management
Dashboard Template
Get a list of dashboard templates
get
Dashboard
Create a dashboard
post
Get a list of dashboards
get
Get a dashboard
get
Get a statistic of dashboards
get
Update a dashboard
put
Delete a dashboard
del
Advertiser affiliate
Get an advertiser affiliate
get
Get a advertiser affiliate budget data
get
Get a advertiser affiliate commission data
get
Get a advertiser affiliate commission data filter values
get
Get a advertiser affiliate commission summary data
get
Get a advertiser affiliate performance data
get
Get a advertiser affiliate performance data filter values
get
Get a advertiser affiliate performance summary data
get
Budget
Create a dashboard budget
post
Get dashboard budgets
get
Get a dashboard budget
get
Update a dashboard budget
put
Make dashboard budget default
put
Delete a dashboard budget
del
Connector
Create a dashboard connector
post
Get a list of dashboard connectors
get
Get a dashboard connector
get
Get dashboard connector API key
get
Get secret for a connector
get
Make connector active
put
Update a dashboard connector
put
Delete a connector
del
Connector management
Connector Template
Get connector templates
get
Check a connector config
post
Get a connector config schema
get
Connector
Get a connector
get
Get a connector api key
get
Get secret for a connector
get
Vendors
Create a vendor for a connector
post
Import vendors for a connector
post
Get vendors
get
Update vendor account
put
Upsert vendor crypto billing details
put
Upsert vendor Payoneer billing details
put
Upsert vendor PayPal billing details
put
Upsert vendor wire billing details
put
Update vendor contact information
put
Update vendor tax information
put
Delete vendor
del
Invoice management
Invoice
Create invoice
post
Generate invoice by id
get
Get a list of invoices
get
Get invoice
get
Export invoices
get
Get document
get
Get invoice history
get
Get payout statistics
get
Get original document
get
Upload invoice document
post
Upload original invoice
post
Assign vendor to invoice
patch
Calculate an invoice
patch
Update invoice
patch
Make invoice approved
put
Make all invoice approved
put
Pay approved invoices
put
Pay all approved invoices
put
Pay failed invoices
put
Pay all failed invoices
put
Make invoice pending
put
Make invoice draft
put
Move failed invoice to draft
put
Move all failed invoice to draft
put
Make all draft_valid invoices pending
put
Archive all draft_valid invoices
put
Make invoice rejected
put
Reject all invoices
put
Make invoice archived
put
Reactivate a rejected invoice
put
Delete invoice
del
Invoice allowance
Allow an action on an invoice
post
Remove allowance of an action on an invoice
post
Invoice runner
Start invoice runner
post
Invoice settings
Get global invoice settings
get
Get account invoice settings
get
Get connector invoice settings
get
Get vendor invoice settings
get
Get invoice permissions for client invoice settings
get
Get invoice permissions for connector invoice settings
get
Update account invoice settings
post
Update connector invoice settings
post
Update vendor invoice settings
post
Set invoice permissions for client invoice settings
post
Set invoice permissions for connector invoice settings
post
Payoneer mfa challange
Get Payoneer MFA challenge for invoice by id
get
Complete Payoneer MFA challenge for invoice by id
post
Issuing
Authorizations
Get authorization status
get
Get single authorization status
get
Cardholders
Create a cardholder
post
Get all cardholders
get
Get cardholder details
get
Update a cardholder
post
Delete cardholder
post
Cards
Create a card
post
Get all cards
get
Get card details
get
Get sensitive card details
get
Get card remaining limits
get
Activate a card
post
Update a card
post
Get PAN token for specific card
post
Config
Get issuing config
get
Update issuing config
post
Digital Wallet Tokens
Get single digital wallet token
get
Get all digital wallet tokens
get
Transaction Disputes
Create a transaction dispute
post
Get a transaction dispute
get
Get all transaction disputes
get
Update a transaction dispute
post
Submit a transaction dispute
post
Cancel a transaction dispute
post
Transactions
Get transactions
get
Get single transaction
get
Payouts
Beneficiaries
Create a new beneficiary
post
Get list of beneficiaries
get
Get a beneficiary by ID
get
Get the API schema
post
Get the form schema
post
Validate beneficiary
post
Update existing beneficiary
post
Delete existing beneficiary
post
Payments
Validate payment
post
Create a payment
post
Get list of supported currencies
get
Get list of payments
get
Get list of business day
get
Get payment by ID
get
Get list of Payment information
post
Get Payment commission
post
Cancel a payment by ID
get
Conversions
Create a conversion
post
List all conversions
get
Retrieve a conversion
get
Get current exchange rate.
post
Conversion amendment
Create an amendment quote
post
Create an amendment on a booked but unsettled conversion.
post
Retrieve all amendments associated with a conversion ID.
get
Retrieve all amendments associated with a conversion ID.
get
Quote
Create a quote
post
Rate
Retrieve a current rate
post
Account
System roles
Get a list of system roles
get
Get a system role by id
get
Assign users to a system role
put
Transaction
Get list of transaction
get
Generate transactions report
get
Create confirmation letter.
post
Billing
Get plans
get
Get active subscription
get
Get active subscription
get
Inbound mailbox
Check availability of inbound email
post
Create a new inbound mailbox
post
Create or update inbound mailboxes in bulk
post
Update an existing inbound mailbox
put
Vendor accounts
Get information about vendor account.
get
Update vendor contact information.
put
Enable a phone number authentication for all users under this account
post
Disable a phone number authentication for all users under this account
post
Update account settings.
put
Account settings
Settings
Update account settings.
patch
Contact Information
Update account contact information.
put
MFA
Disable a phone number authentication for all users under this account
post
Enable a phone number authentication for all users under this account
post
Enable a TOTP authentication for all users under this account
post
Disable a TOTP authentication for all users under this account
post
TAX forms address
Get account TAX form address
get
Update account TAX form address
patch
Tax Information
Get tax information
get
Update tax information
post
Validate tax address
post
VAT information
Get account vat address
get
Update account vat address
patch
Validate account vat address
post
Prepaid Card
Get account prepaid card settings
get
Update account prepaid card settings
put
Update account prepaid card logo
put
Delete account prepaid card logo
del
Bank validation
Validate bank codeses
post
BIC/SWIFT code validation
post
Validate iban
post
Crypto payment
Batch transfers
Create a batch of crypto transfers.
post
Find crypto transfers.
get
Find crypto transfer by id.
post
Update a batch of crypto transfer
patch
Execute batched crypto transaction. It schedules the payment
post
Execute all batched crypto transactions. It schedules payments
post
Archive crypto transfer.
post
Recipients
Preserving crypto beneficiaries.
post
Getting crypto recipients.
get
Update crypto beneficiaries.
patch
Delete crypto beneficiaries.
del
Screening
Verify that the end-user’s entered crypto address is not problematic policy-wise.
post
Quote
Request crypto rates.
post
Transfer
Initializing a crypto transaction.
post
Vendor card
Invite a vendor
post
Get information about vendor for account.
get
Get payable status for vendor.
get
Get an vendor VAT details
get
Get tax form by vendor id
get
Get tax form withholding by vendor id
get
Update vendor billing details
patch
Update tax form
patch
Users
Users
Invite a new user
post
Accept invitation
post
Activate user
post
Terminate user. They won't be able to log in
post
Get a list of users
get
Assign roles to a user
put
Remove roles from a user
post
Get information about the currently authenticated user
get
Update the currently authenticated user
patch
Update default currency for user
put
Update currency setting for user
post
Get currency setting for user
get
Get available and pending balances for every currency
get
Get available balances in default currency
get
User Identity
Get information about the currently authenticated user identity
get
Update the currently authenticated user
patch
Verify email of the authenticated user
post
Disable a phone number authentication
post
Enable a phone number authentication
post
Generate a secret and qr code to share with an authentication app
post
Verify and set a generated TOTP secret of the authenticated user with status INVITED
post
Verify and update a generated TOTP secret of the authenticated user with status ACTIVE.
post
Change user's password
post
Update a password of the authenticated user with status INVITED
post
Set a phone number of the authenticated user with status INVITED
post
Update a phone number of the authenticated user with status ACTIVE
post
Get all available users for the authenticated user identity
get
PayPal
Connect PayPal to account
post
Get connected paypal status
get
Get paypal balance
get
Initializing a paypal transfer.
post
Find paypal transfers
get
Get a paypal transfer
get
Update a paypal transfer.
patch
Approve a paypal transfer.
post
Archive a paypal transfer.
post
Initializing a paypal transfer.
post
Disconnect PayPal from account
del
Payoneer
Connect Payoneer to account
post
Get connected payoneer status
get
Get authorization url
get
Get withdraw eligibility
get
Get balances of all receiving accounts associated with the account
get
Disconnect Payoneer from account
del
Prepaid card
Get available prepaid card products
get
Get prepaid card product by code
get
Create a prepaid card recipient
post
Find prepaid card recipients
get
Get a prepaid card recipient
get
Update a prepaid card recipient
put
Delete a prepaid card recipient
del
Initializing a prepaid card transfer.
post
Find prepaid card transfers
get
Get a prepaid card transfer
get
Update a prepaid card transfer.
patch
Archive a prepaid card transfer.
post
Estimate prepaid card transfer.
post
Find prepaid reloadable cards
get
Get a reloadable card with limits
get
Payment acceptance
Customers
Create a Customer object. We require the Customer ID in the merchant's system as a mandatory field.
post
Get list of customers
get
Generate a client secret for a Customer
get
Update a customer
post
Payment attempts
Retrieve a PaymentAttempt
get
Get list of PaymentAttempts
get
Configuration
Get available payment method types
get
Get available bank names.
get
Payment consents
Create a payment consent
post
Get list of PaymentAttempts
get
Retrieve a PaymentAttempt
get
Disable a payment consent
post
Verify a payment consent
post
Payment intent
Create a Payment Intent
post
Get list of payment intents
get
Retrieve a PaymentIntent
get
Capture a PaymentIntent
post
Confirm a PaymentIntent
post
Continue to confirm a PaymentIntent
post
Disable a PaymentIntent
post
Payment link
Create a new payment link
post
Get list of payment link
get
Retrieve a PaymentLink
get
Activate a PaymentLink
post
Deactivate a PaymentLink
post
Send a PaymentLink
post
Delete a PaymentLink
post
Update existing payment link
post
Payment method
Get list of payment link
get
Retrieve a PaymentMethod
get
Create a PaymentMethod
post
Disable a PaymentMethod
post
Quotes
Get list of Quotes
get
Retrieve a Quote
get
Create a Quote.
post
Reference data
Retrieve BIN Info
get
Refund
Create a Refund.
post
Retrieve a Refund
get
Get list of Refunds
get
Email change request
Create a request to change email
post
Approve the change email request
post
Get the latest pending email change request
get
Send an email notification to the latest pending email change request
post
Global accounts
Get a list of global accounts
get
Open a global account
post
Close a global account
post
Update a global account
post
Generate global account statement
post
Files
Upload a file
post
Get onboarding file download links
post
Invoice widgets
Get a list of invoices
get
Onboardings
Register an onboarding
post
Get the current onboarding
get
Update the current onboarding
patch
Update phone number
post
Verify email
post
Finish the current onboarding and register an account
post
Generate a secret and qr code to share with an authentication app
post
Generate a secret and qr code to share with an authentication app
post
Reset password request
Create a request to reset password
post
Approve the password reset request
post
RFIs
Retrieves details of an RFI using the given RFI ID.
get
Returns a list of RFIs raised for your account, sorted by the RFI creation date in descending order.
get
Allows you to respond to an RFI request by providing the required answers.
post
Webhooks registry
Register webhook
post
Get registered webhooks
get
Get registered webhooks for connector
get
Get list of available events for webhooks
get
Update webhook
patch
Reveal secret for webhook
post
Resend webhook event
post
Delete webhook
del
Financial report
Create a financial report
post
Get financial report by ID
get
Get contents of a financial report by ID
get
Get financial report status by ID
get
Get file of a financial report by ID
get
Tax treaties
Get all tax treaties
get
Web notifications
Create new web notification
post
Create new web notification for multiply users as company
post
Get all web notifications to current user
get
Mark as read for multiple web notifications
patch
Mark as archived for multiple web notifications
patch
Delete one or many web notifications
del
Vendor portal API
/new-endpoint-1
get
get
/new-endpoint
New Endpoint
get
/oauth/token
post
post
Vendor Account Settings
VAT information
Get vat address
get
Update vat information
patch
Validate account vat address
post
Powered by
Disconnect Payoneer from account
Ask AI
delete
https://api.stage.payouts.com/payoneer
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer +2
URL
Base URL
https://api.stage.payouts.com
/payoneer
Response
Click
Try It!
to start a request and see the response here!