ORDER-104 - Create credit card registration

post

https://example.com/v1/shop/commercial-orders/{commercialOrderId}/card-registration

Initiates a credit card registration process for the specified commercial order.

⚠️ This route is only available for use with the MangoPay payment provider.

Use Case: This API is specifically intended for front-end integrations using the MangoPay Checkout SDK.

It returns the necessary registration data (such as a card registration URL and credentials) to initiate the payment flow using MangoPay's embedded component.

Permissions: Requires a valid API key and client type.

Multistore Support: Optional store context headers allow filtering by store and storeview.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

commercialOrderId

string

required

Unique identifier of the commercial order for which the card registration should be initiated.

Query Params

paymentProvider

string

enum

required

Payment provider to be used for the card registration process.

Only MANGOPAY is supported for this operation.

Allowed:

currency

string

enum

required

Currency code to be used for the card registration.

Valid values include:

AED, AUD, CAD, CHF, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK.

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.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

201Credit card registration created