Card Collections

Card Collections allows businesses to accept card payments from their customers through LedgerBlock.

The card collection flow is designed to securely process card details, initialize a payment, handle any required customer authentication, and complete the transaction.

How Card Collection Works

A typical card collection follows these stages:

1. Initialize the collection

   • Create a card collection request with the required transaction and customer information.
   • LedgerBlock returns the information required to continue the payment.

2. Secure the card details

   • Card information is encrypted before it is transmitted for processing.
   • Sensitive card information should not be exposed or stored by the merchant application.

3. Complete the payment

   • Depending on the card and transaction, additional authentication may be required.
   • This can include OTP, PIN, or 3D Secure (3DS).

4. Receive the final transaction status

   • Once the required steps are completed, the transaction is finalized.
   • Use the transaction response and/or webhook notification to determine the final payment status.

For implementation details, see the [Card Collection API Reference].

Encryption, Initialization, and Completion

Encryption

Card details must be handled securely before they are submitted for processing.

LedgerBlock's card collection flow uses encryption to protect sensitive card information during the collection process.

See the [Card Encryption API Reference] for the required encryption method and request format.

Initialization

After the card information has been securely prepared, initialize the card collection using the required transaction details.

The initialization step creates the payment transaction and determines whether additional customer authentication is required.

See the [Initialize Card Collection API Reference] for the request and response fields.

Completion

A card collection may require additional steps before the transaction can be completed.

After the required authentication step has been successfully completed, submit the required completion request.

See the [Complete Card Collection API Reference] for the implementation details.

OTP, PIN, and 3DS Completion

Some card transactions require additional authentication before they can be completed.

OTP

Where OTP authentication is required, the customer provides the OTP received from their card issuer.

The OTP is then submitted through the appropriate LedgerBlock completion flow.

PIN

Some transactions may require the customer's card PIN as part of the authentication process.

The PIN should only be handled through the supported LedgerBlock flow and must not be stored by the merchant.

3D Secure (3DS)

3D Secure provides an additional authentication layer for supported card transactions.

When 3DS is required, the customer is redirected or presented with the required authentication experience. Once authentication is successful, the transaction can proceed to completion.

The exact completion flow depends on the response returned during initialization.

For implementation details, see the [3DS Card Collection API Reference].

Card Collection Fees

Card collection fees are charged based on the applicable card transaction pricing.

Note: Fees may vary based on the transaction type, card type, currency, or other applicable processing conditions. Refer to the current LedgerBlock pricing for the applicable charges.

API References

Use the following API references when integrating Card Collections:

• [Encrypt Card]
• [Initialize Card Collection]
• [Complete Card Collection]
• [Card Collection Status]
• [Card Collection Webhooks]