🪄 API Reference

💳 Payment processing and transactions

Check API Connection Status

get

Verifies that the connection to the One-CP API is established and returns the provider information. This endpoint is used for health checks and connection validation.

Responses

201

Connection established successfully.

application/json

401

Invalid authentication credentials provided.

403

Access denied - insufficient permissions.

get

HTTPcURLJavaScriptPython

GET /status HTTP/1.1
Host: api.1-cp.com
Accept: */*

{
  "status": "ready",
  "provider": "667999d063824b596cf82155"
}

Initialize Corporate Checkout Transaction

post

Creates a new transaction for corporate checkout processing. This endpoint accepts a complete checkout request with items, pricing, and metadata to generate a transaction ready for payment processing.

Body

currencystringRequired

Currency of the CorporateCheckout

Example: EUR

titlestringRequired

Title of the CorporateCheckout

Example: Off site event

notestringOptional

Additional notes about the CorporateCheckout. (Internal note only - not visible to the customer)

Example: Internal note

Responses

201

Transaction created successfully with unique identifier

application/json

400

Invalid request data - validation errors in the request body

application/json

401

Authentication failed - invalid credentials

403

Access denied - insufficient permissions

post

HTTPcURLJavaScriptPython

POST /initialize HTTP/1.1
Host: api.1-cp.com
Content-Type: application/json
Accept: */*
Content-Length: 577

{
  "currency": "EUR",
  "items": [
    {
      "category": "text",
      "period": {
        "start": "2024-04-16T12:07:05.159Z",
        "end": "2024-04-16T15:07:05.159Z"
      },
      "departure": "FRA",
      "destination": "MUC",
      "airline": "LH",
      "serviceClass": "ECONOMY_CLASS",
      "flightNumber": "LH441",
      "fareClass": "Y"
    }
  ],
  "refIDs": {
    "google-id": "667999d063824b596cf82155sdfwew334435"
  },
  "title": "Off site event",
  "attachments": [
    {
      "url": "http://file_url.pdf",
      "type": "INVOICE"
    }
  ],
  "note": "Internal note",
  "email": {
    "subject": "Your booking confirmation",
    "content": "Thank you for your booking. Please find your details below.",
    "recipients": [
      "[email protected]"
    ]
  }
}

{
  "transactionId": "667999d063824b596cf82155"
}

Cancel Transaction and Process Refund

patch

Cancels items in an existing contract and processes refunds based on cancellation policies.

Features:

• Partial or full cancellation support

• Automatic refund calculation based on cancellation policies

• Optional invoice file upload for documentation

• Real-time refund processing

Cancellation Process:

1. Validate contract status and permissions

2. Calculate refundable amount based on cancellation policy

3. Process refund transaction

4. Update contract status

5. Generate cancellation receipt

Body

all ofOptional

Responses

200

Cancellation processed successfully

application/json

400

Invalid request data or contract status does not allow cancellation

application/json

401

Authentication failed - invalid credentials

403

Access denied - insufficient permissions

404

Contract not found with the provided ID

500

Internal server error or refund processing failure

patch

HTTPcURLJavaScriptPython

PATCH /cancel HTTP/1.1
Host: api.1-cp.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 159

{
  "contractId": "667999d063824b596cf82155",
  "itemsOrder": [
    0,
    1
  ],
  "amount": 1000,
  "invoiceTitle": "Cancellation Invoice",
  "invoiceNumber": "INV-2024-001",
  "file": "binary"
}

{
  "status": "SUCCESS",
  "errorMessage": "error.message"
}