Online Payments

Cartes Bancaires

Cartes Bancaires (CB) is a card interbank network in France that facilitates online purchase transactions. Cartes Bancaires transactions follow the general structure found in the Online Payments API documentation except for additional parameter requirements for network routing preferences and transactions including 3DS details .

Cartes Bancaires requires your consumer be provided the option to choose a network routing preference when using a CB co-branded card. Although network routing preference is provided, the cardholder is not required to select a routing preference to complete the purchase.

If the cardholder does not select a routing preference, you have the option of submitting your routing preference when submitting your request.
If no routing preference is included in your CB transaction request, the transaction is routed to Cartes Bancaires.

Note

For recurring CB payments refer to Online Payments API recurring transactions and note the additional CB field recurringNumber is required in the recurring payment request.
Submit merchant initiated (MIT) stored payments as outlined in the CB Cardholder Agreement - e.g., timeframes, fixed or variable amount.

The following fields are Cartes Bancaires specific request fields:

Cartes Bancaires specific request fields
Field name	Description
`paymentMethodType.card.preferredPaymentNetworkRoutingCode`	The transaction routing model preferred by the initiator. Valid values are: `VI` `MC` `CB`
`paymentMethodType.card.preferredRoutingInitiatorCode`	The initiator of the transaction routing model. Valid values are: `Merchant` `Consumer`
`recurring.recurringNumber`	Current sequence number of the total number of payment (recurring payments only).

The following fields are Cartes Bancaires specific response fields:

Cartes Bancaires specific response fields
Field name	Description
`cardType`	Field in the response indicating which Method of Payment was used to process the transaction. Valid value: CB
`cardTypeName`	Field in the response indicating the name of which card network processed the transaction. Valid values: CARTES_BANCAIRES

HTTP method: POST

Endpoint: /payments

Scenario: Cartes Bancaires payment transaction

Json

{
    "captureMethod": "NOW",
    "amount": 5000,
    "currency": "EUR",
    "initiatorType": "CARDHOLDER",
    "accountOnFile": "NOT_STORED",
    "isAmountFinal": true,
    "merchant": {
        "merchantSoftware": {
            "companyName": "Payment Company",
            "productName": "Application Name",
            "version": 1.235
        },
        "merchantCategoryCode": 4899
    },
    "paymentMethodType": {
        "card": {
            "accountNumber": "5071009999540002",
            "expiry": {
                "month": 5,
                "year": 2025
            },
            "cvv":"123",
            "isBillPayment": true,
            "authentication": {
                "walletAuthenticationMethod": "test-wlt-auth-method"
            }
        }
    },
    "merchantOrderNumber": "123456789012",
    "dynamicCVV2Timestamp": "2024-03-12T01:23:45.567Z",
    "accountHolder": {
        "referenceId": "ABC1234567891234567"
    }
}

Response:

Json

{
    "transactionId": "205f5882-cca5-4aff-9e9b-f9574835eb64",
    "requestId": "a48d6494-a6bd-4627-b67a-61875f66daa7",
    "transactionState": "CLOSED",
    "responseStatus": "SUCCESS",
    "responseCode": "APPROVED",
    "responseMessage": "Transaction approved by issuer.",
    "paymentMethodType": {
        "card": {
            "cardType": "CB",
            "cardTypeName": "CARTES_BANCAIRES",
            "isBillPayment": true,
            "maskedAccountNumber": "507100XXXXXX0002",
            "networkResponse": {
                "networkTransactionId": "1000000000045908363",
                "networkAccountUpdater": {
                    "networkResponseCode": "00"
                },
                "networkResponseCode": "00"
            },
            "authentication": {
                "walletAuthenticationMethod": "test-wlt-auth-method"
            }
        }
    },
    "captureMethod": "NOW",
    "captureTime": "2024-12-03T05:56:42.190Z",
    "initiatorType": "CARDHOLDER",
    "accountOnFile": "NOT_STORED",
    "isVoid": false,
    "transactionDate": "2024-12-03T05:56:42.190Z",
    "approvalCode": "218759",
    "hostMessage": "00",
    "isAmountFinal": true,
    "amount": 5000,
    "currency": "EUR",
    "remainingRefundableAmount": 5000,
    "remainingAuthAmount": 0,
    "merchantOrderNumber": "123456789012",
    "merchant": {
        "merchantId": "998408663762",
        "merchantSoftware": {
            "companyName": "Payment Company",
            "productName": "Application Name",
            "version": "1.235"
        },
        "merchantCategoryCode": "4899"
    },
    "paymentRequest": {
        "paymentRequestId": "205f5882-cca5-4aff-9e9b-f9574835eb64",
        "paymentRequestStatus": "CLOSED",
        "authorizations": [
            {
                "authorizationId": "205f5882-cca5-4aff-9e9b-f9574835eb64",
                "amount": 5000,
                "transactionStatusCode": "CAPTURED",
                "authorizationType": "INITIAL"
            }
        ],
        "captures": [
            {
                "captureId": "205f5882-cca5-4aff-9e9b-f9574835eb64",
                "amount": 5000,
                "transactionStatusCode": "CLOSED",
                "captureRemainingRefundableAmount": 5000
            }
        ]
    },
    "retryRequestId": "205f5882-cca5-4aff-9e9b-f9574835eb64"
}

3DS details

Recurring payments

Stored payments

Cartes Bancaires

Related