Commencer

Environnement de test

Utilisez l'environnement de test pour essayer l'API. Vous pouvez télécharger la collection de requêtes API Postman pour tester certaines fonctionnalités de base de gestion des cartes dans le package SmartVista.

Télécharger la collection Postman

Commencez à travailler avec Sandbox

Suivez le lien et cliquez sur "Se connecter" pour créer un compte dans Sandbox :
/cabinet/
Vous obtiendrez l'accès à toutes les API et au Cabinet Personnel.

Caractéristiques générales

Toutes les méthodes fonctionnent via HTTP POST.

Content-Type: application/json tant pour les requêtes que pour les réponses.

Authentification

L'authentification de base d'accès est une méthode par laquelle un utilisateur HTTP peut fournir un nom d'utilisateur et un mot de passe lors de l'envoi d'une requête. Avec l'authentification HTTP de base, la requête contient un champ d'en-tête sous la forme Authorization: Basic <credentials>, où les identifiants sont une représentation en Base64 de la combinaison de l'identifiant et du mot de passe, reliés par deux-points :.

Clients

registerCustomer

Enregistre un nouveau client dans SmartVista et crée un compte. Vous pouvez créer autant de clients que vous le souhaitez. Mais dans l'environnement de test, vous ne pouvez créer qu'un seul compte pour chaque client — cette limitation a été ajoutée pour simplifier la logique de l'environnement de test. Dans un projet réel, vous pourrez créer autant de comptes pour chaque client que nécessaire pour votre entreprise.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`productName`	String	Identifiant du modèle de client qui sera utilisé pour créer le client. Dans l'environnement de test, il n'y a qu'un seul modèle de client, et pour les clients de l'environnement de test, cette valeur doit toujours être « CRCU1001 ».
Obligatoire	`parameters`	Object	Liste des paramètres. La liste exacte dépend du modèle de création de client pour le projet spécifique. Nous l'avons créé pour l'environnement de test, et vous pouvez voir les paramètres nécessaires sous ce tableau.
Obligatoire	parameters.`name`	String	Définir le paramètre dans le modèle de client pour lequel la valeur correspondante est définie.
Obligatoire	parameters.`value`	String	Valeur qui doit être définie pour le paramètre spécifique.

Pour créer un client dans l'environnement de test, il est nécessaire de transmettre les paramètres suivants avec leurs valeurs :

institutionId Valeur que vous avez reçue par email après l'inscription.
agent_number Identique à institutionId.
customer_number Any text. Doit être unique dans votre projet d'environnement de test.
product_id Valeur que vous avez reçue par email après l'inscription.
start_date Any date in the past. Format AAAA-MM-JJ.
service_id_acc Valeur que vous avez reçue par email après l'inscription.
surname firstName secondName email mobile_phone region city street house apartment8 postal_code paramètres du client N'importe quel texte.
country_code Code numérique de pays ISO 3166-1.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/registerCustomer \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "productName": "CRCU1001",
  "parameters":  [
      {
        "name": "institutionId",
        "value": "3006"
      },
      {
        "name": "agent_number",
        "value": "3006"
      },
      {
        "name": "customer_number",
        "value": "3006P_0000003"
      },
      {
        "name": "product_id",
        "value": "70000304"
      },
      {
        "name": "start_date",
        "value": "2021-09-06"
      },
      {
        "name": "service_id_acc",
        "value": "70000305"
      },
      {
        "name": "surname",
        "value": "Smith"
      },
      {
        "name": "firstName",
        "value": "John"
      },
      {
        "name": "secondName",
        "value": "A."
      },
      {
        "name": "email",
        "value": "johnsmith@email.com"
      },
      {
        "name": "mobile_phone",
        "value": "319220977338"
      },
      {
        "name": "country_code",
        "value": "528"
      },
      {
        "name": "region",
        "value": "BJ"
      },
      {
        "name": "city",
        "value": "Utrecht"
      },
      {
        "name": "street",
        "value": "Papendorpseweg"
      },
      {
        "name": "house",
        "value": "99"
      },
      {
        "name": "apartament",
        "value": "1"
      },
      {
        "name": "postal_code",
        "value": "3528"
      }
    ]  
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`customerNumber`	String	Numéro du client. Vous recevrez celui que vous envoyez dans la requête car l'environnement de test est configuré pour définir le numéro demandé pour le client créé.
Obligatoire	`accountNumber`	String	Numéro de compte. L'environnement de test retourne le numéro de compte qu'il crée pour le Client.

Exemple de réponse

{
      "customerNumber": "3006P_0000003",
      "accountNumber": "3006978700000000108"
    }

getCustomerInfo

Obtenir les informations sur le client.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Facultatif	`accountNumber`	String	Numéro de compte.
Obligatoire	`customerNumber`	String	Numéro du client.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getCustomerInfo \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "customerNumber" : "3210_P004"
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`customerNumber`	String	Numéro du client.
Obligatoire	`customerName`	String	Nom du client.
Facultatif	`limits`	Object	Liste des limites.
Obligatoire	limits.`limitName`	String	Dénomination de la limite.
Obligatoire	limits.`limitType`	String	Dénomination de la limite.
Facultatif	limits.`value`	Long	Valeur de la limite.
Facultatif	limits.`currentValue`	Long	Valeur actuelle.
Facultatif	`accounts`	Object	Liste des comptes.
Obligatoire	accounts.`accountNumber`	String	Numéro de compte.
Obligatoire	accounts.`accountType`	String	Type de compte.
Obligatoire	accounts.`product`	Object	Paramètres du produit.
Obligatoire	product.`productNumber`	String	Numéro du produit.
Obligatoire	product.`productName`	String	Dénomination du produit.
Facultatif	accounts.`balances`	Object	Liste des soldes des comptes.
Obligatoire	balances.`type`	String	Type de solde.
Obligatoire	balances.`value`	Long	Valeur du solde.

Exemple de réponse

{
    "customerNumber": "3210_P004",
    "customerName": "Smith John A.",
    "limits": [
        {
            "limitName": "Customer-level credit limit",
            "limitType": "LMTP0901",
            "value": 0,
            "currentValue": 0
        },
        {
            "limitName": "Customer-level cash advance credit limit",
            "limitType": "LMTP0902",
            "value": 0,
            "currentValue": 0
        }
    ],
    "accounts": [
        {
            "accountNumber": "3210978700000000579",
            "accountType": "ACTP0100",
            "balances": []
        }
    ]
}

isCustomerExist

Vérification de l'existence de l'identifiant du client.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`customerNumber`	String	Numéro du client.
Facultatif	`institutionId`	Integer	Identifiant de l'établissement

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/isCustomerExist \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "customerNumber": 1002,
  "institutionId": 7001
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`result`	Boolean	Identifiant de l'établissement.

Exemple de réponse

{
  "result" : true
}

Comptes

changeAccountLimit

Modifier la limite du compte.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`accountNumber`	String	Numéro de compte.
Obligatoire	`limit`	Object	Paramètres de la limite.
Obligatoire	limit.`name`	String	Nom de la limite dans SVBO.
Facultatif	limit.`startDate`	DateTime	Date de début de la limite. format: date-heure
Facultatif	limit.`endDate`	DateTime	Date de fin de la limite.
Facultatif	limit.`value`	Long	Valeur de la limite
Facultatif	limit.`cycleType`	Integer	Type de cycle
Facultatif	limit.`cycleLength`	Integer	Durée du cycle
Facultatif	limit.`currency`	Integer	Devise
Facultatif	limit.`currentValue`	Long	Valeur actuelle de la limite
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/changeAccountLimit \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber" : 4000010000000003,
  "limit" : {
    "name" : "LMTTC01",
    "startDate" : "2015-02-15",
    "endDate" : "2015-02-20",
    "value" : 10000000,
    "cycleType" : 4,
    "cycleLength" : 1
  }
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de finalisation d'opération dans SmartVista.

Exemple de réponse

{
  "responseCode" : 00
}

getAccountLimits

Obtenir la liste des limites du compte.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`accountNumber`	String	Numéro de compte.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getAccountLimits \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber" : 4000010000000003
}'

Exemple de réponse

{
  "limits": [
    {
      "name": "LMTTC01",
      "value": 10000000,
      "cycleType": 4,
      "cycleLength": 1,
      "currency": 978,
      "currentValue": 0,
      "limitExceptions": [
        {
          "limitName": "LMTTA02",
          "startDate": "2014-12-30",
          "endDate": "2014-12-31",
          "value": 10000,
          "cycleType": 0,
          "cycleLength": 0
        }
      ]
    }

changeAccountStatus

Changer le statut du compte.

Paramètres de la requête

Requis	Nom	Type	Description
Obligatoire	`accountNumber`	string	Numéro de compte.
Obligatoire	`accountStatus`	integer	Statut du compte

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/changeAccountStatus \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber": 2652,
  "accountStatus": 1
}'

Paramètres de la réponse

Requis	Nom	Type	Description
Obligatoire	`responseCode`	string	Code de finalisation de l'opération dans SmartVista.

Exemple de réponse

{
  "responseCode" : 00
}

changeAccountStatusInFe

Modifier le statut du compte.

Paramètres de la demande

Caractère obligatoire	Nom	Type	Description
Obligatoire	`accountNumber`	String	Numéro de compte.
Obligatoire	`accountStatus`	Integer	Statut du compte
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/changeAccountStatusInFe \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber": 3210978700000000579,
  "accountStatus": 1
  }
}'

Paramètres de la réponse

Caractère obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista.

Exemple de réponse

{
    "responseCode": "00",
    "processingCode": "810000",
    "systemTraceAuditNumber": 320257,
    "localTransactionDate": "2024-02-08T15:08:14"
}

getAccountData

Obtenir les données du compte.

Paramètres de la demande

Obligatoire	Nom	Type	Description
Obligatoire	`accountNumber`	String	Numéro de compte.
Facultatif	`returnCardNumber`	Boolean	Indique s'il faut spécifier le numéro complet de la carte dans la réponse.

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`accountData`	Object	Paramètres du compte.
Obligatoire	accountData.`number`	String	Numéro de compte.
Obligatoire	accountData.`currency`	Integer	Devise du compte.
Facultatif	accountData.`currencyAlphaCode`	String	Code alphabétique de la devise du compte.
Obligatoire	accountData.`balance`	Integer	Solde du compte.
Facultatif	accountData.`creditLimit`	Integer	Limite de crédit.
Obligatoire	accountData.`customerId`	String	ID du client.
Facultatif	accountData.`defaultAccount`	Boolean	Indicateur de compte par défaut.
Obligatoire	accountData.`cards`	Object	Liste des cartes pour le compte.
Facultatif	cards.`cardType`	String	Type de carte.
Facultatif	cards.`cardNumber`	String	Numéro de carte.
Facultatif	cards.`expiryDate`	String	Date d'expiration de la carte.
Facultatif	cards.`cardStatus`	String	Statut de la carte.
Facultatif	cards.`accountNumber`	String	Numéro de compte.
Facultatif	cards.`accountStatus`	String	Statut du compte.
Facultatif	cards.`gmfIndicator`	String	Indicateur de compte GMF.
Facultatif	cards.`productNumber`	String	Numéro de produit.
Obligatoire	cards.`productId`	String	Numéro d'identification du produit.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getAccountData \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber" : 3210978700000000579
}'

Exemple de réponse

{
    "accountData": {
        "number": "3210978700000000579",
        "currency": 978,
        "currencyAlphaCode": "EUR",
        "balance": 0,
        "customerId": "3210_P004",
        "cards": [
            {
                "cardNumberMask": "414210******8086",
                "expiryDate": "202512",
                "cardId": "100000003347",
                "hotCardStatus": 0,
                "cardTypeName": "VISA - PLUS",
                "embossedName": "GENERAL POOL",
                "customerId": "3210_P004",
                "personId": "3210P_0000001",
                "pinDenialCounter": 0,
                "plasticNumber": 1,
                "hotCardStatusDescription": "VALID CARD",
                "cardIsPrimary": false,
                "cardBindToCustomer": false,
                "customerIsCardholder": false
            }
        ]
    }
}

setAllowedBeneficiaries

Définir la liste des bénéficiaires autorisés pour la carte ou le compte.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/setAllowedBeneficiaries \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber": "4000010000000003",
  "beneficiaries": [
    "M0001"
  ] 
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista.

Exemple de réponse

{
  "responseCode": "00"
}

getAllowedBeneficiaries

Obtenir la liste des bénéficiaires autorisés par carte ou compte.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getAllowedBeneficiaries \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber" : 4000010000000003
}'

Exemple de réponse

{
  "beneficiaries": [
    M0001
  ]
}

setAllowedMccList

Définition de la liste des MCC autorisés pour la carte ou le compte.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/setAllowedMccList \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber": "4000010000000003",
  "mccList" : [
    1750
  ]
}'

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista.

Exemple de réponse

{
  "responseCode": "00"
}

getAllowedMccList

Obtenir la liste des MCC autorisés pour une carte ou un compte.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getAllowedMccList \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber" : 4000010000000003
}'

Exemple de réponse

{
  "mccList": [
    1750
  ]
}

Marchands

changeMerchantStatus

Modifier le statut du vendeur.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`merchantNumber`	String	Numéro du vendeur.
Obligatoire	`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`agentId`	String	Identifiant de l'agent.
Obligatoire	`customerNumber`	String	Numéro du client.
Obligatoire	`contractNumber`	String	Numéro du contrat.
Obligatoire	`status`	String	Statut du marchand.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/changeMerchantStatus \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "merchantNumber": "M000001",
  "institutionId": "3210",
  "agentId": "32",
  "customerNumber": "3210_P004",
  "contractNumber": "201",
  "status": "Valid Entity"
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de finalisation de l'opération dans SmartVisa.

Exemple de réponse

{
  "responseCode" : "00"
}

getMerchantTransactions

Obtenir la liste des transactions du marchand

Paramètres de la requête

Caractère obligatoire	Nom	Type	Description
Obligatoire	`merchantId`	String	Identifiant du vendeur.
Facultatif	`terminalId`	String	Identifiant du terminal.
Obligatoire	`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`period`	Object	Période de temps.
Facultatif	period.`start`	DateTime	Date de début.
Facultatif	period.`end`	DateTime	Date de fin.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getMerchantTransactions \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "merchantIdn" : "M999101",
  "institutionId": 2,
  "period": {
    "start": "2019-05-01",
    "end": "2019-06-01"
  }
}'

Paramètres de la réponse

Caractère obligatoire	Nom	Type	Description
Obligatoire	`transactions`	Object	Transactions.
Obligatoire	transactions.`utrnno`	Long	Identifiant de la transaction dans SVFE
Facultatif	transactions.`reversal`	Boolean	Indicateur d'annulation.
Obligatoire	transactions.`merchantId`	String	Identifiant du vendeur.
Obligatoire	transactions.`terminalId`	String	Identifiant du terminal.
Obligatoire	transactions.`transactionDate`	DateTime	Date/heure de la transaction.
Facultatif	transactions.`settlementDate`	DateTime	Date/heure du règlement.
Obligatoire	transactions.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	transactions.`cardNumber`	String	Numéro de carte.
Facultatif	transactions.`transactionAmount`	Integer	Montant de la transaction.
Facultatif	transactions.`transactionCurrency`	Integer	Code de devise de la transaction
Facultatif	transactions.`submittedAmount`	Integer	Montant demandé.
Facultatif	transactions.`submittedCurrency`	Integer	Devise demandée
Facultatif	transactions.`responseCode`	Integer	Code de réponse interne SVFE.
Facultatif	transactions.`authorizationCode`	String	Code d'autorisation.
Facultatif	transactions.`cashbackAmount`	Integer	Montant de cashback.
Facultatif	transactions.`transactionType`	String	Type de transaction.
Facultatif	transactions.`networkType`	String	Type de réseau.
Facultatif	transactions.`cardType`	String	Type de carte.
Facultatif	transactions.`orderNumber`	String	Numéro d'ordre de paiement.
Facultatif	transactions.`orderId`	String	Identifiant d'ordre de paiement.

Exemple de réponse

{
        "transactions": {
          "transaction": [
            {
              "utrnno": 7220355,
              "reversal": false,
              "merchantId": "M999101",
              "terminalId": 999101,
              "transactionDate": "2019-05-15T13:08:07+04:00",
              "cardNumber": 4440010000000001,
              "transactionAmount": 10000,
              "transactionCurrency": 978,
              "responseCode": 802,
              "authorizationCode": 0,
              "cashbackAmount": 0,
              "transactionType": 736,
              "networkType": 28,
              "cardType": 0
            },
            {
              "utrnno": 7220403,
              "reversal": false,
              "merchantId": "M999101",
              "terminalId": 999101,
              "transactionDate": "2019-05-15T13:11:38+04:00",
              "cardNumber": 4440010000000001,
              "transactionAmount": 10000,
              "transactionCurrency": 978,
              "responseCode": 802,
              "authorizationCode": 0,
              "cashbackAmount": 0,
              "transactionType": 736,
              "networkType": 28,
              "cardType": "DEF"
            },
            {
              "utrnno": 7220431,
              "reversal": false,
              "merchantId": "M999101",
              "terminalId": 999101,
              "transactionDate": "2019-05-15T13:12:55+04:00",
              "cardNumber": 4440010000000001,
              "transactionAmount": 10000,
              "transactionCurrency": 978,
              "responseCode": 801,
              "authorizationCode": 0,
              "cashbackAmount": 0,
              "transactionType": 736,
              "networkType": 44,
              "cardType": "DEF"
            }
          ]
        }
      }

changeTerminalStatus

Modifier le statut du terminal.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`merchantNumber`	String	Numéro du marchand.
Obligatoire	`terminalNumber`	String	Numéro du terminal.
Obligatoire	`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`agentId`	String	Identifiant de l'agent.
Obligatoire	`customerNumber`	String	Numéro du client.
Obligatoire	`contractNumber`	String	Numéro du contrat.
Obligatoire	`status`	String	Statut du terminal.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/changeTerminalStatus \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "merchantNumber" : "M999201",
  "terminalNumber" : "00999201",
  "institutionId" : "3210",
  "agentId" : "32",
  "customerNumber" : "3210_P004",
  "contractNumber" : "201",
  "status" : "Valid Entity"
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de finalisation de l'opération dans SmartVisa.

Exemple de réponse

{
  "responseCode" : "00"
}

generateKey

Générer une clé.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Facultatif	`terminalId`	Long	Identifiant interne du terminal SVFE (pid)
Facultatif	`terminalNumber`	String	Identifiant du terminal.
Facultatif	`merchantNumber`	String	Identifiant du vendeur.
Obligatoire	`hostId`	Integer	Identifiant interne de la clé ZMK (PID), qui doit être utilisé pour exporter la clé générée.
Obligatoire	`keyType`	String	Type de clé.
Obligatoire	`keyLength`	String	Longueur de la clé générée. Valeurs possibles : [ENKL_0016, ENKL_0032, ENKL_0048]

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/generateKey \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "hostId" : 54329,
  "keyType": "string",
  "keyLength": "ENKL_0016",
  "keySerialNumber": "string",
  "dukptId": 0
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Facultatif	`keyValue`	String	Clé générée (chiffrée ZMK).
Facultatif	`checkValue`	String	Valeur de vérification
Facultatif	`lmkHsmKeyValue`	String	Clé générée (chiffrée LMK).

Exemple de réponse

{
  "keyValue" : "keyValue",
  "lmkHsmKeyValue" : "lmkHsmKeyValue",
  "checkValue" : "checkValue"
}

setKey

Définir la clé.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Facultatif	`terminalId`	Long	Identifiant interne du terminal SVFE (pid)
Facultatif	`terminalNumber`	String	Identifiant du terminal.
Facultatif	`merchantNumber`	String	Identifiant du vendeur.
Obligatoire	`hostId`	Integer	PID de l'hôte
Obligatoire	`keyType`	String	Type de clé. Valeurs possibles : [ENKTTMKA, ENKTTMKP, ENKTTAK, ENKTIKEY]
Facultatif	`inputKeyPrefix`	String	Saisir le préfixe de la clé. Valeurs possibles : [U, T, X, Y]
Obligatoire	`key`	String	Clé.
Facultatif	`keyCheckValue`	String	Valeur de vérification
Obligatoire	`newKeyPrefix`	String	Nouveau préfixe de la clé. Valeurs possibles : [U, T, X, Y]

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/setKey \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "terminalId": 0,
  "terminalNumber": "string",
  "merchantNumber": "string",
  "hostId": 0,
  "keyType": "ENKTTMKA",
  "inputKeyPrefix": "U",
  "key": "string",
  "keyCheckValue": "string",
  "newKeyPrefix": "U"
}'

Paramètres de la réponse

Exemple de réponse

{ }

serviceAction

Exécuter une action avec le service.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`serviceIdentification`	Object	Données d'identification du service.
Obligatoire	serviceIdentification.`serviceType`	String	Type de service.
Obligatoire	serviceIdentification.`serviceId`	String	Identifiant du service.
Obligatoire	serviceIdentification.`serviceObjectType`	String	Objet auquel le service peut être lié. Valeurs possibles : [SERVICE_OBJECT_CARD, SERVICE_OBJECT_ACCOUNT]
Obligatoire	`actionCode`	String	Code d'action. Valeurs possibles : [ACTION_CODE_ADD, ACTION_CODE_UPDATE, ACTION_CODE_DELETE, ACTION_CODE_CHECK, ACTION_CODE_CHANGE_ACCESS, ACTION_CODE_CHECK_PARAMETERS, ACTION_CODE_RESTORE_PARAMETERS, ACTION_CODE_INQUIRE, ACTION_CODE_ACTION]
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. `expDate` et (`cardNumber`) ou (`barCode`) ou (`cardNumberMask` et `phoneNumber`) sont obligatoires.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte crypté.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro du plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du détenteur de la carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'institution.
Facultatif	`accountNumber`	String	Numéro de compte.
Facultatif	`serviceParameters`	Object	Paramètres du service.
Facultatif	serviceParameters.`phoneNumber`	String	Numéro de téléphone.
Facultatif	serviceParameters.`email`	String	Courrier électronique
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse de localisation du terminal.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/serviceAction \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "serviceIdentification": {
    "serviceType" : 7,
    "serviceId" : 300,
    "serviceObjectType": "SERVICE_OBJECT_CARD"
  },
  "actionCode": "ACTION_CODE_ADD",
  "cardIdentification": {
    "cardNumber": 4000010000000003
  }
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVisa.

Exemple de réponse

{
  "responseCode" : 00
}

Cartes et portefeuilles

blockCard

Bloquer la carte. Pour bloquer la carte dans l'environnement de test, elle doit être dans un statut actif (code de statut '0'). Vous pouvez obtenir le code de statut de la carte à l'aide de getCardData.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Pour obtenir des informations plus détaillées sur les autres options d'identification de cartes qui peuvent être utilisées dans un projet réel, et non dans cet environnement de test, consultez la description de createVirtualCard.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte. Vous l'obtiendrez dans la réponse CreateVirtualCard().
Facultatif	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardId`	String	Identifiant de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique Pas pour l'environnement de test.
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du titulaire de la carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`customerId`	String	ID client. Pas pour l'environnement de test.
Facultatif	cardIdentification.`customerNumber`	String	Numéro de client dans SVB02. Pas pour l'environnement de test.
Facultatif	cardIdentification.`barCode`	String	Code-barres. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cvv2`	String	CVV2. Pas pour l'environnement de test.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque. Pas pour l'environnement de test.
Facultatif	cardIdentification.`token`	String	Jeton. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardTypeCode`	String	Code de type de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`email`	String	Adresse électronique. Pas pour l'environnement de test.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'institution.
Obligatoire	`hotCardStatus`	Integer	Statut de carte. Pour l'environnement de test doit être '6'. Cela signifie que la carte est bloquée et doit être saisie lors d'une tentative d'utilisation.
Facultatif	`cardAcceptorParameters`	Object	Paramètres de terminal. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`terminalIdentification`	String	Identifiant de terminal. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`merchantIdentification`	String	Identifiant de commerçant. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`merchantType`	String	Code de catégorie de commerçant. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal. Pas pour l'environnement de test.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/blockCard \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 100000000873
  },
  "hotCardStatus" : 6
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de finalisation d'opération dans SmartVisa. «00» signifie succès.

Exemple de réponse

{
        "responseCode": "00",
        "processingCode": "910000",
        "systemTraceAuditNumber": 620397,
        "localTransactionDate": "2021-09-23T14:37:36"
    }

validateCard

Débloquer la carte.

Paramètres de la demande

Obligation	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Variantes d'identification possibles : (`cardNumber`) ou (`cardId`) ou (`cardNumberMask` et `cardholderId`) ou (`cardNumberMask` et `phoneNumber`).
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du titulaire de la carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/validateCard \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification": {
    "cardId" : 100000000873
  }
}'

Paramètres de la réponse

Obligation	Nom	Type	Description
Obligatoire	`responseCode`	String	Code d'achèvement de l'opération dans SmartVista.

Exemple de réponse

{
    "responseCode": "00",
    "processingCode": "980000",
    "systemTraceAuditNumber": 320252,
    "localTransactionDate": "2024-02-08T15:06:53"
}

bindCardToAccount

Lier une carte à un compte.

Paramètres de la demande

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. `cardNumber` et `expDate` sont obligatoires.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`accountNumber`	String	Numéro de compte pour la liaison.
Obligatoire	`accountType`	String	Type de compte. Valeurs possibles : [ACCOUNT_TYPE_DEFAULT, ACCOUNT_TYPE_SAVING, ACCOUNT_TYPE_CHECKING, ACCOUNT_TYPE_CREDIT, ACCOUNT_TYPE_FIRST_OTHERS, ACCOUNT_TYPE_LOANS, ACCOUNT_TYPE_ENVELOPE, ACCOUNT_TYPE_ESCROW, ACCOUNT_TYPE_MONEY_MARKET, ACCO UNT_TYPE_LOYALTY]
Facultatif	`accountCurrency`	Integer	Devise du compte (requis uniquement pour les nouveaux comptes).
Facultatif	`personalData`	Object	Données personnelles du porteur de carte.
Facultatif	personalData.`firstName`	String
Facultatif	personalData.`lastName`	String
Facultatif	`customerId`	String	ID du client.
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse de localisation du terminal.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/bindCardToAccount \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4000010000000001,
    "expDate" : 202512
  },
  "accountNumber" : 4000010000000001,
  "accountType" : "ACCOUNT_TYPE_DEFAULT",
  "accountCurrency" : 978,
  "personalData" : {
    "firstName" : "IVAN",
    "lastName" : "IVANOV"
  },
  "customerId" : "3210_P004"
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista.

Exemple de réponse

{
  "responseCode" : 00
}

getCardLimits

Obtenir les limites pour une carte spécifique. L'ensemble des limites est défini pour le produit de carte et prédéfini dans l'environnement de test. Initialement, les limites pour une carte spécifique héritent des paramètres du produit. Vous pouvez modifier les valeurs des limites pour une carte spécifique à l'aide de changeCardLimits.

Les limites suivantes sont disponibles (les types de cycles sont indiqués pour la configuration de limite par défaut et peuvent être modifiés par la requête changeCardLimit) :

LMTP0111 - Limite MOTO/ECOM (montant) par mois.
LMTP0112 - Limite MOTO/ECOM (montant) par jour.
LMTP0108 - limite d'achat (montant) par mois.
LMTP0110 - limite d'achat (montant) par jour.
LMTP0109 - limite (montant) de retrait d'espèces par mois.
LMTP0107 - limite (montant) de retrait d'espèces par jour. Vous pouvez vérifier cette limite dans l'environnement de test à l'aide de la requête p2pTransfer.

Les types de limites CycleType suivants sont disponibles :

0 – jour. Le cycle d'une journée commence chaque jour à 00:00:00.
1 – semaine. Le cycle hebdomadaire commence tous les 7 jours à 00:00:00.
2 – semaine calendaire. Le cycle d'une semaine calendaire commence chaque lundi à 00:00:00.
3 – mois. Le cycle mensuel commence le même jour de chaque mois à la même heure.
4 – mois calendaire. Le cycle d'une durée d'1 mois calendaire commence à 00:00:00 le premier jour de chaque mois.
5 – trimestre (3 mois). Le cycle d'1 trimestre commence le même jour tous les 3 mois à la même heure.
6 – trimestre calendaire. Le cycle d'1 trimestre calendaire commence le 1er janvier, 1er avril, 1er juillet, 1er octobre à 00:00:00.
7 – année. Le cycle d'1 année commence le même jour et à la même heure exactement un an plus tard.
8 – année calendaire. Le cycle d'une durée d'1 année calendaire commence le 1er janvier à 00:00:00.
11 – heure. Le cycle d'une heure commence à la même minute et seconde de chaque heure (c'est-à-dire toutes les 3600 secondes).
12 – heure calendaire. L'heure calendaire commence à 0 minute et 0 seconde de chaque heure et se termine à 59 minutes 59 secondes de la même heure.

Paramètres de requête

Caractère obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Pour obtenir des informations plus détaillées sur d'autres options d'identification de cartes qui peuvent être utilisées dans un projet réel, et non dans cet environnement de test, consultez la description de createVirtualCard.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte. Vous l'obtiendrez dans la réponse CreateVirtualCard().
Facultatif	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardId`	String	Identifiant de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique Pas pour l'environnement de test.
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`customerId`	String	ID client. Pas pour l'environnement de test.
Facultatif	cardIdentification.`customerNumber`	String	Numéro de client dans SVB02. Pas pour l'environnement de test.
Facultatif	cardIdentification.`barCode`	String	Code-barres. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cvv2`	String	CVV2. Pas pour l'environnement de test.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque. Pas pour l'environnement de test.
Optionnel	cardIdentification.`token`	String	Token. Pas pour la plateforme de test.
Optionnel	cardIdentification.`cardTypeCode`	String	Code de type de carte. Pas pour la plateforme de test.
Optionnel	cardIdentification.`email`	String	Courrier électronique. Pas pour la plateforme de test.
Optionnel	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement. Pas pour la plateforme de test.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getCardLimits \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardId" : 100000000873
  }
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`limits`	Object	Liste des limites de carte.
Obligatoire	limits.`name`	String	Dénomination de la limite.
Optionnel	limits.`startDate`	DateTime	Date de début de la limite Pas pour la plateforme de test.
Optionnel	limits.`endDate`	DateTime	Date de fin de la limite. Pas pour la plateforme de test.
Optionnel	limits.`value`	Long	Valeur de la limite.
Optionnel	limits.`cycleType`	Integer	Type de cycle. Plusieurs types de cycles de limites sont possibles – quotidiens, mensuels, etc.
Optionnel	limits.`cycleLength`	Integer	Durée du cycle. Par exemple, la valeur 2 pour une limite mensuelle signifie 2 mois.
Optionnel	limits.`currency`	Integer	Devise.
Optionnel	limits.`currentValue`	Long	Valeur actuelle de la limite.
Obligatoire	limits.`limitExceptions`	Object	Limiter la liste des exceptions. Pas pour la plateforme de test.

Exemple de réponse

{
        "limits": [
            {
                "name": "LMTP0111",
                "value": 999999999999,
                "cycleType": 0,
                "cycleLength": 1,
                "currency": 978,
                "currentValue": 0,
                "limitExceptions": []
            },
            {
                "name": "LMTP0112",
                "value": 999999999999,
                "cycleType": 3,
                "cycleLength": 1,
                "currency": 978,
                "currentValue": 0,
                "limitExceptions": []
            },
            {
                "name": "LMTP0108",
                "value": 999999999999,
                "cycleType": 3,
                "cycleLength": 1,
                "currency": 978,
                "currentValue": 0,
                "limitExceptions": []
            },
            {
                "name": "LMTP0110",
                "value": 999999999999,
                "cycleType": 3,
                "cycleLength": 1,
                "currency": 978,
                "currentValue": 0,
                "limitExceptions": []
            },
            {
                "name": "LMTP0109",
                "value": 999999999999,
                "cycleType": 0,
                "cycleLength": 1,
                "currency": 978,
                "currentValue": 0,
                "limitExceptions": []
            },
            {
                "name": "LMTP0107",
                "value": 999999999999,
                "cycleType": 0,
                "cycleLength": 1,
                "currency": 978,
                "currentValue": 0,
                "limitExceptions": []
            }
        ]
    }

addCardLimitException

Ajouter une exception de limite de carte.

Paramètres de la demande

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Options d'identification possibles : (`cardNumber`) ou (`cardId`) ou (`barCode`) ou (`cardNumberMasked` et `cardholderId`) ou (`cardNumberMasked` et ``phoneNumber`).
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte crypté.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du titulaire de la carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Token.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Adresse électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`limitException`	Object	Paramètres de l'exception de limite.
Obligatoire	limitException.`limitName`	String	Nom de la limite dans SVBO.
Obligatoire	limitException.`startDate`	DateTime	Date de début de l'exception.
Obligatoire	limitException.`endDate`	DateTime	Date de fin de l'exception.
Facultatif	limitException.`value`	Long	Valeur de la limite
Facultatif	limitException.`cycleType`	Integer	Type de cycle
Facultatif	limitException.`cycleLength`	Integer	Durée du cycle
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du commerçant.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du commerçant.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse de localisation du terminal.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/addCardLimitException \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4000010000000003
  },
  "limitException" : {
    "limitName" : "LMTTC01",
    "startDate" : "2015-04-20",
    "endDate" : "2015-04-30",
    "value" : 10000000,
    "cycleType" : 4,
    "cycleLength" : 1
  }
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista.

Exemple de réponse

{
  "responseCode" : 00
}

changeCardLimit

Modifier les valeurs de limites pour une carte spécifique. L'ensemble de limites est défini pour le produit de carte et prédéfini dans la plateforme de test. Initialement, les limites pour une carte spécifique héritent des paramètres du produit. Utilisez getCardLimits pour obtenir les noms des limites.

Les limites suivantes sont disponibles (les types de cycles sont spécifiés pour la configuration de limite par défaut et peuvent être modifiés par la requête changeCardLimit) :

LMTP0111 - Limite MOTO/ECOM (montant) par mois.
LMTP0112 - Limite MOTO/ECOM (montant) par jour.
LMTP0108 - limite d'achat (montant) par mois.
LMTP0110 - limite d'achat (montant) par jour.
LMTP0109 - limite (montant) de retrait d'espèces par mois.
LMTP0107 - limite (montant) de retrait d'espèces par jour. Vous pouvez vérifier cette limite dans la plateforme de test avec la requête p2pTransfer.

Les restrictions cycleType suivantes sont disponibles :

0 – jour. Le cycle d'une journée commence chaque jour à 00:00:00.
1 – semaine. Le cycle hebdomadaire commence tous les 7 jours à 00:00:00.
2 – semaine calendaire. Le cycle d'une semaine calendaire commence chaque lundi à 00:00:00.
3 – mois. Le cycle mensuel commence le même jour de chaque mois à la même heure.
4 – mois calendaire. Le cycle d'une durée d'1 mois calendaire commence à 00:00:00 le premier de chaque mois.
5 – trimestre (3 mois). Le cycle d'1 trimestre commence le même jour tous les 3 mois à la même heure.
6 – trimestre calendaire. Le cycle d'1 trimestre calendaire commence le 1er janvier, 1er avril, 1er juillet, 1er octobre à 00:00:00.
7 – année. Le cycle d'1 année commence le même jour et à la même heure exactement un an plus tard.
8 – année calendaire. Le cycle d'une durée d'1 année calendaire commence le 1er janvier à 00:00:00.
11 – heure. Le cycle d'une heure commence à la même minute et seconde de chaque heure (c'est-à-dire toutes les 3600 secondes).
12 – heure calendaire. L'heure calendaire commence à 0 minute et 0 seconde de chaque heure et se termine à 59 minutes 59 secondes de la même heure.

Paramètres de requête

Obligation	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de carte. Pour obtenir des informations plus détaillées sur les autres options d'identification de cartes qui peuvent être utilisées dans un projet réel, et non dans cette plateforme de test, consultez la description de createVirtualCard.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte. Vous l'obtiendrez dans la réponse CreateVirtualCard().
Facultatif	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardId`	String	Identifiant de carte. Pas pour la plateforme de test.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte. Pas pour la plateforme de test.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique. Pas pour la plateforme de test.
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte. Pas pour la plateforme de test. Pas pour la plateforme de test.
Facultatif	cardIdentification.`customerId`	String	ID client. Pas pour la plateforme de test.
Facultatif	cardIdentification.`customerNumber`	String	Numéro de client dans SVB02. Pas pour la plateforme de test.
Facultatif	cardIdentification.`barCode`	String	Code-barres. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cvv2`	String	CVV2. Pas pour la plateforme de test.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque. Pas pour la plateforme de test.
Facultatif	cardIdentification.`token`	String	Jeton. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardTypeCode`	String	Code de type de carte. Pas pour la plateforme de test.
Facultatif	cardIdentification.`email`	String	Courrier électronique. Pas pour la plateforme de test.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement. Pas pour la plateforme de test.
Obligatoire	`limit`	Object	Paramètres de limite.
Obligatoire	limit.`name`	String	Nom de la limite. Il est prédéfini dans la plateforme de test. Vous pouvez obtenir la liste des limites avec getCardLimits() et obtenir les noms des limites à partir de sa réponse.
Facultatif	limit.`startDate`	DateTime	Date de début de la limite Pas pour la plateforme de test.
Facultatif	limit.`endDate`	DateTime	Date de fin de la limite. Pas pour la plateforme de test.
Facultatif	limit.`value`	Long	Valeur de la limite.
Facultatif	limit.`cycleType`	Integer	Type de cycle.
Facultatif	limit.`cycleLength`	Integer	Durée du cycle.
Facultatif	limit.`currency`	Integer	Devise. Pas pour la plateforme de test.
Facultatif	limit.`currentValue`	Long	Valeur actuelle de la limite. Pas pour la plateforme de test.
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal. Pas pour la plateforme de test.
Facultatif	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal. Pas pour la plateforme de test.
Facultatif	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand. Pas pour la plateforme de test.
Facultatif	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand. Pas pour la plateforme de test.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse de localisation du terminal. Pas pour la plateforme de test.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/changeCardLimit \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardId" : 100000000873
  },
  "limit" : {
    "name" : "LMTP0112",
    "value" : 13000000,
    "cycleType" : 4,
    "cycleLength" : 1
  }
}'

Paramètres de réponse

Caractère obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista. «00» signifie succès.

Exemple de réponse

{
        "responseCode": "00",
        "processingCode": "710000",
        "systemTraceAuditNumber": 620394,
        "localTransactionDate": "2021-09-23T14:35:24"
    }

changeCardLimitException

Modifier l'exception de limite de carte.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. `cardNumber` ou `cardId` sont obligatoires.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro du plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de la carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`limitException`	Object	Paramètres de l'exception de limite.
Obligatoire	limitException.`limitName`	String	Nom de la limite dans SVBO.
Obligatoire	limitException.`startDate`	DateTime	Date de début de l'exception.
Obligatoire	limitException.`endDate`	DateTime	Date de fin de l'exception.
Facultatif	limitException.`value`	Long	Valeur de la limite
Facultatif	limitException.`cycleType`	Integer	Type de cycle
Facultatif	limitException.`cycleLength`	Integer	Durée du cycle
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse de localisation du terminal.

Exemple de réponse

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/changeCardLimitException \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4000010000000003,
    "expDate" : 202512
  },
  "limitException" : {
    "limitName" : "LMTTC01",
    "startDate" : "2015-04-20",
    "endDate" : "2015-04-30",
    "value" : 10000000
  }
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista.

Exemple de réponse

{
  "responseCode" : 00
}

deleteCardLimitException

Supprimer une exception de limite de carte.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Options d'identification possibles : (`cardNumber`) ou (`cardId`) ou (`barCode`) ou (`cardNumberMask` et `cardholderId`) ou (`cardNumberMask` et `phoneNumber`).
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte.
Facultatif	cardIdentification.`customerId`	String	ID client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code de type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`limitException`	Object	Paramètres d'exception de limite.
Obligatoire	limitException.`limitName`	String	Nom de limite dans SVBO.
Obligatoire	limitException.`startDate`	DateTime	Date de début de l'exception.
Obligatoire	limitException.`endDate`	DateTime	Date de fin de l'exception.
Facultatif	limitException.`value`	Long	Valeur de limite
Facultatif	limitException.`cycleType`	Integer	Type de cycle
Facultatif	limitException.`cycleLength`	Integer	Durée du cycle
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du commerçant.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du commerçant.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse de localisation du terminal.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/deleteCardLimitException \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4000010000000003,
    "expDate" : 202512
  },
  "limitException" : {
    "limitName" : "LMTTC01",
    "startDate" : "2015-02-15",
    "endDate" : "2015-02-20"
  }
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de completion de l'opération dans SmartVista.

Exemple de réponse

{
  "responseCode" : 00
}

generatePin

Générer un code PIN.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. (`encryptedCardNumber`) ou (`cardNumberMask` et `phoneNumber`) ou identifiant de carte externe.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte.
Facultatif	cardIdentification.`customerId`	String	ID client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code de type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne d'établissement.
Facultatif	`pinDeliveryMethod`	String	Méthode de livraison du code PIN. Valeurs possibles : [SMS — par SMS, WS — dans la réponse du service web, HALF_AND_HALF — les deux premiers chiffres dans la réponse WS, les deux seconds chiffres par SMS, WS_ENCRYPTED — dans la réponse du service web en utilisant le chiffrement public RSA en mode ECB, NONE — ne pas livrer le PIN]
Facultatif	`encryptedPinValue`	ByteArray	Code PIN chiffré.
Facultatif	`pinValue`	String	PIN.
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du commerçant.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du commerçant.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal.
Facultatif	`parameters`	Object	Liste de paramètres arbitraires.
Facultatif	parameters.`name`	String
Facultatif	parameters.`value`	String
Facultatif	`checkCardOnly`	Boolean	Drapeau indiquant s'il faut seulement vérifier la présence et le statut de la carte, et non générer et modifier le PIN.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/generatePin \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumberMask" : "400001%0003",
    "phoneNumber" : 79021111111
  },
  "pinDeliveryMethod" : "WS"
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de finalisation d'opération dans SmartVista (00 – succès).
Facultatif	`pinValue`	String	PIN.
Facultatif	`encryptedPinValue`	ByteArray	Code PIN chiffré.

Exemple de réponse

{
  "encryptedPinValue" : [ "encryptedPinValue", "encryptedPinValue" ],
  "pinValue" : 1111,
  "responseCode" : 00
}

changePin

Modifier le code PIN.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. `cardNumber` ou `cardId` sont obligatoires.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du titulaire de la carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`newPinData`	String	Nouveau code PIN.
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du commerçant.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du commerçant.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse de localisation du terminal.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/changePin \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4000010000000003
  },
  "newPinData" : "059B2AA97DF72557"
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista.

Exemple de réponse

{
  "responseCode" : 00
}

resetPinCounter

Remise à zéro du compteur de tentatives incorrectes de saisie du code PIN.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. `cardNumber` ou `cardId` sont obligatoires.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Token.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du commerçant.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du commerçant.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/resetPinCounter \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification": {
    "cardNumber": 4142100007657181
  },
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVisa.

Exemple de réponse

{
    "responseCode": "00",
    "processingCode": "890000",
    "systemTraceAuditNumber": 452018,
    "localTransactionDate": "2021-11-11T12:28:19",
    "rrn": "000000224348",
    "authorizationIdResponse": "224348"
}

generateCVC2

Générer CVC2.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de carte. Variantes possibles d'identification : (`cardNumber`) ou (`cardId`) ou (`barCode`) ou (`cardNumberMask` et `cardholderId`) ou (`cardNumberMask` et `phoneNumber`).
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Optionnel	cardIdentification.`cardId`	String	Identifiant de carte.
Optionnel	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Optionnel	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Optionnel	cardIdentification.`phoneNumber`	String	Téléphone du client. Doit être transmis, si `deliveryMethod` — c'est SMS, et `phoneNumber` N'EST PAS utilisé en tant que paramètre d'identification.
Optionnel	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte.
Optionnel	cardIdentification.`customerId`	String	ID client.
Optionnel	cardIdentification.`customerNumber`	String	Numéro client dans SVB02.
Optionnel	cardIdentification.`barCode`	String	Code-barres.
Optionnel	cardIdentification.`cvv2`	String	CVV2.
Optionnel	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque.
Optionnel	cardIdentification.`token`	String	Token.
Optionnel	cardIdentification.`cardTypeCode`	String	Code de type de carte.
Optionnel	cardIdentification.`email`	String	Courrier électronique.
Optionnel	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Optionnel	`deliveryMethod`	String	Méthode de livraison du code. Valeurs possibles : [SMS, WS, HALF_AND_HALF, WS_ENCRYPTED, NONE]
Optionnel	`cardAcceptorParameters`	Object	Paramètres de terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant de terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand.
Optionnel	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/generateCVC2 \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4149070067595816
  }
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération SVFE.
Optionnel	`cardNumberMask`	String	Numéro de carte masqué.
Optionnel	`cardNumber`	String	Numéro de carte.
Optionnel	`cvc2`	String	Valeur générée CVV2.

Exemple de réponse

{
    "responseCode": "00",
    "cardNumberMask": "****07006759****",
    "cvc2": "692"
}

setGeoRestrictions

Définir les restrictions géographiques pour la carte. Seules les règles qui peuvent être modifiées sont retournées.

Paramètres de la requête

Obligation	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Variantes d'identification possibles : (`cardNumber`) ou (`cardId`).
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`restrictions`	Object	Liste des restrictions.
Obligatoire	restrictions.`countryId`	Integer	Identifiant du pays.
Obligatoire	restrictions.`regionId`	Integer	Identifiant de la région.
Obligatoire	restrictions.`transactionGroupId`	Integer	Identifiant du groupe de transactions.
Obligatoire	restrictions.`status`	String	Statut de la restriction. Valeurs possibles : [ENABLED, DISABLED]
Facultatif	restrictions.`startDate`	DateTime	Date d'entrée en vigueur des restrictions.
Facultatif	restrictions.`endDate`	DateTime	Date de levée des restrictions.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/setGeoRestrictions \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification": {
    "cardNumber" : 4000010000000001
  },
  "restrictions": {
    "restriction": [
      {
        "regionId": 5,
        "transactionGroupId": 999,
        "status": "DISABLED",
        "startDate": "2021-05-01T00:00:00",
        "endDate": "2021-05-09T23:59:59"
      },
      {
        "regionId" : 11,
        "transactionGroupId" : 3,
        "status" : "DISABLED"
      }
    ]
  } 
}'

Paramètres de la réponse

Obligation	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista.

Exemple de réponse

{
  "responseCode" : 00
}

getGeoRestrictions

Obtenir la liste des restrictions géographiques pour la carte. Seules les règles imposant des restrictions pour la carte sont renvoyées.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Variantes d'identification possibles : `cardNumber` ou `cardId`.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte crypté.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte.
Facultatif	cardIdentification.`customerId`	String	ID client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro de client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Token.
Facultatif	cardIdentification.`cardTypeCode`	String	Code de type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne d'établissement.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getGeoRestrictions \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4000010000000001
  }
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`regions`	Object	Liste des régions.
Obligatoire	regions.`id`	Integer	Identifiant de région.
Obligatoire	regions.`description`	String	Description.
Facultatif	`countries`	Object	Liste des pays.
Obligatoire	countries.`id`	Integer	Identifiant de pays.
Obligatoire	countries.`description`	String	Description.
Obligatoire	`transactionGroups`	Object	Liste des groupes de transactions.
Obligatoire	transactionGroups.`id`	Integer	Identifiant de groupe
Obligatoire	transactionGroups.`description`	String	Description.
Obligatoire	`restrictions`	Object	Liste des restrictions.
Obligatoire	restrictions.`countryId`	Integer	Identifiant de pays.
Obligatoire	restrictions.`regionId`	Integer	Identifiant de région.
Obligatoire	restrictions.`transactionGroupId`	Integer	Identifiant de groupe de transactions.
Obligatoire	restrictions.`status`	String	Statut de restriction. Valeurs possibles : [ENABLED, DISABLED]
Facultatif	restrictions.`startDate`	DateTime	Date d'entrée en vigueur des restrictions.
Facultatif	restrictions.`endDate`	DateTime	Date de levée des restrictions.

Exemple de réponse

{
        "regions": {
          "region": [
            {
              "id": 1,
              "description": "NETHERLANDS"
            },
            {
              "id": 2,
              "description": "EUROPEAN UNION"
            }
          ]
        },
        "countries": {
          "country": [
            {
              "id": 978,
              "description": "NETHERLANDS"
            },
            {
              "id": 840,
              "description": "UNITED STATES"
            }
          ]
        },
        "transactionGroups": {
          "transactionGroup": [
            {
              "id": 1,
              "description": "Purchase Or Payments"
            },
            {
              "id": 2,
              "description": "Cash Withdrawal"
            }
          ]
        },
        "restrictions": {
          "restriction": [
            {
              "regionId": 1,
              "transactionGroupId": 1,
              "status": "DISABLED"
            },
            {
              "countryId": 640,
              "transactionGroupId": 1,
              "status": "DISABLED",
              "startDate": "2021-05-01T00:00:00+03:00",
              "endDate": "2021-05-09T23:59:59+03:00"
            }
          ]
        }
    }

cardStatusInquiry

Faire une demande sur le statut de la carte.

Paramètres de la demande

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Variantes d'identification possibles : (`cardNumber`) ou (`cardId`) ou (`barCode`) ou (`cardNumberMask` et `cardholderId`) ou (`cardNumberMask` et `phoneNumber`). Paramètres d'identification de la carte. Variantes d'identification possibles : (`cardNumber`) ou (`cardId`) ou (`barCode`) ou (`cardNumberMask` et `cardholderId`) ou (`cardNumberMask` et `phoneNumber`).
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro du plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du détenteur de la carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Token.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du commerçant.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du commerçant.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/cardStatusInquiry \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4000010000000003
  } 
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`hotCardStatus`	Integer	Statut de la carte

Exemple de réponse

{
  "hotCardStatus" : 0
}

changeCardStatus

Modifier le statut de la carte. Dans l'environnement de test, vous pouvez modifier le statut de la carte uniquement pour les cartes bloquées (code de statut de carte — '6'). Vous pouvez obtenir le code de statut de carte à l'aide de la requête getCardData. Pour modifier le statut de carte de «0» à «6» (bloquée), utilisez la requête blockCard.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de carte. Pour obtenir plus d'informations détaillées sur d'autres variantes d'identification de cartes, qui peuvent être utilisées dans un projet réel, et non dans cet environnement de test, consultez la description de createVirtualCard.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte. Vous l'obtiendrez dans la réponse CreateVirtualCard().
Facultatif	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Facultatif	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardId`	String	Identifiant de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique. Pas pour l'environnement de test.
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du propriétaire de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`customerId`	String	ID client. Pas pour l'environnement de test.
Facultatif	cardIdentification.`customerNumber`	String	Numéro de client dans SVB02. Pas pour l'environnement de test.
Facultatif	cardIdentification.`barCode`	String	Code-barres. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cvv2`	String	CVV2. Pas pour l'environnement de test.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque. Pas pour l'environnement de test.
Facultatif	cardIdentification.`token`	String	Token. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardTypeCode`	String	Code de type de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`email`	String	E-mail. Pas pour l'environnement de test.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement. Pas pour l'environnement de test.
Obligatoire	`hotCardStatus`	Integer	Statut de carte. Pour l'environnement de test doit être «0», pour activer une carte bloquée.
Facultatif	`cardAcceptorParameters`	Object	Paramètres de terminal. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`terminalIdentification`	String	Identifiant de terminal. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse de localisation du terminal. Pas pour l'environnement de test.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/changeCardStatus \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardId" : 100000000873
  },
  "hotCardStatus" : 0
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de finalisation d'opération dans SmartVista. «00» signifie succès.

Exemple de réponse

{
        "responseCode": "00",
        "processingCode": "950000",
        "systemTraceAuditNumber": 620398,
        "localTransactionDate": "2021-09-23T14:38:26"
    }

createVirtualCard

Crée une carte virtuelle pour un client enregistré. Utilisez registerCustomer pour créer un client et un compte si vous ne l'avez pas encore fait.

Paramètres de la demande

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de base de la carte. Il existe de nombreux attributs de carte et leurs combinaisons pour l'identification de carte pris en charge par SmartVista, mais dans l'environnement de test, le plus simple d'entre eux est utilisé — le numéro de carte. Toutes les autres options sont données à titre d'exemple.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte. C'est cette méthode que nous utiliserons dans toutes les demandes de l'environnement de test pour identifier la carte. Pour cette demande, utilisez toujours le numéro de carte "visaBin0000000000", où [visaBin] est le numéro de l'e-mail que vous avez reçu après l'inscription. Pour toutes les autres demandes, utilisez le numéro de carte que vous obtiendrez après avoir créé la carte avec cette demande.
Facultatif	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Généralement utilisé comme l'un des paramètres possibles d'identification de carte, mais pas dans ce projet d'environnement de test, pour éviter la gestion des clés. Ne l'utilisez pas ici.
Facultatif	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Méthode courante d'identification de carte en combinaison avec le numéro de téléphone ou d'autres données de carte, mais pas celle utilisée dans l'environnement de test. Ne l'utilisez pas ici.
Facultatif	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Méthode courante d'identification de carte en combinaison avec le numéro de téléphone, et non celle utilisée dans l'environnement de test. Ne l'utilisez pas ici.
Facultatif	cardIdentification.`cardId`	String	Identifiant de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte. Souvent utilisée avec d'autres attributs de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique. Pas pour l'environnement de test.
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client. Souvent utilisé avec d'autres attributs de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`customerId`	String	ID client. Pas pour l'environnement de test.
Facultatif	cardIdentification.`customerNumber`	String	Numéro client dans SVB02. Pas pour l'environnement de test.
Facultatif	cardIdentification.`barCode`	String	Code-barres. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cvv2`	String	CVV2. Pas pour l'environnement de test.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque. Pas pour l'environnement de test.
Facultatif	cardIdentification.`token`	String	Token. Pas pour l'environnement de test.
Facultatif	cardIdentification.`cardTypeCode`	String	Code de type de carte. Pas pour l'environnement de test.
Facultatif	cardIdentification.`email`	String	Courrier électronique. Pas pour l'environnement de test.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'institution. Pas pour l'environnement de test.
Obligatoire	`virtualCardIdentification`	Object	Paramètres de la carte virtuelle. `expDate` et `productType` sont obligatoires.
Obligatoire	virtualCardIdentification.`expDate`	String	Date d'expiration de la carte. Toute date future au format «AAAAMMJ».
Obligatoire	virtualCardIdentification.`productType`	String	Type de produit. Identifie le produit de carte pour la carte. Dans l'environnement de test doit toujours être un numéro constant «5C», car nous configurons un produit pour vous.
Facultatif	virtualCardIdentification.`cardNumber`	String	Numéro de carte. Pas pour l'environnement de test.
Facultatif	virtualCardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Pas pour l'environnement de test.
Facultatif	virtualCardIdentification.`cardId`	String	Identifiant de carte. Pas pour l'environnement de test.
Facultatif	virtualCardIdentification.`barCode`	String	Code-barres. Pas pour l'environnement de test.
Facultatif	virtualCardIdentification.`cvv2`	String	CVV2/CVC2. Pas pour l'environnement de test.
Obligatoire	`amount`	Integer	Limite par défaut pour les cartes virtuelles nouvellement créées. Dans l'environnement de test doit être un nombre constant «0».
Obligatoire	`currency`	Integer	Devise. Code numérique de devise ISO 4217. Utilisez «978» pour l'environnement de test.
Obligatoire	`accountNumber`	String	Numéro de compte pour l'identification primaire de la carte. Utilisez le numéro de compte obtenu avec la méthode registerCustomer().
Facultatif	`deliveryMethod`	String	Méthode de livraison des paramètres de carte virtuelle. Valeurs possibles : [WS, HALF_AND_HALF] . WS — tous les paramètres, sont transmis dans la réponse du service web. HALF_AND_HALF — certains paramètres sont livrés dans la réponse du service web, certains — par SMS. Pour HALF_AND_HALF la réponse du service web contiendra le numéro de carte masqué (par exemple, //// 1111 1111 ////), et le SMS contiendra CVV2 et l'autre moitié du numéro de carte masqué (1111 //// //// 1111). Utilisez la valeur «WS» pour l'environnement de test.
Facultatif	`personalData`	Object	Données personnelles du titulaire de carte. Pas pour l'environnement de test.
Facultatif	personalData.`firstName`	String	Pas pour l'environnement de test.
Facultatif	personalData.`lastName`	String	Pas pour l'environnement de test.
Facultatif	`cardAcceptorParameters`	Object	Paramètres de terminal. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`terminalIdentification`	String	Identifiant de terminal. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`merchantIdentification`	String	Identifiant de marchand. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`merchantType`	String	Code de catégorie de marchand. Pas pour l'environnement de test.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal. Pas pour l'environnement de test.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/createVirtualCard \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4140050000000000,
    "phoneNumber" : "319220977337",
    "customerId" : "3006P_0000002"
  },
  "virtualCardIdentification" : {
    "expDate" : 202512,
    "productType" : "5C"
  },
  "amount" : 0,
  "currency" : 978,
  "accountNumber" : "3006978700000000108",
  "deliveryMethod" : "WS"
}'

Paramètres de réponse

Caractère obligatoire	Nom	Type	Description
Obligatoire	`virtualCardIdentification`	Object	Paramètres de carte virtuelle.
Facultatif	virtualCardIdentification.`cardNumber`	String	Numéro de carte. Ici vous recevrez le numéro de carte créée dans l'environnement de test. Sauvegardez-le pour toutes les opérations ultérieures avec la carte créée.
Facultatif	virtualCardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Pas pour l'environnement de test.
Facultatif	virtualCardIdentification.`cardId`	String	Identifiant de carte. Pas pour l'environnement de test.
Obligatoire	virtualCardIdentification.`expDate`	String	Date d'expiration de carte. Pas pour l'environnement de test.
Obligatoire	virtualCardIdentification.`productType`	String	Type de produit. Pas pour l'environnement de test.
Facultatif	virtualCardIdentification.`barCode`	String	Code-barres. Pas pour l'environnement de test.
Facultatif	virtualCardIdentification.`cvv2`	String	CVV2/CVC2. Pas pour l'environnement de test.

Exemple de réponse

{
        "virtualCardIdentification": {
            "cardNumber": "4140050021658271",
            "cardId": "100000000873",
            "expDate": "202512",
            "productType": "5C"
        }
    }

getCardData

Retourne les données sur les cartes que vous avez créées. Peut être utilisé après la création d'une carte à l'aide de createVirtualCard.

Paramètres de la requête

Caractère obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. `cardNumber` est requis. Pour obtenir des informations plus détaillées sur les autres options d'identification des cartes qui peuvent être utilisées dans un projet réel, et non dans cette zone de test, consultez la description de createVirtualCard.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte. Vous l'obtiendrez dans la réponse CreateVirtualCard().
Facultatif	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Non pour la zone de test.
Facultatif	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Non pour la zone de test.
Facultatif	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Non pour la zone de test.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte. Non pour la zone de test.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte. Non pour la zone de test.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique Non pour la zone de test.
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client. Non pour la zone de test.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du titulaire de la carte. Non pour la zone de test.
Facultatif	cardIdentification.`customerId`	String	ID du client. Non pour la zone de test.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02. Non pour la zone de test.
Facultatif	cardIdentification.`barCode`	String	Code-barres. Non pour la zone de test.
Facultatif	cardIdentification.`cvv2`	String	CVV2. Non pour la zone de test.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque. Non pour la zone de test.
Facultatif	cardIdentification.`token`	String	Jeton. Non pour la zone de test.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte. Non pour la zone de test.
Facultatif	cardIdentification.`email`	String	Courrier électronique. Non pour la zone de test.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement. Non pour la zone de test.
Facultatif	`rsaPublicKey`	ByteArray	Clé publique pour chiffrer le numéro de carte dans le message de réponse. Non pour la zone de test.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getCardData \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardId" : 100000000873
  }
}'

Paramètres de réponse

Caractère obligatoire	Nom	Type	Description
Obligatoire	`cardData`	Object	Paramètres de la carte.
Facultatif	cardData.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Non pour la zone de test.
Facultatif	cardData.`cardNumberMask`	String	Numéro de carte masqué. Non pour la zone de test.
Obligatoire	cardData.`cardNumber`	String	Numéro de carte.
Facultatif	cardData.`expiryDate`	String	Date d'expiration de la carte. Au format AAAANM.
Facultatif	cardData.`formattedExpiryDate`	String	Date d'expiration de la carte, formatée par l'utilisateur. Non pour la zone de test.
Facultatif	cardData.`cardId`	String	Identifiant de la carte. Il s'agit de l'identifiant interne de la carte SmartVista, qui peut être utilisé pour identifier la carte pour les applications non compatibles avec PCI DSS.
Facultatif	cardData.`hotCardStatus`	Integer	Statut de la carte.
Facultatif	cardData.`cardTypeName`	String	Type de carte.
Facultatif	cardData.`embossedName`	String	Nom sur le plastique. Cela a du sens pour les cartes plastiques embossées, et non pour les cartes virtuelles dans la zone de test.
Optionnel	cardData.`customerId`	String	ID du client.
Optionnel	cardData.`customerName`	String	Nom du client. Pas pour l'environnement de test.
Optionnel	cardData.`personId`	String	Identifiant du propriétaire de la carte. Pas pour l'environnement de test.
Optionnel	cardData.`pinDenialCounter`	Integer	Nombre de tentatives incorrectes de saisie du code PIN
Optionnel	cardData.`plasticNumber`	Integer	Numéro du plastique. Pas pour l'environnement de test.
Optionnel	cardData.`hotCardStatusDescription`	String	Description du statut de la carte.
Optionnel	cardData.`cardIsPrimary`	Boolean	Indicateur de carte principale. Toujours false pour l'environnement de test.
Optionnel	cardData.`cardBindToCustomer`	Boolean	Indicateur de liaison de la carte au client. Toujours false pour l'environnement de test.
Optionnel	cardData.`customerIsCardholder`	Boolean	Indicateur si le client est porteur de carte. Toujours false pour l'environnement de test.
Optionnel	cardData.`cardContractId`	String	Identifiant du contrat de carte. Pas pour l'environnement de test.
Optionnel	cardData.`cardPlasticId`	String	Identifiant du type de plastique. Pas pour l'environnement de test.
Optionnel	cardData.`cardPlasticDescription`	String	Description du type de plastique. Pas pour l'environnement de test.
Optionnel	cardData.`memorableWord`	String	Mot secret. Pas pour l'environnement de test.
Optionnel	cardData.`email`	String	Courrier électronique. Pas pour l'environnement de test.
Optionnel	cardData.`lastWrongPinDate`	DateTime	Date/heure de la dernière tentative de saisie de code PIN incorrect. Pas pour l'environnement de test.
Optionnel	cardData.`cardCreationDate`	DateTime	Date d'émission de la carte. Pas pour l'environnement de test.
Optionnel	cardData.`cardBlockingDate`	DateTime	Date/heure de blocage de la carte. Pas pour l'environnement de test.
Optionnel	cardData.`directDebitAccount`	String	Compte utilisé pour les paiements automatiques. Pas pour l'environnement de test.
Optionnel	cardData.`cardholderMobilePhoneNumber`	String	Numéro de téléphone du propriétaire de la carte. Pas pour l'environnement de test.
Optionnel	cardData.`accounts`	Object	Liste des comptes pour la carte. Dans l'environnement de test, il ne devrait y avoir qu'un seul compte.
Obligatoire	accounts.`number`	String	Numéro de compte.
Obligatoire	accounts.`currency`	Integer	Devise du compte
Optionnel	accounts.`currencyAlphaCode`	String	Code alphabétique de la devise du compte.
Obligatoire	accounts.`balance`	Integer	Solde du compte.
Optionnel	accounts.`creditLimit`	Integer	Limite de crédit.
Obligatoire	accounts.`customerId`	String	ID du client.
Optionnel	accounts.`defaultAccount`	Boolean	Indicateur de compte par défaut. Toujours true pour l'environnement de test.

Exemple de réponse

{
        "cardData": {
            "cardNumber": "4140050021658271",
            "expiryDate": "202512",
            "cardId": "100000000873",
            "hotCardStatus": 0,
            "cardTypeName": "VISA - PLUS",
            "embossedName": "GENERAL POOL",
            "customerId": "3006P_0000003",
            "personId": "3006P_0000002",
            "pinDenialCounter": 0,
            "plasticNumber": 1,
            "hotCardStatusDescription": "VALID CARD",
            "cardIsPrimary": false,
            "cardBindToCustomer": false,
            "customerIsCardholder": false,
            "accounts": [
                {
                    "number": "3006978700000000108",
                    "accountType": 1,
                    "currency": 978,
                    "currencyAlphaCode": "EUR",
                    "balance": 0,
                    "creditLimit": 0,
                    "customerId": "3006P_0000003",
                    "defaultAccount": true
                }
            ],
            "customParameters": []
        }
    }

getCardFees

Obtenir les commissions par carte.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardNumber`	String	Numéro de carte.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getCardFees \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardNumber" : 4000010000000003
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`fees`	Object	Liste des commissions.
Obligatoire	fees.`feeType`	String	Type de commission.
Obligatoire	fees.`feeValue`	number	Montant de la commission.

Exemple de réponse

{
  "fees" : [ {
    "feeValue" : 1.46581298050294517310021547018550336360931396484375,
    "feeType" : "feeType"
  }, {
    "feeValue" : 1.46581298050294517310021547018550336360931396484375,
    "feeType" : "feeType"
  } ]
}

getCardListByOwner

Obtenir la liste des cartes en utilisant l'identifiant du client et/ou l'identifiant du propriétaire de la carte.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. (`customerId`), (`phoneNumber`) ou (`email`) sont obligatoires.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte crypté.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du propriétaire de la carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'institution.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getCardListByOwner \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "customerId" : 10022830
  }
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Facultatif	`cards`	Object
Facultatif	cards.`encryptedCardNumber`	ByteArray	Numéro de carte crypté.
Obligatoire	cards.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cards.`cardNumber`	String	Numéro de carte.
Facultatif	cards.`expiryDate`	String	Date d'expiration de la carte.
Facultatif	cards.`formattedExpiryDate`	String	Date d'expiration de la carte formatée par l'utilisateur.
Facultatif	cards.`cardId`	String	Identifiant de la carte.
Facultatif	cards.`hotCardStatus`	Integer	Statut de la carte
Facultatif	cards.`cardTypeName`	String	Type de carte.
Facultatif	cards.`embossedName`	String	Nom sur le plastique.
Facultatif	cards.`customerId`	String	ID du client.
Facultatif	cards.`customerName`	String	Nom du client.
Facultatif	cards.`personId`	String	Identifiant du propriétaire de la carte.
Facultatif	cards.`pinDenialCounter`	Integer	Nombre de tentatives de saisie incorrecte du code PIN
Facultatif	cards.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cards.`hotCardStatusDescription`	String	Description du statut de la carte.
Facultatif	cards.`cardIsPrimary`	Boolean	Indicateur de carte principale.
Facultatif	cards.`cardBindToCustomer`	Boolean	Indicateur de liaison de la carte au client.
Facultatif	cards.`customerIsCardholder`	Boolean	Indicateur si le client est porteur de la carte.
Facultatif	cards.`cardContractId`	String	Identifiant du contrat de carte.
Facultatif	cards.`cardPlasticId`	String	Identifiant du type de plastique.
Facultatif	cards.`cardPlasticDescription`	String	Description du type de plastique.
Facultatif	cards.`memorableWord`	String	Mot secret.
Facultatif	cards.`email`	String	Courrier électronique.
Optionnel	cards.`lastWrongPinDate`	DateTime	Date/heure de la dernière tentative de saisie d'un code PIN incorrect.
Optionnel	cards.`cardCreationDate`	DateTime	Date d'émission de la carte.
Optionnel	cards.`cardBlockingDate`	DateTime	Date/heure de blocage de la carte.
Optionnel	cards.`directDebitAccount`	String	Compte utilisé pour les paiements automatiques.
Optionnel	cards.`cardholderMobilePhoneNumber`	String	Numéro de téléphone du titulaire de la carte.
Optionnel	cards.`accounts`	Object	Liste des comptes pour la carte.
Obligatoire	accounts.`number`	String	Numéro de compte.
Obligatoire	accounts.`currency`	Integer	Devise du compte
Optionnel	accounts.`currencyAlphaCode`	String	Code alphabétique de la devise du compte.
Obligatoire	accounts.`balance`	Integer	Solde du compte.
Optionnel	accounts.`creditLimit`	Integer	Limite de crédit.
Obligatoire	accounts.`customerId`	String	ID du client.
Optionnel	accounts.`defaultAccount`	Boolean	Indicateur de compte par défaut.

Exemple de réponse

{
        "cards": {
          "card": [
            {
              "cardNumberMask": "400001******0004",
              "expiryDate": 202512,
              "cardId": 99,
              "hotCardStatus": 0,
              "cardTypeName": "EC/MC Virtual",
              "embossedName": "TEST FOR_BO_TRANS1",
              "customerId": 10022830,
              "personId": 40000004,
              "pinDenialCounter": 0,
              "plasticNumber": 0,
              "hotCardStatusDescription": "VALID CARD",
              "cardIsPrimary": true,
              "cardBindToCustomer": true,
              "customerIsCardholder": false
            },
            {
              "cardNumberMask": "400001******0008",
              "expiryDate": 202512,
              "hotCardStatus": 8,
              "cardTypeName": "EC/MC Virtual",
              "embossedName": "TEST FOR_BO_TRANS1",
              "customerId": 10022830,
              "personId": 40000008,
              "pinDenialCounter": 0,
              "plasticNumber": 0,
              "hotCardStatusDescription": "CALL SECURITY, CAPTURE",
              "cardIsPrimary": true,
              "cardBindToCustomer": true,
              "customerIsCardholder": false
            },
            {
              "cardNumberMask": "400001******0017",
              "expiryDate": 202512,
              "hotCardStatus": 0,
              "cardTypeName": "EC/MC Virtual",
              "embossedName": "TEST FOR_BO_TRANS1",
              "customerId": 10022830,
              "personId": 40000017,
              "pinDenialCounter": 0,
              "plasticNumber": 0,
              "hotCardStatusDescription": "VALID CARD",
              "cardIsPrimary": true,
              "cardBindToCustomer": true,
              "customerIsCardholder": false
            }
          ]
        }
    }

getTransactionSchemeAdditions

Obtenez les règles supplémentaires du schéma de transactions.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de carte. Variantes possibles d'identification : `cardId`.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte.
Facultatif	cardIdentification.`customerId`	String	ID client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro de client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Token.
Facultatif	cardIdentification.`cardTypeCode`	String	Code de type de carte.
Facultatif	cardIdentification.`email`	String	Adresse électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Facultatif	`templateSchemeId`	Long	Identifiant du schéma utilisé comme modèle

Request example

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getTransactionSchemeAdditions \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification": {
    "cardId": 1000
  },
  "templateSchemeId": 10
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Facultatif	`transactionSchemeAdditions`	Object	Liste des règles supplémentaires du schéma de transactions.
Obligatoire	transactionSchemeAdditions.`id`	Long	Identifiant de règle
Obligatoire	transactionSchemeAdditions.`domain`	String	Identifiant de l'établissement émetteur.
Obligatoire	transactionSchemeAdditions.`countryGroup`	Integer	Identifiant du groupe de pays
Obligatoire	transactionSchemeAdditions.`mccGroup`	Integer	Identifiant du groupe MCC
Obligatoire	transactionSchemeAdditions.`transactionType`	Integer	Type de transaction : format
Obligatoire	transactionSchemeAdditions.`posDataCode`	String	Valeur du code de données POS.

Exemple de réponse

{
        "transactionSchemeAdditions": {
          "addition": [
            {
              "id": 141,
              "domain": 9999,
              "countryGroup": 9987,
              "mccGroup": -1,
              "transactionType": 781,
              "posDataCode": "************"
            },
            {
              "id": 142,
              "domain": 9999,
              "countryGroup": 9987,
              "mccGroup": -1,
              "transactionType": 781,
              "posDataCode": "************"
            },
            {
              "id": 143,
              "domain": 9999,
              "countryGroup": 9987,
              "mccGroup": -1,
              "transactionType": 781,
              "posDataCode": "************"
            }
          ]
        }
    }

setTransactionSchemeAdditions

Définissez la liste des règles pour le schéma de transaction supplémentaire.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Variantes possibles d'identification : `cardId`.
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte.
Facultatif	cardIdentification.`customerId`	String	ID du client.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Facultatif	cardIdentification.`barCode`	String	Code-barres.
Facultatif	cardIdentification.`cvv2`	String	CVV2.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Facultatif	cardIdentification.`token`	String	Jeton.
Facultatif	cardIdentification.`cardTypeCode`	String	Code de type de carte.
Facultatif	cardIdentification.`email`	String	Courrier électronique.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`transactionSchemeAdditions`	Object	Liste des règles supplémentaires du schéma de transactions.
Obligatoire	transactionSchemeAdditions.`id`	Long	Identifiant de la règle
Obligatoire	transactionSchemeAdditions.`domain`	String	Identifiant de l'établissement émetteur.
Obligatoire	transactionSchemeAdditions.`countryGroup`	Integer	Identifiant du groupe de pays
Obligatoire	transactionSchemeAdditions.`mccGroup`	Integer	Identifiant du groupe MCC
Obligatoire	transactionSchemeAdditions.`transactionType`	Integer	Type de transaction : format
Obligatoire	transactionSchemeAdditions.`posDataCode`	String	Valeur du code de données POS.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/setTransactionSchemeAdditions \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification": {
    "cardId": 1000
  },
  "transactionSchemeAdditions": {
    "addition": [
      {
        "id": 141,
        "domain": 9999,
        "countryGroup": 9987,
        "mccGroup": -1,
        "transactionType": 793,
        "posDataCode": "************"
      },
      {
        "id": 142,
        "domain": 9999,
        "countryGroup": 9987,
        "mccGroup": -1,
        "transactionType": 781,
        "posDataCode": "************"
      },
      {
        "id": 143,
        "domain": 9999,
        "countryGroup": 9987,
        "mccGroup": -1,
        "transactionType": 781,
        "posDataCode": "************"
      }
    ]
  }
}'

Paramètres de la réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération dans SmartVista.

Exemple de réponse

{
  "responseCode" : 00
}

topUp

Recharger la carte ou le compte.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/topUp \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "pan": "string",
  "expiryMonth": "string",
  "expiryYear": "string",
  "cvc": "string",
  "cardholderName": "string"
}'

Exemple de réponse

{
  "preAuthorization": false,
  "cardIdentification": {
    "encryptedCardNumber": [
      "string"
    ],
    "cardNumberMask": "string",
    "cardLastDigitMask": "string",
    "cardNumber": "string",
    "cardId": "string",
    "expDate": "string",
    "plasticNumber": 0,
    "phoneNumber": "string",
    "cardholderId": "string",
    "customerId": "string",
    "customerNumber": "string",
    "barCode": "string",
    "cvv2": "string",
    "externalCardId": "string",
    "token": "string",
    "cardTypeCode": "string",
    "email": "string",
    "institutionId": "string"
  },
  "amount": 0,
  "currency": 0,
  "accountType": "ACCOUNT_TYPE_DEFAULT",
  "accountIndex": 0,
  "accountNumber": "string",
  "account2Type": "ACCOUNT_TYPE_DEFAULT",
  "account2Index": 0,
  "account2Number": "string",
  "tds": {
    "xid": "string",
    "cavv": "string",
    "ucaf": "string",
    "authenticationIndicator": "NOT_PERFORMED"
  },
  "senderReceiverInfo": {
    "senderName": "string",
    "senderAddress": "string",
    "senderCity": "string",
    "senderCountry": "string",
    "senderPostalCode": "string",
    "receiverName": "string"
  },
  "pointOfServiceDataCode": "string",
  "pointOfServiceConditionCode": "string",
  "fee": {
    "feeAmount": 0,
    "feeCurrency": 0
  },
  "cardAcceptorParameters": {
    "terminalIdentification": "string",
    "merchantIdentification": "string",
    "merchantType": "string",
    "nameAndLocation": "string"
  },
  "securityLevelIndicator": "string",
  "fundingSource": 0,
  "externalTransactionId": "string",
  "originalTransactionParameters": {
    "systemTraceAuditNumber": 0,
    "localTransactionDate": "2021-10-29T11:57:14.481Z",
    "rrn": "string"
  },
  "posCardholderPresence": 0,
  "uniqueReferenceNumber": "string",
  "otp": "string",
  "serviceId": "string",
  "paymentSpecificData": {
    "f57": "string",
    "f58": "string",
    "f59": "string",
    "f60": "string",
    "f61": "string",
    "f62": "string",
    "f63": "string",
    "f64": "string",
    "f65": "string",
    "f66": "string",
    "f67": "string",
    "f68": "string",
    "f69": "string",
    "f70": "string",
    "f71": "string",
    "f72": "string",
    "f73": "string"
  },
  "transactionComment": "string",
  "additionalAmounts": [
    {
      "accountType": "ACCOUNT_TYPE_DEFAULT",
      "amountType": "string",
      "currency": 0,
      "amount": 0
    }
  ]
}

Transactions

creditCard

Dépôt de fonds sur la carte.

Paramètres de la requête

Obligatoire	Nom	Type	Description
Facultatif	`preAuthorization`	Boolean	Indicateur de pré-autorisation.
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Pour obtenir des informations plus détaillées sur d'autres options d'identification des cartes qui peuvent être utilisées dans un projet réel, et non dans ce terrain d'essai, consultez la description de createVirtualCard.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte. Vous l'obtiendrez dans la réponse CreateVirtualCard().
Facultatif	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro du plastique. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`customerId`	String	ID client. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`customerNumber`	String	Numéro client dans SVB02. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`barCode`	String	Code-barres. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`cvv2`	String	CVV2. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`token`	String	Token. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`email`	String	Courrier électronique. Pas pour le terrain d'essai.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'institution. Pas pour le terrain d'essai.
Obligatoire	`amount`	Integer	Montant.
Obligatoire	`currency`	Integer	Devise. Code numérique de devise ISO 4217. Utilisez « 978 » pour le terrain d'essai.
Facultatif	`tds`	Object	Paramètres de transaction 3DS.
Facultatif	tds.`xid`	String	Identifiant de transaction VISA 3DS. Pas pour le terrain d'essai.
Facultatif	tds.`cavv`	String	Valeur de vérification d'authentification VISA. Pas pour le terrain d'essai.
Facultatif	tds.`ucaf`	String	Champ d'authentification universelle Mastercard. Pas pour le terrain d'essai.
Facultatif	tds.`authenticationIndicator`	String	Type d'authentification de transaction de commerce électronique. Valeurs possibles : [NOT_PERFORMED, TDS_MERCHANT_ONLY, TDS_PERFORMED, ADDITIONAL_PROTOCOL_USED, RECURRENT_PAYMENT_AUTH]. Pas pour le terrain d'essai.
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal. Pas pour le terrain d'essai.
Facultatif	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal. Pas pour le terrain d'essai.
Facultatif	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand. Pas pour le terrain d'essai.
Facultatif	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand. Pas pour le terrain d'essai.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse de localisation du terminal. Pas pour le terrain d'essai.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/creditCard \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4140050021658271,
    "expDate" : 202512
  },
  "amount" : 10000,
  "currency" : 978,
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code de fin d'opération SVFE. « 00 » signifie succès.
Obligatoire	`processingCode`	String	code de traitement.
Obligatoire	`systemTraceAuditNumber`	Integer	Numéro d'enregistrement d'audit
Obligatoire	`localTransactionDate`	DateTime	Date de transaction. Format : date-heure
Obligatoire	`rrn`	String	Identifiant externe RNN.
Optionnel	`authorizationIdResponse`	String	Identifiant d'autorisation.
Optionnel	`uniqueReferenceNumber`	String	Numéro de référence unique de l'opération.
Optionnel	`otp`	String	Mot de passe à usage unique. Pas pour la plateforme de test.
Optionnel	`acquirerFeeAmount`	String	Montant de commission de l'acquéreur. Pas pour la plateforme de test.
Optionnel	`issuerFeeAmount`	String	Montant de commission de l'émetteur. Pas pour la plateforme de test.
Optionnel	`paymentSpecificData`	Object	Données spéciales sur le paiement.

Exemple de réponse

{
        "responseCode": "00",
        "processingCode": "270000",
        "systemTraceAuditNumber": 620399,
        "localTransactionDate": "2021-09-23T14:39:15",
        "rrn": "000000154798",
        "authorizationIdResponse": "154798",
        "paymentSpecificData": {}
    }

debitCard

Retirer des fonds de la carte.

Paramètres de la demande

Obligatoire	Nom	Type	Description
Optionnel	`preAuthorization`	Boolean	Drapeau de pré-autorisation.
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Variantes d'identification possibles : (`cardNumber`) ou (`cardId`) ou (`barCode`) ou (`cardNumberMask` et `cardholderId`) ou (`cardNumberMask` et `phoneNumber`).
Obligatoire	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré.
Obligatoire	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué.
Obligatoire	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de carte.
Optionnel	cardIdentification.`cardId`	String	Identifiant de la carte.
Optionnel	cardIdentification.`expDate`	String	Date d'expiration de la carte.
Optionnel	cardIdentification.`plasticNumber`	Integer	Numéro de plastique
Optionnel	cardIdentification.`phoneNumber`	String	Téléphone du client.
Optionnel	cardIdentification.`cardholderId`	String	Identifiant du porteur de la carte.
Optionnel	cardIdentification.`customerId`	String	ID du client.
Optionnel	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02.
Optionnel	cardIdentification.`barCode`	String	Code-barres.
Optionnel	cardIdentification.`cvv2`	String	CVV2.
Optionnel	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque.
Optionnel	cardIdentification.`token`	String	Jeton.
Optionnel	cardIdentification.`cardTypeCode`	String	Code du type de carte.
Optionnel	cardIdentification.`email`	String	Courrier électronique.
Optionnel	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`amount`	Integer	Montant.
Obligatoire	`currency`	Integer	Devise
Optionnel	`fee`	Object	Paramètres de commission de l'acquéreur.
Obligatoire	fee.`feeType`	String	Type de commission.
Obligatoire	fee.`feeValue`	number	Montant de la commission.
Optionnel	`cardAcceptorParameters`	Object	Paramètres du terminal.
Obligatoire	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal.
Obligatoire	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand.
Obligatoire	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand.
Optionnel	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal.
Optionnel	`tds`	Object	Paramètres de transaction 3DS.
Optionnel	tds.`xid`	String	Identifiant de transaction VISA 3DS.
Optionnel	tds.`cavv`	String	Valeur de vérification d'authentification VISA.
Optionnel	tds.`ucaf`	String	Champ d'authentification universelle Mastercard.
Optionnel	tds.`authenticationIndicator`	String	Type d'authentification de transaction de commerce électronique. Valeurs possibles : [NOT_PERFORMED, TDS_MERCHANT_ONLY, TDS_PERFORMED, ADDITIONAL_PROTOCOL_USED, RECURRENT_PAYMENT_AUTH]

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/debitCard \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardNumber" : 4000010000000003
  },
  "amount" : 100000,
  "currency" : 978,
  "fee" : {
    "feeAmount" : 1000
  }
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`responseCode`	String	Code d'achèvement d'opération SVFE.
Obligatoire	`processingCode`	String	code de traitement.
Obligatoire	`systemTraceAuditNumber`	Integer	Numéro d'enregistrement d'audit
Obligatoire	`localTransactionDate`	DateTime	Date de transaction. Format : date-heure
Obligatoire	`rrn`	String	Identifiant externe RNN.
Optionnel	`authorizationIdResponse`	String	Identifiant d'autorisation.
Facultatif	`uniqueReferenceNumber`	String	Numéro de référence unique de l'opération.
Facultatif	`otp`	String	Mot de passe à usage unique.
Facultatif	`acquirerFeeAmount`	String	Montant de la commission de l'acquéreur.
Facultatif	`issuerFeeAmount`	String	Montant de la commission de l'émetteur.
Facultatif	`paymentSpecificData`	Object	Données spécifiques du paiement.
Facultatif	paymentSpecificData.`f57`	String	Champ spécial 57.
Facultatif	paymentSpecificData.`f58`	String	Champ spécial 58.
Facultatif	paymentSpecificData.`f59`	String	Champ spécial 59.
Facultatif	paymentSpecificData.`f60`	String	Champ spécial 60.
Facultatif	paymentSpecificData.`f61`	String	Champ spécial 61.
Facultatif	paymentSpecificData.`f62`	String	Champ spécial 62.
Facultatif	paymentSpecificData.`f63`	String	Champ spécial 63.
Facultatif	paymentSpecificData.`f64`	String	Champ spécial 64.
Facultatif	paymentSpecificData.`f65`	String	Champ spécial 65.
Facultatif	paymentSpecificData.`f66`	String	Champ spécial 66.
Facultatif	paymentSpecificData.`f67`	String	Champ spécial 67.
Facultatif	paymentSpecificData.`f68`	String	Champ spécial 68.
Facultatif	paymentSpecificData.`f69`	String	Champ spécial 69.
Facultatif	paymentSpecificData.`f70`	String	Champ spécial 70.
Facultatif	paymentSpecificData.`f71`	String	Champ spécial 71.
Facultatif	paymentSpecificData.`f72`	String	Champ spécial 72.
Facultatif	paymentSpecificData.`f73`	String	Champ spécial 73.

Exemple de réponse

{
  "systemTraceAuditNumber" : 51106,
  "paymentSpecificData" : {
    "f61" : "f61",
    "f72" : "f72",
    "f60" : "f60",
    "f71" : "f71",
    "f63" : "f63",
    "f62" : "f62",
    "f73" : "f73",
    "f65" : "f65",
    "f64" : "f64",
    "f67" : "f67",
    "f66" : "f66",
    "f58" : "f58",
    "f69" : "f69",
    "f57" : "f57",
    "f68" : "f68",
    "f59" : "f59",
    "f70" : "f70"
  },
  "acquirerFeeAmount" : "acquirerFeeAmount",
  "processingCode" : 170000,
  "issuerFeeAmount" : "issuerFeeAmount",
  "localTransactionDate" : "2000-01-23T04:56:07.000+00:00",
  "otp" : "otp",
  "authorizationIdResponse" : "123ABC",
  "responseCode" : 00,
  "rrn" : 987654321987,
  "uniqueReferenceNumber" : "uniqueReferenceNumber"
}

p2pTransfer

Virement p2p de carte à carte.

Paramètres de la demande

Obligatoire	Nom	Type	Description
Facultatif	`preAuthorization`	Boolean	Indicateur de pré-autorisation.
Obligatoire	`sourceCardIdentification`	Object	Paramètres d'identification de la carte pour la carte source. Pour obtenir des informations plus détaillées sur les autres options d'identification des cartes qui peuvent être utilisées dans un projet réel, et non dans cette aire de test, consultez la description de createVirtualCard.
Obligatoire	sourceCardIdentification.`cardNumber`	String	Numéro de carte. Vous l'obtiendrez dans la réponse CreateVirtualCard().
Obligatoire	sourceCardIdentification.`expDate`	String	Date d'expiration de la carte. Format AAAANNM.
Facultatif	sourceCardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`cardId`	String	Identifiant de carte. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`plasticNumber`	Integer	Numéro de plastique. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`phoneNumber`	String	Téléphone du client. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`cardholderId`	String	Identifiant du porteur de carte. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`customerId`	String	ID client. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`customerNumber`	String	Numéro de client dans SVB02. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`barCode`	String	Code-barres. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`cvv2`	String	CVV2. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`token`	String	Token. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`cardTypeCode`	String	Code de type de carte. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`email`	String	Courrier électronique. Pas pour l'aire de test.
Facultatif	sourceCardIdentification.`institutionId`	String	Identifiant interne d'établissement. Pas pour l'aire de test.
Obligatoire	`destinationCardIdentification`	Object	Paramètres d'identification de la carte de crédit. Pour obtenir des informations plus détaillées sur les autres options d'identification des cartes qui peuvent être utilisées dans un projet réel, et non dans cette aire de test, consultez la description de createVirtualCard.
Obligatoire	destinationCardIdentification.`cardNumber`	String	Numéro de carte. Vous l'obtiendrez dans la réponse CreateVirtualCard().
Facultatif	destinationCardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Pas pour l'aire de test.
Facultatif	destinationCardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Pas pour l'aire de test.
Facultatif	destinationCardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Pas pour l'aire de test.
Facultatif	destinationCardIdentification.`cardId`	String	Identifiant de carte. Pas pour l'aire de test.
Facultatif	destinationCardIdentification.`expDate`	String	Date d'expiration de la carte. Pas pour l'aire de test.
Facultatif	destinationCardIdentification.`plasticNumber`	Integer	Numéro de plastique Pas pour l'aire de test.
Facultatif	destinationCardIdentification.`phoneNumber`	String	Téléphone du client. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`cardholderId`	String	Identifiant du porteur de carte. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`customerId`	String	ID du client. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`customerNumber`	String	Numéro du client dans SVB02. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`barCode`	String	Code-barres. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`cvv2`	String	CVV2. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`externalCardId`	String	Identifiant de carte dans le système externe de la banque. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`token`	String	Token. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`cardTypeCode`	String	Code de type de carte. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`email`	String	Courrier électronique. Pas pour la plateforme de test.
Facultatif	destinationCardIdentification.`institutionId`	String	Identifiant interne de l'établissement. Pas pour la plateforme de test.
Obligatoire	`amount`	Integer	Montant.
Obligatoire	`currency`	Integer	Devise. Code numérique de devise ISO 4217. Utilisez « 978 » pour la plateforme de test.
Facultatif	`sourceAccountNumber`	String	Numéro de carte depuis laquelle le débit des fonds est effectué. Pas pour la plateforme de test.
Facultatif	`destinationAccountNumber`	String	Numéro de carte sur laquelle le crédit est effectué. Pas pour la plateforme de test.
Facultatif	`tds`	Object	Paramètres de transaction 3DS. Pas pour la plateforme de test.
Facultatif	tds.`xid`	String	Identifiant de transaction VISA 3DS. Pas pour la plateforme de test.
Facultatif	tds.`cavv`	String	Valeur de vérification d'authentification VISA. Pas pour la plateforme de test.
Facultatif	tds.`ucaf`	String	Champ d'authentification universelle Mastercard. Pas pour la plateforme de test.
Facultatif	tds.`authenticationIndicator`	String	Type d'authentification de transaction de commerce électronique. Valeurs possibles : [NOT_PERFORMED, TDS_MERCHANT_ONLY, TDS_PERFORMED, ADDITIONAL_PROTOCOL_USED, RECURRENT_PAYMENT_AUTH]. Pas pour la plateforme de test.
Obligatoire	`senderReceiverInfo`	Object	Information sur l'expéditeur et le destinataire du paiement. Pas pour la plateforme de test.
Obligatoire	senderReceiverInfo.`senderName`	String	Nom de l'expéditeur au format « Nom de famille, Prénom ».
Obligatoire	senderReceiverInfo.`senderAddress`	String	Adresse de l'expéditeur.
Facultatif	senderReceiverInfo.`senderCity`	String	Ville de l'expéditeur. Pas pour la plateforme de test.
Facultatif	senderReceiverInfo.`senderCountry`	String	Code pays de l'expéditeur. Pas pour la plateforme de test.
Facultatif	senderReceiverInfo.`senderPostalCode`	String	Code postal de l'expéditeur. Pas pour la plateforme de test.
Facultatif	senderReceiverInfo.`receiverName`	String	Nom du destinataire au format « Nom de famille, Prénom ». Pas pour la plateforme de test.
Facultatif	`pointOfServiceDataCode`	String	Ensemble de codes définissant les capacités du terminal, les paramètres de son environnement et l'utilisation des moyens de sécurité pendant la transaction. Pas pour la plateforme de test.
Obligatoire	`pointOfServiceConditionCode`	String	Code définissant les conditions de réalisation de la transaction au point de service. N'importe quel texte.
Facultatif	`cardAcceptorParameters`	Object	Paramètres du terminal. Pas pour la plateforme de test.
Facultatif	cardAcceptorParameters.`terminalIdentification`	String	Identifiant du terminal. Pas pour la plateforme de test.
Facultatif	cardAcceptorParameters.`merchantIdentification`	String	Identifiant du marchand. Pas pour la plateforme de test.
Facultatif	cardAcceptorParameters.`merchantType`	String	Code de catégorie du marchand. Pas pour la plateforme de test.
Facultatif	cardAcceptorParameters.`nameAndLocation`	String	Adresse d'emplacement du terminal. Pas pour la plateforme de test.
Facultatif	`securityLevelIndicator`	String	Indicateur du niveau de sécurité. Pas pour la plateforme de test.
Facultatif	`originalTransactionParameters`	Object	Paramètres de la transaction d'origine. Doit être inclus dans la demande de vérification du statut de la transaction. Pas pour la plateforme de test.
Facultatif	originalTransactionParameters.`systemTraceAuditNumber`	Integer	Numéro d'enregistrement d'audit. Pas pour la plateforme de test.
Facultatif	originalTransactionParameters.`localTransactionDate`	DateTime	Date de transaction. Pas pour la plateforme de test.
Facultatif	originalTransactionParameters.`rrn`	String	Identifiant externe RNN. Pas pour la plateforme de test.
Facultatif	`posCardholderPresence`	Integer	Type de présence du porteur de carte au point de service. Pas pour la plateforme de test.
Facultatif	`businessApplicationIdentifier`	String	Identifiant du type de transaction MC. Pas pour la plateforme de test.

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/p2PTransfer \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification": {
    "cardNumber": 4140050021658271,
    "expDate": 202512
  },
  "amount": 10000,
  "currency": 978,
  "senderReceiverInfo": {
    "senderName": "Tor, John",
    "senderAddress": "New York, USA"
  },
  "pointOfServiceDataCode": 810
}'

Paramètres de réponse

Obligation	Nom	Type	Description
Obligatoire	`responseCode`	String	Code d'achèvement de l'opération. « 00 » signifie succès.
Obligatoire	`processingCode`	String	Code de traitement.
Obligatoire	`systemTraceAuditNumber`	Integer	Numéro d'enregistrement d'audit
Obligatoire	`localTransactionDate`	DateTime	Date de transaction. Format : date-heure
Obligatoire	`rrn`	String	Identifiant externe RNN.
Facultatif	`authorizationIdResponse`	String	Identifiant d'autorisation.
Facultatif	`paymentSpecificData`	Object	Données spéciales sur le paiement.

Exemple de réponse

{
        "responseCode": "00",
        "processingCode": "490000",
        "systemTraceAuditNumber": 620400,
        "localTransactionDate": "2021-09-23T14:40:05",
        "rrn": "000000154799",
        "authorizationIdResponse": "154801",
        "paymentSpecificData": {}
    }

getOrderDetails

Obtenir des informations détaillées sur l'ordre de paiement.

Paramètres de demande

Obligatoire	Nom	Type	Description
Obligatoire	`orderId`	Long	Identifiant de l'ordre de paiement

Exemple de demande

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getOrderDetails \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "orderId": 2343
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`transactionList`	Object	Liste des transactions.
Obligatoire	transactionList.`merchantId`	String	Identifiant du vendeur.
Obligatoire	transactionList.`terminalId`	String	Identifiant du terminal.
Obligatoire	transactionList.`transactionDate`	DateTime	Date/heure de la transaction.
Facultatif	transactionList.`cardNumber`	String	Numéro de carte.
Facultatif	transactionList.`transactionAmount`	Integer	Montant de la transaction.
Facultatif	transactionList.`transactionCurrency`	Integer	Code de devise de la transaction
Facultatif	transactionList.`submittedAmount`	Integer	Montant demandé.
Facultatif	transactionList.`submittedCurrency`	Integer	Devise demandée
Facultatif	transactionList.`authorizationCode`	String	Code d'autorisation.
Facultatif	transactionList.`cashbackAmount`	Integer	Montant du cashback.
Facultatif	transactionList.`transactionType`	String	Type de transaction.
Facultatif	transactionList.`networkType`	String	Type de réseau.
Facultatif	transactionList.`cardType`	String	Type de carte.
Facultatif	transactionList.`orderNumber`	String	Numéro de l'ordre de paiement.

Exemple de réponse

{
  "transactionList" : [ {
    "terminalId" : "00999201",
    "transactionDate" : "2000-01-23T04:56:07.000+00:00",
    "merchantId" : "M000001",
  } ]
}

getPaymentOrders

Obtenir la liste des ordres de paiement.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`merchantNumber`	String	Numéro du marchand.
Obligatoire	`institutionId`	String	Identifiant interne de l'établissement.
Obligatoire	`period`	Object	Période de temps.
Facultatif	period.`start`	DateTime	Date de début.
Facultatif	period.`end`	DateTime	Date de fin.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getPaymentOrders \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "merchantNumber" : "M000001",
  "institutionId": "3012",
  "period": {
    "start": "2020-04-20",
    "end": "2020-04-30"
  }
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`orderList`	Object	Liste des ordres de paiement.
Obligatoire	orderList.`id`	Long	Identifiant de l'ordre de paiement
Facultatif	orderList.`eventDate`	DateTime	Date de l'événement.
Facultatif	orderList.`purpose`	String	Objectif.
Facultatif	orderList.`currency`	Integer	Code de devise
Facultatif	orderList.`amount`	Integer	Montant.
Facultatif	orderList.`status`	String	Date de dernière mise à jour du statut.
Facultatif	orderList.`orderNumber`	String	Numéro de l'ordre de paiement.

Exemple de réponse

{
  "orderList" : [ {
    "amount" : 1,
    "orderNumber" : "2344552",
    "id" : 3,
    "eventDate" : "2020-04-30",
  } ]
}

getTransactionDetails

Obtenez les détails de la transaction.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`utrnno`	Long	Identifiant de transaction dans SVFE
Facultatif	`reversal`	Boolean	Indicateur de reversal.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getTransactionDetails \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "utrnno": 2203248,
  "reversal": true
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`transaction`	Object	Paramètres de transaction.
Facultatif	transaction.`boWriteOffDate`	DateTime	Heure et date de débit SVBO.
Obligatoire	transaction.`authorizationDate`	DateTime	Date/heure d'autorisation.
Obligatoire	transaction.`transactionType`	String	Type de transaction.
Obligatoire	transaction.`operationDirection`	String	Direction de l'opération. Valeurs possibles : [CREDIT, DEBIT, NOOP]
Obligatoire	transaction.`amount`	Integer	Montant de la transaction.
Obligatoire	transaction.`currency`	Integer	Devise de l'opération
Obligatoire	transaction.`amountInAccountCurrency`	Integer	Montant de la transaction dans la devise du compte.
Obligatoire	transaction.`utrnno`	Long	Identifiant de transaction dans SVFE
Facultatif	transaction.`boUtrnno`	Long	Identifiant de transaction dans SVBO.
Facultatif	transaction.`transactionDescription`	String	Description de la transaction.
Facultatif	transaction.`feeDirection`	String	Direction de commission. Valeurs possibles : [CREDIT, DEBIT, NOOP]
Facultatif	transaction.`acquireFeeAmount`	Integer	Montant de commission acquéreur, calculé pour l'opération SVFE.
Facultatif	transaction.`feIssuerFeeAmount`	Integer	Montant de commission émetteur, calculé pour le fonctionnement SVFE.
Facultatif	transaction.`boIssuerFeeAmount`	Integer	Montant de commission émetteur, calculé pour l'opération SVBO.
Facultatif	transaction.`mcc`	Long	MCC.
Facultatif	transaction.`merchantCountry`	String	Pays du marchand.
Facultatif	transaction.`merchantCity`	String	Ville du marchand.
Facultatif	transaction.`merchantName`	String	Nom du marchand.
Facultatif	transaction.`merchantId`	String	Identifiant du vendeur.
Facultatif	transaction.`terminalAddress`	String	Adresse du terminal.
Facultatif	transaction.`posDataCode`	String	Code de données POS.
Facultatif	transaction.`authorizationIdResponse`	String	Identifiant d'autorisation.
Facultatif	transaction.`reversalDate`	DateTime	Date/heure de reversal.
Facultatif	transaction.`reversal`	Boolean	Indicateur de reversal.
Facultatif	transaction.`requestAmount`	Integer	Montant demandé pour la transaction.
Facultatif	transaction.`terminalId`	String	Identifiant du terminal.
Facultatif	transaction.`payId`	String	Identifiant assigné par le fournisseur de services.

Exemple de réponse

{
        "transaction": {
          "authorizationDate": "2015-04-09T11:15:35+04:00",
          "transactionType": 774,
          "operationDirection": "debit",
          "amount": 10000,
          "currency": 978,
          "amountInAccountCurrency": 0,
          "utrnno": 2203248,
          "transactionDescription": "POS purchase",
          "feeDirection": "debit",
          "acquireFeeAmount": 0,
          "feIssuerFeeAmount": 0,
          "mcc": 5999,
          "merchantCountry": "NLD",
          "merchantCity": "NETHERLANDS1234512345123451234512345",
          "merchantName": "PREDPRINIMATEL",
          "merchantId": "M999101",
          "terminalAddress": "MERCHANT2 NLD NETHERLANDS ELANDSGRACHT 50/A",
          "authorizationIdResponse": 0,
          "requestAmount": 10,
          "terminalId": 1
        }
      }

getTransactions

Obtenir l'historique des transactions pour une carte spécifique.

Paramètres de requête

Obligatoire	Nom	Type	Description
Obligatoire	`cardIdentification`	Object	Paramètres d'identification de la carte. Pour obtenir des informations plus détaillées sur d'autres variantes d'identification des cartes, qui peuvent être utilisées dans un projet réel, et non dans cette plateforme de test, consultez la description de createVirtualCard.
Obligatoire	cardIdentification.`cardNumber`	String	Numéro de la carte. Vous l'obtiendrez dans la réponse CreateVirtualCard().
Facultatif	cardIdentification.`encryptedCardNumber`	ByteArray	Numéro de carte chiffré. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardNumberMask`	String	Numéro de carte masqué. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardLastDigitMask`	String	Derniers chiffres du numéro de carte. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardId`	String	Identifiant de la carte. Pas pour la plateforme de test.
Facultatif	cardIdentification.`expDate`	String	Date d'expiration de la carte. Pas pour la plateforme de test.
Facultatif	cardIdentification.`plasticNumber`	Integer	Numéro de plastique. Pas pour la plateforme de test.
Facultatif	cardIdentification.`phoneNumber`	String	Téléphone du client. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardholderId`	String	Identifiant du porteur de carte. Pas pour la plateforme de test.
Facultatif	cardIdentification.`customerId`	String	ID du client. Pas pour la plateforme de test.
Facultatif	cardIdentification.`customerNumber`	String	Numéro du client dans SVB02. Pas pour la plateforme de test.
Facultatif	cardIdentification.`barCode`	String	Code-barres. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cvv2`	String	CVV2. Pas pour la plateforme de test.
Facultatif	cardIdentification.`externalCardId`	String	Identifiant de la carte dans le système externe de la banque. Pas pour la plateforme de test.
Facultatif	cardIdentification.`token`	String	Token. Pas pour la plateforme de test.
Facultatif	cardIdentification.`cardTypeCode`	String	Code du type de carte. Pas pour la plateforme de test.
Facultatif	cardIdentification.`email`	String	Courrier électronique. Pas pour la plateforme de test.
Facultatif	cardIdentification.`institutionId`	String	Identifiant interne de l'établissement. Pas pour la plateforme de test.
Obligatoire	`period`	Object	Période de temps.
Facultatif	period.`start`	DateTime	Date de début. Format AAAA-MM-JJ.
Facultatif	period.`end`	DateTime	Date de fin. Format AAAA-MM-JJ.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getTransactions \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification": {
    "cardId": 100000000873
  },
  "period": {
    "start": "2020-04-01",
    "end": "2020-05-01"
  }
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	`transactions`	Object	Transactions.
Facultatif	transactions.`boWriteOffDate`	DateTime	Heure et date de débit SVBO. Pas pour la plateforme de test.
Obligatoire	transactions.`authorizationDate`	DateTime	Date/heure d'autorisation.
Obligatoire	transactions.`transactionType`	String	Type de transaction.
Obligatoire	transactions.`operationDirection`	String	Direction de la transaction. Valeurs possibles : [CREDIT, DEBIT, NOOP]
Obligatoire	transactions.`amount`	Integer	Montant de la transaction.
Obligatoire	transactions.`currency`	Integer	Devise.
Obligatoire	transactions.`amountInAccountCurrency`	Integer	Montant de la transaction dans la devise du compte.
Obligatoire	transactions.`utrnno`	Long	Identifiant de la transaction dans SVFE (identifiant interne SmartVista).
Facultatif	transactions.`boUtrnno`	Long	Identifiant de la transaction dans SVBO. (identifiant interne SmartVista).
Facultatif	transactions.`transactionDescription`	String	Description de la transaction.
Optionnel	transactions.`feeDirection`	String	Direction de la commission. Valeurs possibles : [CREDIT, DEBIT, NOOP]
Optionnel	transactions.`acquireFeeAmount`	Integer	Montant de la commission de l'acquéreur.
Optionnel	transactions.`feIssuerFeeAmount`	Integer	Montant de la commission en ligne de l'émetteur.
Optionnel	transactions.`boIssuerFeeAmount`	Integer	Montant de la commission hors ligne de l'émetteur.
Optionnel	transactions.`mcc`	Long	MCC.
Optionnel	transactions.`merchantCountry`	String	Pays du marchand.
Optionnel	transactions.`merchantCity`	String	Ville du marchand.
Optionnel	transactions.`merchantName`	String	Nom du marchand.
Optionnel	transactions.`merchantId`	String	Identifiant du vendeur.
Optionnel	transactions.`terminalAddress`	String	Adresse du terminal.
Optionnel	transactions.`posDataCode`	String	Code de données POS.
Optionnel	transactions.`authorizationIdResponse`	String	Identifiant d'autorisation.
Optionnel	transactions.`reversalDate`	DateTime	Date/heure d'annulation.
Optionnel	transactions.`reversal`	Boolean	Indicateur d'annulation.
Optionnel	transactions.`requestAmount`	Integer	Montant demandé pour la transaction.
Optionnel	transactions.`terminalId`	String	Identifiant du terminal.
Optionnel	transactions.`payId`	String	Identifiant assigné par le fournisseur de services.

Exemple de réponse

{
        "transactions": [
            {
                "authorizationDate": "2021-09-23T14:35:24",
                "transactionType": "578",
                "operationDirection": "NOOP",
                "amount": 0,
                "currency": 0,
                "amountInAccountCurrency": 0,
                "utrnno": 154793,
                "transactionDescription": "Change limit",
                "feeDirection": "DEBIT",
                "acquireFeeAmount": 0,
                "feIssuerFeeAmount": 0,
                "mcc": 6012,
                "merchantCountry": "NLD",
                "merchantCity": "BPC TEST ADDRESS N 2",
                "merchantName": "Test Mobile Bank",
                "merchantId": "TEST__MB",
                "terminalAddress": "APIGATE  FE  TEST BPC TEST ADDRESS N 1",
                "posDataCode": "600550U00110",
                "reversal": false,
                "requestAmount": 0,
                "terminalId": "TEST__MB",
                "internalResponseCode": -1
            },
            {
                "authorizationDate": "2021-09-23T14:37:36",
                "transactionType": "493",
                "operationDirection": "NOOP",
                "amount": 0,
                "currency": 0,
                "amountInAccountCurrency": 0,
                "utrnno": 154796,
                "transactionDescription": "Card blocking",
                "feeDirection": "DEBIT",
                "acquireFeeAmount": 0,
                "feIssuerFeeAmount": 0,
                "mcc": 6012,
                "merchantCountry": "NLD",
                "merchantCity": "BPC TEST ADDRESS N 2",
                "merchantName": "Test Mobile Bank",
                "merchantId": "TEST__MB",
                "terminalAddress": "APIGATE  FE  TEST BPC TEST ADDRESS N 1",
                "posDataCode": "600550U00110",
                "authorizationIdResponse": "154796",
                "reversal": false,
                "requestAmount": 0,
                "terminalId": "TEST__MB",
                "internalResponseCode": -1
            },
            {
                "authorizationDate": "2021-09-23T14:38:26",
                "transactionType": "672",
                "operationDirection": "NOOP",
                "amount": 0,
                "currency": 0,
                "amountInAccountCurrency": 0,
                "utrnno": 154797,
                "transactionDescription": "Card status change",
                "feeDirection": "DEBIT",
                "acquireFeeAmount": 0,
                "feIssuerFeeAmount": 0,
                "mcc": 6012,
                "merchantCountry": "NLD",
                "merchantCity": "BPC TEST ADDRESS N 2",
                "merchantName": "Test Mobile Bank",
                "merchantId": "TEST__MB",
                "terminalAddress": "APIGATE  FE  TEST BPC TEST ADDRESS N 1",
                "posDataCode": "600550U00110",
                "authorizationIdResponse": "154797",
                "reversal": false,
                "requestAmount": 0,
                "terminalId": "TEST__MB",
                "internalResponseCode": -1
            },
            {
                "authorizationDate": "2021-09-23T14:39:15",
                "transactionType": "760",
                "operationDirection": "CREDIT",
                "amount": 10000,
                "currency": 978,
                "amountInAccountCurrency": 10000,
                "utrnno": 154798,
                "transactionDescription": "Credit account presentment",
                "feeDirection": "CREDIT",
                "acquireFeeAmount": 0,
                "feIssuerFeeAmount": 0,
                "mcc": 6012,
                "merchantCountry": "NLD",
                "merchantCity": "BPC TEST ADDRESS N 2",
                "merchantName": "Test Mobile Bank",
                "merchantId": "TEST__MB",
                "terminalAddress": "APIGATE  FE  TEST BPC TEST ADDRESS N 1",
                "posDataCode": "600550U00110",
                "authorizationIdResponse": "154798",
                "reversal": false,
                "requestAmount": 10000,
                "terminalId": "TEST__MB",
                "internalResponseCode": -1
            },
            {
                "authorizationDate": "2021-09-23T14:40:05",
                "transactionType": "781",
                "operationDirection": "DEBIT",
                "amount": 1000,
                "currency": 978,
                "amountInAccountCurrency": 1000,
                "utrnno": 154800,
                "transactionDescription": "P2P Debit part",
                "feeDirection": "DEBIT",
                "acquireFeeAmount": 0,
                "feIssuerFeeAmount": 0,
                "mcc": 6012,
                "merchantCountry": "NLD",
                "merchantCity": "BPC TEST ADDRESS N 2",
                "merchantName": "Test Mobile Bank",
                "merchantId": "TEST__MB",
                "terminalAddress": "APIGATE  FE  TEST BPC TEST ADDRESS N 1",
                "posDataCode": "600550U00110",
                "authorizationIdResponse": "154800",
                "reversal": false,
                "requestAmount": 1000,
                "terminalId": "TEST__MB",
                "internalResponseCode": -1
            },
            {
                "authorizationDate": "2021-09-23T14:40:05",
                "transactionType": "689",
                "operationDirection": "NOOP",
                "amount": 1000,
                "currency": 978,
                "amountInAccountCurrency": 1000,
                "utrnno": 154799,
                "transactionDescription": "Card-to-Card money transfer",
                "feeDirection": "DEBIT",
                "acquireFeeAmount": 0,
                "feIssuerFeeAmount": 0,
                "mcc": 6012,
                "merchantCountry": "NLD",
                "merchantCity": "BPC TEST ADDRESS N 2",
                "merchantName": "Test Mobile Bank",
                "merchantId": "TEST__MB",
                "terminalAddress": "APIGATE  FE  TEST BPC TEST ADDRESS N 1",
                "posDataCode": "600550U00110",
                "authorizationIdResponse": "154801",
                "reversal": false,
                "requestAmount": 1000,
                "terminalId": "TEST__MB",
                "internalResponseCode": -1
            }
        ]
    }

getTransactionCurrencies

Obtenir la devise des transactions.

Exemple de requête

curl --request POST \
--url https://dev.bpcbt.com/v1/apigate/ws/rest/getTransactionCurrencies \
--header 'Authorization: Basic YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cardIdentification" : {
    "cardId" : "1000"
  }
}'

Paramètres de réponse

Obligatoire	Nom	Type	Description
Obligatoire	transaction.`currency`	Integer	Code de devise

Exemple de réponse

{
  "currencies": [
    978
  ]
}

Catégories:

Banque API V1