Reference - Partner APIOnboardings

Get an Onboarding by Onboarding ID

Allows a partner to retrieve onboarding details using the onboardingId.

Path parameters

onboardingIdstringRequired
The id that is returned during a successful Create an onboarding call.

Headers

User-AgentstringRequired
AcceptstringRequiredDefaults to application/json
Specifies media types that are acceptable for the response.

Response

Onboarding details retrieved successfully
onboardingIdstringOptional
The ID that can be used to update merchant's configs and get an onboarding status.
updatedAtstringOptional
Last updated timestamp of this onboarding.
merchantReferencestringOptional

Unique ID for the merchant in the partner’s internal systems to index to Afterpay’s Merchant ID (MID).

parentMerchantReferencestringOptional
Unique ID for the platform of the merchant in the partner's internal systems to index to merchantReference.
legalBusinessNamestringOptional
Legal business name found in incorporation or similar documents.
storeNamestringOptional

Recognizable doing-business-as name.

websitestringOptional
Homepage URL of the merchant.
platformstringOptional
Platform the merchant is on.
industrystringOptional

A four-digit number that classifies the type of goods or services a business offers following the ISO 18245 standard.

aveTimeToShipstringOptional
Average time to ship for this business.
registeredCountrystringOptional

Country code in the two-letter ISO 3166-1 alpha-2 standard format defining the consumer market where the merchant will sell goods or services.

countryOfOperationsstringOptional
The consumer market where the merchant will sell goods or services.
businessTypestringOptional
Type of business matching exactly the naming conventions outlined in the business type section.
einstringOptional
Identifying tax number such as TIN, ABN, or SSN depending on the relevant jurisdiction. Can be null.
selfFulfillmentbooleanOptional
Indicates if the merchant fulfills orders themselves.
address1stringOptional
Business address 1 of the merchant.
address2stringOptional
Business address 2 of the merchant, if applicable. Can be null.
citystringOptional
City of the business address of the merchant.
statestringOptional
State or province of the business address of the merchant.
postCodestringOptional
Postal code of the business address of the merchant.
emailstringOptional
Customer support email that will be shown within the Afterpay native application.
settlementContractIdstringOptional
Defines the country and the banking entity for the partner's online channel for the benefit of the merchant.
ownerslist of objectsOptional

Errors

401
Unauthorized Error
404
Not Found Error
503
Service Unavailable Error