Connect to merchant account

This endpoint allows API users to connect a SignNow organization to a payment service.

For more information, see the Request payments guide.

Currently, the organization can be connected to Stripe and Stripe Connect. To receive payments, you'll need a valid payment system account.

[!NOTE] An organization is limited to one active account per payment service. The connected payment service will apply to all organization members by default.

<details> <summary>Use additional attributes to customize the request</summary>

Parameter	Description	Example
display_credit_card_form	Boolean indicating whether to display the credit card form by Stripe to the recipient. Must be true if account_type is Stripe.	<img src="/reference-assets/images/Request_payments/payment_form_card.png" alt="Make Payment dialog with the credit card form">

</details>

post/organizations/{org_id}/merchantaccount

Request

Base URL
https://api.signnow.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/signnow/apis/signnow-api/docs/organizations/:org_id/merchantaccount/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ID of the requested organization.

Request body

currencystring

The currency used for recipient transactions.

secure_keystring

Secure API key (secret) given by Stripe. Required if account_type is Stripe.

account_namestring required

Name of the new merchant account.

account_typestring required

The type of payment service. Allowed values: Stripe, StripeConnect.

publishable_keystring

Publishable API key given by Stripe. Required if account_type is Stripe.

display_ach_formboolean

Deprecated. Boolean indicating whether to display the ACH payment form by Stripe. If account_type is Stripe, the only accepted value is false. Omit this parameter.

display_credit_card_formboolean

Boolean indicating whether to display the credit card form by Stripe. Required if account_type is Stripe, and the only accepted value is true. Other account types ignore this parameter.

Example request

{
  "currency": "USD",
  "secure_key": "sk_yyyy_0vkrljcpCb9qbdk8IMXNyyyy",
  "account_name": "My Stripe",
  "account_type": "Stripe",
  "publishable_key": "pk_xxxx_y16i7GDlOVChs1OowXjAiYYY"
}

Response

Successful response.

idstring

ID of the merchant account.

Changes

No recorded changes to this operation across all 1 revision of this API.