RequiredField

SwaggerUI

Parameter description

Request

name type required desc example
param JSONObject YES
─epayAccount string YES Merchant Epay Account test2020@epay.com
─version string YES Version number V2.0.0
─category string YES BANK or CASH BANK
─receiveCurrency string YES Receivement Currency SGD
─countryCode string YES Country code: ISO 2 bits SG
─transactionType string YES Transaction mode(C2C,B2C,B2B,C2B) C2C
─type string NO RECEIVE,PAYMENT,refer to payType PAYMENT
sign string YES Signature

Response

name type required desc example
sign string YES Signature
epayAccount string YES Merchant Epay Account test2020@epay.com
version string YES Version number V2.0.0
code integer YES Response code 1 : Success 1
message string YES Message info success
data JSONarray
─channelCode string YES Channel Code 56
─senderOrReceiver integer YES Payee: 1 is payer 2 is payee
1 is payer senderInfo,senderBusiness required field, 2 is payee receiverInfo,receiverBusiness required field		 1
─currency string YES currency SGD
─showName string YES showName {\"EN_US\": \"First Name\", \"ZH_CN\": \"姓\"}
─value string YES Field surName
─maxLength integer YES Maximum length 20
─required integer YES 1 Required 0 Not required 1

Parameter example

RequestExample ResponseExample 
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/getRequiredField' \
--header 'Content-Type: application/json' \
--data-raw '{
  "param": {
    "epayAccount": "test2020@epay.com",
    "category": "BANK",
    "receiveCurrency": "SGD",
    "countryCode": "SG",
    "transactionType": "C2C",
    "version": "V2.0.0"
  },
  "sign": "{{sign}}"
}'

RequestExample

curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/getRequiredField' \
--header 'Content-Type: application/json' \
--data-raw '{
  "param": {
    "epayAccount": "test2020@epay.com",
    "category": "BANK",
    "receiveCurrency": "SGD",
    "countryCode": "SG",
    "transactionType": "C2C",
    "version": "V2.0.0"
  },
  "sign": "{{sign}}"
}'

ResponseExample

{
  "sign": "",
  "epayAccount": "test2020@epay.com",
  "version": "V2.0.0",
  "code": 1,
  "message": "success",
  "data": [
    {
      "channelCode": "56",
      "senderOrReceiver": 1,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"First Name\", \"ZH_CN\": \"姓\"}",
      "value": "surName",
      "maxLength": 20,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 1,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"Last Name\", \"ZH_CN\": \"名\"}",
      "value": "givName",
      "maxLength": 20,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 1,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"Country\", \"ZH_CN\": \"国家\"}",
      "value": "country",
      "maxLength": 50,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 1,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"Address\", \"ZH_CN\": \"地址\"}",
      "value": "address",
      "maxLength": 100,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 1,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"Purpose Of Remittance\", \"ZH_CN\": \"汇款用途\"}",
      "value": "purposeOfRemittance",
      "maxLength": 50,
      "required": 1
  },
    {
      "channelCode": "56",
      "senderOrReceiver": 2,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"First Name\", \"ZH_CN\": \"姓\"}",
      "value": "surName",
      "maxLength": 20,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 2,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"Last Name\", \"ZH_CN\": \"名\"}",
      "value": "givName",
      "maxLength": 20,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 2,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"Location ID\", \"ZH_CN\": \"银行\"}",
      "value": "locationId",
      "maxLength": 20,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 2,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"Bank ID\", \"ZH_CN\": \"银行 ID\"}",
      "value": "bankId",
      "maxLength": 20,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 2,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"Bank Name\", \"ZH_CN\": \"银行名称\"}",
      "value": "bankName",
      "maxLength": 50,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 2,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"accountNo\", \"ZH_CN\": \"银行账户\"}",
      "value": "accountNo",
      "maxLength": 50,
      "required": 1
    },
    {
      "channelCode": "56",
      "senderOrReceiver": 2,
      "currency": "SGD",
      "showName": "{\"EN_US\": \"country\", \"ZH_CN\": \"国家\"}",
      "value": "country",
      "maxLength": 50,
      "required": 1
    }
  ]
}

results matching ""

    No results matching ""