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

    Id string

    Company

    object

    AccountName string
    AccountPhone string
    AccountEmail string
    Website string

    CompanyAddresses

    object[]

  • Array [

    • Country string
    Street string
    City string
    State string
    PostalCode string
    Id string
    IsoA2 string
    CountryName string
    Type AddressType (string)

    Possible values: [Billing, Shipping]

  • ]

    • FinancialInformation

    object

    UniqueId string

    BillingInformation

    object

    LegalBusinessName string
    Subsidiary Subsidiary (string)

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

    VatGstNumber string
    BillingCurrency BillingCurrency (string)

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

    MonetaryFlow MonetaryFlow (string)

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

    RegisteredNumber string

    DebitBank

    object

    SettlementChannel DebitSettlementChannel (string)

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

    BankAccountNumber string
    BankAccountType BankAccountType (string)

    Possible values: [Checking, Savings]

    BankAccountName string
    GoCardlessMandateId string
    GoCardlessCustomerId string
    GoCardlessGivenName string
    GoCardlessFamilyName string
    GoCardlessCompanyName string
    GoCardlessEmail string
    BSBCode string
    BankNumber string

    CreditBank

    object

    SettlementChannel CreditSettlementChannel (string)

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

    BankAccountNumber string
    BankAccountType BankAccountType (string)

    Possible values: [Checking, Savings]

    BankAccountName string
    BSBCode string
    TransitNumber string
    BankCode string
    SwiftCode string
    IBAN string
    BankNumber string

    FundingSetup

    object

    CreditLine number
    RiskRating RiskRating (string)

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

    ReservePool number
    FundingTrigger FundingTriggers (string)

    Possible values: [None, PlanActivation, Shipment]

    DebitOnHold boolean
    FundingOnHold boolean
    FundingEndDate date-time
    FundingStartDate date-time
    SettlementType SettlementType (string)

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

    FundNonSecuredPlans FundNonSecuredPlans (string)

    Possible values: [NA, NO, YES]

    Contracts

    object[]

  • Array [

    • Id string
    Name string
    StartDate date-time
    EndDate date-time
    SubscriptionERP_Id string

    Pricings

    object[]

  • Array [

    • Id string
    SKU string
    TransactionFeePercentage number
    TransactionFixedFee number
    ChargebackFee number
    ErpId string
    BankRejectFee number
    Description string
    MinInstallment int32
    MaxInstallment int32

  • ]

    • BusinessUnitUniqueId string

  • ]

    • ModifiedDate date-time
    IsDeleted boolean
    Status AccountStatuses (string)

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

    Contacts

    object[]

  • Array [

    • Id string
    Type ContactPersonType (string)

    Possible values: [Business, Technical, Financial]

    Email string
    FullName string

  • ]

    • CustomerERPId string

    RelatedEntities

    object

    AMSParentId string

    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.

    CallbackUrl string

Responses​

Success

Response Headers

    Schema

      Errors

      object[]

    • Array [

      • Code string
      Message string
      AdditionalInfo string

    • ]

      • StatusCode int32required
      TraceId string
      IsSuccess booleanrequired

      Data

      object

      property name* string
    Loading...