PAY-502 - Precheck Purchasing Card Level 3 readiness

get

https://example.com/v1/shop/payments/precheck

Verifies whether Level 3 (Purchasing Card) data is complete for the given reference and context. Returns a ready flag and, when not ready, a structured list of missing fields.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

reference

string

required

The reference of the order given the reference type. Example: "174-107-9164387". Order Djust IDs or external IDs are not allowed.

referenceType

string

Defaults to COMMERCIAL

The reference type of the order. Possible values: ["COMMERCIAL", "LOGISTIC"].

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

API key required for authentication. Must be valid and linked to the requesting user.

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

(Optional) Store view ID in multi-store environments.

customer-account-id

string

(Optional) Customer account ID in multi-account customer user.

Responses

400

Bad request (malformed query)

401

Unauthorized (invalid or missing API key)

403

Forbidden (insufficient permissions)

404

Not found (unknown reference

500

Internal server error

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Precheck result