Update merchant

put

https://www.affirm.com/api/pba/v1/merchants/{merchant_id}

Update an existing merchant (idempotent)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

merchant_id

string

required

ID of the Merchant

Body Params

Merchant object

legal_business_name

string | null

Business legal name

url

string | null

URL of business website

first_name

string | null

Business contact first name

last_name

string | null

Business contact last name

email_address

string | null

Business contact email

financing_package_uuid

string | null

UUID of the financing package to bind to the Merchant

ein

string | null

Employer Identification Number

settlement_bank_account_number

string | null

Account to disburse settlements to. If this field is updated, disbursements and debits will be automatically re-enabled for the merchant, if they were disabled

settlement_bank_routing_number

string | null

Routing number of bank. If this field is updated, disbursements and debits will be automatically re-enabled for the merchant, if they were disabled

mcc

string | null

Four digit ISO-18245 code

business_type

string | null

enum

Allowed:

remittance_name

string | null

Name of the bank account

pre_approved

boolean | null

A boolean indicating whether the merchant has been pre-approved

external_merchant_id

string | null

Partner-owned ID for the merchant

phone_number

string | null

Business contact phone number

business_display_name

string | null

Display name of the business

statement_descriptor_suffix

string | null

Text to use as the suffix for the statement descriptor. Should be 14 characters or less

business_phone

string | null

Phone number of the business

annual_volume

string | null

Annual volume of sales, in dollars

average_order_value

string | null

Average value of a single order, in dollars

capture_to_shipment_time

integer | null

Average time between payment capture to shipment of product, in days

business_owner_dob

string | null

Date of birth of the business owner

business_owner_ssn

string | null

Social security number of the business owner

industry

string | null

enum

sub_industry

string | null

enum

business_address

object | null

business_owner_address

object | null

status

string

enum

An enum indicating the status of the merchant

Allowed:

disbursement_enabled

boolean

This flag should be sent in order to programmatically turn on disbursements for the merchant

settlement_bank_account_state

string | null

enum

Allowed:

Headers

Country-Code

string

Alpha-3 country code used to denote the merchant's country.

Locale

string

The 5-character locale code to be used for the merchant.

Responses

200Success

400Invalid Input

401Unauthorized

404Merchant not found

409Conflict

500Internal server error