Create new payment file record

Creates a new payment file record for the business.

Request

POST http:///api/v2/business/{businessId}/paymentfiles

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

The request body takes a complete MyBankDetailsModel resource, containing the following writable properties:

{
    "accountName": "string",
    "accountNumber": "string",
    "bankCode": "string",
    "bankPublicKey": {
        "businessId": "int32",
        "createdDate": "date-time",
        "expiryDate": "date-time",
        "id": "int32",
        "keyName": "string"
    },
    "branchCode": "string",
    "clientKeyPair": {
        "businessId": "int32",
        "id": "int32",
        "privateKey": {
            "businessId": "int32",
            "createdDate": "date-time",
            "expiryDate": "date-time",
            "id": "int32",
            "keyName": "string"
        },
        "publicKey": {
            "businessId": "int32",
            "createdDate": "date-time",
            "expiryDate": "date-time",
            "id": "int32",
            "keyName": "string"
        }
    },
    "corporateId": "string",
    "encryptAndSign": "boolean",
    "fileFormat": "string",
    "hsbcConnectCustomerId": "string",
    "hsbcnetCustomerId": "string",
    "id": "int32",
    "lodgementReference": "string",
    "organisationCode": "string",
    "paymentAdditionalContent": "string",
    "paymentCode": "string",
    "valueDateDaysBeforeDatePaid": "int32"
}

Properties

Name Type Description
accountName string String
accountNumber string String
bankCode string String
bankPublicKey object PgpKeyEditModel
bankPublicKey.businessId int32 Int32
bankPublicKey.createdDate date-time DateTime
bankPublicKey.expiryDate date-time Nullable
bankPublicKey.id int32 Int32
bankPublicKey.keyName string String
branchCode string String
clientKeyPair object PgpKeyPairEditModel
clientKeyPair.businessId int32 Int32
clientKeyPair.id int32 Int32
clientKeyPair.privateKey object PgpKeyEditModel
clientKeyPair.privateKey.businessId int32 Int32
clientKeyPair.privateKey.createdDate date-time DateTime
clientKeyPair.privateKey.expiryDate date-time Nullable
clientKeyPair.privateKey.id int32 Int32
clientKeyPair.privateKey.keyName string String
clientKeyPair.publicKey object PgpKeyEditModel
clientKeyPair.publicKey.businessId int32 Int32
clientKeyPair.publicKey.createdDate date-time DateTime
clientKeyPair.publicKey.expiryDate date-time Nullable
clientKeyPair.publicKey.id int32 Int32
clientKeyPair.publicKey.keyName string String
corporateId string String
encryptAndSign boolean Nullable
fileFormat string BankFileFormatMy

Possible values are:

  • HSBC
  • Maybank
  • HSBCnet
  • AmBank
  • CIMBBulkPayment
  • PublicBankECP
  • HongLeongConnectFirst
  • HongLeongConnectBiz
  • OCBCGiro
  • Maybank2UBiz
  • Maybank2E_StaffPayroll
  • RHBSmartPayroll
  • AllianceBizSmart
  • EAmPayday
  • UnitedOverseas
  • StandardCharteredS2B
  • IslamBulkPayment
hsbcConnectCustomerId string String
hsbcnetCustomerId string String
id int32 Nullable
lodgementReference string String
organisationCode string String
paymentAdditionalContent string PaymentFilePaymentAdditionalContent

Possible values are:

  • None
  • PeriodEndingDate
  • PaymentDate
  • EmployeeId
  • PayRunId
paymentCode string String
valueDateDaysBeforeDatePaid int32 Nullable

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK