Update references

PATCH /v3/session/:sessionId/order/update/references

Update order references of a completed session.

Path Parameters

• sessionId string required

  Format: UUID

  Example: c5674f4f-7e84-405c-a44b-c83736bb7209

Header Parameters

• Content-Type string

  Possible values: [application/json]

• Accept string

  Possible values: [application/json]

• Authorization string

  Format: "Basic <base64(username:secret)>"

application/json

Request Body

• references object required

  Your own references, we recommend using property name "reference1" as your order reference for payments since this property is default for multiple payment providers. But any additional property name can be used e.g. customerId. Example: { "reference1": "000", "customerId": "12345" }

  property name* string

  Possible values: <= 512 characters

Responses

• 204
• 400
• 403

---

application/json

Schema

Schema

• error object

  code string

  Possible values: [INVALID_CREDENTIALS, INVALID_DATA, ORDER_NOT_COMPLETED, ORDER_REJECTED, ORDER_PENDING, ORDER_CANCELLED, UPDATE_NOT_ALLOWED, UPDATE_NOT_SUPPORTED, UNKNOWN]

  message string

Example (from schema)

{
  "error": {
    "code": "INVALID_CREDENTIALS",
    "message": "string"
  }
}

application/json

Schema

Schema

• error object

  code string

  Possible values: [INVALID_CREDENTIALS, INVALID_API_KEY, AUTH_SECRET_EXPIRED]

  message string

Example (from schema)

{
  "error": {
    "code": "INVALID_CREDENTIALS",
    "message": "string"
  }
}

Loading...