For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Guides API Reference

Reference - Partner API

Create an Onboarding
Get an Onboarding by Merchant Reference
Get an Onboarding by Onboarding ID
Update an Onboarding
Get Activations
Capabilities
Channel
Owner
Business
Onboarding
PostOnboardingResponse
OnboardingPostPut
Get Capabilities
Enable or Disable Payment Method
Enable or Disable Cross Border Trade
Lending
ProductConfiguration
Approve Contract
Approve Custom Rate
Update Tier
Get Contract
Get Custom Rate
BuyRates
Contract
CustomRate
Event: custom-rate.created
BaseRate
RateObjDuration
RateObjDurationEffectiveFrom
User
Get Settlement Batches
Get Settlement Batches by Date
Get Settlement Batch Files
BatchSettlement
400Response
400Response2
401Response
409Response
404Response
503Response
Event: rates-contract.created

Reference - Partner API Onboardings

PostOnboardingResponse

Example

1 {
2   "onboardingId": "123abcd-456efgh-1124bd",
3   "timestamp": "2024-02-21 09:00:14.016",
4   "merchantReference": "merchantId123",
5   "parentMerchantReference": "merchantPlatform",
6   "status": "APPROVED"
7 }

Response

post_onboarding_responseobjectRequired

Was this page helpful?