Order, activate and get a card pin
To create card application use this api: ConnectPay APIs
Required parameters:
Parameter |
Value |
Description |
Condition |
Constrains |
---|---|---|---|---|
|
string |
Card will be linked to this IBAN |
mandatory |
LT and 18 numbers |
|
string |
Cardholder first name embossed on the card |
mandatory |
Min length 3 Max 13 Allowed characters:
|
|
string |
Cardholder last name embossed on the card |
mandatory |
Min length 3 Max 13 Allowed character: same as for first_name |
|
string |
Company name embossed on the card |
conditional |
Mandatory when using business card Min length 3 Max 13 Allowed characters:
|
|
|
|
|
|
|
string |
|
conditional |
Mandatory for card for product type <= 45 characters |
|
string |
|
optional |
<= 45 characters |
|
string |
|
conditional |
Mandatory for card for product type <= 10 characters |
|
string |
|
conditional |
Mandatory for card for product type <= 35 characters |
|
string |
Country code in ISO 3166-1 Alpha-3 code standard. |
conditional |
Mandatory for card for product type Card can be delivered to: |
|
string |
Card dispatch method |
conditional |
Mandatory for card for product type Valid values: “Regular” , “Express” |
|
string |
|
conditional |
Mandatory for card for product type Format: |
|
enum |
Card type. Physical plastic card or virtual card |
mandatory |
Possible values: |
|
enum |
Card product. Depends on the product which is used by customer. Value is generated by ConnectPay and shared individually based on customers product range |
mandatory |
|
Request body:
Sample Request Body for cardProduct ConnectPayBusiness Card and cardType ChipAndPin:
{
"bankAccount": {
"iban": "LT523740010000007273"
},
"embossing": {
"firstName": "Jessica",
"lastName": "Atreides",
"companyName":"Dune Corp"
},
"deliveryAddress": {
"addressLine1": "Brickell St 50-100",
"addressLine2": null,
"postcode": "01580",
"city": "Vilnius",
"countryCode": "LT",
"deliveryDispatchMethod": "Regular",
"phoneNo": "37066888777"
},
"cardType": "ChipAndPin",
"cardProduct": "ConnectPayBusiness"
}
Sample Request Body for cardProduct ConnectPayBusiness Card and cardType Virtual:
{
"bankAccount": {
"iban": "LT523740010000007273"
},
"embossing": {
"firstName": "Jessica",
"lastName": "Atreides",
"companyName":"Dune Corp"
},
"cardType": "Virtual",
"cardProduct": "ConnectPayBusiness"
}
Sample Request Body for cardProduct ConnectPayDebit Card and cardType ChipAndPin:
{
"bankAccount": {
"iban": "LT523740010000007273"
},
"embossing": {
"firstName": "Jessica",
"lastName": "Atreides"
},
"deliveryAddress": {
"addressLine1": "Brickell St 50-100",
"addressLine2": null,
"postcode": "01580",
"city": "Vilnius",
"countryCode": "LT",
"deliveryDispatchMethod": "Regular",
"phoneNo": "37066888777"
},
"cardType": "ChipAndPin",
"cardProduct": "ConnectPayDebit"
}
Sample Request Body for cardProduct ConnectPayDebit Card and cardType Virtual:
{
"bankAccount": {
"iban": "LT523740010000007273"
},
"embossing": {
"firstName": "Jessica",
"lastName": "Atreides"
},
"cardType": "Virtual",
"cardProduct": "ConnectPayDebit"
}
Response body:
In a response body you will get "application_id"
and "card_id"
After card application is approved/declined you will get a notification with "application_id"
"card_id"
should be used to get more card details when card application is approved
{
"application_id": "A2110",
"card_id": "01a75221-4e5c-4ab8-a1a6-4abe0c8d8c17"
}
Card activate
After card is received by cardholder it can be activated. Only "cardType": "ChipAndPin"
can be activated. "cardType": "Virtual"
are active by default.
To activate a card use path baas/ob/cards/{{BaasClientCardId}}/activate
Card “id” is required to activate the card
Request:
curl --location -g --request POST 'https://{{cp_host}}/baas/ob/cards/edbff40e-738f-443b-a260-ee0bb39cff9e/activate' \ --header 'Content-Type: application/json'
Response:
{
"status": "activated"
}
Get PIN
Card PIN can be retrieved by using this api: ConnectPay APIs
Card “id” is required to get card PIN. PIN should be decrypted in your system frontend .
Request:
curl --location -g --request POST 'https://api-stage.connectpay.com/baas/ob/cards/{{cardId}}/encryptedpin' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json;version=1' \ --data-raw '{"publicKey":"LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0NCk1JSUJJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBUThBTUlJQkNnS0NBUUVBMUxXSVFGNXFHcnhJa3VCbkx0Q1ENCnNWMXd5c3BjZlB3VEZYMDJaQjU5bTUydEJIdFZndXdpbEh5VVh5TkRsanBSWHpMOElUaFlKQUl6TTB4UEhaMUYNCm5qQ2JOSzFQWjdhUmJxVDFsZ2J5ZjVoMXM5SnRQWmxDUWQ2RGtEL2hHR0QxZ1BHckY4cWJZY1JxU253dXY3bjgNCjZZRnVkL1RTVUpST2hVbWU2UExZUUQvN2lwb3FHM3FLUTN3MFhkY3g1dW9LNjBUcWRJVmpZeVBTZzFsSGQzcTMNCjE0YjU4ajlUME44QVdOLzZYKy9UWkt0UTIzRm1mN3VySUVleTljRVVqT0htdE8vQVFTaTRQdWZLdTEyaUxTWnQNCmkzb1IwRnVJU1lsUDhnNmhGZU1YWVdBWEJTakROUjNRN3pmaDAvalpaZnVyZDNuVkkyN2tyV1dQNCtOb2h1Um0NCjN3SURBUUFCDQotLS0tLUVORCBQVUJMSUMgS0VZLS0tLS0NCg=="}'
Response:
{
"encryptedPin": "X/w2lXS1RsiwWy90cf7XuELEgarpdYUR0afIpALeG/oVSGFoupm7D1pwKnjPhdQH0hgvsmygI
RYdiaRgEmsfzUVF8UJMQZjyoKOup3nn72e+vrkeVKfi3gKRygs55BStpOksC08XyO0qEvjmdDNpERn+ZboaDu1HVk5HQsAp+pIWIpRscDiDY8VCL+0HmETyQ1
cOW6bunCQOdkmVPFxpmbIQE6QaP1WJr4VBnCMR4OjG22h9he013VpQdJ+Mhbw6vG/XHfsLizQ6xrWt8NsulIMOUsQm+KJLbIbXZdWEJM2GOFbXV4mXZxNpedh
s4Shl++AIzivkU4VbVWVYYub+XQ=="
}
Get Card Details:
To get card details use this api: ConnectPay APIs.
Card “id” is required to get card details.
Request:
curl --location -g --request GET 'https://api-stage.connectpay.com/baas/ob/cards/{{cardId}}' \ --header 'Content-Type: {{contentType}}' \ --header 'Accept: {{accept}}'
Response:
{
"maskedPan": "474367******2535",
"expiresAt": "2026-03-31",
"status": "Active",
"deliveryDispatchMethod": "Regular",
"createdAt": "2023-03-01T19:44:44.000Z",
"limits": {
"contactlessPayments": {
"isEnabled": false,
"limits": {
"daily": 10000.0,
"weekly": 50000.0,
"monthly": 50000.0,
"transaction": 10000.0
},
"availableAmount": {
"daily": 10000.0,
"weekly": 50000.0,
"monthly": 50000.0
},
"usedAmount": {
"daily": 0.0,
"weekly": 0.0,
"monthly": 0.0
}
},
"internetPurchases": {
"isEnabled": true,
"limits": {
"daily": 10000.0,
"weekly": 50000.0,
"monthly": 50000.0,
"transaction": 10000.0
},
"availableAmount": {
"daily": 10000.0,
"weekly": 50000.0,
"monthly": 50000.0
},
"usedAmount": {
"daily": 0.0,
"weekly": 0.0,
"monthly": 0.0
}
},
"withdrawals": {
"isEnabled": true,
"limits": {
"daily": 1000.0,
"weekly": 5000.0,
"monthly": 5000.0,
"transaction": 1000.0
},
"availableAmount": {
"daily": 1000.0,
"weekly": 5000.0,
"monthly": 5000.0
},
"usedAmount": {
"daily": 0.0,
"weekly": 0.0,
"monthly": 0.0
}
},
"overallLimits": {
"isEnabled": true,
"limits": {
"daily": 10000.0,
"weekly": 50000.0,
"monthly": 50000.0
},
"availableAmount": {
"daily": 10000.0,
"weekly": 50000.0,
"monthly": 50000.0
},
"usedAmount": {
"daily": 0.0,
"weekly": 0.0,
"monthly": 0.0
}
}
},
"deliveryAddress": {
"firstName": "Jessica",
"lastName": "Atreides",
"city": "Vilnius",
"addressLine1": "Brickell St 11",
"addressLine2": null,
"postcode": "55555",
"countryCode": "LT",
"phoneNo": "918374493854"
},
"3dsSettings": {
"phoneNo": "918374493854"
},
"embossing": {
"fullName": "Jessica A"
},
"blockType": null