Payee Required Fields Query

API Information

• Path: /api/v1/acct/queryPaymentFeild
• Method: POST
• Content-Type: application/json

Business Description

• A value of "Y" indicates a required field, "C" indicates a conditionally required field, and "N" indicates an optional field.

Request Parameters

Request Body

Parameter	Type	Description	Required
merchantNo	string	The merchant number of the request initiator.	M
onBehalfOf	string	The merchant number that the request is actually associated with. Provide this field only when initiating a request on behalf of another merchant.	N
payoutCurrency	string(10)	Account currency, e.g.: PHP	M
bankCountry	string(10)	Payout destination country, e.g.: PH	M
entityType	string(1)	Entity type enum[0,1], 0: Company, 1: Individual	M
paymentMethod	string(1)	Payment method	M
walletType	string	Wallet Type- The payment method is wallet	C
sign	string	Signature	M

Request Example

{
  "merchantNo": "800538",
  "payoutCurrency": "NGN",
  "bankCountry": "US",
  "entityType": "0",
  "paymentMethod": "BANK_TRANSFER",
  "sign": "skip_verify"
}

Response Result

Response Body

Parameter	Type	Description
respCode	string	Response code
respMsg	string	Response message
data	object	Response data
|─merchantNo	string	Merchant number
|─accountInfomation	object	Account information
|─cardNumber	string	Card number/IBAN
|─accountType	string	Account type [0:checking, 1:saving, 2:ordinary]
|─swiftCode	string	SWIFT code
|─sortCode	string	Sort code/ABA routing number
|─branchCode	string	Branch code
|─bankHolderName	string	Bank account holder name
|─walletType	string	Wallet type
|─walletPhone	string	Wallet phone number
|─pickUpBankName	string	Pickup bank name
|─pickUpBankBranchName	string	Pickup bank branch name
|─pickUpBankBranchId	string	Pickup bank branch ID
|─pickUpBankBranchAddress	string	Pickup bank branch address
|─address	object	Address information
|─state	string	State/Province
|─city	string	City
|─addressLine1	string	Address line 1
|─addressLine2	string	Address line 2
|─addressLine3	string	Address line 3
|─postalCode	string	Postal code
|─receiverInfo	object	Recipient information
|─nickName	string	Nickname
|─companyName	string	Company name
|─lastName	string	Last name
|─firstName	string	First name
|─areaCode	string	Area code
|─phone	string	Phone number
|─vatNumber	string	VAT number/CPF/CNPJ (Brazil)/ID number (other countries)
|─birthDate	string	Date of birth (yyyy-MM-dd)
|─email	string	Recipient email address (conditional field)

Response Example

{
  "respCode": "20000",
  "respMsg": null,
  "data": {
    "merchantNo": "800538",
    "accountInfomation": {
      "cardNumber": "Y",
      "accountType": "Y",
      "swiftCode": "Y",
      "sortCode": "N",
      "branchCode": "N",
      "bankHolderName": "N",
      "walletType": "N",
      "walletPhone": "N",
      "pickUpBankName": "N",
      "pickUpBankBranchName": "N",
      "pickUpBankBranchId": "N",
      "pickUpBankBranchAddress": "N"
    },
    "address": {
      "state": "N",
      "city": "Y",
      "addressLine1": "Y",
      "addressLine2": "C",
      "addressLine3": "C",
      "postalCode": "Y"
    },
    "receiverInfo": {
      "nickName": "Y",
      "companyName": "Y",
      "lastName": "N",
      "firstName": "N",
      "areaCode": "N",
      "phone": "N",
      "vatNumber": "N",
      "birthDate": "N",
      "email": "N"
    }
  }
}