Worldpay Merchant Boarding API — onboard merchants programmatically.
Partners (ISOs) collect merchant business information and submit it via this API, giving full control over the merchant onboarding experience.
Example
{:ok, merchant} = Worldpay.Partner.Boarding.create_merchant(%{
"merchant" => %{
"businessName" => "Jane's Bakery",
"businessType" => "soleTrader",
"mcc" => "5462",
"website" => "https://janesbakery.com",
"contact" => %{
"firstName" => "Jane",
"lastName" => "Doe",
"email" => "jane@example.com",
"phone" => "+441234567890"
},
"address" => %{
"address1" => "123 High Street",
"city" => "London",
"postalCode" => "SW1A 1AA",
"countryCode" => "GB"
},
"bankAccount" => %{
"accountNumber" => "12345678",
"sortCode" => "010203",
"accountName" => "Jane Doe"
}
}
}, config)Summary
Functions
Create (board) a new merchant.
Retrieve a boarded merchant by ID.
List boarded merchants for the partner.
Update an existing merchant's details.
Functions
@spec create_merchant(map(), Worldpay.Config.t()) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Create (board) a new merchant.
@spec get_merchant(String.t(), Worldpay.Config.t()) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Retrieve a boarded merchant by ID.
@spec list_merchants( keyword(), Worldpay.Config.t() ) :: {:ok, map()} | {:error, Worldpay.Error.t()}
List boarded merchants for the partner.
@spec update_merchant(String.t(), map(), Worldpay.Config.t()) :: {:ok, map()} | {:error, Worldpay.Error.t()}
Update an existing merchant's details.