WePay logo
      Nothing Found

Create an account

post/accounts

The POST /accounts call allows your platform to create a new account owned by a legal entity. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.

SecurityappIdAuth and appTokenAuth
Request
header Parameters
Api-Version
required
string
Example: 3.0
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
string
WePay-Risk-Token
string

This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used.

Client-IP
string

This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used.

Request Body schema: application/json
legal_entity_id
required
string [ 1 .. 255 ] characters

ID of the object or resource.

beneficiary_legal_entity_id
string or null

If the Account is being transferred to a beneficiary, provide the Legal Entity ID of the beneficiary receiving the Account. Note: This parameter requires permission from WePay to use.

object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

description
string or null <= 65535 characters

Short description of the merchant account.

object

Identify the payment methods this merchant will accept, and describe this merchant's relationship with card association.

object

Categorizes the type of service or item a merchant is providing.

name
string or null [ 1 .. 255 ] characters ^(?!.*[Ww][Ee][Pp][Aa][Yy]).*\w+.*$

Name of the merchant account; use the "Doing Business As" title for the merchant. Must not contain the word wepay. Note: Account names can include any regex word character.

object

Details the merchant’s payout method.

platform_onboarding_time
integer or null <int64> >= 0

The Unix epoch time (in seconds) when the account finished onboarding to the platform.

object

The Merchant IC+ pricing model and Blended pricing model to collect platform payment fees from the merchant. Your markup fees should be inclusive of WePay processing fees, which will be debited from your platform Account. For any markup that you define, you'll receive that amount less WePay fees. If you choose to have a lower markup than the fees WePay charges, your Account will be debited to cover the difference.

projected_monthly_transaction_volume
integer or null

The projected monthly transaction volume, TPV, of an account.

Array of objects or null

Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects.

reference_id
string or null [ 1 .. 255 ] characters

A custom reference ID for your platform to track the object. It can be any string.

object

Information regarding the referring representative

referral_partner
string [ 1 .. 75 ] characters

The non ISV partner/solution that refers merchants for payment processing services

statement_description
string or null [ 1 .. 255 ] characters ^((?![Ww][Ee][Pp][Aa][Yy])[ -~ōšžà-ïñ-öù-ýÿāū...

A non-empty, ASCII-printable string that does not contain the word WePay. This will appear on payers' credit card statements. Note: The API allows up to 255 characters, but card issuers will only print 12-14 characters on statements. Find more information here.

Responses
201
Response Schema: application/json
api_version
required
string
required
object

Displays balances pertaining to the merchant account.

required
object

Details the owner resource and owner path.

create_time
required
integer <int64> >= 0

The UNIX timestamp for when the object was created.

required
object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

description
required
string or null <= 65535 characters

Short description of the merchant account.

required
Array of objects

An array of documents attached to this merchant to verify fee disclosure.

id
required
string [ 1 .. 255 ] characters

ID of the merchant account, generated by WePay when the account is created.

required
object

Identify the payment methods this merchant will accept, and describe this merchant's relationship with card association.

required
object

Categorizes the type of service or item a merchant is providing.

name
required
string or null [ 1 .. 255 ] characters ^(?!.*[Ww][Ee][Pp][Aa][Yy]).*\w+.*$

Name of the merchant account; use the "Doing Business As" title for the merchant. Must not contain the word wepay. Note: Account names can include any regex word character.

required
object

Details the owner resource and owner path.

path
required
string

The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it.

required
object

Details the merchant’s payout method.

platform_onboarding_time
required
integer or null <int64> >= 0

The Unix epoch time (in seconds) when the account finished onboarding to the platform.

required
object

The Merchant IC+ pricing model and Blended pricing model to collect platform payment fees from the merchant. Your markup fees should be inclusive of WePay processing fees, which will be debited from your platform Account. For any markup that you define, you'll receive that amount less WePay fees. If you choose to have a lower markup than the fees WePay charges, your Account will be debited to cover the difference.

reference_id
required
string or null [ 1 .. 255 ] characters

A custom reference ID for your platform to track the object. It can be any string.

resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
accounts
statement_description
required
string or null [ 1 .. 255 ] characters ^((?![Ww][Ee][Pp][Aa][Yy])[ -~ōšžà-ïñ-öù-ýÿāū...

A non-empty, ASCII-printable string that does not contain the word WePay. This will appear on payers' credit card statements. Note: The API allows up to 255 characters, but card issuers will only print 12-14 characters on statements. Find more information here.

enhanced_review
string or null

Indicates if the account is under enhanced review by WePay.

projected_monthly_transaction_volume
integer or null

The projected monthly transaction volume, TPV, of an account.

object

Information regarding the referring representative

referral_partner
string [ 1 .. 75 ] characters

The non ISV partner/solution that refers merchants for payment processing services

400

INVALID_PARAMS, UNSUPPORTED_COUNTRY, UNSUPPORTED_CURRENCY

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "description": "Foo Bar Shop on 5th ave.",
  • "industry": {
    • "category_detail": "Website design",
    • "merchant_category_code": "7333"
    },
  • "legal_entity_id": "3cd20b3c-4008-400b-b708-2b844ce7be84",
  • "name": "Foo Bar Shop",
  • "payout": {
    • "currencies": {
      • "CAD": {
        • "payout_method_id": "62b90e13-81f6-400f-bca1-e9fd4099921e",
        • "period": "weekly"
        },
      • "USD": {
        • "payout_method_id": "0102b1c6-2bc7-448a-aa1d-076b1637547c",
        • "period": "daily"
        }
      }
    },
  • "incoming_payments": {
    • "amex": {
      • "countries": {
        • "US": {
          • "opt_blue": {
            • "opt_into_marketing": true
            }
          }
        }
      }
    },
  • "reference_id": null,
  • "statement_description": "Foo Bar Shop",
  • "projected_monthly_transaction_volume": 500
}
Response samples
application/json
{
  • "name": "tmp",
  • "description": "Req to create CA account",
  • "documents": [ ],
  • "enhanced_review": "not_requested",
  • "industry": {
    • "merchant_category_code": "7399",
    • "category_detail": null
    },
  • "reference_id": null,
  • "statement_description": null,
  • "incoming_payments": {
    • "accepted_methods": [
      • "visa",
      • "mastercard",
      • "american_express"
      ],
    • "opted_out_methods": {
      • "countries": {
        • "CA": {
          • "debit_cards": false
          }
        }
      },
    • "amex": {
      • "countries": {
        • "US": {
          • "opt_blue": {
            • "opt_into_marketing": true,
            • "amex_seller_number": 1912187301,
            • "amex_seller_id": "970001000016308"
            }
          }
        }
      }
    },
  • "payout": {
    • "default_currency": "CAD",
    • "currencies": {
      • "CAD": null
      }
    },
  • "custom_data": null,
  • "create_time": 1568156223,
  • "balances": {
    • "currencies": { }
    },
  • "pricing": {
    • "currencies": {
      • "CAD": {
        • "credit_card": null,
        • "payment_bank": null,
        • "recurring_fee": null,
        • "other_fees": {
          • "debit_failure_fee": null
          }
        }
      }
    },
  • "id": "7485adcc-42d9-4f75-b0cd-a5a8d66def7b",
  • "resource": "accounts",
  • "path": "/accounts/7485adcc-42d9-4f75-b0cd-a5a8d66def7b",
  • "owner": {
    • "id": "f26f0e63-5bf9-4216-8db6-8f13a42cd174",
    • "resource": "legal_entities",
    • "path": "/legal_entities/f26f0e63-5bf9-4216-8db6-8f13a42cd174"
    },
  • "api_version": "3.0",
  • "beneficiary": {
    • "id": "f26f0e63-5bf9-4216-8db6-8f13a42cd174",
    • "resource": "legal_entities",
    • "path": "/legal_entities/f26f0e63-5bf9-4216-8db6-8f13a42cd174"
    },
  • "platform_onboarding_time": null,
  • "projected_monthly_transaction_volume": 500
}