Add Merchant Partner

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

Path Parameters
profileId string — REQUIRED 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)

Request Body — REQUIRED

Account object Id string Company object AccountName string AccountPhone string AccountEmail string Website string CompanyAddresses object[] Country string Street string City string State string PostalCode string Id string IsoA2 string CountryName string Type AddressType Possible values: [Billing, Shipping] FinancialInformation object UniqueId string BillingInformation object LegalBusinessName string Subsidiary Subsidiary Possible values: [SplititAustraliaPtyLtd, SplititOperationsCALtd, SplititUKLtd, SplititUSAInc] VatGstNumber string BillingCurrency BillingCurrency Possible values: [AUD, CAD, EUR, GBP, JPY, SGD, USD] MonetaryFlow MonetaryFlow Possible values: [DBS, PCO, DPL, MER] RegisteredNumber string DebitBank object SettlementChannel DebitSettlementChannel Possible values: [ABA, ACH, GoCardless, INVOICE] BankAccountNumber string BankAccountType BankAccountType 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 Possible values: [ABA, ACH, CrossBorder, FasterPayment, PAD, WireTransfer] BankAccountNumber string BankAccountType BankAccountType Possible values: [Checking, Savings] BankAccountName string BSBCode string TransitNumber string BankCode string SwiftCode string IBAN string BankNumber string FundingSetup object CreditLine number RiskRating RiskRating Possible values: [None, High, Medium, Low] ReservePool number FundingTrigger FundingTriggers Possible values: [None, PlanActivation, Shipment] DebitOnHold boolean FundingOnHold boolean FundingEndDate date-time FundingStartDate date-time SettlementType SettlementType Possible values: [NetSettle, NetSettleOutgoingOnly, GrossSettle, GrossSettleInvoiced, None] FundNonSecuredPlans FundNonSecuredPlans Possible values: [NA, NO, YES] Contracts object[] Id string Name string StartDate date-time EndDate date-time SubscriptionERP_Id string Pricings object[] 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 Possible values: [New, PendingApproval, Approved, Rejected, Synced, Failed] Contacts object[] Id string Type ContactPersonType 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
200 Success Schema — OPTIONAL Errors object[] — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL StatusCode int32 TraceId string — OPTIONAL IsSuccess boolean Data object — OPTIONAL
404 Not Found Schema — OPTIONAL Errors object[] — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL StatusCode int32 TraceId string — OPTIONAL IsSuccess boolean
500 Internal Server Error Schema — OPTIONAL Errors object[] — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL StatusCode int32 TraceId string — OPTIONAL IsSuccess boolean