Skip to main content

Add Merchant Partner

POST 

/api/v1/partner-profiles/create-account/:profileId

Use this endpoint to add a new merchant to your account by providing information for the fields that were returned in the object from Structure for Add Merchant Partner Requests. As before, authenticate with your bearer token. Note that you can receive ongoing webhooks related to onboarding status by adding your desired URL to the OnboardingInitialSetup object

Request

Path Parameters

    profileId stringrequired

    The profile id from your merchant account that you would like to use (a merchant account may have more than one). It is returned in RequestUrlEndpoint in the response from Structure for Add Merchant Partner Requests (at the end of the string)

Body

required

    Account

    object

    Idstring

    Company

    object

    AccountNamestring
    AccountPhonestring
    AccountEmailstring
    Websitestring

    CompanyAddresses

    object[]

  • Array [

  • Countrystring
    Streetstring
    Citystring
    Statestring
    PostalCodestring
    Idstring
    IsoA2string
    CountryNamestring
    TypeAddressType (string)

    Possible values: [Billing, Shipping]

  • ]

  • FinancialInformation

    object

    UniqueIdstring

    BillingInformation

    object

    LegalBusinessNamestring
    SubsidiarySubsidiary (string)

    Possible values: [SplititAustraliaPtyLtd, SplititOperationsCALtd, SplititUKLtd, SplititUSAInc]

    VatGstNumberstring
    BillingCurrencyBillingCurrency (string)

    Possible values: [AUD, CAD, EUR, GBP, JPY, SGD, USD]

    MonetaryFlowMonetaryFlow (string)

    Possible values: [DBS, PCO, DPL, MER]

    RegisteredNumberstring

    DebitBank

    object

    SettlementChannelDebitSettlementChannel (string)

    Possible values: [ABA, ACH, GoCardless, INVOICE]

    BankAccountNumberstring
    BankAccountTypeBankAccountType (string)

    Possible values: [Checking, Savings]

    BankAccountNamestring
    GoCardlessMandateIdstring
    GoCardlessCustomerIdstring
    GoCardlessGivenNamestring
    GoCardlessFamilyNamestring
    GoCardlessCompanyNamestring
    GoCardlessEmailstring
    BSBCodestring
    BankNumberstring

    CreditBank

    object

    SettlementChannelCreditSettlementChannel (string)

    Possible values: [ABA, ACH, CrossBorder, FasterPayment, PAD, WireTransfer]

    BankAccountNumberstring
    BankAccountTypeBankAccountType (string)

    Possible values: [Checking, Savings]

    BankAccountNamestring
    BSBCodestring
    TransitNumberstring
    BankCodestring
    SwiftCodestring
    IBANstring
    BankNumberstring

    FundingSetup

    object

    CreditLinenumber
    RiskRatingRiskRating (string)

    Possible values: [None, High, Medium, Low]

    ReservePoolnumber
    FundingTriggerFundingTriggers (string)

    Possible values: [None, PlanActivation, Shipment]

    DebitOnHoldboolean
    FundingOnHoldboolean
    FundingEndDatedate-time
    FundingStartDatedate-time
    SettlementTypeSettlementType (string)

    Possible values: [NetSettle, NetSettleOutgoingOnly, GrossSettle, GrossSettleInvoiced, None]

    FundNonSecuredPlansFundNonSecuredPlans (string)

    Possible values: [NA, NO, YES]

    Contracts

    object[]

  • Array [

  • Idstring
    Namestring
    StartDatedate-time
    EndDatedate-time
    SubscriptionERP_Idstring

    Pricings

    object[]

  • Array [

  • Idstring
    SKUstring
    TransactionFeePercentagenumber
    TransactionFixedFeenumber
    ChargebackFeenumber
    ErpIdstring
    BankRejectFeenumber
    Descriptionstring
    MinInstallmentint32
    MaxInstallmentint32
  • ]

  • BusinessUnitUniqueIdstring
  • ]

  • ModifiedDatedate-time
    IsDeletedboolean
    StatusAccountStatuses (string)

    Possible values: [New, PendingApproval, Approved, Rejected, Synced, Failed]

    Contacts

    object[]

  • Array [

  • Idstring
    TypeContactPersonType (string)

    Possible values: [Business, Technical, Financial]

    Emailstring
    FullNamestring
  • ]

  • CustomerERPIdstring

    RelatedEntities

    object

    AMSParentIdstring

    OnBoardingInitialSetup

    object

    This is a URL (where you can provide a webhook) that will be called with ongoing updates related to the status of onboarding your merchant.

    CallbackUrlstring

Responses

Success

Response Headers

    Schema

      Errors

      object[]

    • Array [

    • Codestring
      Messagestring
      AdditionalInfostring
    • ]

    • StatusCodeint32required
      TraceIdstring
      IsSuccessbooleanrequired

      Data

      object

      property name*string