• 简体中文
  • 虚拟账号创建

    请求路径

    /api/v2/virtual/account/label/create

    参数列表

    名称类型长度必填描述
    virtualAccountNameString200是虚拟账号的名称
    identityTypeString32是使用者的证件类型: ● 个人类型并且使用BVN校验 为 "personal" ● 个人类型并且使用NIN校验 为"personal_nin" ● 企业类型并且使用CAC校验 为 "company"
    licenseNumberString64是证件号码 ● 若证件类型为personal,则传使用人的BVN号码 ● 若证件类型为personal_nin,则传使用人的NIN号码 ● 若证件类型为company,则传公司的CAC号码,注意必须以RC或BN开头
    emailString128否使用者的邮箱
    customerNameString200是使用者的名称 ● 个人类型 为 个人姓名 ● 企业类型 为 CAC上的公司名
    accountReferenceString120否虚拟账户备注字段,可自定义,只有在删除时清除

    返回值

    名称类型长度必填描述
    virtualAccountNameString200是虚拟账号的名称
    virtualAccountNoString64是虚拟账号的号码
    statusString32是虚拟账号的状态: Enabled 、Disabled 、Deleted 创建成功默认状态为Enabled
    identityTypeString32否使用者的身份类型: ● 个人类型 为 "personal" ● 企业类型 为 "company"
    licenseNumberString64否证件号码 ● 个人类型 为 使用人的BVN号 ● 码企业类型 为 公司的CAC号码
    emailString128否使用者的邮箱
    customerNameString200否使用者的名称 ● 个人类型 为 个人姓名 ● 企业类型 为 CAC上的公司名
    accountReferenceString120否虚拟账户备注字段,可自定义,只有在删除时清除

    错误码

    参见此文

    Postman请求示例

    request

    curl --location 'https://open-gw-sandbox.palmpay-inc.com/api/v2/virtual/account/label/create' \
    --header 'Authorization: Bearer L231127063379321376521' \
    --header 'countryCode: NG' \
    --header 'Signature: Xgp7oFDxe5Jvy859hDxvlFo2+Hc4VtZrMge+b09XLnwngPc7l2RinScXK4aADDMcreZtN5thCsj/qfM6rXzHBPF5lrUvAPN8TB+rc2wTacqNVLDElEusYjAEDVHCv9CeMsmTgsERMQgHpRwUkOLqUEcE7JAsX/MnHdFsv+nQdtqvc5wn0O7nCq/o2MhUiNhvNIw7UFfjy9p5Pz+JM8yV92Tno1QoWv0w01pWZHR15LoSauRCzdEN2K+ctbHrKF+He+xxHL0kdunI1yqj7hnfZ5qblEckR8DhqowAFNSu/Yp7TaAFbBBM4yGJTTEB4Hg7uocsWtd3zwYa2nU0lLetJA==' \
    --header 'content-type: application/json;charset=UTF-8' \
    --data '{
    	"requestTime":1703152048883,
    	"identityType":"company",
    	"licenseNumber":"dasd141234114123",
    	"virtualAccountName":"PPTV2",
    	"version":"V2.0",
    	"customerName":"palmpayTester",
    	"email":"2222@palmpay.com",
    	"nonceStr":"8GagBq4oGahVZAD8PQgLFJdhGQxoS1gy"
    }'

    response

    {
        "data": {
            "identityType": "company",
            "licenseNumber": "dasd141234114123",
            "virtualAccountName": "PPTV2(Account Suffix of Institution)",
            "virtualAccountNo": "6664564951",
            "email": "2222@palmpay.com",
            "customerName": "palmpayTester",
            "status": "Enabled",
            "accountReference": "accountReference example"
        },
        "respMsg": "success",
        "respCode": "00000000",
        "status": true
    }