Products

Product code will be provided to partners along with the partner credentials.

Apply for a product

put

This endpoint enables partner customers to apply for a product.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

emailstringRequired

The email of the customer.

Example: [email protected]

productCodestringRequired

The product code customer wants to subscribe to.

Example: PI3

Responses

200Success

application/json

400

The request could not be processed due to incorrect syntax, missing parameters, or invalid data. Please review and resubmit the request with correct information.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The request could not be processed as provided email was not found

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

put

/api/v2/partner/product/application

HTTPcURLJavaScriptPython

PUT /api/v2/partner/product/application HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "email": "[email protected]",
  "productCode": "PI3"
}

{
  "status": "EligibilityInProgress"
}

Get Product Application Status

get

This endpoint offers information regarding customers' eligibility for a product.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

emailstringRequiredExample: 46136eed-cde2-4513-85b0-c143c8f1d144

productCodestringRequiredExample: ProductCode

Responses

200Success

application/json

400

The request could not be processed due to incorrect syntax, missing parameters, or invalid data. Please review and resubmit the request with correct information.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The request could not be processed as provided email was not found

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

get

/api/v2/partner/product/applicationStatus

HTTPcURLJavaScriptPython

GET /api/v2/partner/product/applicationStatus?email=46136eed-cde2-4513-85b0-c143c8f1d144&productCode=ProductCode HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "eligibilityStatus": "NotEligible",
  "reason": "Credit Verification Failed",
  "isOnboarded": false
}

Unsubscribe a product

put

This endpoint enables partner customers to unsubscribe a product.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

emailstringRequired

The email of the customer.

Example: [email protected]

productCodestringRequired

The product code customer wants to subscribe to.

Example: PI3

Responses

200Success

No content

400

The request could not be processed due to incorrect syntax, missing parameters, or invalid data. Please review and resubmit the request with correct information.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The request could not be processed as provided email or product was not found

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

put

/api/v2/partner/product/unsubscribe

HTTPcURLJavaScriptPython

PUT /api/v2/partner/product/unsubscribe HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "email": "[email protected]",
  "productCode": "PI3"
}

No content