Create a new Submerchant

Creates a submerchant FastPay account linked to the MerchantMaster.

POST /v1/submerchants

Create a new Submerchant

cURL

curl --request POST \
  --url https://api-global.fastpaybrasil.com/v1/submerchants \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "legalName": "ACME Corp",
  "tradeName": "ACME",
  "companyTaxId": "12.345.678/0001-99",
  "website": "https://google.com",
  "averageMonthlyRevenue": 5000,
  "averageOrderValue": 100,
  "productType": "digital",
  "legalRepresentative": {
    "fullName": "John Doe",
    "dateOfBirth": "1980-01-01",
    "nationality": "United State",
    "email": "[e-mail]",
    "motherName": "Jane Doe",
    "gender": "M",
    "phones": [
      {
        "type": "mobile",
        "number": "5551234"
      }
    ],
    "idNumber": "1234567890",
    "idType": "passport",
    "issuingCountry": "USA"
  },
  "contactEmail": "[e-mail]",
  "productDescription": "We sell electronic gadgets and accessories.",
  "address": {
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 1",
    "neighborhood": "Downtown",
    "city": "New York",
    "state": "CA",
    "country": "USA",
    "postalCode": "12345"
  },
  "phones": [
    {
      "type": "mobile",
      "number": "5551234"
    }
  ],
  "bankAccount": {
    "bankCode": "001",
    "agencyCode": "1234",
    "accountNumber": "567890",
    "accountDigit": "0",
    "accountType": "checking",
    "bankName": "Bank of America",
    "recipientName": "John Doe",
    "recipientDocument": "12345678900",
    "routingNumber": "021000021"
  },
  "softDescriptor": "ACME*GADGETS",
  "postbackUrl": "https://merchant.com/webhooks/merchant-status",
  "canAccessDashboard": true
}
'

201

{
  "id": "2vorkDcXyvzifL63YX09S9VqcnI"
}

Authorizations

Authorization · string · header · required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Body

application/json

legalName · string · required

The legal name of the merchant.

Example:

"ACME Corp"

tradeName · string · required

The trade name of the merchant.

Example:

"ACME"

companyTaxId · string · required

The tax identification number of the merchant.

Example:

"12.345.678/0001-99"

website · string<uri> · required

The website URL of the merchant.

Example:

"https://google.com"

averageMonthlyRevenue · number · required

The average monthly revenue of the merchant.

Example:

5000

averageOrderValue · number · required

The average order value of the merchant.

Example:

100

productType · enum<string> · required

The type of products sold by the merchant.

Available options: digital, physical, both

Example:

"digital"

legalRepresentative · object · required

Show child attributes

contactEmail · string · required

The contact email of the merchant.

Example:

"[e-mail]"

productDescription · string · required

A brief description of the products or services offered by the merchant.

Example:

"We sell electronic gadgets and accessories."

address · object · required

The address of the merchant.

Show child attributes

phones · object[] · required

List of phone numbers for the merchant.

Show child attributes

bankAccount · object · required

Show child attributes

softDescriptor · string

The soft descriptor that will appear on customers' credit card statements.

Maximum string length: 40

Example:

"ACME*GADGETS"

postbackUrl · string<uri>

Optional URL to receive a webhook notification when the merchant approval status changes.

Example:

"https://merchant.com/webhooks/merchant-status"

canAccessDashboard · boolean

Defines if the merchant can access the dashboard.

Example:

true

user · object

Required when canAccessDashboard is true.

Show child attributes

Response

201

application/json

The charge has been successfully created

id · string · required

The unique identifier of the created charge

Example:

"2vorkDcXyvzifL63YX09S9VqcnI"