Go to home page
Docs API Reference

Business Onboarding Batch

Used to bulk onboard Businesses into the Centrapay platform.

Type NameFile FormatRecord Type
business-onboardCSV Business Onboarding Record

Business Onboarding Record

Attributes

  • nzbn

    string

    The unique NZBN identifier.

  • companyName

    string required

    Legal name recorded in the Companies Register.

  • tradingName

    string

    Trading name of the Business.

  • contactName

    string required

    The name of the primary contact of the Business.

  • primaryContactEmail

    string required

    The email address of the primary contact of the business.

  • externalBusinessId

    string required

    The unique identifier of the Business in your system.

  • categoryCode

    string required

    The Merchant category code.

  • settlementAccountNumber

    string required

    The bank account number for settlement.

  • chargeAccountNumber

    string

    The bank account number for charges. This will default to the settlementAccountNumber if not provided.

  • assetProgramId

    string required

    The unique identifier of the Asset Program that the Business is to be onboarded to.

  • merchantName

    string required

    The name of the Merchant.

  • merchantStreet

    string

    The street number and name where the Merchant is located. Required if the Merchant type is physical.

  • merchantSuburb

    string

    The suburb where the Merchant is located.

  • merchantCity

    string

    The town or city where the Merchant is located. Required if the Merchant type is physical.

  • merchantState

    string

    The state or region where the Merchant is located. Required if the Merchant type is physical.

  • merchantPostcode

    string

    The post code where the Merchant is located.

  • merchantCountry

    string required

    The country where the Merchant is located.

  • merchantType

    string required

    They type of Merchant. Valid values are physical or e-commerce.

  • externalMerchantId

    string required

    The unique identifier of the Merchant in your system.

  • salesChannelId

    string required

    The unique identifier of the Sales Channel that the Merchant is to be onboarded to.

  • deviceId

    string

    The software or logical ID of the payment device. One of deviceId or deviceSerialNumber is required.

  • deviceSerialNumber

    string required

    The hardware ID or serial number of the payment device. One of deviceId or deviceSerialNumber is required.

  • deviceModel

    string

    The model of the payment device.

Example CSV File

Terminal window
nzbn,companyName,tradingName,contactName,primaryContactEmail,externalBusinessId,categoryCode,settlementAccountNumber,chargeAccountNumber,assetProgramId,merchantName,merchantStreet,merchantSuburb,merchantCity,merchantPostcode,merchantCountry,merchantType,externalMerchantId,salesChannelId,deviceId,deviceSerialNumber,deviceModel
9421234567891,My Great Company Limited,Centrapay Cafe,John Doe,johndoe@gmail.com,1234567,4121,00-1234-0322592-001,00-2345-0322592-001,ap_WRhAxxWpTKb5U7pXyxQjjY,Centrapay Cafe,17 South Street,Auckland Central,Auckland,1010,NZ,physical,2345678,sc_WRhAxxWpTKb5U7pXyxQjjY,002039390093939,002-039-390,T650P`