CSP On-Demand Developer Guide

This is our legacy SOAP API that is currently in use with existing partners

🚧

Legacy

Conferma recommends new partners connect via the RESTful API. Existing partners can refer to this Developer Guide to support existing connections.

View the guide here: https://www.conferma.com/app/uploads/2024/03/CSP-On-Demand-API-Developer-Guide.pdf

Quick Reference:

Process	Description	Page Number
Generic Process	The Generic Process is an immediate deployment. The Generic Process is the simplest implementation to any development where there is a necessity to place a traceable virtual card into the payment process. Cards can be used in circumstances such as accommodation, air, car rental and rail purchasing.	13
Hotel Process	The Hotel Process is an immediate deployment. This mode of immediate deployment supports a structure of hotel bookings. The data submitted is structured around hotel bookings and will be represented as so in both the CSP Matching & Reconciliation tool and reports. If you intend Conferma to send faxes for hotel bookings, you must utilise this mode.	19
Air Process	Air card deployment is an immediate deployment. This mode of immediate deployment supports a structure of air bookings. The data submitted is structured around air and will be represented as such in both the CSP Matching & Reconciliation tool and reports. In addition these deployments will be supplemented with card transaction level 3 data (provided by the card provider where possible).	28
Rail Process	Rail card deployment is an immediate deployment. This mode of immediate deployment supports a structure for rail bookings. The data submitted is structured around rail and will be represented as such in both the CSP Matching & Reconciliation tool and reports. In addition these deployments will be supplemented with card transaction level 3 data (provided by the card provider where possible).	33
Car Rental Process	A Car Rental card deployment is an immediate deployment. This mode of immediate deployment supports a structure for car rental purchases. The data submitted is structured around car rental and will be represented as such in both the CSP Matching & Reconciliation tool and reports. In addition these deployments will be supplemented with card transaction level 3 data (provided by the card provider where possible).	39
Get Deployment	Once an immediate deployment has been successful, the selected payment card can be retrieved from the system at any time.	45
Update Deployment	Once an immediate deployment has been successful, consumers can update the deployment. Whether consumers are using the Generic, Air, Car Rental, Hotel or Rail GetCard, this method is to be used. This method allows consumers to change varied values on the deployment such as card check-out periods, status, amounts, identifiers, supplier information, air and hotel data. Consumers cannot change the deployment type. This method supersedes UpdateDeploymentStatus web method.	50
Get BIN	The BIN range of a virtual card represents the first six digits of a virtual card’s Primary Account Number (PAN). The BIN range identifies the card issuer and type of card being used. In some use cases where a final purchase price is impacted by the type of card used, it may be required check the BIN range being used for a particular Card Pool without generating a virtual card. The GetBIN web method enables this. The standard Card Pool credentials and Spend Type should be sent in the message to return the correct BIN range. In the main, a Card Pool will only generate cards of a single BIN range. An exception case exists for AirPlus International when generating a virtual card for Air. Additional validation takes place on the Conferma system to check if the airline supports UATP. If so, a UATP BIN will be returned instead of a MasterCard. See AirPlus International UATP Switch section in the appendices for more information.	57
Get Card Activity	Dependent on Card Issuer capability, it is possible to retrieve the real-time authorisation data from the virtual card by Deployment ID. Visibility on card activity helps reduce the need to contact the Card Issuer regarding merchant billing queries.	58
Get Message Queue	If Conferma is being used for faxing, consumers can view the message delivery history of a particular deployment. These statuses can be managed via the GetMessageQueue web method.	60
Get Card Pool Balance	If a pre-funded virtual card product is being used, the balance of the funding account can be retrieved. Note: This operation is dependent on Card Issuer capability.	62