API Reference

Create Opco

post
https://api-sandbox.urbanpayx.com/api/v1/opcos/create

Create an operating company

Creates a new operating company (Sub-TPP) in DRAFT status. The record is saved locally and not yet submitted to the payment network. Use POST /opcos/{opco_id}/submit to register it when ready.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Type of the Opco

Allowed:
string
required

Name of the Opco

string
required

Domain of the Opco

string
required
length between 2 and 5

Country code where merchant operates (e.g. DE, GB)

string
required

Full Legal Entity name

string
required

Company Registration Number

string
enum
Defaults to PIS: Funding an account

Merchant primary use case. Possible values: AIS: Accounting package integration, AIS: Cash flow management, AIS: Credit risk analysis, AIS: Customer onboarding / verification, AIS: Personal finance management, PIS: eCommerce merchant payment, PIS: Funding an account, PIS: In store merchant payment, PIS: Paying a bill, PIS: Paying off debt

string
required

IBAN of the bank where payments are settled

BIC of the bank where payments are settled

Merchant Category Code Sub-Type

Base64 encoded logo image

string
required

Merchant Category Code (must be a valid 4-digit MCC code)

Parent Sub-TPP ID for hierarchy

PersonInfo | null

Sole Trader info, required for sole trader

array | null

Ultimate Beneficial Owners

array | null

Directors

array | null

Signatories

Responses

Updated 28 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago