Boarding Management

The Boarding Management API allows you to create and manage merchant applications for payment processing. This RESTful service handles the complete merchant onboarding process from application creation to final submission.

Base URLs

Environment
URL

Sandbox

https://boarding-sb.clearent.net/api/

Production

https://boarding.clearent.net/api/

Headers

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay

Available Endpoints

  • Upsert Application Properties:

    • PUT /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Properties

  • Retrieve a Property:

    • GET /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Properties/{propertyName}

  • Create Application:

    • POST /api/BoardingManagement/v1.0/Applications/Create

  • Create Default Pricing:

    • POST /api/BoardingManagement/v1.0/Applications/{merchantNumber}/InitializePricing

  • Submit Signatures:

    • POST /api/BoardingManagement/v1.0/Applications/{merchantNumber}/SubmitSignatures

  • Submit Application:

    • POST /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Submit

Path Parameters

Name
Data Type
Required?
Description

merchantNumber

String

Required

Merchant identifier

propertyName

String

Required

Property name to retrieve

The /Applications/Create endpoint does not use any path parameters since it creates a new merchant and returns the merchantNumber in the response.

Last updated

Was this helpful?