Get Onboarding Status

Used for retrieving an onboarding result/response.

HTTP GET

Environment	Endpoint
QA	https://onboarding-service.{instance}.qa.rubean.io/api/{acquirer}/{client}/status/{requestId}
PROD	https://onboarding-service.{instance}.phonepos.online/api/{acquirer}/{client}/status/{requestId}

Parameter	Format	Occurrence	Description
requestId	ANS 36	M	Either a Rubean-generated request ID (returned in create response) or one provided by the requester in the onboarding request

Request Example

Retrieve an onboarding response using Rubean uuid:

https://onboarding-service.{instance}.qa.rubean.io/api/{acquirer}/{client}/status/3fa85f64-5717-4562-b3fc-2c963f66afa6

Retrieve an onboarding response using the externalID:

https://onboarding-service.{instance}.qa.rubean.io/api/{acquirer}/{client}/status/12345678

Response Example

Response Message Structure

{
  "id": "string",
  "terminalId": "string",
  "activationCode": "string",
  "status": {
    "result": "COMPLETE",
    "timestamp": "string",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "description": "string"
  }
}