OPE External API

Base Path and Authentication

All routes under /api/v1/ope/** are protected by HTTP Basic auth (stateless). Encode clientId:clientSecret in the Authorization: Basic header. The server uses the Basic username as the company id for authorization.

CopyAuthorization: Basic BASE64(your-client-id:your-client-secret)

Errors and response shapes

The primary error body for business failures is a simple map:

Copy{ "error": "message_string" }

HTTP status and typical error values

Some cases (malformed JSON, invalid endpoint path, etc) return more details instead. The return object contains:

POST /api/v1/ope/getModal

Creates a session and returns the modal URL for your company.

Request Body

Example Request Body

Copy{
  "amount": 100.00,
  "planId": 1,
  "invoiceNumber": "INV-1001",
  "onlyShowApplication": false,
  "callbackUrl": "https://example.com/webhook/ope"
}

Response Cases

Copy{
  "sessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "url": "https://modal.transend.com/1"
}

Copy{
  "error": "invalid amount"
}

Copy{
  "error": "invalid credit plan"
}

Copy{
  "error": "unauthorized"
}

Copy{
  "error": "unexpected server error"
}

GET /api/v1/ope/requests/supplier

Lists sessions for the authenticated supplier. Sessions with onlyShowApplication == true are omitted.

Response Body (List of)

Response Cases

Copy[
  {
    "txRequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "amount": 100.00,
    "status": "PENDING",
    "invoiceNumber": "INV-1001",
    "createdAt": "2025-10-28T15:30:59.776538300",
    "expiresAt": "2025-10-28T16:30:59.776538300"
  }
]

Copy{
  "error": "unauthorized"
}

Copy{
  "error": "unexpected server error"
}

POST /api/v1/ope/status

Session status by id. If a session is accepted, the created accepted transaction id is returned.

Request Body

Response Body

Example Request Body

Copy{
  "sessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Response cases

Copy{
  "sessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "PENDING",
  "acceptedTxid": null
}

Copy{
  "sessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "ACCEPTED",
  "acceptedTxid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Copy{
  "sessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "CLOSED",
  "acceptedTxid": null
}

Copy{
  "error": "invalid session id"
}

Copy{
  "error": "unauthorized"
}

Copy{
  "error": "unexpected server error"
}

GET /api/v1/ope/preauths/supplier

Lists accepted transactions (authorizations) for the supplier.

Response Body (List of)

Response Cases

Copy[
  {
    "id": "auth-guid-here",
    "txRequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "capturedAmount": 20.00,
    "voidedAmount": 0.00,
    "totalAmount": 100.00,
    "createdAt": "2025-10-28T15:10:03.748819500",
    "lastUpdatedAt": "2025-10-28T15:10:03.748819500"
  }
]

Copy{
  "error": "unauthorized"
}

Copy{
  "error": "unexpected server error"
}

POST /api/v1/ope/capture/{acceptedTransactionId}

Capture part of an accepted transaction and create a new transaction entry. Path parameter acceptedTransactionId is the accepted transaction (authorization) GUID.

Request Body

Response Body

Example Request Body

Copy{
  "amount": 50.00,
  "memo": "Partial shipment"
}

Response Cases

Copy{
  "id": "event-guid",
  "acceptedTxId": "auth-guid-here",
  "txRequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "amount": 50.00,
  "status": "CAPTURED",
  "createdAt": "2025-10-28T15:07:31.054817600Z",
  "lastUpdatedAt": "2025-10-28T15:07:31.054817600Z"
}

Copy{
  "error": "invalid accepted transaction id"
}

Copy{
  "error": "invalid capture amount"
}

Copy{
  "error": "unauthorized"
}

Copy{
  "error": "unexpected server error"
}

POST /api/v1/ope/void/{acceptedTransactionId}

Void part of an accepted transaction. Path parameter acceptedTransactionId is the accepted transaction (authorization) GUID.

Request Body

Response Body

Example Request Body

Copy{
  "amount": 25.00,
  "memo": "Cancel partial hold"
}

Response Cases

Copy{
  "id": "event-guid",
  "acceptedTxId": "auth-guid-here",
  "txRequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "amount": 25.00,
  "status": "VOIDED",
  "createdAt": "2025-10-28T15:31:28.035102500Z",
  "lastUpdatedAt": "2025-10-28T15:31:28.035102500Z"
}

Copy{
  "error": "invalid accepted transaction id"
}

Copy{
  "error": "invalid void amount"
}

Copy{
  "error": "unauthorized"
}

Copy{
  "error": "unexpected server error"
}

POST /api/v1/ope/refund/{transactionId}

Refunds against a capture transaction event. Path transactionId is the GUID for a CAPTURED event.

Request Body

Response Body

Example Request Body

Copy{
  "amount": 10.00,
  "memo": "Return merchandise"
}

Example response (200)

Copy{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "acceptedTxId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "txRequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "amount": 10.00,
  "status": "REFUNDED",
  "createdAt": "2025-10-28T15:40:00.000000000Z",
  "lastUpdatedAt": "2025-10-28T15:40:00.000000000Z"
}

Response Cases

Copy{
  "id": "refund-event-guid",
  "acceptedTxId": "auth-guid-here",
  "txRequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "amount": 10.00,
  "status": "REFUNDED",
  "createdAt": "2025-10-28T15:40:00.000000000Z",
  "lastUpdatedAt": "2025-10-28T15:40:00.000000000Z"
}

Copy{
  "error": "invalid transaction id"
}

Copy{
  "error": "invalid refund amount"
}

Copy{
  "error": "unauthorized"
}

Copy{
  "error": "unexpected server error"
}

GET /api/v1/ope/transactions/supplier

Lists capture-backed transactions for reporting.

Response Body (List of)

Example response (200)

Copy[
  {
    "transactionId": "capture-event-guid",
    "amount": 1500.00,
    "lastUpdateDate": "2025-10-28T12:00:00",
    "status": "0",
    "loanNumber": "LN-1000",
    "currentBalance": 1000.00
  }
]

Response cases

Copy[
  {
    "transactionId": "capture-event-guid",
    "amount": 1500.00,
    "lastUpdateDate": "2025-10-28T12:00:00",
    "status": "0",
    "loanNumber": "LN-1000",
    "currentBalance": 1000.00
  }
]

Copy{
  "error": "unauthorized"
}

Copy{
  "error": "unexpected server error"
}