API Method: POST /api/paymentCards/design
/api/paymentCards/design
**Description:**This endpoint generates and returns preview card designs based on the provided financial account and card type. It allows users (typically administrators or issuers) to visually preview how a payment card will appear before issuing it to a user or sub-user.
The design preview includes front and back images in different sizes and formats, depending on the card profile and issuing partner. This is helpful for customizing card branding, verifying layout aesthetics, or confirming design configurations before physical or virtual issuance.
Request:
-
Method: POST
-
Endpoint:
https://api.banking.netevia.dev/api/paymentCards/design
-
Headers:
Authorization
: Bearer<access_token>
(required)Content-Type
:application/json
Body Parameters:
{
"financialAccountId": "string",
"cardType": 0
}
Field | Type | Required | Description |
---|---|---|---|
financialAccountId | string | Yes | The ID of the financial account the card will be linked to (must not be empty). |
cardType | int32 | No | Optional integer representing the type of card (e.g., physical, virtual). |
Response:
- Status Code: 200 OK
- Content Type:
application/json
Error Responses:
- 400 Bad Request – Missing or invalid
financialAccountId
- 401 Unauthorized – Missing or invalid access token
- 403 Forbidden – User does not have permission to access card designs
- 404 Not Found – No available design templates for given account/card type
- 500 Internal Server Error – Unexpected server error while generating preview
**Use Case Example:**A card issuer wants to preview the front and back design of a virtual debit card linked to a specific financial account before issuing it to a sub-user. They call this endpoint with the appropriate financialAccountId
and cardType
.