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
onboardingIdstring or null
The ID that can be used to update merchant's configs and get an onboarding status.
updatedAtstring or null
Last updated timestamp of this onboarding.
merchantReferencestring or null

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

parentMerchantReferencestring or null
Unique ID for the platform of the merchant in the partner's internal systems to index to merchantReference.
legalBusinessNamestring or null
Legal business name found in incorporation or similar documents.
storeNamestring or null

Recognizable doing-business-as name.

websitestring or null
Homepage URL of the merchant.
platformstring or null
Platform the merchant is on.
industrystring or null

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

aveTimeToShipstring or null
Average time to ship for this business.
registeredCountrystring or null

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.

countryOfOperationsstring or null
The consumer market where the merchant will sell goods or services.
businessTypestring or null
Type of business matching exactly the naming conventions outlined in the business type section.
einstring or null
Identifying tax number such as TIN, ABN, or SSN depending on the relevant jurisdiction. Can be null.
selfFulfillmentboolean or null
Indicates if the merchant fulfills orders themselves.
address1string or null
Business address 1 of the merchant.
address2string or null
Business address 2 of the merchant, if applicable. Can be null.
citystring or null
City of the business address of the merchant.
statestring or null
State or province of the business address of the merchant.
postCodestring or null
Postal code of the business address of the merchant.
emailstring or null
Customer support email that will be shown within the Afterpay native application.
settlementContractIdstring or null
Defines the country and the banking entity for the partner's online channel for the benefit of the merchant.
ownerslist of objects or null

Errors