Create Card

post https://api.cert-confermapay.com/deployments/v1/deployments

Creates a new virtual card deployment.

Body Params

clientAccountCode

object

required

Conferma Pay VCN account identifier. This is the account or Card Pool that will be used to generate the VCN.

spendType

string

required

consumerReference

string | null

Reference provided by the consumer platform. This should be unique and can be used to identify a deployment by a third-party system reference such as a booking id or PO number.

supplierReference

string | null

Reference provided for the supplier/beneficiary. Typically, this would be a booking confirmation or invoice reference.

deploymentAmount

object

required

The amount object is used to capture a monetary value and currency code. The deployment amount will drive the maximum authorisation value permitted on the virtual card, excluding any tolerances or additional controls.

invoiceAmount

object

The invoice amount object is used to capture a monetary value and currency code. This can be used where the deployment amount required does not reflect the purchase value e.g. a tolerance or buffer may have been added to the deploymentAmount, or the invoice allows for a discount.

paymentRange

object

required

Open to spend period for the deployment VCN.

customer

object

customData

array of objects | null

Custom identifiers captured against the card deployment. Custom validation may be applied where custom data templates have been configured against the Card Pool.

customData

supplier

object

required

Vendor, merchant or beneficiary expected to charge the card or receive funds

hotel

object

Hotel booking details.

air

object

Flight booking data.

rail

object

Rail booking data.

transport

object

Ground transportation booking data.

travellers

array of objects | null

One or more travellers associated to the deployment. The use of travellers is spendType specific; this property may not be present for non-travel spend types.

travellers

ancillaries

array of objects | null

One or more ancillaries associated to the deployment. Ancillaries should be used to itemise additional spend items such as airline speedy boarding, baggage or wifi.
Any amount value provided as part of an ancillary item will be added to the VCN on top of the deploymentAmount.

ancillaries

serviceFees

array of objects | null

One or more service fees associated to the deployment.

serviceFees

pnr

object

GDS PNR locator data associated with the deployment.

isAdvancedPurchase

boolean | null

Advanced Purchase flag that can be used to open the VCN for immediate use.

straightThroughProcessingEnabled

boolean

paymentRequestFulfilmentRequests

array of objects | null

paymentRequestFulfilmentRequests

advancedCardControls

array of objects | null

It is possible to specify additional controls enabled by the connected card issuer platform. For a full list of controls available for your banking partner, contact the Conferma Pay Implementations Team.

advancedCardControls

timeZoneOffset

int32

UTC TimeZone Offset in minutes. Virtual card date controls are applied in UTC. Use the offset to accomodate your preferred timezone.

timeZone

string | null

Responses

Response body

object

deploymentId

int32

Unique identifier assigned to the card deployment at the point of creation.

status

string

Deployed NotUsed FailedWithSupplier CancelledWithSupplier CardDeploymentFailed NoCard AmendLimitChangeFailed PreDeployment All

contextualStatus

string

Active OpenToSpend AwaitingApproval Rejected RejectedByYou Cancelled Failed FailedWithSupplier Expired Completed

spendType

string

Unknown Generic Air Accommodation Rail Transport MultiType ServiceFee

creator

string | null

Full name of the user who created the deployment.

createdDateTime

date-time

Date and Time the card deployment was created.

platform

string | null

Name of the operating platform / system for which the deployment was created.

cardPool

object

cardPoolId

int32

guid

uuid

required

length between 0 and 36

name

string

required

length between 0 and 50

clientId

int32

deploymentMethodId

int32

cardProviderId

string | null

Unique Id for the Card Provider.

consumerReference

string | null

Reference provided by the consumer platform. This should be unique and can be used to identify a deployment by a third-party system reference such as a booking id or PO number.

supplierReference

string | null

Reference provided for the supplier/beneficiary. Typically, this would be a booing confirmation or invoice reference.

deploymentAmountDetails

object

deploymentAmount

object

convertedAmount

object

invoiceAmount

object

value

double | null

≥ 1

Monetary value fixed at 2 decimal places.

currency

string

required

length between 0 and 3

3-letter ISO currency code.

formatted

string | null

Formatted amount and currency.

paymentRange

object

Open to spend period for the deployment VCN.

startDate

date-time

Start of the open to spend period for the VCN. Must not exceed 2 years in the future, or 1 year in the past.

endDate

date-time

Closing date for the VCN open to spend period. Must occur on or after the startDate. Must not exceed 2 years in the future, or 1 year in the past.

card

object

Reference information for the VCN. Does not contain CHD.

providerName

string | null

Name of the issuing card provider.

providerLogoURL

string | null

Card provider logo Url for the Card. Use this when rendering card image.

backgroundImageURL

string | null

Background image Url for the Card. Use this when rendering card image.

hexColour

string | null

Background hex colour for the Card. Use this when rendering card image (where no background image is available).

last4Digits

string | null

Last 4 digits of the card number.

type

string | null

Card type / scheme identifier.

signPostName

string | null

Card product or signpost. Use this when rendering card image.

cardFontHexColour

string | null

Font Hex Colour on the card

disableCardImageGradient

boolean

Option to disable gradient on card image.

cardDetails

object

Full CHD and card image reference data.

providerName

string | null

Name of the issuing card provider.

providerLogoURL

string | null

Card provider logo Url for the Card. Use this when rendering card image.

backgroundImageURL

string | null

Background image Url for the Card. Use this when rendering card image.

hexColour

string | null

Background hex colour for the Card. Use this when rendering card image (where no background image is available).

last4Digits

string | null

Last 4 digits of the card number.

type

string | null

Card type / scheme identifier.

signPostName

string | null

Card product or signpost. Use this when rendering card image.

cardFontHexColour

string | null

Font Hex Colour on the card

disableCardImageGradient

boolean

Option to disable gradient on card image.

holderName

string | null

Card holder name.

number

string | null

Primary Account Number of the card.

expiryMonth

int32

2-digit month value for the visible expiry date of the card. Expires end.

expiryYear

int32

2-digit year value for the visible expiry date of the card. Expires end.

cvv

string | null

Card security number.

billingAddress

object

Address details.

customer

object

customerId

string | null

A unique identifier or customer number.

customerName

string | null

Name of the customer.

customData

array of objects | null

Custom identifiers captured against the card deployment.

customData

object

key

string | null

Name or label for the custom data field e.g. Cost Centre, Account Code, Project Number etc.

value

string | null

Custom data field value.

reportKey

string | null

A report reference that can be used to identify a data field for a third-party reporting system.

supplier

object

Vendor, merchant or beneficiary expected to charge the card or receive funds

int32 | null

Supplier ID.

name

string

required

length between 0 and 100

Name of the supplier, merchant or beneficiary.

address

object

Address details.

telephone

string | null

Supplier contact telephone number.

fax

string | null

Supplier fax number.

string | null

Supplier contact email address. This should always be provided when email payment communications are in use.

knownSupplierId

int32 | null

Conferma Pay Known Supplier ID.

consumerSupplierId

string | null

Reference for the supplier provided by the consumer platform. This should be unique and can be used to identify a supplier by a third-party system reference.

hotel

object

Hotel booking details.

bookingPlatform

string | null

Name of the booking provider e.g. a GDS, hotel platform or OTA.

checkInDate

date-time

required

Arrival date.

checkOutDate

date-time

required

Departure date. Must occur after the arrival date.

roomType

string | null

Room type.

rateInformation

string | null

Description of the rate booked.

cancellationPolicy

string | null

Hotel cancellation policy covering the rate booked.

cancellationReference

string | null

Cancellation reference. Can be provided if available for cancelled bookings.

contactName

string | null

Contact name for the booking.

careOfName

string | null

Use to provide the name of company the booking is for, if card account is held by agency. This will be presented on any payment communications to the hotel. UK TOMS requirement.

paymentInformation

string | null

Payment detail or instructions with regards to charging the card, e.g. "ROOM ONLY" or "DBB NO ALCOHOL". This will be presented on any payment communications to the hotel.

otherInformation

string | null

Any additional information. This will be presented on any payment communications to the hotel.

air

object

Flight booking data.

legs

array of objects | null

legs

object

airLegId

int32

legIndex

int32

required

Index can be used for reference and ordering.

departureAirportCode

string

required

length between 0 and 3

3-Letter IATA code for the departure airport.

departureAirportName

string | null

Departure airport name.

arrivalAirportCode

string

required

length between 0 and 3

3-Letter IATA code for the arrival airport.

arrivalAirportName

string | null

Arrival airport name.

departureDateTime

date-time

required

Date and time of departure.

arrivalDateTime

date-time

required

Date and time of arrival.

journeyId

string | null

Flight number.

supplierCode

string

required

length between 0 and 2

Airline carrier code.

ticketClass

string

required

Economy PremiumEconomy Business First

active

boolean

Flag used to identify active records.

airAncillaries

array of objects | null

Associated ancillaries for the leg e.g. Extra leg room.

airAncillaries

object

ancillaryId

int32

reference

string

required

length between 0 and 50

description

string

required

length between 0 and 200

amount

object

required

cancelled

boolean

created

date-time | null

amended

date-time | null

airAncillary

object

route

string | null

Consolidated flight data into a single 'route' string.

fareCalculation

string | null

tourCode

string | null

endorsementRestrictions

string | null

rail

object

Rail booking data.

legs

array of objects | null

legs

object

departureStation

string

required

length between 0 and 50

departureDateTime

date-time

required

arrivalStation

string

required

length between 0 and 50

arrivalDateTime

date-time

required

operator

string | null

class

string

Economy PremiumEconomy Business First

ticketDescription

string | null

transport

object

Ground transportation booking data.

vehicleModel

string | null

Model/specification of vehicle.

vehicleDescription

string | null

Description of vehicle.

registrationNumber

string | null

Vehicle registration number.

pickupDateTime

date-time

required

Pickup date and time.

pickupLocation

string

required

length between 0 and 50

Name of the pickup location.

pickupAddress

object

Address details.

dropoffDateTime

date-time

required

Drop off date and time.

dropoffLocation

string

required

length between 0 and 50

Name of the drop off location.

dropoffAddress

object

Address details.

driversAge

int32 | null

Age of the vehicle driver.

travellers

array of objects | null

One or more travellers associated to the deployment. The use of travellers is spendType specific; this property may not be present for non-travel spend types.

travellers

object

salutation

string | null

Person salutation or title e.g. Mr, Ms, Mrs

forename

string | null

First name of the traveller.

surname

string | null

Last name of the traveller.

emailAddress

string | null

Email address of the traveller.

ancillaries

array of objects | null

One or more ancillaries associated to the deployment. Ancillaries should be used to itemise additional spend items such as airline speedy boarding, baggage or wifi.

ancillaries

object

ancillaryId

int32

reference

string

required

length between 0 and 50

description

string

required

length between 0 and 200

amount

object

required

cancelled

boolean

created

date-time | null

amended

date-time | null

airAncillary

object

serviceFees

array of objects | null

One or more service fees associated to the deployment.

serviceFees

object

int32

description

string

required

length between 0 and 100

reference

string | null

chargeDate

date-time

required

amount

object

required

associatedDeploymentID

int32

workflow

object

requestId

int32

requestStatus

string

Pending Approved Rejected Completed

requestorUser

string | null

requestorEmailAddress

string | null

requestorTelephone

string | null

requestAmount

double

requestCurrency

string | null

requestStartDate

date-time

requestEndDate

date-time

requestDate

date-time

approver1UserId

int32 | null

approver1User

string | null

approver1EmailAddress

string | null

approver1Telephone

string | null

approval1DateTime

date-time | null

approver2UserId

int32 | null

approver2User

string | null

approver2EmailAddress

string | null

approver2Telephone

string | null

approval2DateTime

date-time | null

awaitingApprovalFromUserId

int32 | null

awaitingApprovalFromUser

string | null

awaitingApprovalFromEmailAddress

string | null

awaitingApprovalFromTelephone

string | null

userCanApprove

boolean

invoiceUploadCode

string | null

Unique document upload code for the Deployment.

invoiceUploadEmail

string | null

Unique email address that can be used to submit invoice or document attachments for the deployment. These attachments will be made visible in Conferma Pay Online.

pnr

object

GDS PNR locator data associated with the deployment.

pnrLocator

string | null

PNR Locator

pnrWorkArea

string | null

Office ID or PCC

pnrSegmentStatus

string

NotSet Online Passive

profileId

int32 | null

Unique identifier for the Data Connector Profile. Read Only.

connectorId

int32 | null

Unique identifier for the Data Connector. Read Only.

notificationRecipientAddress

string | null

System event notification email address. This will be used to communicate the status of automated activities such as the sending of Conferma Pay Connect fax communications.

links

array of objects | null

An array of request related HATEOAS links.

links

object

href

string | null

rel

string | null

method

string | null

documentCount

int32 | null

Number of associated documents attached to the deployment.

appUserCount

int32 | null

Number of users with access to the deployment in the Conferma Pay App.

advancedCardControls

array of objects | null

Additional controls applied at the point of deployment.

advancedCardControls

object

keyName

string | null

keyDisplayName

string | null

value

string | null

vcnDetails

object

vcnAmount

object

convertedAmount

object

toleranceAppliedDetails

object

paymentRange

object

Open to spend period for the deployment VCN.

straightThroughProcessing

object

provider

object

stripePayment

object

eftPayment

object

relationshipId

int32

supplierPortalRelationshipId

int32 | null

paymentRequests

array of objects | null

paymentRequests

object

requestId

int32

requestGuid

uuid

batchRequestId

int32

paymentReference

string | null

supplierName

string | null

supplierContact

string | null

supplierEmail

string | null

supplierAddress1

string | null

supplierAddress2

string | null

supplierCity

string | null

supplierPostalCode

string | null

supplierCountryCode

string | null

supplierPhoneNumber

string | null

paymentAmount

double

paymentAmountCurrency

string | null

dueDate

date-time

invoiceDate

date-time | null

paymentDate

date-time

originatorRequestIdentifier

string | null

supplierRelationshipGuid

uuid | null

platformName

string | null

requestStatus

string

New AwaitingFulfilment Fulfilled Rejected ImportFailed

identifiers

array of objects | null

identifiers

object

int32

requestId

int32

key

string | null

value

string | null

deploymentId

int32

totalItems

int32

digitalWalletDeployment

object

deploymentId

int32

notes

string | null

teamName

string | null

usersName

string | null

showApprovalWorkflow

boolean

Show Approval Workflow

showFailoverDetails

boolean

Show Failover Details

failover

object

failoverDeploymentId

int32 | null

Fail over Deployment ID

failedOverToCardPoolGuid

uuid | null

Failed over Card Pool

failedDeploymentId

int32 | null

Failed Deployment ID

failedCardPoolGuid

uuid | null

Failed Card Pool

showRoutingDetails

boolean

Show RoutingDetails

routing

object

originalCardPoolName

string | null

originalDeploymentMethodId

int32

401

Unauthorized

403

Forbidden

200Success

400Bad Request