POST {culture}/api/payments/create

IMPORTANT NOTE: Depending on your integration strategy, you may choose to map some of ID-s to your system ID-s (e.g. car categories, offices, equipment, pricelists). If you do that, please note that ID-s WILL BE DIFFERENT ON PRODUCTION AND TEST ENVIRONMENTS, so you should make it easily configurable on your side.

Create a new payment for reservation or booking.

Request Information

URI Parameters

Name	Description	Type	Additional information
culture		string	None.

Body Parameters

PaymentCreateModel

Name	Description	Type	Additional information
Amount	Amount for payment. The Amount for payment may not exceed the total unpaid amount from reservation or booking.	decimal number	Required
BookingNumber	Booking number. Identifier of booking in provider system.	string	Required
Client	Client information.	ClientModel	Required
CreditCardTypeCode	Credit card type codes: MAESTRO DINERS MASTER VISA AMERICAN OTHER UNIONPAY DISCOVER MADA JCB	string	None.
CurrencyCode	Currency code.	string	Required
OfficeCode	Alphanumeric code of the office where finance document will be created.	string	Required
PaymentRemark	Arbitrary remark visible only inside provider system.	string	None.
PaymentTypeCode	Payment type codes: CC - Credit card PYP - PayPal CHKO - Checkout TA - Transaction Account (invoice) PYTB - PayTabs	string	Required
TransactionId	Transaction ID for external payment system (eg. PayPal, Checkout)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BookingNumber": "2016-ZS-4568",
  "OfficeCode": "ZG1",
  "CurrencyCode": "EUR",
  "PaymentTypeCode": "CC",
  "CreditCardTypeCode": "VISA",
  "PaymentRemark": "Payment from B2B",
  "TransactionId": "sample string 1",
  "Amount": 2.0,
  "Client": {
    "IsCompany": true,
    "VatId": "6458762234",
    "Name": "Company name ltd.",
    "Code": "CD1234",
    "Surname": "",
    "Email": "client.email@email.com",
    "Remark": "Employee driver for client",
    "Street": "Winter Street 24",
    "PostalCode": "10003",
    "TownName": "New York",
    "ProvinceCode": "PA",
    "CountryCode": "US",
    "PhoneNumber": "+385912112589",
    "NationalityCode": "US",
    "IsDriverLicenceDomestic": true,
    "DriverLicenceTownCode": "sample string 2",
    "DriverLicenceCountryCode": "sample string 3",
    "IsPassportDomestic": true,
    "PassportTownCode": "sample string 5",
    "PassportCountryCode": "sample string 6",
    "IsIdCardDomestic": true,
    "IdCardTownCode": "sample string 8",
    "IdCardCountryCode": "sample string 9",
    "DriversLicenseNumber": "5036489",
    "DriversLicenseIssuedIn": "New York",
    "DriversLicenseIssueDate": "2017-04-10T00:00:00",
    "DriversLicenseValidUntil": "2017-04-10T00:00:00",
    "DriversLicenseValidUnlimited": true,
    "PassportNumber": "45896652",
    "PassportIssuedIn": "New York",
    "PassportIssueDate": "2017-04-10T00:00:00",
    "PassportValidUntil": "2017-04-10T00:00:00",
    "PassportValidUnlimited": true,
    "IdentityCardNumber": "45896652",
    "IdentityCardIssuedIn": "New York",
    "IdentityCardIssueDate": "2017-04-10T00:00:00",
    "IdentityCardValidUntil": "2017-04-10T00:00:00",
    "IdentityCardValidUnlimited": true
  }
}

Response Information

Resource Description

Create a new payment for reservation or booking.

PaymentModel

Name	Description	Type	Additional information
Amount	Total amount of payment	decimal number	None.
BookingNumber	Booking number.	string	None.
ClientName	Client name.	string	None.
CreditCardTypeCode	Credit card type codes: MAESTRO DINERS MASTER VISA AMERICAN OTHER UNIONPAY DISCOVER MADA JCB	string	None.
CurrencyCode	Currency code (e.g. USD, EUR).	string	None.
Id	Identifier of invoice in provider system. Used as input parameter for get PDF method.	integer	None.
IsCancelled	True for cancelled documents	boolean	None.
IsPaymentUpfront	True for payments that are made for bookings prior to booking's pickup date	boolean	None.
Number	Number.	string	None.
PaymentDate	Invoice creation date. UTC representation in ISO 8601 format.	date	None.
PaymentTypeCode	Payment type code (e.g. CHKO, PP, CC).	string	None.
PaymentTypeName	Payment type name (e.g. Checkout, PayPal, Credit card).	string	None.
TransactionId	Transaction Id of the payment	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Number": "17/040/228",
  "PaymentTypeName": "sample string 2",
  "PaymentTypeCode": "sample string 3",
  "IsCancelled": true,
  "Amount": 25.0,
  "PaymentDate": "2026-05-15T11:07:27.544656+02:00",
  "CurrencyCode": "EUR",
  "ClientName": "Some Car Hire Ltd.",
  "TransactionId": "sample string 5",
  "IsPaymentUpfront": true,
  "BookingNumber": "17-040-228",
  "CreditCardTypeCode": "VISA"
}