Account Management System (AMS) API Guide
Follow the steps below to onboard your own merchant partner accounts by API. You have two choices of flow, one that only uses API calls, whereby you provide the data for your merchant partners, and one that uses a form, in which case your merchant partners input their data.
API Flow Option
The API flow lets you onboard merchants purely by API, requiring that you provide all of the information for your merchant partners yourself.
1. Authenticate
Authenticate to the Splitit ID server using the instructions at the auth endpoint. You'll need to add the response token as a bearer header to all subsequent calls.
2. View the Required Format for Your Add Requests
Make sure to attach your token from step 1 as a bearer header, then call Structure for Add Merchant Partner Requests to get a response that shows the fields you'll need to provide in each of your add requests. Note that the response here includes a RequestUrlEndpoint field with the profileId (at end), which you'll need in step 3.
Example Response Object
{
"MetaData": [
{
"Fields": [
{
"AccountFieldName": "Account.Company.AccountName",
"AccountFieldType": "String",
"IsMandatory": true
},
{
"AccountFieldName": "Account.Company.AccountPhone",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.AccountEmail",
"AccountFieldType": "String",
"IsMandatory": true
},
{
"AccountFieldName": "Account.Company.Website",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.CompanyAddresses.Item.Country",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.CompanyAddresses.Item.Street",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.CompanyAddresses.Item.City",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.CompanyAddresses.Item.State",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.CompanyAddresses.Item.PostalCode",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.CompanyAddresses.Item.Id",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.CompanyAddresses.Item.IsoA2",
"AccountFieldType": "String",
"AllowedOptions": [
"BG",
"MM",
"KH",
"BI",
"BY",
"DZ",
"CM",
"CA",
"CV",
"KY",
"LK",
"CL",
"CF",
"TD",
"CN",
"TW",
"AS",
"CO",
"KM",
"CG",
"CD",
"CK",
"AD",
"CR",
"HR",
"CY",
"CZ",
"BJ",
"DK",
"DO",
"DM",
"EC",
"SV",
"GQ",
"AO",
"ET",
"EE",
"FJ",
"FI",
"FR",
"GA",
"DJ",
"GE",
"GM",
"PS",
"DE",
"AG",
"GH",
"GI",
"KI",
"GR",
"GD",
"AZ",
"GU",
"AR",
"GT",
"GN",
"GY",
"HT",
"HN",
"VA",
"HK",
"HU",
"IS",
"IN",
"AU",
"ID",
"IQ",
"IR",
"IE",
"IL",
"IT",
"CI",
"JM",
"JP",
"KZ",
"AF",
"JO",
"AT",
"KE",
"KP",
"KR",
"LA",
"KW",
"KG",
"LB",
"LS",
"LY",
"LV",
"LR",
"LI",
"BS",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MR",
"BH",
"MU",
"MX",
"MN",
"MC",
"MD",
"ME",
"BD",
"MS",
"MZ",
"MA",
"AM",
"NA",
"BB",
"OM",
"NP",
"NL",
"CW",
"AW",
"SX",
"VU",
"NI",
"NZ",
"NE",
"BE",
"NU",
"FM",
"NO",
"NG",
"PA",
"PK",
"PG",
"BM",
"PH",
"PY",
"PL",
"PE",
"PT",
"GW",
"PR",
"BT",
"QA",
"RO",
"RU",
"RW",
"LC",
"KN",
"VC",
"AI",
"SM",
"RS",
"BO",
"SN",
"SA",
"SC",
"BA",
"VN",
"SL",
"SG",
"SK",
"SI",
"SO",
"ZA",
"ZW",
"ES",
"BW",
"SR",
"BR",
"CH",
"SZ",
"SE",
"SY",
"TJ",
"TT",
"TG",
"AE",
"TH",
"TO",
"TN",
"TR",
"TM",
"TC",
"UG",
"AL",
"UA",
"MK",
"EG",
"GB",
"BZ",
"TZ",
"US",
"VI",
"VE",
"WS",
"ZM",
"UY",
"BF",
"UZ",
"YE",
"SB",
"VG",
"EU",
"KS",
"JE",
"BN",
"IM",
"NC",
"MP",
"NF",
"PW",
"RE",
"BL",
"PN",
"MF",
"ST",
"SD",
"SJ",
"GS",
"PM",
"TL",
"TK",
"UM",
"TV",
"SH",
"NR",
"YT",
"FK",
"BQ",
"BV",
"MH",
"AX",
"IO",
"AQ",
"CX",
"CC",
"TP",
"WF",
"CU",
"MQ",
"FO",
"PF",
"GF",
"TF",
"GL",
"GG",
"ER",
"HM",
"EH"
],
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.CompanyAddresses.Item.CountryName",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Company.CompanyAddresses.Item.Type",
"AccountFieldType": "AddressType",
"AllowedOptions": [
"Billing",
"Shipping"
],
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.BillingInformation.LegalBusinessName",
"AccountFieldType": "String",
"IsMandatory": true
},
{
"AccountFieldName": "Account.FinancialInformation.BillingInformation.VatGstNumber",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.BillingInformation.RegisteredNumber",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.DebitBank.BankAccountNumber",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.DebitBank.BankAccountType",
"AccountFieldType": "BankAccountType",
"AllowedOptions": [
"Checking",
"Savings"
],
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.DebitBank.BankAccountName",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.DebitBank.BankNumber",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.CreditBank.BankAccountNumber",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.CreditBank.BankAccountType",
"AccountFieldType": "BankAccountType",
"AllowedOptions": [
"Checking",
"Savings"
],
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.CreditBank.BankAccountName",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.CreditBank.BankNumber",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.Contracts.Item.Pricings.Item.SKU",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.Contracts.Item.Pricings.Item.TransactionFeePercentage",
"AccountFieldType": "Decimal",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.Contracts.Item.Pricings.Item.TransactionFixedFee",
"AccountFieldType": "Decimal",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.Contracts.Item.Pricings.Item.ChargebackFee",
"AccountFieldType": "Decimal",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FinancialInformation.Contracts.Item.Pricings.Item.BankRejectFee",
"AccountFieldType": "Decimal",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Contacts.Item.Type",
"AccountFieldType": "ContactPersonType",
"AllowedOptions": [
"Business",
"Technical",
"Financial"
],
"IsMandatory": false
},
{
"AccountFieldName": "Account.Contacts.Item.Email",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.Contacts.Item.FullName",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FileIds.Item.FileId",
"AccountFieldType": "String",
"IsMandatory": false
},
{
"AccountFieldName": "Account.FileIds.Item.FileType",
"AccountFieldType": "FileType",
"AllowedOptions": [
"General",
"Contract",
"CreditCardProcessingStatement",
"YtdFinancialStatements",
"AuditedCPA",
"KYC"
],
"IsMandatory": false
}
],
"Account": {
"Company": {
"AccountName": "String",
"AccountPhone": "String",
"AccountEmail": "String",
"Website": "String",
"CompanyAddresses": [
{
"Country": "String",
"Street": "String",
"City": "String",
"State": "String",
"PostalCode": "String",
"Id": "String",
"IsoA2": "BG",
"CountryName": "String",
"Type": "Billing"
}
]
},
"FinancialInformation": {
"BillingInformation": {
"LegalBusinessName": "String",
"VatGstNumber": "String",
"RegisteredNumber": "String"
},
"DebitBank": {
"BankAccountNumber": "String",
"BankAccountType": "Checking",
"BankAccountName": "String",
"BankNumber": "String"
},
"CreditBank": {
"BankAccountNumber": "String",
"BankAccountType": "Checking",
"BankAccountName": "String",
"BankNumber": "String"
},
"Contracts": [
{
"Pricings": [
{
"SKU": "String",
"TransactionFeePercentage": "654827.561513539277346",
"TransactionFixedFee": "436297852.98064334690748",
"ChargebackFee": "1539358594.557046125761100",
"BankRejectFee": "1022681608.43968529577408"
}
]
}
]
},
"Contacts": [
{
"Type": "Business",
"Email": "String",
"FullName": "String"
}
],
"FileIds": [
{
"FileId": "String",
"FileType": "General"
}
]
},
"RequestUrlEndpoint": "https://account-mgmt-system.sandbox.splitit.com/api/v1/partner-profiles/create-account/PP_E80D13562D6F4C71876B85BE79D2AC79",
"Description": "Splitit BASE profile",
"Method": "POST",
"AuthorizationHeader": "Bearer <<your-token>>"
}
],
"Errors": null,
"StatusCode": 200,
"TraceId": "0LP1D6CTBD4M3:00000005#U4TtoG052xMPlAC",
"IsSuccess": true
}
3. Add New Merchants
Onboard your merchant by calling Add Merchant Partner with a properly formed request (using the format and profileId from step 2).
Form Flow Option
The form flow lets you send your merchant partner to a form, onto which they can input their own data.
1. Authenticate
Authenticate to the Splitit ID server using the instructions at the auth endpoint. You'll need to add the response token as a bearer header to all subsequent calls.
2. Send Emails
Send your merchant partner to a prefilled form by providing their email address(es) and profileId to the Send Invite Emails endpoint. If you don't have your profileId, you can get it by calling Structure for Add Merchant Partner Requests and looking at the end of the RequestUrlEndpoint field in the response.