Merchants

41 endpoints

A merchant is a business that takes payments on the platform. Merchants are onboarded, activated once their business details are verified, and may be suspended or closed.

A merchant of type ServiceProvider receives money without selling, a supplier being paid through the platform rather than a business taking payments.

GET/merchants/{merchantId}Get merchant

GET/merchantsList merchants

POST/merchantsCreate merchants

PATCH/merchants/{merchantId}Update merchant

PATCH/merchantsUpdate merchants

POST/merchants/{merchantId}Act on merchant

GET/merchants/{merchantId}/apple-pay-registrationsGet merchant apple pay registration

GET/beneficial-owners/{beneficialOwnerId}Get beneficial owner

GET/beneficial-ownersList beneficial owners

POST/beneficial-ownersCreate beneficial owners

PUT/beneficial-owners/{beneficialOwnerId}Replace beneficial owner

DELETE/beneficial-owners/{beneficialOwnerId}Delete beneficial owner

GET/files/{fileId}Get file

GET/filesList files

POST/filesCreate files

GET/balancesList balances

GET/external-accountsList external accounts

POST/external-accountsCreate external accounts

PATCH/external-accounts/{externalAccountId}Update external account

GET/travel-uploadsList travel uploads

POST/travel-uploadsCreate travel uploads

PATCH/travel-uploads/{travelUploadId}Update travel upload

GET/travel-batchesList travel batches

GET/travel-files/{travelFileId}Get travel file

GET/travel-filesList travel files

GET/travel-files/{travelFileId}/batches/{batchId}Get travel file batch

GET/travel-files/{travelFileId}/missing-dbi-workbooks/{layout}Get travel file missing dbi workbook

GET/travel-files/{travelFileId}/batchesList travel file batches

GET/travel-files/{travelFileId}/errorsList travel file errors

GET/travel-entries/{travelEntryId}Get travel entry

GET/travel-entriesList travel entries

PATCH/travel-entries/{travelEntryId}Update travel entry

GET/travel-entries/{travelEntryId}/errorsList travel entry errors

GET/travel-entries/{travelEntryId}/refund-candidatesList travel entry refund candidates

GET/merchant-travel-settings/{merchantTravelSettingId}Get merchant travel setting

PATCH/merchant-travel-settings/{merchantTravelSettingId}Update merchant travel setting

GET/merchant-travel-settings/{merchantTravelSettingId}/missing-dbi-workbooks/{layout}Get merchant travel setting missing dbi workbook

GET/merchant-statement-passwords/{merchantStatementPasswordId}Get merchant statement password

PATCH/merchant-statement-passwords/{merchantStatementPasswordId}Update merchant statement password

GET/travel-dbi-correctionsList travel dbi corrections

POST/travel-dbi-correctionsCreate travel dbi corrections