v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Gateway Features
Merchants

Assign Fee Schedule to Merchant / Complete and Send Welcome Email / Agree to TOS and Fees for a Merchant

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Assign a Fee Schedule to the Merchant</summary>

This can be done when creating the merchant in the first place <a href="createmerchant">(1. Create a Merchant)</a> but you can also add it whenever you’d like using the request below.

Assign Fee Schedule Request

Please note this is a PATCH request. Attempting a POST will result in an error.<br /> As noted above, the costPlan value can be passed in the initial merchant boarding step if you know what it will be at that point.

</details> <details> <summary>Complete & Send the Welcome Email</summary>

This request will complete the merchant creation and send the welcome email to the merchant. activatePendingServices is optional, and is the equivalent of checking the “activate pending services immediately” box in the partner portal.

Complete and Send Welcome Email Request

This is a PATCH request, not a POST.<br /> activatePendingServices is optional and defaults to false.<br /> Note - agreementTextId is based on the agreement that is needed to be agreed to. You can pull the correct agreement language with a /merchants/{id}/agreement_text request. This will return the id and language that you are agreeing to.

</details> <details> <summary>Agree to TOS and Fees for Merchant Request</summary>

Agree to TOS and Fees for Merchant Request

This is a PATCH request, not a POST.<br /> This request will activate any and all pending service on a merchant account. This is the equivalent of checking the “Activate pending services immediately” box in the partner portal.<br> agreementTextId is based on the agreement that is needed to be agreed to. You can pull the correct agreement language with a /merchants/{id}/agreement_text request. This will return the id and language that you are agreeing to.

</details>
patch/v4/merchants/{gateway_id}

Path parameters

gateway_idstring required

The merchant ID that the request should operate on.

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Request body

OR
OR

Response

Success

objectType'merchant'

The type of object that was returned as a result of the request.

idinteger

The unique identifier of the processor or service instance added.

typestring

The type of the merchant account which the fee scheduled was added to.

createdstring

The date and time that the merchant was created.

updatedstring

The date and time of the last update to the merchant.

firstNamestring

The first name of the merchant's company contact.

lastNamestring

The last name of the merchant's company contact.

companystring

The merchant's company name.

emailstring

The email of the merchant's company contact.

phonestring

The phone number of the merchant's company contact.

faxstring

The fax number of the merchant's company contact.

urlstring

The merchant's website URL.

address1string

The first line of the merchant's address.

address2string

The second line of the merchant's address.

citystring

The city associated with the merchant's address.

statestring

The state associated with the merchant's address.

zipstring

The postal code associated with the merchant's address.

countrystring

The country associated with the merchant's address.

timezonestring

The merchant's timezone.

costPlanstring

The cost plan assigned to the merchant.

statusstring

The status of the merchant.

externalIdentifierstring

A description to further describe or identify the merchant.

lastTransactionDatestring

The date of the last transaction on the merchant.

parentAffiliateIdstring

The ID of the affiliate directly above the merchant.

needsPendingServicesActivatedstring

Merchant needs pending services activated.

payFacBillingPeriodstring

Payment Facilitator Billing Period.

rejectedCertificatesstring

Number of rejected certificates.