Nothing Special   »   [go: up one dir, main page]

Pay One Era Pi Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 52
At a glance
Powered by AI
The document discusses Payoneer's payment services and provides documentation on account setup, API functions, and file formats.

The main sections covered include an overview, payee signup process, notifications, API reference, file validations, and partner account setup process.

Information needed to set up a partner account includes partner details, technical details, and IPCN URLs.

Payoneer Prepaid MasterCard is the perfect choice for you!

Payoneer Inc
Implementation Guide Payoneer Payout Services
http://www.payoneer.com

Document Version: 1.8


June 23rd, 2010

Page 1

Payoneer Prepaid MasterCard is the perfect choice for you!

Table of Contents
Confidentiality ............................................................................................................... 3 How to use this document ............................................................................................. 4 Revision History ............................................................................................................ 5 1. Overview ................................................................................................................ 6 The Process .............................................................................................................. 6 Workflow Schematics ............................................................................................ 6 Data and Fund Exchanges .................................................................................... 7 Communication Security ........................................................................................... 7 Sandbox/Testing Environment .................................................................................. 8 Payee Management .................................................................................................. 8 2. Payee Sign-up ....................................................................................................... 9 3. Payee Sign-up / Auto Population ......................................................................... 11 XML Parameters .................................................................................................. 12 4. Instant Process Completion Notification .............................................................. 15 5. Payoneer API....................................................................................................... 17 Function: Echo ........................................................................................................ 17 Function: GetVersion ............................................................................................... 18 Function: Payment Order Submission ..................................................................... 19 Function: Query Account Balance Method .............................................................. 21 Function: Get Payee Details .................................................................................... 22 Function: Change Payee ID .................................................................................... 24 Function: Get Payees Report .................................................................................. 26 Function: Get Single Payee Report ......................................................................... 28 Function: Send Message To Payee ........................................................................ 29 Function: Send Message To All Payees .................................................................. 30 Function: Get Unclaimed Payments XML ................................................................ 31 Function: Get Unclaimed Payments CSV ................................................................ 33 Function: Cancel Payment ...................................................................................... 34 6. InterPay via Web Based Admin Console ............................................................. 35 Payee List ............................................................................................................... 35 Mass Payment......................................................................................................... 36 Perform Single Payment ......................................................................................... 37 7. Payee Virtual Card Sign-up ................................................................................. 38 XML Parameters .................................................................................................. 40 Function: Get Card Token ................................................................................... 44 Payoneer Virtual Card - ....................................................................................... 45 Appendices ................................................................................................................. 47 Appendix B Payoneer Mass Payment XML File Format ....................................... 48 Appendix C Payoneer Mass Payment CSV File Format ...................................... 50 Appendix D Field Validations................................................................................ 51 Appendix E Partner Account Setup Process ........................................................ 52

Page 2

Payoneer Prepaid MasterCard is the perfect choice for you!

Confidentiality
By proceeding, you hereby acknowledge that all the information contained herein constitutes valuable property and trade secrets of Payoneer Inc, which are strictly confidential. You agree that you shall not directly or indirectly: 1. Use or permit the use of this document for, or in connection with, any other business whatsoever, or for any purpose other then the analysis of the project contemplated hereby, or 2. Disclose or permit the disclosure of any part of this document to any person or entity other than officers, shareholders or representatives of your same organization who are made aware of the confidential nature of this document and the restrictions on the disclosure or use of its contents and for the purpose stated. Lastly, you agree to immediately notify Payoneer Inc of the circumstances surrounding any breach of this confidentiality of which you become aware.

THIS DOCUMENT CONSTITUTES INTELLECTUAL PROPERTY OF PAYONEER INC

COPYRIGHT PAYONEER INC 2010 ALL RIGHTS RESERVED

Page 3

Payoneer Prepaid MasterCard is the perfect choice for you!

How to use this document


This document is intended for developers who are integrating with Payoneer payment services. Section 1: Overview - is intended for all developers. Section 2: Payee Sign-Up - is intended for partners who will be redirecting their payees to Payoneer to sign up for a prepaid MasterCard. Section 3: Payee Sign-up / Auto Population - is intended for partners who will be redirecting their customers to Payoneer to sign up for a prepaid card and wish to auto-populate data fields presented to the customer. Section 4: Instant Process Completion Notification - is intended for developers who want to receive Payoneers IPCN (Instant Process Completion Notification) notification to receive feedback on status of registered, approved and declined card applicants. Section 5: Payoneer API - is intended for developers who want to query the Payoneer platform directly for information about their payees and payments. Section 6: InterPay via Web Based Admin Console - describes the InterPay platform which provides an interface for partners to submit payments instructions to Payoneer via xml or csv files. Section 7: Payee Virtual Card Sign-up & Payments - is intended for developers who will be redirecting their payees to Payoneer to sign up for a Virtual Card.

Page 4

Payoneer Prepaid MasterCard is the perfect choice for you!

Revision History
Date
June 23, 2010

Change Description

June 23, 2010

June 23, 2010 June 23, 2010 June 23, 2010 June 23, 2010 June 23, 2010

Added new Payee Is Inactive status for payees in PaymentOrderSubmission API 010 - Payee Is Inactive status is for payees who have registered with Payoneer but are not yet approved (Please note: Payee does not exist status is for payees who have not yet registered with Payoneer. These payee status details are provided during the PaymentOrderSubmission API. GetPayeeDetails API card status change to include only active/inactive payee status - other status types are not supported GetPayeeDetails API change to include only the active card of the payee other Card statuses are not supported GetPayeesReport limitation for 1 month period. Remove Escrow payments. Remove Get Unfinished Visits Reports API Remove CashCard Program

Page 5

Payoneer Prepaid MasterCard is the perfect choice for you!

1. Overview
Payoneer Inc provides a full-scale, easy-to-implement solution for fund disbursement. Operating the solution includes two steps: 1. Payee registration, performed on branded web pages fully hosted by Payoneer; 2. Payment instruction submission to Payoneer, via one of the two supported interfaces: a. Automated interface HTTPS Request/Response interfaces are available to automate data submission and to retrieve reports. The APIs are described further in this document; the specific credentials for submitting API calls are provided at the time of partner account setup. b. Manual interface Payoneer Web Admin Console (InterPay) provides a convenient interface for manual data submission and access to reports. InterPay supports initiation of a single payment as well as large batch file uploads.

The Process
Workflow Schematics

Page 6

Payoneer Prepaid MasterCard is the perfect choice for you!

Data and Fund Exchanges


Data and fund exchanges per schematics above: 1. A Payee signs up on a branded page at Payoneer's site. For the purpose of signing up, the partner redirects its payees to the Payoneer site. Upon completion of the sign up, the payee is redirected back to the partner web site or any other provided URL. 2. Payoneer ships the card to the payee. 3. Partner settles the payout funds to Payoneer's bank account. 4. Partner sends payout instructions to Payoneer. These instructions are sent via the API or InterPay (web based admin console). 5. Payoneer sends an email with a card load confirmation request to the payee; 6. Payoneer loads the card. Payoneer provides each partner with data and payment information and status at all stages of the workflow. The reports are available via the following interfaces: - Payoneer Web-based reports; - E-mail reports sent on a daily or monthly basis.

Communication Security
To ensure communication safety and message integrity, Payoneer's platform has been enhanced with a wide range of standard and proprietary security measures. Some of the measures are listed below: 1. Validation of the originating IP address: Originating IP addresses of all partner communications are validated against a list of confirmed IPs pre-defined for each partner account (used for all applications). 2. API Permission system: Partners may only use the API functions they need in accordance with their contract with Payoneer Inc. No unauthorized API calls are allowed and all calls are logged. 3. SSL-protected communications: Electronic communications are performed via an SSL-protected channel. 4. Password protected communications: API calls are authenticated using username and password allocated for partners at the time of account setup.

Page 7

Payoneer Prepaid MasterCard is the perfect choice for you!

Sandbox/Testing Environment
Use the Sandbox Test Environment to manage test accounts and their associated emails and API credentials and functions. The Payoneer Sandbox is a self-contained environment in which you can prototype and test your integration with Payoneer systems and applications. Before moving any Payoneer-based application/web site into production, you should test the application in the Sandbox to ensure that it functions as you intend and within the guidelines and standards set forth by Payoneer. The Sandbox is for use by developers of business solutions. Sandbox credentials will be sent by Payoneers Professional services department in an email. URLs: To access the Sandbox environment you will need to use a separate set of URLs, the credentials for both Sandbox and Productions environment will be the same. This means that the move from Sandbox to Production will involve changing only the base URLs. API URL: https://api.sandbox.payoneer.com/payouts/HttpApi/Api.aspx?parameters Partner Admin Console URL: http://partners.sandbox.payoneer.com/WebApps/Admin/Login.aspx

Payee Management
Prior to issuing payment instructions, the partner account balance at Payoneer needs to be credited accordingly. The account funding procedure is agreed upon contractually between Payoneer and the partner. Payout instruction submission will fail if the partner account balance does not have sufficient funds to perform the card loads. Payoneer API and InterPay are the two interfaces available for submitting payment instructions to Payoneer.

Page 8

Payoneer Prepaid MasterCard is the perfect choice for you!

2. Payee Sign-up
The payee sign-up page URL is unique and is generated by Payoneer specifically for each sign-up session. The URL is provided in response to a request submitted via HTTP of the following form: https://APIURL/API.aspx?mname=GetToken&p1=username&p2=password &p3=X&p4=Y&p5=A&p6=U&p7=MC&p8=T&p9=y Note: This URL is not the URL to be used for payee redirection!

Payee Sign-up Parameters


Parameter
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] Unique partner ID assigned by Payoneer. [Required] Unique payee ID as used within the partner system. [Optional] Payee session ID on the partner Web site. If provided, Payoneer sends it back upon process completion. [Optional] URL used by Payoneer for redirecting the payee back after completion of the sign-up process. [Optional] Token representing the type of the card that the cardholder is allowed to order. Options: ATM or MC (default). [Optional] The delay in seconds between

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner Id p4 (HTTP API) Partner Payee Id p5 (HTTP API) Session Id p6 (HTTP API) Redirect URL p7 (HTTP API) Card Type p8 (HTTP API)

AlphaNumeric AlphaNumeric No special chars AlphaNumeric

AlphaNumeric

String ATM or MC

Numeric

Page 9

Payoneer Prepaid MasterCard is the perfect choice for you!


Redirect Time the confirmation pages to the redirection to the partner URL at the end of the card application. Default is 10 seconds. [Optional] Creates a test Payee to check later with API functions. [Optional] Creates a XML response with the token URL.

p9 (HTTP API) Test Card p10 (HTTP API) XML Response

AlphaNumeric String True - XML False no XML

*See Field Validations on Appendix D Payoneer's server response contains the unique URL to the payee sign-up page. The payee then needs to be redirected to this URL for completion of the registration process. Example of a sign-up page URL (No XML):
https://payouts.payoneer.com/partners/lp.aspx?token=

Or (XML):
<?xml version="1.0" encoding="UTF-8" ?> - <PayoneerToken> <Token>https://payouts.payoneer.com/partners/lp.aspx?token= </Token> </PayoneerToken>

This URL is valid for a single payee registration.

Page 10

Payoneer Prepaid MasterCard is the perfect choice for you!

3. Payee Sign-up / Auto Population


The payee sign-up page URL is unique and is generated by Payoneer specifically for each sign-up session. The URL is provided in response to a request submitted via HTTP of the following form: https://APIURL/API.aspx?mname=GetTokenXML&p1=username&p2=passw ord&p3=PartnerId&xml=XMLSting * xml need to be passed using POST and not GET for security reasons. (p1, p2, p3 can still be passed using GET if needed)
Parameter
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] Unique partner ID assigned by Payoneer. [Required] Unique partner ID assigned by Payoneer.

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner Id Xml (HTTP API)

AlphaNumeric AlphaNumberic XML String Format

*See Field Validations on Appendix D Sample of XML String: <?xml version="1.0" encoding="UTF-8" ?> <PayoneerDetails> <Credentials> <userName>useruser</userName> <password>xxxxxx</password> </Credentials> <Details> <prid>partnerId</prid> <apuid>payeeId</apuid> <sessionid></sessionid> <redirect></redirect>

Page 11

Payoneer Prepaid MasterCard is the perfect choice for you! <redirectTime>20</redirectTime> <cardType>MC</cardType> <BlockType>0</BlockType> </Details> <PersonalDetails> <firstName>John</firstName> <lastName>Doe</lastName> <dateOfBirth>08091974</dateOfBirth> <address1>642W 42nd St.</address1> <address2>Ste 5E</address2> <city>New York</city> <country>US</country> <state>NY</state> <zipCode>10022</zipCode> <mobile></mobile> <phone>2125551234</phone> <email>me@payoneer.com</email> </PersonalDetails> </PayoneerDetails>

XML Parameters
Parameter
userName Partner Username password Partner Password prid Partner Id apuid Partner Payee Id sessionid Session Id redirect Redirect URL

Description
[Required] partner account username assigned by Payoneer Inc (provided upon setup) [Required] unique partner password assigned by Payoneer Inc (provided upon setup) [Required] Unique partner ID assigned by Payoneer. [Required] Unique payee ID as used within the partner system. [Optional] Payee session ID on the partner Web site. If provided, Payoneer sends it back upon process completion. [Optional] URL used by Payoneer for redirecting the payee back after completion of the sign-up process

Data Type
AlphaNumeric

AlphaNumeric

AlphaNumeric AlphaNumeric No special chars AlphaNumeric

AlphaNumeric 0

Page 12

Payoneer Prepaid MasterCard is the perfect choice for you!


cardType Card Type [Optional] Token representing the type of the card that the cardholder is allowed to order. Options: ATM or MC (default). [Optional] The level of field blocking in the auto-population option: 0 - no block (all fields can be changed) - default 1 - block all fields 2 - block address fields 3 - block name fields 4 block email address 5 - block name & address & email fields 6 DOB [Optional] The delay in seconds between the confirmation pages to the redirection to the partner URL at the end of the card application. Default is 10 seconds. [Optional] used for autofill purposes [Optional] used for autofill purposes [Optional] used for autofill purposes to be parsed correctly must be in MMDDYYYY format [Optional] used for autofill purposes [Optional] used for autofill purposes [Optional] used for autofill purposes [Optional] used for autofill purposes [Optional] used for autofill purposes State code (as appears in states table in database) String ATM or MC

BlockType Block type

Numeric 0-6

redirectTime Redirect Time

Numeric

firstName Partner Payee first name lastName Partner Payee last name dateOfBirth Partner Payee birth date address1 Partner Payee address address2 Partner Payee secondary address city Partner Payee city country Partner Payee country state Partner Payee state

AlphaNumeric AlphaNumeric Numeric

AlphaNumeric 30 Chars AlphaNumeric 30 Chars AlphaNumeric AlphaNumeric ISO2 code AlphaNumeric State code

Page 13

Payoneer Prepaid MasterCard is the perfect choice for you!


zipCode Partner Payee zip mobile Partner Payee mobile phone phone Partner Payee phone e-mail [Optional] used for autofill purposes [Optional] used for autofill purposes [Optional] used for autofill purposes [Optional] used for autofill purposes AlphaNumeric AlphaNumeric AlphaNumeric AlphaNumeric

*See Field Validations on Appendix D

Response
A XML formatted string, containing the unique URL to the payee sign-up page and information about the new cardholder created. The URL is valid for a single payee registration. Example:
<?xml version="1.0" encoding="UTF-8" ?> <PayoneerToken> <Token>http://payouts.payoneer.com/partners/lp.aspx?token=XXXAAAB</Token> <CardholderSignup> <Description><!-- If Status is not 000, This will describes the reason for rejecting the request --> </Description> <PaymentID><!-- A unique reference code for the payment performed --> </PaymentID> <Status><!-- See status code table below --> </Status> <PayoneerID><!-- The unique Payee ID in the Payoneer Inc system --> </PayoneerID> </CardholderSignup> </PayoneerToken>

Status code table:


000 001 099 PE1001 PE1004 PE1005 PE1006 FFA009A 000FFF0 A00B556F OK (Request accepted) Field format is invalid or is not supported Unauthorized access No XML Received UserName/Password not match to partner ID No partner id received No payee id received Auto populate XML contains invalid entries API Function Not Allowed By Partner Unauthorized Access or invalid parameters, please check your IP address and parameters

Page 14

Payoneer Prepaid MasterCard is the perfect choice for you!

4. Instant Process Completion Notification


Upon successful sign-up process, successful card issuance, card application rejection or credit to partners account, Payoneer's server issues Instant Process Completion Notification (IPCN): an HTTP/S request to a predefined URL on the partner site. If the call fails due to network timeout, Payoneer's server performs ten additional attempts. If all ten IPCN attempts fail, an e-mail notification is sent to a pre-defined e-mail address within the partner organization. IPCN can be set up to include any of the sign up session parameters, for example: https://www.partnercompany.com/payoneer_confirmation.asp? p4={{apuid}}&p5={{sessionid}} Payoneer Provide the following IPCNs notifications: IPCN Registration Confirmation: after payee completes the registration process for a prepaid card. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?REG=tr ue&payeeid={{apuid}}&sessionid={{sessionid}} IPCN ACH Registration Confirmation: after payee finishes the registration process for ACH. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?ACHRE G=true&payeeid={{apuid}}&sessionid={{sessionid}} IPCN Approved: once Payoneer approves payee card application. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?APPRO VED=true&payeeid={{apuid}}&sessionid={{sessionid}} IPCN Decline: once Payoneer declines payee card application. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?DECLIN E=true&payeeid={{apuid}}&sessionid={{sessionid}} Account Funded IPCN: upon reception of partner funds (once Partner balance with Payoneer is updated). Example: https://www.partnercompany.com/payoneer_confirmation.aspx?BALAN CE_UPDATED=true

Page 15

Payoneer Prepaid MasterCard is the perfect choice for you! Load Money to ACH IPCN: after funds are sent to ACH payee. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?LOADA CH=true&payeeid={{apuid}}

Payment Request Accepted IPCN: after Payoneer send the funds to the Payee. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?PAYME NT=true&payeeid={{apuid}} Note: once Payoneer approves payee card application (see IPCN Approved above) payee ID exists in the Payoneer system and Partner can submit payments to the Payee.

Page 16

Payoneer Prepaid MasterCard is the perfect choice for you!

5. Payoneer API
Function: Echo
Http usage: https://APIURL/API.aspx?mname=Echo This method returns the status of the API and Payout Services (Heart Beep). Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile)

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <PayoneerResponse> <Status> </Status> <Description> </Description> </PayoneerResponse>

Code table:
000 001 002 OK System down for scheduled maintenance System down

Page 17

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: GetVersion
Http usage: https://APIURL/API.aspx?mname=GetVersion This method returns the API version (to match with the relevant integration guide). Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile)

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <PayoneerResponse> <Version> </Version> </PayoneerResponse>

Page 18

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Payment Order Submission


Http usage: https://APIURL/API.aspx?mname=PerformPayoutPayment This method, if successful, creates a payment request in the Payoneer system. If there are not enough funds in the Partner account it will fail, therefore it is advisable to check the balance before each payment to make sure there are enough funds in the account. The fees required by the Partner will be updated in the Fees account, while any fees required by the payee will be deducted from the payment amount (sent as a parameter).

Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner username p2 (HTTP API) Partner password p3 (HTTP API) Partner ID p4 (HTTP API) Program ID p5 (HTTP API) Internal Payment ID p6 (HTTP API) Internal Payee ID p7 (HTTP API) Amount

Description
[Required] The method name. [Required] Partner account username assigned by Payoneer Inc [Required] Partner password assigned by Payoneer Inc [Required] Partner ID at Payoneer Inc as supplied during the partner account setup [Required] Program code at Payoneer Inc as supplied when the partner account setup [Required] Unique payment ID assigned by the partner [Required] Payee ID as set in the Partner system. [Required] Payment amount in USD. Fees charged to payees are deducted from this amount. Payments lower than the minimum payment amount will be rejected. [Required] Payment description [Required] Date of payment, usually today's date

Data Type
AlphaNumeric AlphaNumeric AlphaNumberic AlphaNumeric AlphaNumeric AlphaNumeric No special chars AlphaNumeric No special chars Decimal

p8 (HTTP API) Description p9 (HTTP API) Payment Date

AlphaNumeric Numeric (MM/dd/yyyy HH:mm:ss)

*See Field Validations on Appendix D

Page 19

Payoneer Prepaid MasterCard is the perfect choice for you!

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <PerformPayoutPayment> <Description><!-- If Status is not 000, This will describes the reason for rejecting the request --> </Description> <PaymentID><!-- A unique reference code for the payment performed --> </PaymentID> <Status><!-- See status code table below --> </Status> <PayoneerID><!-- The unique Payee ID in the Payoneer Inc system --> </PayoneerID> </PerformPayoutPayment>

Status code table:


000 001 002 003 004 005 009 010 099 OK (Request accepted) Field format is invalid or is not supported Payee does not exist Insufficient funds Payment Id already exists Internal error Internal error Payee is inactive Unauthorized access

Page 20

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Query Account Balance Method


Http usage: https://APIURL/API.aspx?mname=GetAccountDetails This method returns the available partner account balance.

Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username p2 (HTTP API) Partner Password p3 (HTTP API) Partner ID

Description
[Required] This is the method name. [Required] This will be the partner account username assigned by Payoneer Inc. [Required] This will be the unique partner password assigned by Payoneer Inc. [Required] This will be the partner account ID number at Payoneer Inc. It will be supplied when setup the partner account profile.

Data Type
AlphaNumeric AlphaNumeric Tokenized AlphaNumberic AlphaNumeric

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <GetAccountDetails> <FeesDue><!-- Fees due by partner to Payoneer Inc --> </FeesDue> <AccountBalance> <!-- Balance remaining in the Partners Account for payments --> </AccountBalance> </GetAccountDetails>

Page 21

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Get Payee Details


Http usage: https://APIURL/API.aspx?mname=GetPayeeDetails This method returns the requested payee's details. Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile) [Required] Partner Payee ID as appears in the Payoneer Inc system

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

p4 (HTTP API) Payee ID

AlphaNumeric No special chars

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <GetPayeeDetails> <Payee> <FirstName></FirstName> <LastName></LastName> <Address1></Address1> <Address2></Address2> <City></City> <State></State> <Zip></Zip> <Country></Country> <Email></Email> <Phone></Phone> <Mobile></Mobile> <PayOutMethod></PayOutMethod><!--Prepaid Card/Direct deposit/Paypal --> <Cards><!-- if it is Prepaid Card --> <Card><!--for active card-->

Page 22

Payoneer Prepaid MasterCard is the perfect choice for you!


<CardID> <CardID/> <ActivationStatus> </ActivationStatus> <CardShipDate> <CardShipDate/> <CardStatus> </CardStatus> </Card> </Cards> <RegDate></RegDate> </Payee> </GetPayeeDetails>

Card Statuses:
Inactive Active Card cannot be used (no funds available on the card or card is blocked) Card can be used at ATMs, POS and Online

Card Activation Statuses:


Not Issued, Pending Approval Card Issued, Not Activated Card Activated Card Cancelled

Page 23

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Change Payee ID


Http usage: https://APIURL/API.aspx?mname=ChangePayeeID This method gets an existing Payee ID (old) and changes it to the new one.

Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile) [Required] Partner Payee ID as appears in the Payoneer Inc system [Required] New Partner Payee ID to set

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

p4 (HTTP API) old Payee ID P5 (HTTP API) new Payee ID

AlphaNumeric No special chars AlphaNumeric No special chars

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <ChangePayeeID> <OldPayee><!The payee ID that was changed --> </OldPayee> <NewPayee><!New Payee ID assigned --> </NewPayee> <Result><!-- See code table --> </Result> <Description> <!description of error --> </Description> </ChangePayeeID>

Page 24

Payoneer Prepaid MasterCard is the perfect choice for you! Code table:
000 001 002 003 OK Payee does not exist in the Payoneer system Internal error New Payee ID already exists

Page 25

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Get Payees Report


Http usage: https://APIURL/API.aspx?mname=GetPayeesReport This method returns all payments made to payees, grouped by payment method. Note: API call limit for 1 month period. Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile) [Required] type of report to generate. At this time only XML report is supported [Optional] Date of payment to start looking from [Optional] Date of payment to end search with

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

p4 (HTTP API) Report Type P5 (HTTP API) Start Date P6 (HTTP API) End Date

Integer (Enum) XML = 0 Date MM/dd/yyyy Date MM/dd/yyyy

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="utf-8" standalone="no"?> <PayoneerPayees> <Prepaid> <!here are listed all the payees that have registered for Prepaid:--> <Payee> <PayeeId></PayeeId> <Name> </Name> <Email> </Email> <RegistrationDate> </RegistrationDate> <Status> </Status> <TotalAmount></TotalAmount>

Page 26

Payoneer Prepaid MasterCard is the perfect choice for you!


<!--all of this payees payments--> <Payments> <Payment> <Date> </Date> <PaymentID> </PaymentID> <Amount> </Amount> <Status> </Status> <Description> </Description> </Payment> </Payments> </Payee> </Prepaid> <BankAccount> <!here are listed all the payees that have registered for ACH--> </BankAccount> <PayPal> <!here are listed all the payees that have registered for PayPal --> </PayPal> </PayoneerPayees>

Page 27

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Get Single Payee Report


Http usage: https://APIURL/API.aspx?mname=GetSinglePayeeReport This method returns all payments made to a single payee.

Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile) [Required] Partner Payee ID as appears in the Payoneer Inc system

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID p4 (HTTP API) Payee ID

AlphaNumeric

AlphaNumeric No special chars

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <PayoneerPayees> <Prepaid> <Payee> <Name> </Name> <Email> </Email> <RegistrationDate> </RegistrationDate> <Status> </Status> <TotalAmount> </TotalAmount> <Payments> <Payment> <Date> </Date> <PaymentID> </PaymentID> <Amount> </Amount> <Status> </Status> <Description> </Description> </Payment> </Payments> </Payee> </Prepaid></PayoneerPayees>

Page 28

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Send Message To Payee


Http usage: https://APIURL/API.aspx?mname=SendMessageToPayee This method sends a message to the requested payee. The payee will then be able to see the message in their My Account page. Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile) [Required] Partner Payee ID as appears in the Payoneer Inc system [Required] The subject of the message [Required] The body of the message [Required] The name of the sender of the message

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

p4 (HTTP API) Payee ID P5 (HTTP API) Subject P6 (HTTP API) Message P7 (HTTP API) From

AlphaNumeric No special chars AlphaNumeric AlphaNumeric AlphaNumeric

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <SendMessageToPayee> <PayeeID></PayeeID> <Subject> </Subject> <Result></Result> <!000 if send, 001 if failed --> <Description> </Description> </SendMessageToPayee>

Page 29

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Send Message To All Payees


Http usage: https://APIURL/API.aspx?mname=SendMessageToAllPayees This method sends a message to all active payees. The payee will then be able to see the message in their My Account page. Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile) [Required] The subject of the message [Required] The body of the message [Required] The name of the sender of the message

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

P4 (HTTP API) Subject P5 (HTTP API) Message P6 (HTTP API) From

AlphaNumeric AlphaNumeric AlphaNumeric

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <SendMessageToAllPayees> <Subject> </Subject> <Result></Result> <!000 if send, 001 if failed --> <Description> </Description> </SendMessageToAllPayees>

Page 30

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Get Unclaimed Payments XML


Http usage: https://APIURL/API.aspx?mname=GetUnclaimedPaymentsXML This method returns a list of all payments that have not been claimed yet. Request Parameters
Field mname (HTTP API) p1 (HTTP API) Partner Username Description [Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile) Data Type AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <GetUnclaimedPayments> <Payment> <IntPayeeId> </IntPayeeId><!--as assigned by partner --> <IntPaymentId> </IntPaymentId><!--as assigned by partner -> <PayoneerPaymentId> </PayoneerPaymentId><!--internal payoneer reference --> <Amount></Amount><!-- as calculated in payment --> <!--payee details as provided by payee: --> <FirstName> </FirstName> <LastName> </LastName> <Address1> </Address1> <Address2> </Address2> <City> </City> <State> </State> <Zip> </Zip> <Country><!--2 letter code --></Country> <Email> </Email> <Phone> </Phone>

Page 31

Payoneer Prepaid MasterCard is the perfect choice for you!


<Mobile> </Mobile> <PayOutMethod></PayOutMethod> <!--Prepaid Card/Direct deposit/Paypal --> <PaymentDate> </PaymentDate> <Description> </Description><!--as provided in payment --> </Payment> </ GetUnclaimedPayments>

Page 32

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Get Unclaimed Payments CSV


Http usage: https://APIURL/API.aspx?mname=GetUnclaimedPaymentsCSV This method returns a list of all payments that have not been claimed yet. Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile)

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

*See Field Validations on Appendix D

Response
A comma separated string where each row contains the following information:
IntPayeeId*,IntPaymentId*,PaymentId,Amount,FirstName,LastName,Address1, Address2,City,State,Zip,Country,Email,Phone,Mobile,PayOutMethod,PaymentDate, Description
* IntPayeeId is the payee Id as set in the partner's system * IntPaymentId is the payment Id as set in the partner's system

Page 33

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Cancel Payment


Http usage: https://APIURL/API.aspx?mname=CancelPayment This method cancels a payment that has not yet been processed and loaded to a card. Request Parameters
Field
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile) [Required] Partner Payment ID as assigned upon payment

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner ID

AlphaNumeric

p4 (HTTP API) Payment ID

AlphaNumeric

*See Field Validations on Appendix D

Response
A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <CancelPayment> <PaymentID> </PaymentID><!-- of the cancelled payment --> <Result> </Result><!000 means success, otherwise see table --> <Amount> </Amount><!-- of the cancelled payment --> <Description> </Description><!-- of the cancelled payment --> </CancelPayment>

Code table:
000 001 002 003 004 005 OK Payment does not exist payment has already been processed payment has already been cancelled / rejected Failed to cancel payment Payment cancelled, but failed to return money to partner's balance

Page 34

Payoneer Prepaid MasterCard is the perfect choice for you!

6. InterPay via Web Based Admin Console


InterPay is an application that transfers partner payment requests to Payoneer Inc. Payments may be performed one at a time or in a mass payment. In order to receive funds/payments, a payee must be registered in the Payoneer system. It is in the registration stage that the payee selects the payment method and provides the relevant details. To access the Partners admin console web interface, please go to https://partners.payoneer.com/WebApps/admin/Login.aspx Listed below are 3 ways to submit payment instructions to Payoneer:

1. Payee List
When entering the InterPay tab on the Admin Console, the payee list will appear. To send payment instructions you will be required to enter the amount, description and payment id. Once completed, click on Update and then Pay. Confirmation page window will appear with the requested payments. Verify the payment then click on the Process Payment button and payments will be transmitted to Payoneer and to your Payees.

Page 35

Payoneer Prepaid MasterCard is the perfect choice for you!

2. Mass Payment
InterPay supports mass payment option by creating an XML or CSV file in the Payoneers format (see Appendix B and C for file format) and uploading it to Payoneer using the web interface.

After the file is uploaded, the payments from the file will be presented on the screen for your review. Verify the payments and click on the Process Payment button. The payments will be transmitted to Payoneer and to your Payees.

Page 36

Payoneer Prepaid MasterCard is the perfect choice for you! 3.

Perform Single Payment


Enter the Payee id, Payment Id, amount and description, click the Pay button and money will be transferred to your payee.

Page 37

Payoneer Prepaid MasterCard is the perfect choice for you!

7. Payee Virtual Card Sign-up & Payments


For CardType VC (virtual card): the submission of this request will create a cardholder registration and a payment to this card according to the details submitted in the XMLString. In this case the <VirtualCard> section is required. A result status will be provided in the response. For all card type the request submitted via HTTP needs to be of the following form: https://APIURL/API.aspx?mname=GetTokenXML&p1=username&p2=passw ord&p3=PartnerId&xml=XMLSting * xml need to be passed using POST and not GET for security reasons. (p1, p2, p3 can still be passed using GET if needed)
Parameter
mname (HTTP API) p1 (HTTP API) Partner Username

Description
[Required] This is the method name. [Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] Unique partner ID assigned by Payoneer. [Required] Unique partner ID assigned by Payoneer.

Data Type
AlphaNumeric AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner Id Xml (HTTP API)

AlphaNumeric AlphaNumberic XML String Format

*See Field Validations on Appendix D

Page 38

Payoneer Prepaid MasterCard is the perfect choice for you!

Sample of XML String: <?xml version="1.0" encoding="UTF-8" ?> <PayoneerDetails> <Credentials> <userName>useruser</userName> <password>xxxxxx</password> </Credentials> <Details> <prid>partnerId</prid> <apuid>payeeId</apuid> <cardType>VC</cardType> </Details> <PersonalDetails> <firstName>John</firstName> <lastName>Doe</lastName> <dateOfBirth>08091974</dateOfBirth> <address1>642W 42nd St.</address1> <address2>Ste 5E</address2> <city>New York</city> <country>US</country> <state>NY</state> <zipCode>10022</zipCode> <mobile></mobile> <phone>2125551234</phone> <email>me@payoneer.com</email> <IdType>4</IdType> <IdNumber>66655544</IdNumber> <NameOnId>Amir Tatarsky</NameOnId> <IdCountry>Israel</IdCountry> <IdExpDate>08092020</IdExpDate> <PassportIssueDate>08092021</PassportIssueDate> </PersonalDetails> <VirtualCard> <CredentialName>Promo code</CredentialName> <CredentialValue>232547567</CredentialValue> <AmounttoLoad>20.00</AmounttoLoad> <PaymentDescription>card load</PaymentDescription> </VirtualCard> </PayoneerDetails>

Page 39

Payoneer Prepaid MasterCard is the perfect choice for you!

XML Parameters
Parameter
userName Partner Username password Partner Password prid Partner Id apuid Partner Payee Id cardType Card Type

Description
[Required] partner account username assigned by Payoneer Inc (provided upon setup) [Required] unique partner password assigned by Payoneer Inc (provided upon setup) [Required] Unique partner ID assigned by Payoneer. [Required] Unique payee ID as used within the partner system. [Required] Token representing the type of the card that the cardholder is allowed to VC Virtual Card Will only be allowed for partners with special permissions. [Required] will be used for cardholder registration [Required] will be used for cardholder registration [Optional] must be in MMDDYYYY format [Required] will be used for cardholder registration [Optional] will be used for cardholder registration [Required] will be used for cardholder registration [Required] will be used for cardholder

Data Type
AlphaNumeric

AlphaNumeric

AlphaNumeric AlphaNumeric No special chars String VC

firstName Partner Payee first name lastName Partner Payee last name dateOfBirth Partner Payee birth date address1 Partner Payee address address2 Partner Payee secondary address City Partner Payee city country Partner Payee

AlphaNumeric AlphaNumeric Numeric

AlphaNumeric 30 Chars AlphaNumeric 30 Chars AlphaNumeric AlphaNumeric ISO2 code

Page 40

Payoneer Prepaid MasterCard is the perfect choice for you!


country State Partner Payee state zipCode Partner Payee zip mobile Partner Payee mobile phone Phone Partner Payee phone e-mail IdType ID Type registration [Optional] State code will be used for cardholder registration [Required] will be used for cardholder registration [Optional] will be used for cardholder registration [Required] will be used for cardholder registration [Required] will be used for cardholder registration [Required] will be used for cardholder registration 1=SSN 2=Driver License 3=National ID 4=Passport Number [Required] will be used for cardholder registration [Required] will be used for cardholder registration [Required for Id Types 2,3,4] will be used for cardholder registration [Required for Id Types 2,4] will be used for cardholder registration must be in MMDDYYYY format [Required for Id Type 4] will be used for cardholder registration must be in MMDDYYYY format iso_3166 AlphaNumeric State code iso_3166 AlphaNumeric AlphaNumeric AlphaNumeric AlphaNumeric Numeric

IdNumber ID Number NameOnid Name on ID IdCountry Country Issued ID IdExpDate ID Expiration Date

Numeric AlphaNumeric AlphaNumeric

Numeric

PassportIssue Date Passport Issued Date

Numeric

Page 41

Payoneer Prepaid MasterCard is the perfect choice for you!

Credential Name Credential Value Amountto Load

[Required]thecredentialnamethat willappearaspromptinlogintothe cardinformation. [Required]thevalueofthecredential willbeexpectedinlogintothecard information.


[Required] Payment amount in USD. Payments lower than the minimum payment amount will be rejected. [Required] Payment description

AlphaNumeric

MaxLength=50
AlphaNumeric

MaxLength=50 Decimal

Payment Description

AlphaNumeric Max Length=50

*See Field Validations on Appendix D

Response
An XML formatted string, containing the unique URL to the payee sign-up page and information about the new cardholder created. The URL is valid for a single payee registration. Example:
<?xml version="1.0" encoding="UTF-8" ?> <PayoneerToken> <Token>http://payouts.payoneer.com/partners/lp.aspx?token=XXXAAAB</Token> <CardholderSignup> <Description><!-- If Status is not 000, This will describes the reason for rejecting the request --> </Description> <PaymentID><!-- A unique reference code for the payment performed --> </PaymentID> <Status><!-- See status code table below --> </Status> <PayoneerID><!-- The unique Payee ID in the Payoneer Inc system --> </PayoneerID> </CardholderSignup> </PayoneerToken>

Page 42

Payoneer Prepaid MasterCard is the perfect choice for you! Status code table:
000 001 003 004 005 006 007 008 009 099 044 045 PE1001 PE1004 PE1005 PE1006 PE1010 FFA009A 000FFF0 A00B556F OK (Request accepted) Field format is invalid or is not supported Insufficient funds Payment Id already exists Internal error Internal error Cannot load negative amount Exceeded minimum loading limit Exceeded maximum loading limit Unauthorized access Payee ID already exists Email already exists No XML Received UserName/Password not match to partner ID No partner id received No payee id received Unauthorized action Auto populate XML contains invalid entries API Function Not Allowed By Partner Unauthorized Access or invalid parameters, please check your IP address and parameters

Page 43

Payoneer Prepaid MasterCard is the perfect choice for you!

Function: Get Virtual Card Token


Http usage: https://APIURL/API.aspx?mname=GetCardToken Use this function to obtain the latest token link for a payee to view their virtual card details. Since this is a onetime link, the API will only provide it if it has never been used. This API is for use only with virtual cards.

Request Parameters

Field

Description
[Required] This is the method name.

DataType

mname (HTTP API) p1 (HTTP API) Partner Username

AlphaNumeric

[Required] partner account username assigned by Payoneer Inc (provided upon setup of the partner account profile) [Required] unique partner password assigned by Payoneer Inc (provided upon setup of the partner account profile)

AlphaNumeric

p2 (HTTP API) Partner Password

AlphaNumeric

p3 (HTTP API) Partner Id

[Required] Unique partner ID assigned by Payoneer.

AlphaNumeric Max Length=50 AlphaNumeric Max Length=50 No special chars

p4 (HTTP API) Partner Payee Id

[Required] Unique payee ID as used within the partner system. (Order ID)

*See Field Validations on Appendix B

Response
Payoneer's server response contains the unique URL to the registration. A string that is an XML file formatted as following:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <PayoneerCardToken> <URL><!A tokened link to the registration and activation page --> </URL> </PayoneerCardToken>

This URL is valid one time only.

Page 44

Payoneer Prepaid MasterCard is the perfect choice for you!

Payoneer Virtual Card - Mass Registration CSV File Format


You must create a Comma-delimited file containing your payees information to send a Mass registration file. A comma-delimited file can be generated from most spreadsheet applications, such as Excel.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

Payee ID First Name Last Name e-mail Address 1 Address 2 city State Zip Code country Phone Number Mobile Number Date Of Birth Credential Name Credential Value Amount To Load Payment Description ID Type

The id this payee has in your system. Partner Payee first name Partner Payee last name Partner Payee e-mail address Partner Payee address [optional] Partner Payee secondary address Partner Payee city [optional] Partner Payee state - State code (iso_3166) Partner Payee zip Partner Payee country ISO2 code (iso_3166) [optional] Partner Payee Phone Number [optional] Partner Payee Mobile Number [optional] Partner Payee Date Of Birth must be in MMDDYYYY format The credential name that will appear as prompt in login to the card information. The value of the credential will be expected in login to the card information. Payment amount in USD. Payment description 1=SSN 2=Driver License 3=National ID 4=Passport Number

19 20

IF ID Type = 1 [SSN] Name on Card Social Security Number Partner Payee Name imprinted on the card Partner Payee Social Security Number

19 20 21

IF ID Type = 2 [Driver License] Driver License Name Driver License Id Driver License Partner License Partner Partner Payee Driver License Name imprinted on the Driver card Payee Driver License Id Payee Driver License Issue Country ISO2 code

Page 45

Payoneer Prepaid MasterCard is the perfect choice for you!


Issue Country Driver License Expired Date 19 20 21 (iso_3166) Partner Payee Driver License Expired Date must be in MMDDYYYY format

22

IF ID Type = 3 [National ID] National ID Name National ID number National ID Issue Country Partner Payee Name imprinted on the National ID card Partner Payee National ID number Partner Payee National ID Issue Country ISO2 code (iso_3166)

19 20 21 22 23

IF ID Type = 4 [Passport] Passport Name Passport Passport Country Passport Date Passport Date ID Issue Issue Expired Partner Payee Name imprinted on the Passport Partner Payee Passport ID Partner Payee passport issued country ISO2 code (iso_3166) Partner Payee Passport Issue Date must be in MMDDYYYY format Partner Payee Passport Expired Date must be in MMDDYYYY format

Here's a sample comma-delimited file:

Mass Registration Tips: To generate a Mass Payment file from Excel, save the file as CSV Comma Delimited If you are using another software application, make sure the program you are using allows you to save in Comma-delimited format. Up to 3,000 records per single upload file. Each line should include unique payee id/email that cannot ever be repeated. If Country is U.S, State field is required. Each line should be separated by a carriage return. (In Excel, this is done automatically.) Please notice that the order of the fields is important. For Field Validation please refer to PayoneerPayoutsIntegrationGuide Appendix D

Page 46

Payoneer Prepaid MasterCard is the perfect choice for you!

Appendices
Appendix A - Payment Failure Codes:
001 002 003 004 005 009 010 099 Field format incorrect or not supported Payee does not exist insufficient funds payment already exists Internal error Internal error Payee is Inactive Unauthorized access

Page 47

Payoneer Prepaid MasterCard is the perfect choice for you!

Appendix B Payoneer Mass Payment XML File Format


Each payment is represented by a PayoutPayment section. The parameters each section are as follows:
1 Payment date This is the exact day that you are making the payment. Please use "MM/dd/yyyy" format. For example, if the Payment date is March 4, 2009 then the correct payment date format would be 03/04/2009 The id this payee has in your system. As appears in your internal system. Must be unique per payment. Amount to transfer to the payee, in US dollars. Must be USD. A short description of the payment. [Optional] Optional field used for grouping payments (allows attribution of payment to a department or expense group)

2 3 4 5 6 7

Payee ID Int. Payment ID Amount Currency Description Group ID

Sample XML file:


<?xml version="1.0" encoding="utf-8" standalone="no"?> <PayoneerIn> <PayoutPayments> <PayoutPayment> <!--Date of payment MM/dd/yyyy--> <PaymentDate> </PaymentDate> <!--ID of the payee --> <PayeeID> </PayeeID> <!--Your internal payment ID for this payment --> <IntPaymentID> </IntPaymentID> <!--Amount to pay in USD --> <Amount> </Amount> <!--Currency of payment amount, always USD --> <Currency>USD</Currency> <!--A description of the payment --> <Description> </Description> <!Optional department for attribution of payment <GroupID> </ GroupID > </PayoutPayment> </PayoutPayments> -->

Page 48

Payoneer Prepaid MasterCard is the perfect choice for you!


<Totals> <!--Total amount of payment - must match the aggregate sum of all payment amounts! --> <Amount> </Amount> </Totals> </PayoneerIn>

Page 49

Payoneer Prepaid MasterCard is the perfect choice for you!

Appendix C Payoneer Mass Payment CSV File Format


A comma-delimited file (CSV) can be generated/imported from most spreadsheet applications, such as Excel by clicking on save as CSV. The CSV file includes six columns: The first column includes the payees unique Payee ID. The second column includes the payment amounts for each Payee in US Dollars (USD). The third column includes the payments currency code which must be USD. The fourth column includes the Payment ID, which is a unique ID number per payment and cannot ever be repeated. The fifth column includes a Description field, which is a free text field to enter the payment description (e.g., March commission payments). The sixth column includes the Payment Date. The seventh column is an Optional field used for grouping payments (It allows attribution of payment to a department or expense group.)
1 2 3 4 5 6 Payee ID Amount Currency Int. Payment ID Description Payment date The id this payee has in your system. Amount to transfer to the payee, in US dollars. Must be USD. As appears in your internal system. Must be unique per payment and cannot be repeated in the future. A short description of the payment. This is the exact date that you are making the payment. Please use "MM/dd/yyyy" format. For example, if the Payment date is March 4, 2009 then the correct payment date format would be 03/04/2009. [Optional] Optional field used for grouping payments (allows attribution of payment to a department or expense group)

Group ID

Sample CSV file formatted for Payoneer Mass Payments:


PayeeID1 PayeeID2 PayeeID3 PayeeID4 PayeeID5 1.25 1.25 2.55 3 1 USD USD USD USD USD IntPaymentID1 IntPaymentID2 IntPaymentID3 IntPaymentID4 IntPaymentID5 TestPaymentforPayeeID1 TestPaymentforPayeeID2 TestPaymentforPayeeID3 TestPaymentforPayeeID4 TestPaymentforPayeeID5 1/1/2009 1/1/2009 1/1/2009 1/1/2009 1/1/2009

Page 50

Payoneer Prepaid MasterCard is the perfect choice for you!

Appendix D Field Validations


FieldType Address Address2 Amount City Country Date Description FirstName intPaymentId LastName PartnerPayeeId Password PhoneNumber RedirectTime SessionID State Zip
ID Type

SSN DriverLicense Number NationalID number PassportID NameOnCard Credential Name CredentialValue

Validcharacters Alfanumeric,whitespaces,.,/,_,,),(,\,&,@,#,`,comma,* Alphanumeric,whitespaces,.,/,_,,),(,\,&,@,#,`,comma,* Digits,comma,., Letters,space, TwoLetters Canbeparsedtoadateusing.netinfrastructure Alfanumeric,whitespaces,(,),/,.,,@,%,!,_,:,$,",+,> Letters,space,digits Lettersanddigits,_,,^,(,),@,/,!,#,space,$,.,: Letters,space,digits Lettersanddigits,_,,^,@,!,?,",. Lettersanddigits,!,@,#,$,%,^,& (,),digits, Digits Digits,letters,.,!,,(space) TwoLetters Letters,digits,space, 1,2,3,4 Digits Letters,digits Letters,digits Letters,digits Letters,digits,space,,_,. Letters,?,',space Letters,digits,space

Min Len. 7 6 1 3 1 4

Max Len. 30 30 100 40 3 50 150 26 50 26 50 12 15 3 50 20 10 1 9 30 30 30 255 50 50

Page 51

Payoneer Prepaid MasterCard is the perfect choice for you!

Appendix E Partner Account Setup Process


In order to set up the partner within Payoneer system, the following information is needed: Partner Details: Contact Person Name Address (City, State, Postal Code, Country) Phone E-mail address Technical Details: 1. IP Addresses of all machines calling the API or using the admin interface 2. E-mail address for sending out the daily/monthly excel reports 3. IPCN (Instant Process Completed Notification) URLs (optional): a. IPCN Registration confirmation - after payee finishes the process. b. IPCN Approved: once Payoneer approved payee card application (card is issued) c. IPCN Decline: once Payoneer declines payee card application d. Account funded IPCN: upon reception of partner funds (once Partner balance with Payoneer is updated) Example URL: https://www.partnercompany.com/payoneer_confirmation.asp? p4={{apuid}}&p5={{sessionid}} 4. Redirect URL, a URL to redirect the payee after the payment method registration is finished. If a redirect URL is sent with the Payout URL as a parameter, Payoneer will redirect the payee to that URL and not to the one on the database. Once setup is completed, the partner will receive the following from Payoneer: a. Username & Password b. Partner Id c. Program Id d. API URL e. Admin Console Interface URL

Page 52

You might also like