ACME Payments documentation is a draft & work in progress.  Updates may be published periodically.  


TABLE OF CONTENTS


Creating a Seller in the ACME Platform

These APIs are used for seller onboarding and for seller updates. ACME designed this overall process via an instant provisioning create API that will return a MID (merchant ID) used for payment processing APIs. In practice, the onboarding is done incrementally as several pieces of data need to be collected either via front-end software flows or in some cases by complementing via the ACME onboarding team.   Requirements depend on the country regulations  for the merchant being onboarded.


The general type of seller data needed before a seller can be activated for payment processing is segmented into

  • "identity" so that the underwriting process (software or manual) can apply the local country regulations by industry to verify the identity.
  • bank account information to deposit the payment proceeds to the seller
  • rate card information to take the ISV proceeds and settle via an already given ISV bank account.
  • webhook data to notify the seller of account state changes as it gets incrementally onboarded until ready for processing once all the data above has been provided.


Generate a Seller

This endpoint is used to create a seller in the ACME platform.

POST /v1/payment/sellers


Request Body

Include a Seller object as the body of the request.


Sample Request

POST https://sand10-api.acmeticketing.net/v1/payment/sellers


Response

Returns the newly created Seller object.


Retrieving a Seller

GET v1/payment/sellers/{mid}

Request Parameter

The merchant id (mid) in the URL of the request.


Sample Request

GET https://sand10-api.acmeticketing.net/v1/payment/sellers/{mid}

Response

Returns the requested Seller object.


Retrieving a List of Seller

GET v1/payment/sellers

Request Parameters

This endpoint will have pagination and sorting parameters.


Sample Request

GET https://sand10-api.acmeticketing.net/v1/payment/sellers

Returns

Returns the list of requested Seller objects.


Updating a Seller

Availability to update a seller's details will depend on the seller's onboarding status.  Once the seller's account has been verified by the processor certain parameters will be read only.  More details to come.

PUT v1/payment/sellers/{mid}


Request Parameter

The merchant id (mid) in the URL of the request.


Request Body

The entire Seller as you would like it to be updated.  The mid of the seller is required in the body.  


Sample Request

PUT https://sand10-api.acmeticketing.net/v1/payment/sellers/{mid}

Returns

Returns the resulting Seller object.


Seller Object

This is the main object used for verification purposes in the automated underwriting multi stage process.  The required fields are the minimum needed to set up the account.  Setting up a Rate Card will be needed before payout can happen.


NameTypeDescriptionRequired for Seller Creation Required for Payment Processing
midstringUnique identifier for this seller. Read OnlyRead Only
timezonestingTime zone of the sellerOptionalRequired
namestringThe seller's company name should match exactly what's shown on the company's SS-4 confirmation letter or Letter 147c including capitalization and punctuation.RequiredRequired
businessTypestringThe type of business.  Must be one of these values ‘individual’, ‘company’, 'government', or 'nonProfit'.  Government can only be used for a US business.OptionalRequired
legalStructurestringThe legal structure of the seller. Must be one of these values.  

"governmentInstrumentality",

"governmentalUnit",

"incorporatedNonProfit",

"limitedLiabilityPartnership",

"multiMemberLlc",

"privateCompany",

"privateCorporation",

"privatePartnership",

"publicCompany",

"publicCorporation",

"publicPartnership",

"singleMemberLlc",

"soleProprietorship",

"taxExemptGovernmentInstrumentality",

"unincorporatedAssociation",

"unincorporatedNonProfit"

Optional Optional
address1StringStreet address. PO Boxes are not allowed.  Verification of address can take up to 30 daysRequired Required
address2String
OptionalOptional
cityStringCity, district, suburb, town, or village.RequiredRequired
stateStringState, county, province, or region.RequiredRequired
zipStringZIP or Postal CodeRequiredRequired
countrystringCountry of residence, into which we settle to the local currency.RequiredRequired
phoneStringE.164 format, +1 (country code) (area code)(phone number)OptionalRequired
urlstringseller websiteOptionalRequired
principalsList<object>list of significant person(s) and their associated information - name, role, title, address, email, last 4 of SSN.  More details to come.Optional Required
taxRegistrationstingEIN in the US. The seller's EIN should match exactly what's shown on the company's SS-4 confirmation letter or Letter 147c including capitalization and punctuation.OptionalRequired
merchantCategoryNamestringmerchant category description as defined by the banking industry.  Needs to be populated if card processing.OptionalEither Name or Code is Required
merchantCategoryCodenumbermerchant category code (mcc) as defined by the banking industryOptionalEither Name or Code is Required
bankAccountobjectACH routing to deposit proceedsOptional Required
termsOfServiceAcceptanceobjectData indicating that the seller has accepted the Terms of Service for ACME and underlying payment providerOptional Required
onboardingStatusobjectIndication of the onboarding status and list of errors. See status list below.Read OnlyRead Only
createdOnstringThe date that this seller was createdRead OnlyRead Only
updatedOnstringThe date that this seller was last updatedRead OnlyRead Only
confirmedOnstringThe date that this seller was approved for payment processingRead OnlyRead Only

Onboarding Status

StatusDescription
awaitingPaymentDetailsYou've created a merchant and are ready to set up the payment processing.
pendingWe are in the process of verifying your identity but your account has been set up.
restrictedThere is something on the account that needs to be fixed.
rateCardNeededPlease set up a rate card.
cardProcessingReadyGood to go


Seller Sample Request Body

{
    "name" : "Prospersoft Inc",
    "url": "https://sellerurl.com",
    "address1": "165 University Ave",
    "address2": "Suite 28",
    "city": "Palo Alto",
    "state": "CA",
    "zip":"94303",
    "country": "US",
    "businessType": "individual",
    "legalStructure": "publicCorporation",
    "taxRegistration": "12-3456789",
    "merchantCategoryCode": 4816,
    "phone":"+1-408-555-1212",
    "timezone": "America/Los_Angeles",
    "payoutBankAccountNumber": "123-456-789"
}



Seller Sample Response Body

{
    "mid" : "987-654-321",
    "name" : "Prospersoft Inc",
    "url": "https://sellerurl.com",
    "address1": "165 University Ave",
    "address2": "Suite 28",
    "city": "Palo Alto",
    "state": "CA",
    "zip":"94303",
    "country": "US",
    "businessType": "individual",
    "taxRegistration": "12-3456789",
    "legalStructure": "publicCorporation",
    "merchantCategoryCode": 4816,
    "merchantCategoryName": "Computer Network/Information Services",
    "phone":"+1-408-555-1212",
    "payoutBankAccountNumber": "123-456-789",
    "timezone": "America/Los_Angeles",
    "createdOn": "2021-03-31T13:07:20Z",
    "updatedOn": "2021-03-31T13:07:20Z",
    "confirmedOn": "2021-03-31T13:07:20Z",
    "onboardingStatus": {
      "status": "cardProcessingReady"
    }
}