Appendix C

You have to add to your CREDIT2VIRTUAL request specific list of parameters which is determined by the value for the brand parameter.

You should get additional information from account manager.

airtel

If you set the value airtel for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`payee_country`	Transaction country (2-letters code)	String	+
`payee_phone`	Mobile Number validated according to ITU-T E.164.	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=airtel&order_id=ORDER12345&order_amount=100
&order_currency=UGX&order_description=Product&parameters[payee_country]=UG&parameters[payee_phone]=0987654321
&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

aircash-withdrawal

If you set the value aircash-withdrawal for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`payer_first_name`	Payer first name	String	+
`payer_last_name`	Payer last name	String	+
`payer_birth_date`	Payer birth date	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&
client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
brand=aircash-withdrawal&
order_id=ORDER12345&
order_amount=100&
order_currency=UGX&
order_description=Product&
parameters[payer_first_name]=John&
parameters[payer_last_name]=Doe&
parameters[payer_birth_date]=2000-08-24&
hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

astropay

If you set the value astropay for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`country`	Transaction Country ISO Code	String 2 characters	+
`merchant_user_id`	A unique identifier on the merchant's end for the user (user email).	String up to 64 characters	+
`phone`	User's phone number. Must contain country code. If you are using the phone number the country code must be added to the number. Ex: 5561900001234	String up to 50 characters	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=astropay
&order_id=ORDER12345&order_amount=1.99&order_currency=USD&order_description=Product
&parameters[country]=BR&parameters[merchant_user_id]=test@test.com&parameters[phone]=5561900001234
&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

bitolo-inr

If you set the value bitolo-inr for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`account_holder_firstname`	First name of the user	String	+
`account_holder_lastname`	Last name of the user	String	+
`bank_name`	Bank name. Example: AXIS	String	+
`account_no`	Account number. Example: 12xxxxx1231	String	+
`ifsc_code`	IFSC code	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=bitolo-inr&order_id=ORDER12345&order_amount=1000.99&order_currency=INR&order_description=Product&parameters[account_holder_firstname]=John&parameters[account_holder_lastname]=Smith&parameters[bank_name]=AXIS&parameters[account_no]=0987654321&parameters[ifsc_code]=1234567890&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

bitolo-brl

If you set the value bitolo-brl for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`mode_of_payout`	Mode of payout. Values: BANK or PIX	String	+
`account_holder_firstname`	First name of the user	String	+
`account_holder_lastname`	Last name of the user	String	+
`bank_code`	Bank code will be shared as a document. Required if mode of payout is BANK	String	-
`bank_branch`	Branch code of the bank. Required if Mode of Payout is BANK	String	-
`account_no`	Account number of the receiver. Required if Mode of Payout is BANK	String	-
`tax_id`	CPF of the receiver	String	+
`pix_key`	PIX key. Required if mode of payout is PIX	String	-

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=bitolo-brl&order_id=ORDER12345
&order_amount=1000.99&order_currency=BRL&order_description=Product&parameters[mode_of_payout]=PIX
&parameters[account_holder_firstname]=John&parameters[account_holder_lastname]=Smith&parameters[tax_id]=0987654321
&parameters[pix_key]=1234567890&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

fairpay

If you set the value fairpay for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`method`	The payout method. List of values: • pix - for PIX, Brasil • bank-transfer-br - for Bank Transfer, Brasil • spei - for SPEI, Mexico • bank-transfer-cl - for Bank transfer, Chile • bank-transfer-pe - for Bank transfer, Peru • bank-transfer-ec - Bank transfer, Ecuador • bank-transfer-co - for Colombia -Bank transfer	String	+
`firstName`	Beneficiary's first name	String	+
`lastName`	Beneficiary's last name	String	+
`documentNumber`	Beneficiary's document number.	String	+
`documentType`	Beneficiary's document type. List of values: • Brasil: One of CPF, CNPJ • Mexico: One of RFC, CURP or ND. • Chile: Should be one of RUT, RUN, PAS, CE. • Peru-Bank transfer: Should be one of DNI, RUC, PAS, CE. • Ecuador-Bank transfer: Should be one of CEDULA, RUC, PAS.	String	+
`bankCode`	Beneficiary's bank code. Optional for payment method PIX (PIX, Brasil)	String	+
`account`	Beneficiary's account number.	String	+
`accountType`	Beneficiary's account type. List of values: • PIX, Brasil: One of: CPF, CNPJ, EVP, PHONE, EMAIL • Bank Transfer, Brasil: One of: SAVINGS, CHECKING • SPEI, Mexico: One of debit, phone or clabe. • Bank transfer, Chile: Should be one of CHECKING, SAVINGS, VISTA, RUT, SALARY. • Bank transfer, Peru: Should be one of CHECKING, SAVINGS. • Bank transfer, Ecuador: Should be one of CHECKING, SAVINGS, VIRTUAL.	String	+
`accountDigit`	Account Digit. Required only for payment method `bank-transfer-br` (Bank Transfer, Brasil)	String	-
`branch`	Branch. Required only for payment method `bank-transfer-br` (Bank Transfer, Brasil)	Max length 4	-
`region`	Region. Required only for payment method `bank-transfer-pe` (Bank transfer, Peru)	String	-

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004
&brand=fairpay&order_id=ORDER12345&order_amount=1.99&order_currency=USD
&order_description=Product&parameters[firstName]=John&parameters[lastName]=Doe
&parameters[method]=bank-transfer-br&parameters[documentNumber]=21532652313
&parameters[documentType]=CPF&parameters[bankCode]=001&parameters[account]=12345678
&parameters[accountType]=CHECKING&parameters[accountDigit]=4&parameters[branch]=1234
&hash="a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

jvz

If you set the value jvz for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`holder_name`	Bank account holder name (mandatory for bank transfer).	String	+
`bank_acc_number`	Bank account number (mandatory for bank transfer).	String	+
`branch_id`	Branch ID (optional).	String	-
`name_of_bank`	Name of the bank (mandatory for bank transfer).	String	+
`banking_code`	Swift code or other banking code (mandatory for bank transfer).	String	+
`branch_bank`	Branch of the bank (optional).	String	-
`address_of_bank`	Address of the bank branch where the account is opened (optional).	String	-
`account_type`	Type of account (e.g., savings account, current account).	String	-
`receiver_name`	Recipient’s full name (required if needed as per regional compliance).	String	-
`receiver_address`	Recipient’s address (optional).	String	-
`user_fname`	First name of the source user.	String	-
`user_lname`	Last name of the source user.	String	-
`user_email`	Email of the source user (e.g., xyz@abc.com).	String	+
`user_address`	Address of the source user.	String	-
`user_city`	City of the source user.	String	-
`user_state`	State of the source user.	String	-
`user_country`	2 or 3-digit transaction country code.	String	+
`user_zip`	Zip code of the source user.	String	-
`user_phone`	Contact number of the source user.	String	+
`user_doc_id`	Payer user ID used for verification (mandatory as per regional compliance).	String	-
`user_doc_type`	Payer user document used for verification (mandatory as per regional compliance).	String	-

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=jvz&order_id=ORDER12345&order_amount=100&order_currency=INR&order_description=Product&parameters[holder_name]=John%20Doe&parameters[bank_acc_number]=1234567890&parameters[name_of_bank]=ExampleBank&parameters[banking_code]=EXAMPLECODE&parameters[branch_id]=001&parameters[branch_bank]=MainBranch&parameters[address_of_bank]=123%20Bank%20Street&parameters[account_type]=savings&parameters[receiver_name]=Jane%20Doe&parameters[receiver_address]=456%20Receiver%20Street&parameters[user_fname]=John&parameters[user_lname]=Doe&parameters[user_email]=xyz@abc.com&parameters[user_address]=789%20User%20Street&parameters[user_city]=Kampala&parameters[user_state]=Central&parameters[user_country]=IN&parameters[user_zip]=12345&parameters[user_phone]=0987654321&parameters[user_doc_id]=987654321&parameters[user_doc_type]=Passport&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

help2pay

If you set the value help2pay for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`ClientIP`	Server IP	String (1-80)	+
`bankCode`	Bank code	String (1-50)	+
`toBankAccountName`	Recipient Account Name	String (1-50)	+
`toBankAccountNumber`	Recipient Account Number	String (1-50)	+
`toProvince`	Customer Bank located within a country	String (1-200)	-
`toCity`	Customer Bank located City	String (1-200)	-

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=help2pay&order_id=ORDER12345&order_amount=1.99
&order_currency=MYR&order_description=Product
&parameters[ClientIP]=127.987.65.432&parameters[bankConde]=AFF &parameters[toBankAccountName]=Name-54321
&parameters[toBankAccountNumber]=number-12345&parameters[toProvince]=KL
&parameters[toCity]=Kuala Lumpur&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

mercury

If you set the value mercury for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`externalMemo`	Optional external memo	String	-
`recipient_name`	Recipient’s name	String	+
`recipient_email`	Recipient’s e-mail	String	+
`recipient_accountNumber`	Recipient account number	String	+
`recipient_routingNumber`	Recipient’s routing number	String	+
`recipient_electronicAccountType`	Recipient’s electronic account type. Possible values: businessChecking businessSavings personalChecking personalSavings	String	+
`recipient_address1`	Recipient’s Address line 1	String	+
`recipient_address2`	Recipient’s Address line 1	String	-
`recipient_city`	Recipient’s city	String	+
`recipient_region`	Recipient’s region. Either a two-letter US state code like "CA" for California or a free-form identification of a particular region worldwide	String	+
`recipient_postalCode`	Recipient’s postal code	String	+
`recipient_country`	Recipient’s country. Use ISO 3166 Alpha2 code	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=mercury&order_id=ORDER12345&order_amount=1.99
&order_currency=USD&order_description=Product
&parameters[externalMemo]=Memo for customer
&parameters[recipient_name]=Recipient Name
&parameters[recipient_email]=recipient3@mail.com
&parameters[recipient_accountNumber]=0987654321
&parameters[recipient_routingNumber]=1234567890
&parameters[recipient_electronicAccountType]=businessSavings
&parameters[recipient_address1]= 5604 Clarke Address Dr
&parameters[recipient_address2]=build 1a&parameters[recipient_city]= Memphis
&parameters[recipient_region]=TN&&parameters[recipient_postalCode]=38115
&parameters[recipient_country]=US&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

mpesa

If you set the value mpesa for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`CommandID`	This is a unique command that specifies B2C transaction type. • SalaryPayment: This supports sending money to both registered and unregistered M-Pesa customers. • BusinessPayment: This is a normal business to customer payment, supports only M-PESA registered customers. • PromotionPayment: This is a promotional payment to customers. The M-PESA notification message is a congratulatory message. Supports only M-PESA registered customers.	String	+
`PartyB`	This is the customer mobile number to receive the amount. The number should have the country code (254) without the plus sign.	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=mpesa&order_id=ORDER12345&order_amount=100
&order_currency=UGX&order_description=Product&parameters[CommandID]= SalaryPayment&parameters[PartyB]=0987654321
&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

noda

If you set the value noda for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`iban`	International Bank Account Number (IBAN) of the Payout Recipient. Example: DE75512108001245126199	String	+
`beneficiaryName`	The full name of the payee as known to their banks	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=noda&order_id=ORDER12345
&order_amount=1.99&order_currency=MYR&order_description=Product&parameters[iban]=GB33BUKB20201555555555
&parameters[beneficiaryName]=John Smith&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

one-collection

If you set the value "one-collection" for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`FullName`	Encrypted submission using platform public key, with RSA mode encryption	String	+
`BankName`	Bank Name	String	+
`BankCode`	Bank Code	String	+
`BranchName`	Branch Name	String	+
`BranchCode`	Branch Code	String	+
`AccountNumber`	Account Number	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004
&brand=one-collection&order_id=ORDER12345&order_amount=1.99&order_currency=USD
&order_description=Product&parameters[FullName]= LzA0Px8pIUSi0VYwyFweLwWAJ/b6y
vJaefGUTwWwIiG6Qv031EM6GjMlhAwxQax2c1Zrd0riWSVb0ph7YntebMKY93ZiLpcYisjpBNnqqpx
owhyvdN79EKAysaajGQwvT5WlLShKvfS/73zubTiLPd8YhxdNJwmH0KQ6ScXyNZv4YKc9gEj+PDIzW
P3SY7LwJtqDWuWAPi2jp5eCo5LJNUs2X44+BXFP6aALA7t8SaaNfw7/9gk1dG2rIuyjp2AuIXiRDFh
X4LNOND7jC5El3xSyfGdmkcZS8g0EO+EmPQAxpcZ8goBJ4uOINtNJWgo0aGOsUZd4jkzT6za8TOyLAw==
&parameters[BankName]=SBI&parameters[BankCode]=0038&parameters[BranchName]=Branch
&parameters[BranchCode]=619&parameters[AccountNumber]=account54321
&parameters[BankCode]=0038&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post –k

papara

If you set the value papara for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`memberId`	Customer ID	String	+
`NameSurname`	Customer Full Name	String	+
`AccountNumber`	The Account Number for payment	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=papara&order_id=ORDER12345&order_amount=100&order_currency=TRY&order_description=Product&parameters[memberId]=123456789&parameters[NameSurname]=John%20Doe&parameters[AccountNumber]=987654321&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

Paygate10 Netbanking/UPI

If you set the value netbanking-upi for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`country_code`	Customer’s country. Must be 2-letter code	String 2 characters	+
`user_name`	Merchant’s customer “user name”	String up to 100 characters	+
`account_name`	Beneficiary Bank Account Name	String up to 100 characters	+
`account_number`	Beneficiary Bank Account Number	String up to 20 characters	+
`bank_name`	Bank name	String up to 100 characters	+
`bank_ifsc`	Bank IFSC code	String up to 20 characters	+
`bank_branch`	Bank branch name	String up to 100 characters	+
`bank_address`	Bank address	String up to 250 characters	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=netbanking-upi&order_id=ORDER12345&order_amount=1.99
&order_currency=USD&order_description=Product&parameters[country_code]=IN
&parameters[user_name]=test&parameters[account_name]=test
&parameters[account_number]=1234567890&parameters[bank_name]=apnaBank
&parameters[bank_ifsc]=ASBL00000007&parameters[bank_branch]=Mumbai
&parameters[bank_address]=Sakinaka&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

payneteasyhpp

If you set the value payneteasyhpp for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`first_name`	Receiver's first name. Can also be sent as first_name	String (128)	Required for countries: Uganda (UGX) Kenia (KES)
`last_name`	Receiver's last name. Can also be sent as last_name	String (128)	Required for countries: Uganda (UGX) Kenia (KES)
`payee_first_name`	Receiver's first name. Can also be sent as first_name	String (128)	Required for countries: Ghana (GHS)
`payee_last_name`	Receiver's last name. Can also be sent as last_name	String (128)	Required for countries: Ghana (GHS)
`phone`	The phone parameter is the wallet, where the money would be sent.	String	Required for countries: Uganda (UGX) Kenia (KES)
`account_number`	Bank account number	String (32)	Required for countries: Nigeria (NGN) Cameron (XAF) Ghana (GHS) Zambia (ZMW)
`account_name`	Bank account name	String (128)	Required for countries: Nigeria (NGN) Cameron (XAF) Ghana (GHS)
`payee_phone`	Receiver's phone. Can also be sent as phone	String (128)	Required for countries: Nigeria (NGN) Cameron (XAF) Ghana (GHS) Zambia (ZMW)
`payee_email`	Receiver's email. Can also be sent as email.	String (128)	Required for countries: Nigeria (NGN)
`bank_name`	Name of the bank	String (255)	Required for Nigeria (NGN)
`bank_code`	Bank code	String (32)	Required for Nigeria (NGN)
`payee_country`	Receiver's country code. Can also be sent as country	String (3)	Required for Ghana (GHS)

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004
&brand=payneteasyhpp&order_id=ORDER12345&order_amount=1000&order_currency=GHS
&order_description=Product&parameters[payee_first_name]=John&parameters[payee_last_name]=Doe
&parameters[payee_phone]=12345678901&parameters[payee_country]=GH
&parameters[account_name]=QWE&parameters[account_number]=12345678901
&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

payftr-in

If you set the value payftr-in for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`country`	Transaction country code	String	+
`account_holder_name`	Account holder name	String	+
`account_number`	Account Number	String	+
`bank_name`	Bank Name	String	+
`bank_code`	Bank code	String	+
`phone`	Phone	String	+
`email`	Email	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL
&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004
&brand=payftr-in
&order_id=ORDER12345
&order_amount=100.00
&order_currency=INR
&order_description=Product
&parameters[country]=IN
&parameters[account_holder_name]=Jane Doe
&parameters[account_number]=1233455790
&parameters[bank_name]=India Bank
&parameters[bank_code]=HDFC0000123
&parameters[phone]=1234567890
&parameters[email]=sakinaka@email.com
&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

payok-payout

If you set the value payok-payout for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`countryCode`	The Country Code of the corresponding country	String (4)	+
`number`	Beneficiary Account Number	String (30)	+
`orgId`	Bank ID	String (20)	+
`orgCode`	Bank Code	String (20)	+
`orgName`	Bank Name	String (45)	+
`holderName`	Bank Card Holder Name	String (200)	+
`firstName`	Beneficiary's First Name	String (20)	+
`lastName`	Beneficiary's Last Name	String (20)	+
`email`	User's email	String (45)	+
`phone`	The cardholder's phone number	String (20)	+
`personalId`	Identity ID of the payee	String (12)	Conditional
`personalType`*	ID type of the payee	String (10)	Conditional
`accountType`*	Account type of the payee	String (10)	Conditional

* - conditional parameters are required for specific method, region and currency that is determined by the payment providers rules.

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=payok-payout&order_id=ORDER12345&order_amount=100&order_currency=USD&order_description=Product&parameters[countryCode]=IN&parameters[number]=33440987654321&parameters[orgId]=0005&parameters[orgCode]=BANKCODE&parameters[orgName]=Bank Name&parameters[holderName]=Jane Doe&parameters[firstName]=Homer&parameters[lastName]=Simpson&parameters[email]=hsimpson@email.com&parameters[phone]=0987654321&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

mtn-momo (MoMo MTN)

If you set the value mtn-momo for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`payee_phone`	Mobile Number validated according to ITU-T E.164.	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=mtn-momo&order_id=ORDER12345&order_amount=100&order_currency=UGX
&order_description=Product&parameters[payee_phone]=0987654321
&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

payretailers

If you set the value payretailers for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`BeneficiaryFirstName`	Beneficiary first name	String	+
`BeneficiaryLastName`	Beneficiary last name	String	+
`PayoutBeneficiaryTypeCode` *	Payout beneficiary type code	String	Conditional
`DocumentType`	Document type	String	+
`DocumentNumber`	Document number	String	+
`Email`	Beneficiary e-mail	String	+
`Phone` *	Beneficiary phone	String	Conditional
`City` *	Beneficiary city	String	Conditional
`Address` *	Beneficiary address	String	Conditional
`Country`	Beneficiary country, 2-letter code	String	+
`BankName`	Bank name. Possible values: 001 - Banco do Brasil S.A. 341 - Banco Itaú S.A. 033 - Banco Santander (Brasil) S.A. 237 - Banco Bradesco S.A. 237 - Next Tecnologia e Serviços Digitais 104 - Caixa Econômica Federal 422 - Banco Safra S.A. 748 - Banco Cooperativo Sicredi S.A. 041 - Banco do Estado do Rio Grande do Sul S.A. BANRISUL 208 - BANCO BTG PACTUAL S.A. 655 - Neon Pagamentos 077 - Banco Inter S.A. 121 - Banco Agibank S.A. 212 - Banco Original S.A. 260 - Nubank 336 - Banco C6 S.A.	String	+
`AbaSwift`	The swift number of the bank used by the customer.	String	Conditional
`AccountAgencyNumber` *	Account agency number	String	-
`AccountNumber`	Account number	String	+
`PayoutChannel` *	Channel through which the payout will be processed. Values: CASH or ONLINE	String	Conditional
`RecipientPixKey` *	The PIX key of the customer.	String	Conditional
`PayoutAccountTypeCode`	Payout account type. Possible values: 0001 - Poupança 0002 - Conta Corrente	String	+
`TermsApproved`	Possible values: Y/N	String	-

* - conditional parameters are required for specific method, region and currency that is determined by the payment providers rules.

Sample curl request (Country = BR)

curl -d curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=payretailers&order_id=ORDER12345&order_amount=100&order_currency=EUR&order_description=Product&parameters[BeneficiaryFirstName]=Jonh&parameters[BeneficiaryLastName]=Doe&parameters[DocumentType]=1&parameters[DocumentNumber]=12346&parameters[Email]=jonhdoe@email.com&parameters[Phone]=112233445566&parameters[Country]=BR&parameters[BankName]=033&parameters[AccountAgencyNumber]=8585&parameters[AccountNumber]=002555343456&parameters[PayoutAccountTypeCode]=002&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

Sample curl request (Country = CL)

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=payretailers&order_id=ORDER12345&order_amount=100&order_currency=EUR&order_description=Product&parameters[BeneficiaryFirstName]=Jonh&parameters[BeneficiaryLastName]=Doe&parameters[PayoutBeneficiaryTypeCode]=person&parameters[DocumentType]=1&parameters[DocumentNumber]=12346&parameters[Email]=jonhdoe@email.com&parameters[Country]=CL&parameters[BankName]=033&parameters[AccountNumber]=002555343456&parameters[PayoutAccountTypeCode]=002&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

Sample curl request (Country = EC or PE)

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=payretailers&order_id=ORDER12345&order_amount=100&order_currency=EUR&order_description=Product&parameters[BeneficiaryFirstName]=Jonh&parameters[BeneficiaryLastName]=Doe&parameters[DocumentType]=1&parameters[DocumentNumber]=12346&parameters[Email]=jonhdoe@email.com&parameters[City]=Magdalena Del Mar&parameters[Address]=Jirón Raúl Porras, 426&parameters[Phone]=112233445566&parameters[Country]=PE&parameters[BankName]=033&parameters[AccountNumber]=002555343456&parameters[PayoutAccountTypeCode]=002&parameters[TermsApproved]=false&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

pspnt

If you set the value pspnt for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`service_code`	Code representing the target mobile money service (e.g., airtel)	String	+
`account_name`	Name of the recipient account holder	String	+
`payee_phone`	Mobile number of the recipient in international format	String	+
`payee_country`	Country code of the recipient (e.g., KE for Kenya).	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&
client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
brand=pspnt&
order_id=ORDER12345&
order_amount=100.00&
order_currency=KES&
order_description=Product&
parameters[service_code]=airtel&
parameters[account_name]=John Doe&
parameters[payee_phone]=0123456789&
parameters[payee_country]=KE&
hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

pspnt-ng

If you set the value pspnt-ng for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`bank_code`	Bank code identifying the beneficiary's bank	String	+
`payee_phone`	Account number of the beneficiary	String	+
`payee_country`	ISO country code for the bank account (e.g., NG for Nigeria)	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&
client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
brand=pspnt-ng&
order_id=ORDER12345&
order_amount=100.00&
order_currency=NGN&
order_description=Product&
parameters[bank_code]=1234&
parameters[payee_phone]=0123456789&
parameters[payee_country]=NG&
hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

ptn-email

If you set the value ptn-email for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`CustomerName`	Indicates Customer Name	String(60)	+
`Email`	Indicates Customer's Email	String(50)	-
`SecurityQuestion`	The security question	String(40)	+
`SecurityQuestionAnswer`	SecurityQuestionAnswer standards: - No spaces. - Length must be between 3 and 25 characters long	String(25)	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=ptn-email&
order_id=ORDER12345&order_amount=100
&order_currency=CAD&order_description=Product&
parameters[CustomerName]=Jonh Doe&parameters[Email]=email@cutomer.com
&parameters[SecurityQuestion]=color&
parameters[SecurityQuestionAnswer]=red
&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

ptn-sms

If you set the value ptn-sms for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`CustomerName`	Indicates Customer Name	String (60)	+
`PhoneNumber`	Indicates customer's phone number with Country Code	Integer(10)	+
`SecurityQuestion`	The security question	String(40)	+
`SecurityQuestionAnswer`	SecurityQuestionAnswer standards: - No spaces. - Length must be between 3 and 25 characters long	String(25)	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=ptn-sms&
order_id=ORDER12345&order_amount=100
&order_currency=CAD&order_description=Product&
parameters[CustomerName]=Jonh Doe&parameters[PhoneNumber]=0987654321&
parameters[SecurityQuestion]=color&
parameters[SecurityQuestionAnswer]=red&
hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

pyk-payout

If you set the value pyk-payout for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`countryCode`	The Country Code of the corresponding country	String (4)	+
`number`	Beneficiary Account Number	String (30)	+
`orgId`	Bank ID	String (20)	+
`orgCode`	Bank Code	String (20)	+
`orgName`	Bank Name	String (45)	+
`holderName`	Bank Card Holder Name	String (200)	+
`firstName`	Beneficiary's First Name	String (20)	+
`lastName`	Beneficiary's Last Name	String (20)	+
`email`	User's email	String (45)	+
`phone`	The cardholder's phone number	String (20)	+
`personalId`	Identity ID of the payee	String (12)	Conditional
`personalType`*	ID type of the payee	String (10)	Conditional
`accountType`*	Account type of the payee	String (10)	Conditional

* - conditional parameters are required for specific method, region and currency that is determined by the payment providers rules.

Sample curl request

curl -X POST https://test.apiurl.com/post -k \
  -d "action=CREDIT2VIRTUAL" \
  -d "client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004" \
  -d "brand=pyk-payout" \
  -d "order_id=ORDER12345" \
  -d "order_amount=100" \
  -d "order_currency=USD" \
  -d "order_description=Product" \
  -d "parameters[countryCode]=IN" \
  -d "parameters[number]=33440987654321" \
  -d "parameters[orgId]=0005" \
  -d "parameters[orgCode]=BANKCODE" \
  -d "parameters[orgName]=Bank Name" \
  -d "parameters[holderName]=Jane Doe" \
  -d "parameters[firstName]=Homer" \
  -d "parameters[lastName]=Simpson" \
  -d "parameters[email]=hsimpson@email.com" \
  -d "parameters[phone]=0987654321" \
  -d "hash=a1a6de416405ada72bb47a49176471dc"

swifipay-withdrawal

If you set the value swifipay-withdrawal for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`ToAccountNumber`	Customer’s bank account number	string(64)	+
`ToAccountName`	Customer’s bank account name	string(64)	+
`ToProvince`	The province of account opening branch	string(64)	+
`ToCity`	The city of account opening branch	string(64)	+
`ToBranch`	Address of the account opening branch	string(64)	+
`ToAddress`	Address of the payee	string(64)	+
`Email`	Email address of the payee	string(20)	+
`Phone`	Phone number of the payee	integer(16)	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&
client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
brand=swifipay-withdrawal&
order_id=ORDER12345&
order_amount=100&
order_currency=EGP&
order_description=Product&
parameters[ToAccountNumber]=123456789&
parameters[ToAccountName]=John Doe&
parameters[ToProvince]=Province&
parameters[ToCity]=City&
parameters[ToBranch]=Branch&
parameters[ToAddress]=Address&
parameters[Email]=test@gmail.com&
parameters[Phone]=0123456789&
hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

yo-uganda-limited

If you set the value yo-uganda-limited for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`payee_phone`	This is a numerical value representing the account number of the mobile money account where you wish to transfer the funds to. This is typically the telephone number of the mobile phone receiving the amount. Telephone numbers MUST have the international code prepended, without the “+” sign. An example of a mobile money account number which would be valid for the MTN Uganda network is 256771234567.	String	+
`AccountProviderCode`	Provide here the account provider code of the institution holding the account indicated in the Account parameter.	String	-
`NarrativeFileName`	This parameter enables you to attach a file to the transaction. This is useful, for example, in the case where you may want to attach a scanned receipt, or a scanned payment authorization, depending on your internally established business rules. This parameter requires you to provide the name of the file you are attaching, as a string, for example “receipt.doc” or “receipt.pdf”. Note that the contents of this parameter are ignored if you have not provided the contents of the file using NarrativeFileBase64 below.	String	-
`NarrativeFileBase64`	This parameter enables you to attach a file to the transaction. This is useful, for example, in the case where you may want to attached a scanned receipt, or a scanned payment authorization, depending on your business rules. This parameter requires you to provide the contents of the file you are attaching, encoded in base-64 encoding. Note that the contents of this parameter are ignored if you have not provided a file name using NarrativeFileName above.	String	-
`ProviderReferenceText`	In this field, enter text you wish to be present in any confirmation message which the mobile money provider network sends to the subscriber upon successful completion of the transaction. Some mobile money providers automatically send a confirmatory text message to the subscriber upon completion of transactions. This parameter allows you to provide some text which will be appended to any such confirmatory message sent to the subscriber.	String	-

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=yo-uganda-limited
&order_id=ORDER12345&order_amount=1.99&order_currency=UGX&order_description=Product&parameters[payee_phone]=+256771234567
&parameters[AccountProviderCode]=provider54321&parameters[NarrativeFileName]=file.img&parameters[NarrativeFileBase64]= iVBORw0KGgoAAAANSUhEUgAAAAEAAAADCAYAAABS3WWCAAAABHNCSVQICAgIfAhkiAAAABl0RVh0U29mdHdhcmUAZ25vbWUtc2NyZWVuc2hvdO8Dvz4AAA
A1aVRYdENyZWF0aW9uIFRpbWUAAAAAANGB0YAsIDEwLdGC0YDQsC0yMDIzIDEyOjA4OjQ3ICswMzAwEHyhlwAAABdJREFUCJlj+P///38mBgYGBiYGBgYG
ADH7BAGR0RGuAAAAAElFTkSuQmCC&parameters[ProviderReferenceText]=thank you&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

upi-2

If you set the value upi-2 for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`customer_name`	Customer Name	String	+
`account_number`	Account Number	String	+
`ifsc_code`	Bank ifsc	String	+
`bank`	Bank Name	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&
client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
brand=upi-2&
order_id=ORDER12345&
order_amount=100.00&
order_currency=INR&
order_description=Product&
parameters[customer_name]=John Doe&
parameters[account_number]=12345&
parameters[ifsc_code]=123&
parameters[bank]=Bank Name&
hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

upi-4

If you set the value upi-4 for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`name`	Name	String	+
`mobile_number`	Mobile number	String	+
`bank`	Bank	String	+
`account_name`	Account name	String	+
`ifsc_code`	Bank ifsc	String	+
`customer_name`	Customer name	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&
client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&
brand=upi-3&
order_id=ORDER12345&
order_amount=100.00&
order_currency=INR&
order_description=Product&
parameters[name]=name&
parameters[mobile_number]=012345689&
parameters[bank]=bank&
parameters[account_name]=account_name&
parameters[ifsc_code]=ifsc_code&
parameters[customer_name]=customer_name&
hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

winnerpay

If you set the value winnerpay for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`contact_id`	The Bitso-generated, unique identifier of your receiving account. You get this identifier back when you create the contact account.	String	+/-
`beneficiary`	The recipient of the withdrawn funds.It is required if you don’t send “contact_id” parameter.	String	+/-
`clabe`	The unique, 18-number identifier of the receiving bank account that follows the Mexican standard for account numbering (Clave Bancaria Estandarizada).It is required if you don’t send “contact_id” parameter.	String	+/-

Sample curl request

curl -d "action=CREDIT2VIRTUAL
&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004
&brand=winnerpay
&order_id=ORDER12345
&order_amount=100.00
&order_currency=MXN
&order_description=Product
&parameters[beneficiary]=recipient name
&parameters[clabe]=6543210987654321
&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

zeropay (BTC Globals)

If you set the value “zeropay” for the brand parameter you have to specify in your request the next parameters as well:

Parameter	Description	Values	Required
`accountNumber`	This is mandatory for payment methods other than UPI.	String	Conditional
`beneficiaryName`	This is mandatory for payment methods other than UPI.	String	Conditional
`ifscCode`	11 digit bank code, this is mandatory for payment methods other than UPI.	String	Conditional
`upiId`	This is mandatory only if paymentMethod selected is UPI.	String	Conditional
`payoutType`	= EXPRESS	String	+
`paymentMethod`	Allowed Values: IMPS NEFT RTGS UPI Payment method the merchant wants to use. If opting for UPI payment method, upiId is a mandatory parameter and for other payment methods accountNumber & ifscCode are mandatory.	String	+

Sample curl request

curl -d "action=CREDIT2VIRTUAL&client_key=c2b8fb04-110f-11ea-bcd3-0242c0a85004&brand=zeropay&order_id=ORDER12345&order_amount=1.99
&order_currency=INR&order_description=Product
&parameters[upiId]=2267896548@ybl&parameters[payoutType]=EXPRESS
&parameters[paymentMethod]=UPI&hash=a1a6de416405ada72bb47a49176471dc" https://test.apiurl.com/post -k

Appendix C​

airtel​

aircash-withdrawal​

astropay​

bitolo-inr​

bitolo-brl​

fairpay​

jvz​

help2pay​

mercury​

mpesa​

noda​

one-collection​

papara​

Paygate10 Netbanking/UPI​

payneteasyhpp​

payftr-in​

payok-payout​

mtn-momo (MoMo MTN)​

payretailers​

pspnt​

pspnt-ng​

ptn-email​

ptn-sms​

pyk-payout​

swifipay-withdrawal​

yo-uganda-limited​

upi-2​

upi-4​

winnerpay​

zeropay (BTC Globals)​

Appendix C

airtel

aircash-withdrawal

astropay

bitolo-inr

bitolo-brl

fairpay

jvz

help2pay

mercury

mpesa

noda

one-collection

papara

Paygate10 Netbanking/UPI

payneteasyhpp

payftr-in

payok-payout

mtn-momo (MoMo MTN)

payretailers

pspnt

pspnt-ng

ptn-email

ptn-sms

pyk-payout

swifipay-withdrawal

yo-uganda-limited

upi-2

upi-4

winnerpay

zeropay (BTC Globals)