WePay logo
      Nothing Found

Get an account

get/accounts/{id}

The GET /accounts/{id} call allows your platform to look up a single account. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string [ 1 .. 255 ] characters

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

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
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.

object

Provide the merchant's identifiers with different card brands they accept as methods of payment.

convenience_fee_amount
integer or null [ 0 .. 9999999 ]

Describe the convenience fees for Merchant IC+ accounts in cents.

enhanced_review
string or null

Indicates if the account is under enhanced review by WePay.

object or null

Address of the legal entity, controller, or additional representatives. When representing the entity's address, send the entity's address of operation. When representing the controller or additional representative send the individual's residential address.

organization
string or null [ 1 .. 500 ] characters

A nullable field allowing partners to differentiate between types of merchants within the partner's hierarchy.

projected_monthly_transaction_volume
integer or null

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

referral_partner
string [ 1 .. 75 ] characters

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

transaction_division_mid
integer or null

file:./descriptions/argument_info.shared.json#/accounts_shared/transaction_division_mid-nullable/description

transaction_type
string or null

file:./descriptions/argument_info.shared.json#/accounts_shared/transaction_type/description

Enum: Description
internet

The merchant will process card-not-present web transactions.

retail

The merchant will process card-present transactions.

400

INVALID_PARAMS

401

COULD_NOT_AUTHENTICATE

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "convenience_fee_amount": 25,
  • "transaction_type": "internet",
  • "onboarding_location": {
    • "line1": "123 candy st.",
    • "city": "redwood city",
    • "region": "CA",
    • "country": "US",
    • "postal_code": "94063"
    },
  • "transaction_division_mid": null,
  • "accepted_method_of_payments": {
    • "countries": {
      • "US": {
        • "visa": {
          • "card_not_present": {
            • "credit": true,
            • "debit": true
            },
          • "card_present": {
            • "contact": {
              • "credit": true,
              • "debit": true
              },
            • "contactless": {
              • "credit": true,
              • "debit": true
              }
            }
          }
        }
      }
    },
  • "balances": {
    • "currencies": {
      • "USD": {
        • "balance": 100000,
        • "incoming_pending": 5000,
        • "outgoing_pending": 21200,
        • "reserve": 10000
        }
      }
    },
  • "create_time": 1480700534,
  • "custom_data": null,
  • "api_version": "3.1",
  • "beneficiary": {
    • "id": "295f2816-07b9-4d9e-a035-4f0884ef228b",
    • "resource": "legal_entities",
    • "path": "/legal_entities/295f2816-07b9-4d9e-a035-4f0884ef228b"
    },
  • "description": "Foo Bar Shop on 5th ave.",
  • "documents": [ ],
  • "enhanced_review": "not_requested",
  • "id": "d3f61e56-5d99-4895-af2d-a07ab48476e9",
  • "incoming_payments": {
    • "accepted_methods": [
      • "payment_bank",
      • "mastercard",
      • "visa",
      • "amex"
      ],
    • "amex": {
      • "countries": {
        • "US": {
          • "opt_blue": {
            • "opt_into_marketing": true,
            • "amex_seller_number": 1912187301,
            • "amex_seller_id": "970001000016308"
            }
          }
        }
      }
    },
  • "industry": {
    • "category_detail": "Website design",
    • "merchant_category_code": "7333"
    },
  • "name": "Foo Bar Shop",
  • "owner": {
    • "id": "3cd20b3c-4008-400b-b708-2b844ce7be84",
    • "path": "/legal_entities/3cd20b3c-4008-400b-b708-2b844ce7be84",
    • "resource": "legal_entities"
    },
  • "path": "/accounts/d3f61e56-5d99-4895-af2d-a07ab48476e9",
  • "payout": {
    • "currencies": {
      • "USD": {
        • "next_payout_time": 14987382982,
        • "payout_method_id": "0102b1c6-2bc7-448a-aa1d-076b1637547c",
        • "period": "daily"
        }
      },
    • "default_currency": "USD"
    },
  • "pricing": {
    • "currencies": {
      • "USD": {
        • "credit_card": null,
        • "payment_bank": null,
        • "recurring_fee": null,
        • "other_fees": {
          • "debit_failure_fee": null
          }
        }
      }
    },
  • "reference_id": null,
  • "resource": "accounts",
  • "statement_description": "Foo Bar Shop",
  • "platform_onboarding_time": null,
  • "projected_monthly_transaction_volume": 500
}