Update Merchant

Various actions for updating a merchant such as updating the bank account used for payouts.

Request

path Parameters

merchantId

required

string

Request Body schema: application/json
required

One of:

required

object (AddMerchantBankAccount1)

Add a new bank account associated with this merchant. The newly added account will automatically be set as the primary bank account where payouts are deposited into.

Responses

200

400

401

403

404

405

406

409

422

429

500

503

patch/merchants/{merchantId}

Request samples

Payload
Curl
JavaScript

application/json

{"AddMerchantBankAccount": {"accountName": "string",
"bankName": "string",
"identifier": {"AuBankAccountIdentifier": {"bsb": "string",
"accountNumber": "string"
}
},
"currency": "AUD",
"setAsPrimary": true
}
}

Response samples

application/json

{"ServiceProviderMerchant": {"merchantId": "mcht_Zz_j6R6IwWmwGetC",
"marketplaceId": "mktp_Zz_j6R6IwWmwGetM",
"businessProfile": {"timeZone": "Australia/Sydney",
"businessName": "string",
"businessType": "company",
"companyType": "Private",
"website": "string",
"supportSite": "string",
"industry": "AcRefrigerationRepair",
"taxCountry": "AU",
"tradingCountry": "AU",
"taxId": "string",
"contactPerson": {"title": "string",
"givenName": "string",
"familyName": "string"
},
"contactEmailAddress": "lucy.diamond@star.com",
"supportEmailAddress": "lucy.diamond@star.com",
"phoneNumber": "+61401234567",
"address": {"unitNumber": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"suburb": "string",
"city": "string",
"state": "string",
"postalCode": 2000,
"country": "AU"
},
"brandName": "string",
"cardStatementName": "Kates Deli",
"smsSenderName": "KatesDeli",
"verificationDocs": {"companyFrontFileId": "lfile_Zz_j6h6IwWmwGetQ",
"companyBackFileId": "lfile_Zz_j6h6IwWmwGetQ",
"companyTaxIdFileId": "lfile_Zz_j6h6IwWmwGetQ",
"partnershipAgreementFileId": "lfile_Zz_j6h6IwWmwGetQ",
"trustDeedFileId": "lfile_Zz_j6h6IwWmwGetQ",
"trustDeedAmendmentFileIds": ["lfile_Zz_j6h6IwWmwGetQ"
]
}
},
"referenceMerchantId": "string",
"readableIdentifier": "string",
"status": "Pending",
"payoutDetails": {"payoutSettings": {"notificationEmails": ["lucy.diamond@star.com"
],
"notificationsEnabled": true
},
"payoutSchedule": "string",
"automatedPayoutsEnabled": true,
"payoutStatus": "Enabled"
},
"billingDetails": {"billingNotificationEmails": ["lucy.diamond@star.com"
],
"billingNotificationsEnabled": true,
"billingAddress": {"unitNumber": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"suburb": "string",
"city": "string",
"state": "string",
"postalCode": 2000,
"country": "AU"
},
"billingPaymentSourceId": "psrc_Zz_j6R6IwWmwGetI"
},
"bankAccounts": [{"accountId": "xacc_Zz_j6x6IwWmwGetX",
"accountName": "string",
"bankName": "string",
"identifier": {"AuBankAccountIdentifier": {"bsb": "string",
"accountNumber": "string"
}
},
"currency": "AUD",
"country": "string",
"isPrimaryForCurrency": true
}
],
"payPlanSettings": {"maxPayPlanAmount": 0,
"minPayPlanAmount": 0
},
"publicToken": "string",
"sourceRules": [{"criterion": { },
"action": [{ }
]
}
]
}
}

Update Merchant

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required