Services

Onboard new merchant

This API enables the partner to onboard a new merchant at Buckaroo with the relevantdata.

Method	Resource
POST	/services/apexrest/partnerapi/v2/merchant

Request/body

{
"isTest": false,
"partnerReference":
"e5d957191987902cb1d80d5b43c528136d90c06c9c2f5556bbe341f2e6d41f5f",
"webshopURL": "https://test.site",
"secretKey": "optional64LongSelfDefinedKey",
"paymentMethods":
[
"iDEAL"
],
"deliveryStreet": "someStreet",
"deliveryHouseNumber": "1",
"deliveryPostalCode": "0000AA",
"deliveryCity": "Traiectum",
"deliveryISOCountryCode": "NL",
"terminalProducts": [
{
"code": "N4",
"acquisitionMethod": "L",
"leaseTerm": 3,
"quantity": 1,
"storeName": "someName",
"storeStreet": "someStreet",
"storeHouseNumber": "1",
"storePostalCode": "0000AA",
"storeCity": "Traiectum",
"storeISOCountryCode": "NL"
},
{
"code": "N4",
Buckaroo B.V | Postbus 8257, 3503 RG UTRECHT | Zonnebaan 9, 3542 EA UTRECHT
KvK 04060983 | BTW NL808888614.B01 | NL62BUKK6288521324 | Tel: +31 (0)88 42 62 777 5
"acquisitionMethod": "B",
"quantity": 1,
"storeName": "someName",
"storeStreet": "someStreet",
"storeHouseNumber": "1",
"storePostalCode": "0000AA",
"storeCity": "Traiectum",
"storeISOCountryCode": "NL"
},
{
"code": "_A0577",
"acquisitionMethod": "B",
"quantity": 2
}
],
"company":
{
"name": "testName",
"streetAndNumber": "teststreet 1",
"postalCode": "1000 AA",
"city": "Traiectum",
"cocRegisteredCountryCode": "DE",
"legalEntityTypeIsUnincorporatedAssociation": "false",
"legalEntityType": "Ak􀆟engesellscha􀅌(AG)",
"cocNumber": "04060983",
"sbiCode": "13245",
"vatNumber": "NL808888614.B01",
"primaryIBAN": "NL02INGB8635612388",
"primaryIBANAscrip􀆟on": "Buckaroo, Traiectum",
"secondaryIBAN": "NL70RABO3135536696",
"secondaryIBANAscrip􀆟on": "Buckaroo, Traiectum"
},
"contact":
{
"firstName": "test the",
"lastName": "tester",
"email": "[email protected]",
"password": "Welkom123!",
"phone": "+31713864315",
"language": "nl_NL"
},
"legalPersons":
[
{
"isDirector": true,
Buckaroo B.V | Postbus 8257, 3503 RG UTRECHT | Zonnebaan 9, 3542 EA UTRECHT
KvK 04060983 | BTW NL808888614.B01 | NL62BUKK6288521324 | Tel: +31 (0)88 42 62 777 6
"isSignatory": true,
"isUBO": true,
"firstName": "test the",
"lastName": "tester",
"jobTitle": "CEO",
"streetAndNumber": "astreet 45",
"postalCode": "0000 AA",
"city": "Traiectum",
"countryCode": "NL",
"na􀆟onalityCountryCode": "NL",
"dateOfBirth": "2013-07-01",
"placeOfBirth": "Traiectum",
"countryCodeOfBirth": "NL",
"percentageOfShares": 60,
"email": "[email protected]",
"phone": "+31713864315",
"verifiedByMerchant": true
}
]
}

Response

Example success response:

{
"onboardingReference": "2ee5f5f5-c976-4c3c-a6a6-0204bd091ea1",
"expectedDocumentsToCompleteOnboarding": [
{
"endpoint": "/services/apexrest/partnerapi/v2/merchant/2ee5f5f5-c976-4c3c-a6a6-
0204bd091ea1/connectionAgreement/6bc85fe3-2622-4494-b3b3-
1a8b6􀄩c8751/document?partnerReference=e5d957191987902cb1d80d5b43c528136d90c06c9c2f5
556bbe341f2e6d41f5f",
"documentType": "connectionAgreement",
"documentDescription": "Signed connec􀆟on agreement"
},
{
Buckaroo B.V | Postbus 8257, 3503 RG UTRECHT | Zonnebaan 9, 3542 EA UTRECHT
KvK 04060983 | BTW NL808888614.B01 | NL62BUKK6288521324 | Tel: +31 (0)88 42 62 777 15
"endpoint": "/services/apexrest/partnerapi/v2/merchant/2ee5f5f5-c976-4c3c-a6a6-
0204bd091ea1/cocExtract/a8643542-9a1c-43d3-a7e7-
e9ebbfc0590e/document?partnerReference=e5d957191987902cb1d80d5b43c528136d90c06c9c2f5
556bbe341f2e6d41f5f",
"documentType": "cocExtract",
"documentDescription": "Extract chamber of commerce"
},
{
"endpoint": "/services/apexrest/partnerapi/v2/merchant/2ee5f5f5-c976-4c3c-a6a6-
0204bd091ea1/bankStatement/b2ad3ae1-5062-4b8b-b676-
88b51570d093/document?partnerReference=e5d957191987902cb1d80d5b43c528136d90c06c9c2f
5556bbe341f2e6d41f5f",
"documentType": "bankStatement",
"documentDescription": "Bank Statement for NL02INGB8635612388"
},
{
"endpoint": "/services/apexrest/partnerapi/v2/merchant/2ee5f5f5-c976-4c3c-a6a6-
0204bd091ea1/bankStatement/cf06e843-4574-4b􀄩-9797-
457e3b05d73e/document?partnerReference=e5d957191987902cb1d80d5b43c528136d90c06c9c2f5
556bbe341f2e6d41f5f",
"documentType": "bankStatement",
"documentDescription": "Bank Statement for NL70RABO3135536696"
},
{
"endpoint": "/services/apexrest/partnerapi/v2/merchant/2ee5f5f5-c976-4c3c-a6a6-
0204bd091ea1/legalPerson/ad541b0c-da65-4beb-8787-
4ca22a533613/document?partnerReference=e5d957191987902cb1d80d5b43c528136d90c06c9c2f5
556bbe341f2e6d41f5f",
"documentType": "legalPerson",
"ddocumentDescription": "Copy Iden􀆟fica􀆟on for test the tester (.legalPersons[0])"
}
]
}

Onboard additional merchant account

This API enables the partner to onboard a new additional merchant account at Buckaroofor an already onboarded merchant with the relevant data.

Method	Resource
POST	/services/apexrest/partnerapi/v2/account

Request/header

Content-type: image/png OR image/jpg OR application/pdf or
application/vnd.openxmlformatsofficedocument.wordprocessingml.document Content- Transfer-Encoding: base64 X-API-Key: <your key>

Supported content-type

application/pdf
image/jpeg
image/gif
image/png
image/tiff
application/vnd.ms-powerpoint
application/vnd.openxmlformatsofficedocument.presentationml.presentation
application/msword
application/vnd.openxmlformatsofficedocument.wordprocessingml.document
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Finalize/complete onboarding

This API marks the onboarding complete in case document/file uploads were required as specified in the response of Onboard New Merchant or Onboard Additional Merchant Account.

Method	Resource
POST	POST /services/apexrest/partnerapi/v2/merchant/<onboardingReference>/complete?partnerReference=<partnerReference>

With onboardingReference the reference returned by Onboard New Merchant or Onboard Additional Merchant Account.

Request/header

X-API-Key: <your key>

Request body

Empty.

Example success response

Http code 200.

Example error response

{"errors": ["No documents were found related to onboarding"]}

Retrieve merchant keys

This API can be used to retrieve merchant API keys.

Method	Resource
POST

Request/header

X-API-Key: <your key>

Example success response

{
"webSiteKey": "abcdef",
"plazaUserName": "username",
"plazaUserKey": "abc"
}

Example error response

{"errors": ["Keys not available, check onboarding status."]}

Retrieve merchant status

This API can be used to retrieve the merchant onboarding status.

Method	Resource
POST

Request/header

X-API-Key: <your key>

Example success response

{
"status": "Wai􀆟ng for Merchant",
"readyForKYCInput": true,
"keysRetrieved": false,
"keysAvailable": true,
"merchantGUID": "someKey"
}

Example error response

{"errors": [".partnerReference: Invalid partnerReference"]}

Retrieve configured payment methods

Using this API you can see the current active payment methods for a certain merchant, including pricing.

Method	Resource
POST

Request/header

X-API-Key: <your key>

Example success response

{"paymentMethods": [
{
"priceParts": [
{
"gatewayFee": 0.23,
"descrip􀆟on": "Debitcards Consumers (EU)",
"currencyISOCode": "EUR",
"commissionPercentage": 1.2
},
{
"gatewayFee": 0.23,
"descrip􀆟on": "Refund: Debitcards Consumers (EU)",
"currencyISOCode": "EUR",
"commissionPercentage": 1.2
}
]}