Skip to main content

API reference

The Partner API is a JSON over HTTPS API. Every route is under /partner/v1 and every field is camelCase.

Base URL​

EnvironmentBase URL
Sandboxhttps://gateway.sandbox.rynopay.io/api
Productionhttps://prod.rynopay.io/api

A full route is the base URL plus the endpoint path, for example https://gateway.sandbox.rynopay.io/api/partner/v1/business-profiles.

Authentication​

Send an access token from the token endpoint on every request.

Authorization: Bearer <access_token>

GET routes need the partner.read scope. POST and PATCH routes need partner.write. See Scopes.

Resources​

Responses​

Every response uses one body, success or failure, except a 500.

{
"value": { },
"isSuccess": true,
"isFailure": false,
"error": { "code": "", "name": "" },
"title": null,
"traceId": "0HN..."
}

Read value when isSuccess is true. On success error is empty and title is null.

Errors​

A failure has the same body, with value set to null and the HTTP status set by the error. Branch on error.code. The error.name and title text can change.

{
"value": null,
"isSuccess": false,
"isFailure": true,
"error": {
"code": "Customer.NotFound",
"name": "Partner customer with ID '3fa85f64-5717-4562-b3fc-2c963f66afa6' not found"
},
"title": "Resource not found",
"traceId": "0HN..."
}

Include traceId when you contact support.

A field that fails validation returns 400 with code ValidationControl.Error. Every field message is joined into error.name. A body that is not valid JSON, a value of the wrong type, or a code the API does not know returns 400 with code Request.Invalid. Its error.name names the field and what it accepts, for example industry: must be one of: Retail, FinancialServices, … or registrationDate: must be a date in the format yyyy-MM-dd.

A 500 is an RFC 7807 problem response instead:

{
"type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
"title": "An unexpected error occurred",
"status": 500,
"detail": "An unexpected error occurred. Please reference error ID: 3e1b... for follow-up.",
"code": "InternalServerError",
"traceId": "0HN..."
}

Common errors​

These can come from any endpoint. Each endpoint page lists its own errors.

CodeHTTPMeaning
Auth.Unauthorized401The token is missing, invalid or expired. Request a new one.
Auth.Forbidden403The token is not a partner credential, or lacks the scope this route needs.
429Rate limit exceeded. See Rate limits.
Partner.NotAuthenticated401The token has no partner identity. Contact support.
Partner.NotFound404Your partner account no longer exists. Contact support.
Partner.NotApproved409Your partner account is not approved to onboard customers yet.
Partner.NotAuthorized403The customerId is a business that is not one of yours. Do not retry.
Customer.NotFound404No customer has this id.
Customer.NotBusiness400The id is a customer that is not a business.
ValidationControl.Error400A request field is invalid. Fix it using error.name.
Request.Invalid400The body is not valid JSON, a value has the wrong type, or a code is unknown. error.name names the field and what it accepts.

Gateway errors for 401, 429 and 503 use a different body. See Errors.