Alma

Alma is a leading provider of payment solutions, offering a wide range of services that enable businesses to process and manage digital payments. ALMA's solutions are designed to support various payment flows, including direct debit, authorization and capture, and asynchronous workflows.

Features

Integration type

Embed (no redirection)

Tokenization

No

Payment Flow

1-step payment flow : Capture (direct debit)

2-step payment flow : Authorization + Capture

3-step payment flow : Pending Authorization + Authorization + Capture (asynchronous)

Additional features

Information request and CIT

MIT

Server-to-server

How to test?

Basic test cards

Credentials	Yes Card	No Card
Card number	4242 4242 4242 4242	XXXXXXXXXXXXXXXXXXX
Expiry date	04/42	XXXXXXXXXXXXXXXXXXX
CVC	424	XXXXXXXXXXXXXXXXXXX

Data Mapping & Mandatory Fields

Below is the mapping between your Create Session request and the fields expected by this payment method.

Purse Session field	Mandatory
amount	Yes
order.redirection	Yes
order.reference	Yes
order.tax_amount	No
order.tax_lines	No
order.currency_code	Yes
customer.reference(Only for tokenization)	No
customer.company_name	No
customer.gender_code	No
customer.middle_name	No
customer.last_name	No
customer.birthdate	No
customer.ip	No
customer.billing_address.address_lines	No
customer.billing_address.city	No
customer.billing_address.postal_code	No
customer.billing_address.country_code	No
customer.billing_address.email	No
customer.billing_address.phone	No
customer.billing_address.mobile_phone	No
customer.billing_address.work_phone	No
customer.account.purchase_count_last_day	No
customer.account.purchase_count_last_six_months	No
customer.account.purchase_count_last_year	No
customer.account.different_card_count_last_day	No
customer.account.authentication_method	No
customer.account.prior_payment_authentication	No
customer.account.age_indicator	No
customer.account.update_date_time	No
customer.account.change_indicator	No
customer.account.creation_date_time	No
customer.account.password_update_date_time	No
customer.account.password_change_indicator	No
customer.account.three_ds_exemption	No
customer.account.challenge_indicator	No
shipments.amount	No
shipments.delivery_type_code	No
shipments.shipping_address.address_lines	No
shipments.shipping_address.city	No
shipments.shipping_address.postal_code	No
shipments.shipping_address.country_code	No
shipments.item_lines.type_code	No
shipments.item_lines.sku_reference	No
shipments.item_lines.name	No
shipments.item_lines.price	No
shipments.item_lines.quantity	No
shipments.item_lines.amount	No
shipments.item_lines.tax_lines.amount	No

Payment Labels

Label	Method	Payment type
alma	cb4x	primary

Actions

Status

PSP status	State	Code	Description
not_started	WAITING	WAITING_PARTNER_RESPONSE	Payment has been created but not started
scored_no	ERROR	FAILED	Payment in several installments is refused by Alma
scored_yes	WAITING	WAITING_PARTNER_RESPONSE	Payment in several installments has been accepted by Alma
scored_maybe	WAITING	WAITING_PARTNER_RESPONSE	Alma needs more information to decide whether to accept payment
in_progress	SUCCESS	SUCCEEDED	Payment in progress – at least one installment has been paid
paid	SUCCESS	SUCCEEDED	Payment is fully paid
ABORTED	ERROR	ABORTED_BY_CUSTOMER	Customer has aborted the payment
validation_error_missing_field	ERROR	BAD_REQUEST	Validation error, there's a field missing
validation_error_invalid_type	ERROR	BAD_REQUEST	Validation error, there's a field type that is incorrect
validation_error_invalid_value	ERROR	BAD_REQUEST	Validation error, there's an invalid value in your call
validation_error_too_short	ERROR	BAD_REQUEST	Validation error, the string in input is too short
validation_error_too_long	ERROR	BAD_REQUEST	Validation error, the string in input is too long
validation_error_too_many_request	PENDING	TECHNICAL_ISSUE_TO_CONTACT_PARTNER	You made too many request to the APIs, wait for a bit before retrying
validation_error_unique_violated	ERROR	BAD_REQUEST	You violated the unique constraint on a field
validation_error_merchant_cant_create_payments	ERROR	FAILED	You violated the unique constraint on a field
validation_error_incompatible_parameters	ERROR	BAD_REQUEST	There are incompatible parameters in your request
validation_error_unauthorized	ERROR	FAILED	Unauthorized to contact partner
validation_error_generic_error	ERROR	FAILED	A generic error occured, contact the partner before
validation_error_payment_already_captured	ERROR	BAD_REQUEST	The payment has been already captured
validation_error	ERROR	BAD_REQUEST	Validation error, data sent during API call are invalid
card_declined	ERROR	REJECTED_BANK	Card declined by the banking network
invalid_amount	ERROR	BAD_REQUEST	Invalid amount.
three_d_s_impossible	ERROR	TECHNICAL_ISSUE_TO_CONTACT_PARTNER	3D Secure - Refusal as authentication by the issuer is impossible
incorrect_cvc	ERROR	WRONG_CARD_DATA	Incorrect card CVC
incorrect_expiration_date	ERROR	WRONG_CARD_DATA	Incorrect card expiration date
incorrect_number	ERROR	WRONG_CARD_DATA	Incorrect card number
insufficient_funds	ERROR	INSUFFICIENT_FUNDS	Insufficient funds on account
expired_card	ERROR	CARD_EXPIRED	Expired card
missing_field	ERROR	BAD_REQUEST	Missing field
invalid_value	ERROR	BAD_REQUEST	Invalid value - Impossible to validate payment
SESSION_DATA_NOT_OK	ERROR	BAD_REQUEST	Session data doesn't meet the alma's requirements
SUCCESS	SUCCESS	SUCCEEDED	Successful operation
ERROR	ERROR	FAILED	Failed operation
UNKNOWN_PARTNER_ERROR	ERROR	FAILED	Received unexpected response from alma
PARTNER_RESPONSE_VALIDATION_FAILED	ERROR	FAILED	Partner response validation failed.
TIMEOUT	UNCERTAIN	TECHNICAL_ISSUE_TO_CONTACT_PARTNER	Timeout while contacting alma
PARTNER_SERVER_ERROR	UNCERTAIN	TECHNICAL_ISSUE_TO_CONTACT_PARTNER	Received internal server error from alma
PARTNER_BAD_GATEWAY	UNCERTAIN	TECHNICAL_ISSUE_TO_CONTACT_PARTNER	Received bad gateway error from alma
PARTNER_UNAVAILABLE	UNCERTAIN	TECHNICAL_ISSUE_TO_CONTACT_PARTNER	Received service unavailable error from alma
VERIFY_PARTNER_ERROR	UNCERTAIN	TECHNICAL_ISSUE_TO_CONTACT_PARTNER	Received 5XX server error from partner when calling verify
VERIFY_TIMEOUT	UNCERTAIN	TECHNICAL_ISSUE_TO_CONTACT_PARTNER	Timeout while contacting alma