Card Order Only for White Label¶

Learn how to manage card orders requests¶

Card order is the two-step process required to issue a new private or business card and retrieve newly generated card data.

Card Order workflow¶

Card Order ¶

To request for a physical or virtual card, you should submit a DAPI endpoint POST /v1/api/cards/order. If the request is successfully submitted, you will receive orderId in the response, which should be used in Order Status endpoint to retrieve card details once the card order request is completed.

Card order scenarios with required parameters and applicable validations:

Private Cards¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

{
  "privateClient": {
    "name": "{{ name }}",
    "surname": "{{ surname }}",
    "mobilePhone": "{{ mobilePhone }}"
  },
  "card": {
    "productCode": "{{ productCode }}",
    "currencies": [
      "EUR"
    ],
    "deliveryAddress": {
      "country": "{{ country }}",
      "city": "{{ city }}",
      "street": "{{ street }}"
    },
    "supplementary": "false"
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "privateClient": {
    "id": "{{ id }}"
  },
  "card": {
    "productCode": "{{ productCode }}",
    "currencies": [
      "EUR"
    ],
    "deliveryAddress": {
      "country": "{{ country }}",
      "city": "{{ city }}",
      "street": "{{ street }}"
    },
    "supplementary": "false"
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "privateClient": {
    "id": "{{ id }}"
  },
  "card": {
    "productCode": "{{ productCode }}",
    "cardAccount": "{{ cardAccount }}",
    "currencies": [
      "EUR"
    ],
    "supplementary": "false"
  }
}

Business Cards¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "businessClient": {
    "registrationNumber": "{{ registrationNumber }}"
  },
  "card": {
    "productCode": "{{ productCode }}",
    "currencies": [
      "EUR"
    ],
    "holder": {
      "name": "{{ name }}",
      "surname": "{{ surname }}",
      "mobilePhone": "{{ mobilePhone }}"
    },
    "deliveryAddress": {
      "country": "{{ country }}",
      "city": "{{ city }}",
      "street": "{{ street }}"
    },
    "supplementary": "false"
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "businessClient": {
    "registrationNumber": "{{ registrationNumber }}"
  },
  "card": {
    "productCode": "{{ productCode }}",
    "currencies": [
      "EUR"
    ],
    "holder": {
      "name": "{{ name }}",
      "surname": "{{ surname }}",
      "mobilePhone": "{{ mobilePhone }}"
    },
    "deliveryAddress": {
      "country": "{{ country }}",
      "city": "{{ city }}",
      "street": "{{ street }}"
    },
    "supplementary": "false"
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

{
  "businessClient": {
    "registrationNumber": "{{ registrationNumber }}"
  },
  "card": {
    "productCode": "{{ productCode }}",
    "currencies": [
      "EUR"
    ],
    "holder": {
      "id": "{{ id }}"
    },
    "deliveryAddress": {
      "country": "{{ country }}",
      "city": "{{ city }}",
      "street": "{{ street }}"
    },
    "supplementary": "false"
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "businessClient": {
    "registrationNumber": "{{ registrationNumber }}"
  },
  "card": {
    "productCode": "{{ productCode }}",
    "cardAccount": "{{ cardAccount }}",
    "currencies": [
      "EUR"
    ],
    "holder": {
      "id": "{{ id }}"
    },
    "supplementary": "false"
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "businessClient": {
    "registrationNumber": "{{ registrationNumber }}"
  },
  "card": {
    "productCode": "{{ productCode }}",
    "cardAccount": "{{ cardAccount }}",
    "currencies": [
      "EUR"
    ],
    "holder": {
      "name": "{{ name }}",
      "surname": "{{ surname }}",
      "mobilePhone": "{{ mobilePhone }}"
    },
    "supplementary": "true"
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "businessClient": {
    "registrationNumber": "{{ registrationNumber }}"
  },
  "card": {
    "productCode": "{{ productCode }}",
    "cardAccount": "{{ cardAccount }}",
    "currencies": [
      "EUR"
    ],
    "holder": {
      "id": "{{ id }}"
    },
    "supplementary": "true"
  }
}

Card Order Status ¶

Once you have created a new card order, you will be able to follow up on the order status via GET /v1/api/orders. This request returns a list of your card orders. The card orders are sorted in descending order by created date - the most recently created object appearing first. To receive a list of orders starting with a particular order, provide either its id or external id number.

Order status values

Here is the list of orders status values and their description:

• Registered – a card order is registered in the system and awaiting the launch of the manual card issue process
• Processing – a card order is registered and is awaiting for manual processing
• Duplicated found – a card order is registered but duplicate orders have been identified
• External check failed – an external person validity check has failed
• Completed – a card order is registered and completed
• Rejected – a card order is registered but issuing has failed

Order gift cards Deprecated¶

If you want to order cards with identical parameters in bulk, you can use the POST /v1/api/cards/order-gift-card endpoint. This request allows users to order up to 10,000 cards in a single request. Cards will be created using Base Private Card with New Client and New Agreement scenario. To avoid additional overload, please use this endpoint in conjunction with a webhook and refrain from using looped order status checks since the completion of ordered cards in bulk can take some time. This endpoint requires additional access rights.

How to set up?¶

1. Contact your DECTA manager about access to this endpoint.
2. Create a web service to get webhook data and send the endpoint data to your DECTA manager.
3. Start using the gift card order endpoint once DECTA has notified you about it.

How to use?¶

1. Send request to POST /v1/api/cards/order-gift-card.
2. Get response with OrderId value.
3. Wait for webhook with end result.
4. Use GET /v1/api/orders to get card data.

Webhook callback overview¶

The webhook notifies the Customer about completion of the gift card order processing to refrain the Customer from using looped order status checks via API. The Customer should create an endpoint on their side that can process incoming requests and send a 200 HTTP code in response. The web service should be ready to receive HTTP POST calls with a payload in JSON format. If the web service uses basic authentication, the credentials should be provided to DECTA for configuration. Each call represents a separate event message received. If the Customer’s designated URL is not available or DECTA receives an HTTP error, then DECTA will continue to resend the webhook every 20 seconds for 24 hours.

Payload example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "endpoint":"GIFT_CARD_ORDER",
  "requestId": "11a11b1c-1d11-11ef-1g11-h1fi1jk11l11",
  "data":[
    {
      "orderId": "f85e63a7-a858-4fa7-afaf-dc7e5f29g9e8",
      "externalId": "GIFT_ORDER-9999999"
    }
  ]
}