Pay One Era Pi Guide

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


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


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


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 Payoneer’s 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.


Revision History Date Change Description

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.

June 23, 2010 “GetPayeeDetails” API card status change to include only active/inactive payee status - other status types are not supported

June 23, 2010 “GetPayeeDetails” API change to include only the active card of the payee other Card statuses are not supported

June 23, 2010 “GetPayeesReport” limitation for 1 month period. June 23, 2010 Remove Escrow payments. June 23, 2010 Remove “Get Unfinished Visits Reports” API

June 23, 2010 Remove CashCard Program


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


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.


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 Payoneer’s 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.


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 Description Data Type mname (HTTP API)

[Required] This is the method name.

AlphaNumeric

p1 (HTTP API) Partner Username

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

AlphaNumeric

p2 (HTTP API) Partner Password

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

AlphaNumeric

p3 (HTTP API) Partner Id

[Required] Unique partner ID assigned by Payoneer.

AlphaNumeric

p4 (HTTP API) Partner Payee Id

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

AlphaNumeric No special chars

p5 (HTTP API) Session Id

[Optional] Payee session ID on the partner Web site. If provided, Payoneer sends it back upon process completion.

AlphaNumeric

p6 (HTTP API) Redirect URL

[Optional] URL used by Payoneer for redirecting the payee back after completion of the sign-up process.

AlphaNumeric

p7 (HTTP API) Card Type

[Optional] Token representing the type of the card that the cardholder is allowed to order. Options: “ATM” or “MC” (default).

String “ATM” or “MC”

p8 (HTTP API)

[Optional] The delay in seconds between

Numeric


Redirect Time the confirmation pages to the redirection to the partner URL at the end of the card application. Default is 10 seconds.

p9 (HTTP API) Test Card

[Optional] Creates a test Payee to check later with API functions.

AlphaNumeric

p10 (HTTP API) XML Response

[Optional] Creates a XML response with the token URL.

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.


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=password&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)



AlphaNumeric



AlphaNumeric



AlphaNumeric



AlphaNumeric

Xml (HTTP API) [Required] Unique partner ID assigned by Payoneer.

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>


<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>[email protected]</email> </PersonalDetails> </PayoneerDetails>

XML Parameters

Parameter Description Data Type userName Partner Username

[Required] partner account username assigned by Payoneer Inc (provided upon setup)

AlphaNumeric

password Partner Password

[Required] unique partner password assigned by Payoneer Inc (provided upon setup)

AlphaNumeric

prid Partner Id


AlphaNumeric

apuid Partner Payee Id



sessionid Session Id

[Optional] Payee session ID on the partner Web site. If provided, Payoneer sends it back upon process completion.

AlphaNumeric

redirect Redirect URL

[Optional] URL used by Payoneer for redirecting the payee back after completion of the sign-up process

AlphaNumeric 0


cardType Card Type

[Optional] Token representing the type of the card that the cardholder is allowed to order. Options: “ATM” or “MC” (default).

String “ATM” or “MC”

BlockType Block type

[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

Numeric 0-6

redirectTime Redirect Time

[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.

Numeric

firstName Partner Payee first name

[Optional] used for autofill purposes

AlphaNumeric

lastName Partner Payee last name


AlphaNumeric

dateOfBirth Partner Payee birth date

[Optional] used for autofill purposes to be parsed correctly must be in MMDDYYYY format

Numeric

address1 Partner Payee address


AlphaNumeric 30 Chars

address2 Partner Payee secondary address



city Partner Payee city


AlphaNumeric

country Partner Payee country


AlphaNumeric ISO2 code

state Partner Payee state

[Optional] used for autofill purposes State code (as appears in states table in database)

AlphaNumeric State code

zipCode Partner Payee zip


AlphaNumeric

mobile Partner Payee mobile phone


AlphaNumeric

phone Partner Payee phone


AlphaNumeric

e-mail [Optional] used for autofill purposes

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> </Description> <PaymentID> </PaymentID> <Status> </Status> <PayoneerID> </PayoneerID>

</CardholderSignup> </PayoneerToken>

Status code table:

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


4. Instant Process Completion

Notification Upon successful sign-up process, successful card issuance, card application rejection or credit to partner’s account, Payoneer's server issues Instant Process Completion Notification (IPCN): an HTTP/S request to a pre-defined 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 IPCN’s notifications: IPCN Registration Confirmation: after payee completes the registration

process for a prepaid card. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?REG=true&payeeid={{apuid}}&sessionid={{sessionid}}

IPCN ACH Registration Confirmation: after payee finishes the registration process for ACH. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?ACHREG=true&payeeid={{apuid}}&sessionid={{sessionid}}

IPCN Approved: once Payoneer approves payee card application. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?APPROVED=true&payeeid={{apuid}}&sessionid={{sessionid}}

IPCN Decline: once Payoneer declines payee card application. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?DECLINE=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?BALANCE_UPDATED=true


Load Money to ACH IPCN: after funds are sent to ACH payee. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?LOADACH=true&payeeid={{apuid}}

Payment Request Accepted IPCN: after Payoneer send the funds to the Payee. Example: https://www.partnercompany.com/payoneer_confirmation.aspx?PAYMENT=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.


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 Description Data Type mname (HTTP API) [Required] This is the

method name. AlphaNumeric



AlphaNumeric



AlphaNumeric

p3 (HTTP API) Partner ID

[Required] partner account ID number at Payoneer Inc (provided upon setup of the partner account profile)

AlphaNumeric


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 OK 001 System down for scheduled maintenance 002 System down


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





AlphaNumeric



AlphaNumeric



AlphaNumeric



<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <PayoneerResponse>

<Version> </Version> </PayoneerResponse>


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 Description Data Type mname (HTTP API) [Required] The method name. AlphaNumeric p1 (HTTP API) Partner username

[Required] Partner account username assigned by Payoneer Inc

AlphaNumeric

p2 (HTTP API) Partner password

[Required] Partner password assigned by Payoneer Inc

AlphaNumberic


[Required] Partner ID at Payoneer Inc as supplied during the partner account setup

AlphaNumeric

p4 (HTTP API) Program ID

[Required] Program code at Payoneer Inc as supplied when the partner account setup

AlphaNumeric

p5 (HTTP API) Internal Payment ID

[Required] Unique payment ID assigned by the partner


p6 (HTTP API) Internal Payee ID

[Required] Payee ID as set in the Partner system.


p7 (HTTP API) Amount

[Required] Payment amount in USD. Fees charged to payees are deducted from this amount. Payments lower than the minimum payment amount will be rejected.

Decimal

p8 (HTTP API) Description

[Required] Payment description AlphaNumeric

p9 (HTTP API) Payment Date

[Required] Date of payment, usually today's date

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


<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <PerformPayoutPayment>

<Description> </Description> <PaymentID> </PaymentID> <Status> </Status> <PayoneerID> </PayoneerID>

</PerformPayoutPayment>

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

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

Request Parameters Field Description Data Type

mname (HTTP API)


AlphaNumeric


[Required] This will be the partner account username assigned by Payoneer Inc.

AlphaNumeric


[Required] This will be the unique partner password assigned by Payoneer Inc.

Tokenized AlphaNumberic


[Required] This will be the partner account ID number at Payoneer Inc. It will be supplied when setup the partner account profile.

AlphaNumeric



<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<GetAccountDetails> <FeesDue> </FeesDue> <AccountBalance>  </AccountBalance>

</GetAccountDetails>

Function: Get Payee Details Http usage: https://APIURL/API.aspx?mname=GetPayeeDetails

This method returns the requested payee's details. Request Parameters





AlphaNumeric



AlphaNumeric



AlphaNumeric

p4 (HTTP API) Payee ID

[Required] Partner Payee ID as appears in the Payoneer Inc system




<?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> <Cards> <Card>


<CardID> <CardID/> <ActivationStatus> </ActivationStatus>

<CardShipDate> <CardShipDate/> <CardStatus> </CardStatus> </Card> </Cards>

<RegDate></RegDate> </Payee> </GetPayeeDetails>

Card Statuses: Inactive Card cannot be used (no funds available on

the card or card is blocked) Active Card can be used at ATMs, POS and Online

Card Activation Statuses: Not Issued, Pending Approval Card Issued, Not Activated Card Activated Card Cancelled

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.


mname (HTTP API) [Required] This is the method name.

AlphaNumeric



AlphaNumeric



AlphaNumeric



AlphaNumeric

p4 (HTTP API) old Payee ID



P5 (HTTP API) new Payee ID

[Required] New Partner Payee ID to set




<?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> </Result>

<Description> <!—description of error --> </Description>

</ChangePayeeID>


Code table:

000 OK 001 Payee does not exist in the Payoneer system 002 Internal error 003 New Payee ID already exists


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





AlphaNumeric



AlphaNumeric



AlphaNumeric

p4 (HTTP API) Report Type

[Required] type of report to generate. At this time only XML report is supported

Integer (Enum) XML = 0

P5 (HTTP API) Start Date

[Optional] Date of payment to start looking from

Date MM/dd/yyyy

P6 (HTTP API) End Date

[Optional] Date of payment to end search with

Date MM/dd/yyyy


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>

<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>


Function: Get Single Payee Report Http usage: https://APIURL/API.aspx?mname=GetSinglePayeeReport

This method returns all payments made to a single payee.


mname (HTTP API) [Required] This is the method name.

AlphaNumeric



AlphaNumeric



AlphaNumeric



AlphaNumeric






<?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>


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





AlphaNumeric



AlphaNumeric



AlphaNumeric




P5 (HTTP API) Subject

[Required] The subject of the message

AlphaNumeric

P6 (HTTP API) Message

[Required] The body of the message

AlphaNumeric

P7 (HTTP API) From

[Required] The name of the sender of the message

AlphaNumeric



<?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>


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





AlphaNumeric



AlphaNumeric



AlphaNumeric

P4 (HTTP API) Subject

[Required] The subject of the message

AlphaNumeric

P5 (HTTP API) Message

[Required] The body of the message

AlphaNumeric

P6 (HTTP API) From

[Required] The name of the sender of the message

AlphaNumeric



<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <SendMessageToAllPayees> <Subject> </Subject> <Result></Result> <!—000 if send, 001 if failed --> <Description> </Description> </SendMessageToAllPayees>

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





AlphaNumeric



AlphaNumeric



AlphaNumeric


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

<GetUnclaimedPayments> <Payment>

<IntPayeeId> </IntPayeeId> <IntPaymentId> </IntPaymentId>

<Amount></Amount> 

<FirstName> </FirstName> <LastName> </LastName> <Address1> </Address1> <Address2> </Address2> <City> </City> <State> </State> <Zip> </Zip> <Country></Country> <Email> </Email> <Phone> </Phone>


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





AlphaNumeric



AlphaNumeric



AlphaNumeric


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

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





AlphaNumeric



AlphaNumeric



AlphaNumeric

p4 (HTTP API) Payment ID

[Required] Partner Payment ID as assigned upon payment

AlphaNumeric



<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <CancelPayment>

<PaymentID> </PaymentID> <Result> </Result><!—000 means success, otherwise see table --> <Amount> </Amount> <Description> </Description> </CancelPayment>

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


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 Partner’s 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.


2. Mass Payment InterPay supports mass payment option by creating an XML or CSV file in the Payoneer’s 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.


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.


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=password&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)



AlphaNumeric



AlphaNumeric



AlphaNumeric



AlphaNumeric

Xml (HTTP API) [Required] Unique partner ID assigned by Payoneer.

AlphaNumberic XML String Format



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>[email protected]</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>


XML Parameters

Parameter Description Data Type

userName Partner Username

[Required] partner account username assigned by Payoneer Inc (provided upon setup)

AlphaNumeric

password Partner Password

[Required] unique partner password assigned by Payoneer Inc (provided upon setup)

AlphaNumeric

prid Partner Id


AlphaNumeric

apuid Partner Payee Id



cardType Card Type

[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.

String “VC”

firstName Partner Payee first name

[Required] will be used for cardholder registration

AlphaNumeric

lastName Partner Payee last name


AlphaNumeric

dateOfBirth Partner Payee birth date

[Optional] must be in MMDDYYYY format

Numeric

address1 Partner Payee address



address2 Partner Payee secondary address

[Optional] will be used for cardholder registration


City Partner Payee city


AlphaNumeric

country Partner Payee

[Required] will be used for cardholder

AlphaNumeric ISO2 code


country registration iso_3166 State Partner Payee state

[Optional] State code will be used for cardholder registration

AlphaNumeric State code iso_3166

zipCode Partner Payee zip


AlphaNumeric

mobile Partner Payee mobile phone

[Optional] will be used for cardholder registration

AlphaNumeric

Phone Partner Payee phone


AlphaNumeric

e-mail [Required] will be used for cardholder registration

AlphaNumeric

IdType ID Type

[Required] will be used for cardholder registration 1=SSN 2=Driver License 3=National ID 4=Passport Number

Numeric

IdNumber ID Number


Numeric

NameOnid Name on ID


AlphaNumeric

IdCountry Country Issued ID

[Required for Id Type’s 2,3,4] will be used for cardholder registration

AlphaNumeric

IdExpDate ID Expiration Date

[Required for Id Type’s 2,4] will be used for cardholder registration must be in MMDDYYYY format

Numeric

PassportIssueDate Passport Issued Date

[Required for Id Type 4] will be used for cardholder registration must be in MMDDYYYY format

Numeric

Credential Name

[Required] the credential name that will appear as prompt in login to the card information.

AlphaNumeric Max Length=50

Credential Value

[Required] the value of the credential will be expected in login to the card information.


Amount to Load

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

Decimal

Payment Description

[Required] Payment description



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> </Description> <PaymentID> </PaymentID> <Status> </Status> <PayoneerID> </PayoneerID>

</CardholderSignup> </PayoneerToken>


Status code table:

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


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 Data Type mname (HTTP API)

[Required] This is the method name. AlphaNumeric



AlphaNumeric



AlphaNumeric




p4 (HTTP API) Partner Payee Id

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

AlphaNumeric Max Length=50 No special chars

*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.


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.

The id this payee has in your system. Payee ID 1 Partner Payee first name First Name 2 Partner Payee last name Last Name 3 Partner Payee e-mail address e-mail 4 Partner Payee address Address 1 5 [optional] Partner Payee secondary address Address 2 6 Partner Payee city city 7 [optional] Partner Payee state - State code (iso_3166) State 8 Partner Payee zip Zip Code 9 Partner Payee country ISO2 code (iso_3166) country 10 [optional] Partner Payee Phone Number Phone Number 11 [optional] Partner Payee Mobile Number Mobile Number 12 [optional] Partner Payee Date Of Birth must be in MMDDYYYY format

Date Of Birth 13

The credential name that will appear as prompt in login to the card information.

Credential Name 14

The value of the credential will be expected in login to the card information.

Credential Value 15

Payment amount in USD. Amount To Load 16 Payment description Payment

Description 17

1=SSN 2=Driver License 3=National ID 4=Passport Number

ID Type 18

IF “ID Type” = 1 [SSN]

Partner Payee Name imprinted on the card Name on Card 19 Partner Payee Social Security Number Social Security

Number 20

IF “ID Type” = 2 [Driver License]

Partner Payee Driver License Name imprinted on the Driver License card

Driver License Name

19

Partner Payee Driver License Id Driver License Id 20 Partner Payee Driver License Issue Country ISO2 code Driver License 21


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

Driver License Expired Date

22

IF “ID Type” = 3 [National ID]

Partner Payee Name imprinted on the National ID card

National ID Name 19

Partner Payee National ID number National ID number

20

Partner Payee National ID Issue Country ISO2 code (iso_3166) National ID Issue Country

21

IF “ID Type” = 4 [Passport]

Partner Payee Name imprinted on the Passport

Passport Name 19

Partner Payee Passport ID Passport ID 20 Partner Payee passport issued country ISO2 code (iso_3166) Passport Issue

Country 21

Partner Payee Passport Issue Date – must be in MMDDYYYY format

Passport Issue Date

22

Partner Payee Passport Expired Date – must be in MMDDYYYY format

Passport Expired Date

23

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


Appendices Appendix A - Payment Failure Codes:

Field format incorrect or not supported001 Payee does not exist002 insufficient funds003 payment already exists004 Internal error 005 Internal error009 Payee is Inactive 010 Unauthorized access099

Appendix B – Payoneer Mass Payment XML File Format Each payment is represented by a PayoutPayment section. The parameters each section are as follows:

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

Payment date 1

The id this payee has in your system.

Payee ID 2

As appears in your internal system. Must be unique per payment.

Int. Payment ID 3

Amount to transfer to the payee, in US dollars. Amount 4 Must be USD. Currency 5 A short description of the payment. Description 6 [Optional] Optional field used for grouping payments (allows attribution of payment to a department or expense group)

Group ID 7

Sample XML file:

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<PayoneerIn>

<PayoutPayments>

<PayoutPayment>



<PaymentDate> </PaymentDate>



<PayeeID> </PayeeID>



<IntPaymentID> </IntPaymentID>



<Amount> </Amount>



<Currency>USD</Currency>



<Description> </Description>

<!—Optional department for attribution of payment -->

<GroupID> </ GroupID >

</PayoutPayment>

</PayoutPayments>


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 payee’s 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.)

The id this payee has in your system. Payee ID 1 Amount to transfer to the payee, in US dollars. Amount 2 Must be USD. Currency 3 As appears in your internal system. Must be unique per payment and cannot be repeated in the future.

Int. Payment ID 4

A short description of the payment. Description 5 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.

Payment date 6

[Optional] Optional field used for grouping payments (allows attribution of payment to a department or expense group)

Group ID 7

Sample CSV file formatted for Payoneer Mass Payments:

PayeeID1 1.25 USD IntPaymentID1 Test Payment for PayeeID1 1/1/2009



PayeeID4 3 USD IntPaymentID4 Test Payment for PayeeID4 1/1/2009

PayeeID5 1 USD IntPaymentID5 Test Payment for PayeeID5 1/1/2009


Appendix D – Field Validations

Field Type Valid characters Min Len.

Max Len.

Address Alfanumeric, whitespaces, . , / , _ , ‐ , ) , ( , \ , & , @ , # , ` , comma , * 30

Address 2 Alphanumeric, whitespaces, . , / , _ , ‐ , ) , ( , \ , & , @ , # , ` , comma , * 30

Amount Digits, comma, . , ‐ 100

City Letters, space , ‐ 40

Country Two Letters 3

Date Can be parsed to a date using .net infrastructure 50

Description Alfanumeric, whitespaces, ( , ) ,/ , . , ‐ , @ , % , ! , _ , : ,$, ", + , > 150

FirstName Letters, space, digits 26

intPaymentId Letters and digits, _ , ‐ , ^ , ( , ) , @ , / , ! , #, space, $, ., : 50

LastName Letters, space, digits 26

PartnerPayeeId Letters and digits, _ , ‐ , ^ , @, ! , ? , ", . 50

Password Letters and digits, !, @, #, $, %, ^, & 7 12

PhoneNumber (, ), digits, ‐ 6 15

RedirectTime Digits 1 3

SessionID Digits, letters, . ,!, ‐ ,(space) 50

State Two Letters 20

Zip Letters, digits, space, ‐ 3 10

ID Type 1,2,3,4 1 1

SSN Digits 4 9

Driver License Number Letters, digits 30

National ID number Letters, digits 30

Passport ID Letters, digits 30

Name On Card Letters, digits, space, ‐, _ ,. 255

Credential Name Letters,?,',space 50

Credential Value Letters, digits, space 50


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

Pay One Era Pi Guide

Documents

Transcript of Pay One Era Pi Guide