Upsert Marketplace Customer

Marketplace customers allow marketplaces to onboard their customers once and have them available over all their sub-merchants. To set up payments for these payments, generate the merchant customer for the relevant sub-merchant using Upsert Customer

SecurityMarketplace API Key | Marketplace JWT | Admin JWT

Request

header Parameters

Marketplace-Id

string

Perform operation in the context of the given marketplace. Usually not required — specify only if acting on behalf of a marketplace not implied by the credentials specified in the Authorization header.

Request Body schema: application/json
required

One of:

required

object (UpsertConsumerMarketplaceCustomer1)

Consumer marketplace customers represent individuals who will be making purchases from one or more sub-merchants of the marketplace. They are uniquely identified by emailAddress for a given marketplace.

Alpha release - Consider this endpoint experimental and very likely to change in future.

Responses

200

400

401

403

404

405

406

409

422

429

500

503

post/marketplaces/customer

Request samples

Payload
Curl
JavaScript

application/json

{"UpsertConsumerMarketplaceCustomer": {"givenName": "string",
"middleName": "string",
"familyName": "string",
"emailAddress": "lucy.diamond@star.com",
"isVerified": true,
"phoneNumber": "+61401234567",
"referenceCustomerId": "CUST-48822821",
"metadata": { }
}
}

Response samples

application/json

{"ConsumerMarketplaceCustomer": {"marketplaceCustomerId": "mktpcust_aQhYQc61KFYeQkGs",
"marketplaceId": "mktp_aQhYQM61KFYeQkGl",
"givenName": "string",
"middleName": "string",
"familyName": "string",
"emailAddress": "lucy.diamond@star.com",
"isVerified": true,
"phoneNumber": "+61401234567",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"referenceCustomerId": "string"
}
}