Skip to main content

payment

Details associated with a payment

oneOf
card object

Card details to be used for the transaction

cardNumstringrequired

This is the card number used for the request.

Possible values: >= 8 characters and <= 20 characters

Example: 4111111111111111
cardExpiry object

This is the card's expiry date.

monthnumberrequired

This is the card expiry month.

Possible values: <= 12

Example: 12
yearnumberrequired

This is the card expiry year.

Possible values: <= 9999

Example: 2022
cvvstring

This is the 3- or 4-digit security code that appears on the card following the card number.

Possible values: >= 3 characters and <= 4 characters, Value must match regular expression ^([0-9]{3,4})$

holderNamestring

This is the name of the card holder.

Possible values: <= 50 characters

Example: Suresh's card
cardTypestring

This is type of card used for the request.

  • AM – American Express

  • DI – Discover

  • JC – JCB

  • MC – Mastercard

  • MD – Maestro

  • SO – Solo

  • VI – Visa

  • VD – Visa Debit

  • VE – Visa Electron

Possible values: [AM, DI, JC, MC, MD, SO, VI, VD, VE]

lastDigitsstring

These are the last four digits of the card used for the request.

nickNamestring

This is the nickname the merchant has for the card holder.

cardBinstring

These are the first 6 digits of the card Bank Identification Number (BIN), for example: the first 6 digits of the card number.

Possible values: <= 6 characters

Example: 411111
idstring

This is the ID returned in the response. This ID can be used for future associated requests.

Possible values: <= 36 characters

Example: 3aeb9c63-6386-46a3-9f8e-f452e722228a
availableToSettlenumber

This is the amount of the Authorization remaining to settle, in minor units.

Example: 0
childAccountNumstring

This is the child merchant account number. It is returned only if the transaction was processed via a master account.

Possible values: <= 10 characters

Example: 3216549877
txnTimedate-time

This is the date and time the request was processed. For example: 2022-12-16T17:45:28Z

Example: 2023-01-19T16:33:49Z
paymentTypestring

This is the payment type associated with the Payment Handle used for this request.

Possible values: [CARD, RAPID_TRANSFER, ACH]

statusstring

This is the status of the transaction request. Possible values are:

  • RECEIVED – Our system has received the request and is waiting for the downstream processor’s response.

  • PROCESSING - Transactions are submitted to Payment Service Provider (PSP)/Scheme and waiting for PSP to complete the transaction.

  • COMPLETED – The transaction was completed.

  • HELD – The request has been placed on hold due to risk considerations.

  • FAILED – The transaction failed, due to either an error or being declined.

  • CANCELLED – The request has been fully voided (reversed).

  • PENDING – The transaction awaiting payment service provider's response.

Possible values: [RECEIVED, PROCESSING, COMPLETED, HELD, FAILED, CANCELLED, PENDING]

gatewayResponse object

This is the read-only raw response returned by an acquirer. It is returned only if your account is configured accordingly.

idstring

This is the response id returned by the processor

processorstring

This is the processor code of the transaction at Paysafe side

codestring

This is acquirer identification code, such as DJN, CRX, etc.

responseCodestring

This is the raw response returned by the acquirer.

avsCodestring

This is the raw AVS code returned by the acquirer.

avsResponsestring

This is the AVS response returned from the card issuer.

Possible values: [MATCH, MATCH_ADDRESS_ONLY, MATCH_ZIP_ONLY, NO_MATCH, NOT_PROCESSED, UNKNOWN]

balanceResponsestring

This is the balance remaining on a gift card, if a gift card was used for the original transaction.

midstring

This is the acquirer MID that was sent to the clearing house.

terminalIdstring

This is the merchant's terminal ID.

batchNumberstring

This is the batch number.

seqNumberstring

This is the merchant's sequence number.

effectiveDatestring

This is the date of the bank deposit associated with the transaction.

financingTypestring

This is the type of financing offered.

planstring

This is the plan number for this financing transaction.

gracePeriodstring

This is the grace period, in months, associated with deferred payment transactions.

termstring

This is the number of payments, in months, for equal payment transactions.

responseIdstring

This is the response ID assigned by Credorax.

requestIdstring

This is the request ID assigned by Paysafe.

descriptionstring

This is a description of the response.

authCodestring

This is the authorization code.

txnDateTimestring

This is the transaction date and time.

referenceNbrstring

This is the Bank net transaction ID/Merch Tran Ref

responseReasonCodestring

This is the raw response reason code returned by Credorax.

cvvVerificationstring

This is the response to the cvv submitted with the transaction request.

Possible values: [MATCH, NO_MATCH, NOT_PROCESSED, UNKNOWN]

cvv2Resultstring

This is the raw cvv2 result code.

statusstring

This is the status of the transaction at the processor side.

orderIdstring

Unique NETELLER reference for the order.

profile object

This is customer's profile details.

idstring

The customer's profile id in the system. If this is present rest all other fields are not required.

statusstring

The status of customer in the system, returned in the response.

merchantCustomerIdstring

This is the reference number for the customer created by the merchant and submitted as part of the request. It must be unique for each customer.

Note: This value is mandatory when fundingTransaction is used.

Possible values: <= 10 characters

localestringrequired

This indicates the customer's locale preference.

Note: Optional for GiroPay, Vippreferred-Direct-Registration. Not required for Paysafe Card Payouts.

Possible values: [en_US, fr_CA, en_GB, en_CA]

firstNamestringrequired

This is the customer’s first name.

Possible values: <= 80 characters

Example: Venkata Suresh
lastNamestringrequired

This is the customer’s last name.

Possible values: <= 80 characters

Example: Chagalamarri
emailstringrequired

This is the customer's email address.

Possible values: <= 255 characters

Example: paysafe@gmail.com
phonestring

This is the customer's phone number.

Note: Optional for GiroPay. Not required for Paysafe Card Payouts.

Possible values: <= 40 characters

Example: 1234567891
dateOfBirth object

This is the recipient's date of birth.

daynumberrequired

This is the day of birth.

Possible values: <= 31

Example: 6
monthnumberrequired

This is the month of birth.

Possible values: <= 12

Example: 5
yearnumberrequired

This is the year of birth.

Possible values: >= 1900

Example: 1998
mobilestring

Customer's mobile number.

Possible values: <= 40 characters

Example: 9846573804
genderstring

This field indicates the Customer's gender.

M - Male

F - Female

Possible values: [M, F]

Example: M
nationalitystring

This field indicates the Customer's nationality.

Possible values: <= 30 characters

Example: Indian
identityDocuments object[]
  • Array [
    • identityDocuments object[]required

    This is array of 2 JSON objects.

    • 1st object contains SSN
    • 2nd object contains Identity document details.
  • Array [
    • anyOf
  • ]
  • ]
    • riskReasonCodeinteger[]

    An array of integers is returned, displaying the detailed Risk reason codes if your transaction was declined. It is returned only if your account is configured accordingly.

    settlements object[]
  • Array [
    • idstring

    This is the ID returned in the response. This ID can be used for future associated request.

    Possible values: <= 36 characters

    Example: 25f6dadf-176a-415f-95c9-6ff39ff697ba
    paymentTypestring

    This is the payment type associated with the settlement used for this request.

    Possible values: [CARD]

    availableToRefundnumber

    This is the remaining amount of the refund, in minor units.99.

    Possible values: <= 99999999999

    childAccountNumstring

    This is the child merchant account number. It is returned only if the transaction was processed via a master account.

    Possible values: <= 10 characters

    Example: 1234567898
    txnTimedate-time

    This is the date and time the request was processed. For example: 2014-01-26T10:32:28Z

    statusstring

    This is the status of the transaction request. Possible values are:

    • RECEIVED – Our system has received the request and is waiting for the downstream processor’s response.

    • INITIATED – The transaction was initiated with the downstream provider.

    • PENDING - The transaction is awaiting the payment service provider's response.

    • FAILED – The transaction failed, due to either an error or being declined.

    • CANCELLED – The transaction request is cancelled.'

    • EXPIRED – The transaction request is expired.

    • COMPLETED – The transaction request is completed.

    Possible values: [RECEIVED, INITIATED, PENDING, FAILED, CANCELLED, EXPIRED, COMPLETED]

    error object

    Details of the error.

    codestring

    The error code. Also shown in the X-Application-Status-Code response header.

    Example: 5068
    messagestring

    A description of the error.

    Example: Field error(s)
    detailsstring[]

    Details of any parameter value errors.

    fieldErrors object[]

    If applicable, this is a list of fields that have issues.

  • Array [
    • fieldstring

    Identifies the JSON request field.

    Example: accountId
    errorstring

    The problem associated with field.

    Example: AccountId is missing in the request. If multiple accounts are registered with same currency, accountId is mandatory.
  • ]
    • riskReasonCodeinteger[]

    An array of integers is returned, displaying the detailed Risk reason codes if your transaction was declined. It is returned only if your account is configured accordingly.

    gatewayResponse object

    This is the read-only raw response returned by an acquirer. It is returned only if your account is configured accordingly.

    idstring

    This is the response id returned by the processor

    processorstring

    This is the processor code of the transaction at Paysafe side

    codestring

    This is acquirer identification code, such as DJN, CRX, etc.

    responseCodestring

    This is the raw response returned by the acquirer.

    avsCodestring

    This is the raw AVS code returned by the acquirer.

    avsResponsestring

    This is the AVS response returned from the card issuer.

    Possible values: [MATCH, MATCH_ADDRESS_ONLY, MATCH_ZIP_ONLY, NO_MATCH, NOT_PROCESSED, UNKNOWN]

    balanceResponsestring

    This is the balance remaining on a gift card, if a gift card was used for the original transaction.

    midstring

    This is the acquirer MID that was sent to the clearing house.

    terminalIdstring

    This is the merchant's terminal ID.

    batchNumberstring

    This is the batch number.

    seqNumberstring

    This is the merchant's sequence number.

    effectiveDatestring

    This is the date of the bank deposit associated with the transaction.

    financingTypestring

    This is the type of financing offered.

    planstring

    This is the plan number for this financing transaction.

    gracePeriodstring

    This is the grace period, in months, associated with deferred payment transactions.

    termstring

    This is the number of payments, in months, for equal payment transactions.

    responseIdstring

    This is the response ID assigned by Credorax.

    requestIdstring

    This is the request ID assigned by Paysafe.

    descriptionstring

    This is a description of the response.

    authCodestring

    This is the authorization code.

    txnDateTimestring

    This is the transaction date and time.

    referenceNbrstring

    This is the Bank net transaction ID/Merch Tran Ref

    responseReasonCodestring

    This is the raw response reason code returned by Credorax.

    cvvVerificationstring

    This is the response to the cvv submitted with the transaction request.

    Possible values: [MATCH, NO_MATCH, NOT_PROCESSED, UNKNOWN]

    cvv2Resultstring

    This is the raw cvv2 result code.

    statusstring

    This is the status of the transaction at the processor side.

    orderIdstring

    Unique NETELLER reference for the order.

    profile object

    This is customer's profile details.

    idstring

    The customer's profile id in the system. If this is present rest all other fields are not required.

    statusstring

    The status of customer in the system, returned in the response.

    merchantCustomerIdstring

    This is the reference number for the customer created by the merchant and submitted as part of the request. It must be unique for each customer.

    Note: This value is mandatory when fundingTransaction is used.

    Possible values: <= 10 characters

    localestringrequired

    This indicates the customer's locale preference.

    Note: Optional for GiroPay, Vippreferred-Direct-Registration. Not required for Paysafe Card Payouts.

    Possible values: [en_US, fr_CA, en_GB, en_CA]

    firstNamestringrequired

    This is the customer’s first name.

    Possible values: <= 80 characters

    Example: Venkata Suresh
    lastNamestringrequired

    This is the customer’s last name.

    Possible values: <= 80 characters

    Example: Chagalamarri
    emailstringrequired

    This is the customer's email address.

    Possible values: <= 255 characters

    Example: paysafe@gmail.com
    phonestring

    This is the customer's phone number.

    Note: Optional for GiroPay. Not required for Paysafe Card Payouts.

    Possible values: <= 40 characters

    Example: 1234567891
    dateOfBirth object

    This is the recipient's date of birth.

    daynumberrequired

    This is the day of birth.

    Possible values: <= 31

    Example: 6
    monthnumberrequired

    This is the month of birth.

    Possible values: <= 12

    Example: 5
    yearnumberrequired

    This is the year of birth.

    Possible values: >= 1900

    Example: 1998
    mobilestring

    Customer's mobile number.

    Possible values: <= 40 characters

    Example: 9846573804
    genderstring

    This field indicates the Customer's gender.

    M - Male

    F - Female

    Possible values: [M, F]

    Example: M
    nationalitystring

    This field indicates the Customer's nationality.

    Possible values: <= 30 characters

    Example: Indian
    identityDocuments object[]
  • Array [
    • identityDocuments object[]required

    This is array of 2 JSON objects.

    • 1st object contains SSN
    • 2nd object contains Identity document details.
  • Array [
    • anyOf
  • ]
  • ]
    • gatewayReconciliationIdstring

    It is the id which is common between paysafe and payment serivce provider.

    Possible values: <= 36 characters

    Example: a5c80e61-e747-455f-843d-2b9526f9963e
    liveModeboolean

    This flag indicates the envrionment.

    • true - Production
    • false - Non-Production
    updatedTimedate-time

    Indicates the last updated time for the resource.

    Example: 2023-01-19T10:48:04Z
    statusTimedate-time

    Indicates the last updated time for the resource.

    Example: 2023-01-19T10:48:04Z
    merchantRefNumstringrequired

    This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request.

    Possible values: <= 255 characters

    amountnumber

    This is the amount of the request, in minor units.For example, to process US $10.99, this value should be 1099.

    Possible values: <= 99999999999

    dupCheckboolean

    This validates that this request is not a duplicate. A request is considered a duplicate if the merchantRefNum has already been used in a previous request within the past 90 days.

    Note: This value defaults to true

    Default value: true
    splitpay object[]
  • Array [
    • linkedAccountstringrequired

    This is the ID of the linked account. This account must already be linked to the merchant account.

    Example: 123124124
    amountnumber

    This is the amount to transfer to the linked account in minor currency units. The total amount to all linked accounts cannot exceed the transaction total.

    Example: 505
    percentnumber

    This is the percentage of the total transaction amount to transfer to that account. The total percentage to all linked accounts cannot exceed 100%.

    Example: 5
  • ]
    • airlineTravelDetails object

    Contains information about your airline travel.

    Note: This object is only for Airline Merchants.

    passengerNamestringrequired

    Name of the passenger to whom the ticket was issued.

    Possible values: <= 20 characters

    Example: Venkata Suresh
    departureDatedaterequired

    Date of passenger’s departure. Date format = YYYY-MM-DD, ISO 8601 expected. For example 2022-12-20.

    Example: 2022-12-20
    originstringrequired

    Departure Airport Code: IATA Airport Code.

    Possible values: >= 3 characters and <= 3 characters

    Example: SXF
    computerizedReservationSystemstring

    Indicates the computerized reservation system used to make the reservation and purchase the ticket. For tickets purchased in Germany, this field should one of these codes:

    • STRT - Start

    • PARS - TWA

    • DATS - Delta

    • SABR - Sabre

    • DALA - Covia-Apollo

    • BLAN - Dr. Blank

    • DERD - DER

    • TUID - TUI

    Note: Required only if the ticket is purchased in Germany. Otherwise it can be omitted.

    Possible values: [STRT, PARS, DATS, SABR, DALA, BLAN, DERD, TUID]

    Example: DATS
    ticket object

    Information about the Airline Ticket Number and if the ticket is restricted.

    ticketNumberstringrequired

    Airline ticket number

    Possible values: <= 20 characters

    Example: 1234567891011
    isRestrictedTicketboolean

    Indicates whether this ticket is non-refundable. This entry should be supplied on CPS/Passenger Transport 1 or 2 transactions if the ticket was purchased as a non-refundable ticket. Valid values are:

    • false - No restriction (default)

    • true - Restricted (non-refundable) ticket'

    customerReferenceNumberstring

    Contains the code that the cardholder supplied to the card acceptor.

    Possible values: <= 20 characters

    Example: 10987654321
    travelAgency object

    Information about the travel agency if the ticket was issued by a travel agency.

    codestring

    Code identifying travel agency if the ticket was issued by a travel agency..

    Possible values: <= 8 characters

    Example: MY AGENT
    namestring

    Information about the travel agency if the ticket was issued by a travel agency.

    Possible values: <= 25 characters

    Example: MYAGENT347
    tripLegs object

    A grouping of four separate trip segments. Each leg contains detailed itinerary information.

    leg1 object

    Contains detailed itinerary information for one of the trip legs

    flight object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCodestring

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    Possible values: >= 2 characters and <= 2 characters

    Example: LH
    flightNumberstring

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    Possible values: non-empty and <= 5 characters

    Example: 0799
    serviceClassstring

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Example: F
    isStopOverAllowedboolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destinationstring

    Destination Airport Code (IATA Airport Code).

    Possible values: >= 3 characters and <= 3 characters

    Example: SOF
    fareBasisstring

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    Possible values: non-empty and <= 6 characters

    Example: VMAY
    departureDatedate

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    Example: 2022-12-20
    leg2 object

    Contains detailed itinerary information for one of the trip legs

    flight object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCodestring

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    Possible values: >= 2 characters and <= 2 characters

    Example: LH
    flightNumberstring

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    Possible values: non-empty and <= 5 characters

    Example: 0799
    serviceClassstring

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Example: F
    isStopOverAllowedboolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destinationstring

    Destination Airport Code (IATA Airport Code).

    Possible values: >= 3 characters and <= 3 characters

    Example: SOF
    fareBasisstring

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    Possible values: non-empty and <= 6 characters

    Example: VMAY
    departureDatedate

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    Example: 2022-12-20
    leg3 object

    Contains detailed itinerary information for one of the trip legs

    flight object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCodestring

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    Possible values: >= 2 characters and <= 2 characters

    Example: LH
    flightNumberstring

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    Possible values: non-empty and <= 5 characters

    Example: 0799
    serviceClassstring

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Example: F
    isStopOverAllowedboolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destinationstring

    Destination Airport Code (IATA Airport Code).

    Possible values: >= 3 characters and <= 3 characters

    Example: SOF
    fareBasisstring

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    Possible values: non-empty and <= 6 characters

    Example: VMAY
    departureDatedate

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    Example: 2022-12-20
    leg4 object

    Contains detailed itinerary information for one of the trip legs

    flight object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCodestring

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    Possible values: >= 2 characters and <= 2 characters

    Example: LH
    flightNumberstring

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    Possible values: non-empty and <= 5 characters

    Example: 0799
    serviceClassstring

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Example: F
    isStopOverAllowedboolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destinationstring

    Destination Airport Code (IATA Airport Code).

    Possible values: >= 3 characters and <= 3 characters

    Example: SOF
    fareBasisstring

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    Possible values: non-empty and <= 6 characters

    Example: VMAY
    departureDatedate

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    Example: 2022-12-20
    passengerNameRecordstring

    The airline company uses the passengerNameRecord as a reservation number.

    Possible values: <= 10 characters

    Example: ABCDE12345
    additionalBookingReferencestring

    BookingReference field. Typically used for the PNR, but should allow an airline to specify any other reference if they feel fit.

    Possible values: <= 50 characters

    totalFarenumber

    Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets

    totalFeenumber

    Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets.

    totalTaxesnumber

    Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets.

    passengersstring

    Information about the passengers reserved tickets with the same transaction.

  • ]
    • error object

    Details of the error.

    codestring

    The error code. Also shown in the X-Application-Status-Code response header.

    Example: 5068
    messagestring

    A description of the error.

    Example: Field error(s)
    detailsstring[]

    Details of any parameter value errors.

    fieldErrors object[]

    If applicable, this is a list of fields that have issues.

  • Array [
    • fieldstring

    Identifies the JSON request field.

    Example: accountId
    errorstring

    The problem associated with field.

    Example: AccountId is missing in the request. If multiple accounts are registered with same currency, accountId is mandatory.
  • ]
    • statusReasonstring

    This is reason for the status. This is present in the case where status is ERROR, FAILURE, or HELD.

    Possible values: <= 255 characters

    authentication object

    3D Secure authentication details.

    idstring

    This is the ID of authentication, returned in the response.

    Example: 5d4db3bc-34c9-417f-a051-0d992ad9284e
    ecinumber

    This is the E-Commerce Indicator (ECI). This value will be returned only on payer authentication transactions, or for enrollments where the issuer is non-participating and the card scheme supports it. This value must be appended to the authorization request, where it enables the interchange benefits granted to merchants processing payer Authentication transactions.

    Visa

    • 5 – Identifies a successfully authenticated transaction.

    • 6 – Identifies an attempts authenticated transaction.

    • 7 – Identifies a non-authenticated transaction.

    Mastercard

    • 1 - Identifies a non-authenticated transaction.

    • 2 - Identifies a successfully authenticated transaction.

    Example: 5
    cavvstring

    This is the Cardholder Authentication Verification Value, indicating that the transaction has been authenticated. This value should be appended to the authorization request signifying that the transaction has been successfully authenticated.

    Possible values: <= 80 characters

    Example: AAABBhkXYgAAAAACBxdiENhf7A+=
    xidstring

    This is the transaction identifier returned by the card issuer.

    Possible values: <= 40 characters

    Example: aWg4N1ZZOE53TkFrazJuMmkyRDA=
    statusstring

    This is the status of the Enrollment Lookup request. Possible values are:

    • COMPLETED - The transaction has been completed.

    • FAILED - The authentication request failed. Check the error code for details.

    Possible values: [COMPLETED , FAILED]

    merchantRefNumstring

    This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request.

    Possible values: <= 255 characters

    Example: merchantABC-123-authentications
    threeDEnrollmentstring

    This indicates whether or not the cardholder is enrolled in 3D Secure. Possible values are:

    • Y – Cardholder authentication available.

    • N – Cardholder not enrolled in authentication.

    • U – Cardholder authentication unavailable

    Possible values: [Y, N, U]

    threeDResultstring

    This indicates the outcome of the Authentication.

    • Y – The cardholder successfully authenticated with their card issuer.

    • A – The cardholder authentication was attempted.

    • N – The cardholder failed to successfully authenticate with their card issuer.

    • U – Authentication with the card issuer was unavailable.

    • E – An error occurred during authentication.

    Possible values: [Y, A, N, U, E]

    signatureStatusstring

    This is the 3D Secure signature verification result value.

    • Y – All transaction and signature checks satisfied.

    • N – At least one transaction or signature check failed.

    Possible values: [Y, N]

    error object

    Details of the error.

    codestring

    The error code. Also shown in the X-Application-Status-Code response header.

    Example: 5068
    messagestring

    A description of the error.

    Example: Field error(s)
    detailsstring[]

    Details of any parameter value errors.

    fieldErrors object[]

    If applicable, this is a list of fields that have issues.

  • Array [
    • fieldstring

    Identifies the JSON request field.

    Example: accountId
    errorstring

    The problem associated with field.

    Example: AccountId is missing in the request. If multiple accounts are registered with same currency, accountId is mandatory.
  • ]
    • gatewayReconciliationIdstring

    Transaction identifier that can be used to reconcile this transaction with the provider gateway.

    Possible values: <= 36 characters

    Example: 4bbfba66-a15b-4fa5-ad77-c209ffdb914f
    updatedTimedate-time

    ISO 8601 format (UTC) This is the date and time the resource was last updated, e.g., 2014-01-26T10:32:28Z

    Example: 2023-01-19T08:37:50Z
    statusTimedate-time

    ISO 8601 format (UTC) This is the date and time the resource status was last updated, e.g., 2014-01-26T10:32:28Z

    Example: 2023-01-19T08:37:50Z
    availableToRefundnumber

    This is the amount of this Settlement that is available to Refund, in minor units. For example, US $10.99 would be 1099.

    Possible values: <= 99999999999

    links object

    URL links to redirect customer during transaction flow

    relstring

    This is the link type that allows different endpoints to be targeted depending on the end state of the transaction.

    • redirect_registration - Merchant needs to redirect consumer to this url to complete registration.

    • redirect_payment - Merchant needs to redirect consumer to this url to complete authentication.

    • on_completed - Paysafe will return to this merchant url post successful payment.

    • on_failed - Paysafe will return to this merchant url post if payment is failed.

    • on_cancelled - Paysafe will return to this merchant url post if payment is cancelled.

    • default - The default return URL that will be used if specific status return URL is not defined.

    Possible values: [redirect_payment, redirect_registration, on_completed, default, on_failed, on_cancelled]

    Example: redirect_payment
    hrefstring

    The url to be used for further actions.

    Example: http://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709
    methodstring

    The corresponding HTTP request method to be invoked on url.

    Example: GET
    liveModeboolean

    This flag indicates the environment.

    • true - production
    • false - Non-Production
    billingDetails object

    Customer's billing details.

    Note: For single-use Payment Handles, this address information will be ignored if the paymentHandleTokenFrom parameter is included in the Payment Handle creation request and there is already address information associated with that customer.

    idstring

    This is the ID of the billing address, returned in the response.

    Possible values: <= 36 characters

    statusstring

    This is the status of the address.

    nickNamestring

    This is the nickname the merchant has for the billing address.

    Possible values: <= 50 characters

    Example: Home
    streetstringrequired

    This is the first line of the customer's street address.

    Possible values: <= 50 characters

    Example: Street
    street1string

    This is the first line of the street address.

    Note: Mandatory for VIPPreferred

    Possible values: <= 50 characters

    Example: street1
    street2string

    This is the second line of the street address, if required (e.g., apartment number).

    Possible values: <= 50 characters

    Example: street2
    citystringrequired

    This is the city where the address is located.

    Possible values: <= 40 characters

    Example: Toronto
    statestring

    This is the state/province/region in which the customer lives.

    Possible values: >= 2 characters and <= 40 characters

    Example: ON
    countrystringrequired

    This is the country where the address is located. See Country Codes.

    Possible values: >= 2 characters and <= 2 characters

    Example: CA
    zipstringrequired

    This is the zip, postal, or post code of the customer's address.

    Possible values: <= 10 characters

    Example: M5H 2N2
    phonestring

    This is the customer's telephone number.

    Possible values: <= 40 characters

    Example: 8765846321
    customerProfile object

    This is customer's profile details.

    idstring

    The customer's profile id in the system. If this is present rest all other fields are not required.

    statusstring

    The status of customer in the system, returned in the response.

    merchantCustomerIdstring

    This is the reference number for the customer created by the merchant and submitted as part of the request. It must be unique for each customer.

    Note: This value is mandatory when fundingTransaction is used.

    Possible values: <= 10 characters

    localestringrequired

    This indicates the customer's locale preference.

    Note: Optional for GiroPay, Vippreferred-Direct-Registration. Not required for Paysafe Card Payouts.

    Possible values: [en_US, fr_CA, en_GB, en_CA]

    firstNamestringrequired

    This is the customer’s first name.

    Possible values: <= 80 characters

    Example: Venkata Suresh
    lastNamestringrequired

    This is the customer’s last name.

    Possible values: <= 80 characters

    Example: Chagalamarri
    emailstringrequired

    This is the customer's email address.

    Possible values: <= 255 characters

    Example: paysafe@gmail.com
    phonestring

    This is the customer's phone number.

    Note: Optional for GiroPay. Not required for Paysafe Card Payouts.

    Possible values: <= 40 characters

    Example: 1234567891
    dateOfBirth object

    This is the recipient's date of birth.

    daynumberrequired

    This is the day of birth.

    Possible values: <= 31

    Example: 6
    monthnumberrequired

    This is the month of birth.

    Possible values: <= 12

    Example: 5
    yearnumberrequired

    This is the year of birth.

    Possible values: >= 1900

    Example: 1998
    mobilestring

    Customer's mobile number.

    Possible values: <= 40 characters

    Example: 9846573804
    genderstring

    This field indicates the Customer's gender.

    M - Male

    F - Female

    Possible values: [M, F]

    Example: M
    nationalitystring

    This field indicates the Customer's nationality.

    Possible values: <= 30 characters

    Example: Indian
    identityDocuments object[]
  • Array [
    • identityDocuments object[]required

    This is array of 2 JSON objects.

    • 1st object contains SSN
    • 2nd object contains Identity document details.
  • Array [
    • anyOf
  • ]
  • ]
    • merchantRefNumstringrequired

    This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request.

    Possible values: <= 255 characters

    Example: 445186567390019700
    amountnumberrequired

    This is the amount of the request, in minor units. For example, to process US $10.99, this value should be 1099.

    Note: The amount specified in the Payment request must match the amount specified in the Payment Handle request from which the paymentHandleToken is taken.

    Possible values: <= 99999999999

    Example: 500
    dupCheckboolean

    This validates that this request is not a duplicate. A duplicate request is when the merchantRefNum has already been used in a previous request within the past 90 days.

    settleWithAuthboolean

    This indicates whether the request is an Authorization only (no Settlement), or a Purchase (Authorization and Settlement).

    • false – The request is not settled

    • true – The request is settled

    Note: Defaults to true.

    preAuthboolean

    This indicates whether the Authorization request should be sent as a Pre-Authorization.

    Note: You should use the preAuth element in cases where you are not sure that you can fully settle the Authorization within 4 days. Contact your account manager for more information.

    partialAuth object

    This is an authorization that is approved for an amount lower than the requested amount. The remainder of the amount could be paid by other means.

    requestedboolean

    This specifies whether or not a partial authorization was requested.

    Example: true
    amountDuenumber

    This is the amount of the full authorization that is not covered by the Payment request.

    Possible values: <= 99999999999

    Example: 1000
    originalAmountnumber

    This is the actual amount of the full authorization.

    Possible values: <= 99999999999

    Example: 2000
    paymentHandleTokenstringrequired

    This is the payment token generated by Paysafe that will be used for the Payment request.

    Possible values: <= 36 characters

    Example: SAJyTBzCvS8YHwwb
    customerIpstring

    This is the customer's IP address.

    Possible values: <= 39 characters

    Example: 172.0.0.1
    descriptionstring

    This is a description of the transaction, provided by the merchant.

    Possible values: <= 255 characters

    Example: Magazine subscription
    currencyCodestringrequired

    This is the currency of the merchant account, e.g., USD or CAD, returned in the request response. See Currency Codes.

    Note: The currencyCode specified in the Payment request must match the currencyCode specified in the Payment Handle request from which the paymentHandleToken is taken.

    Possible values: <= 3 characters

    Example: USD
    level2level3 object

    Level 2 and Level 3 (L2/L3) credit card processing refers to certain B2B card transactions for which the merchant might be eligible for lower credit card interchange rates. The lower rates may be available for merchants who provide more detailed information when processing card-not-present transactions. In order to be eligible for L2/L3 transactions:

    • Your merchant account must be properly configured by Paysafe.

    • The BIN of the credit card used for the transaction must be eligible –typically,these are government-issued credit cards.

    Note: Not all processing gateways support this parameter. Contact your accountmanager for more information.

    exemptLocalTaxboolean

    This indicates whether or not local tax is exempted for the request. If set to true, then the localTaxAmount parameter will be ignored.

    Note: This value defaults to false

    Default value: false
    Example: true
    localTaxAmountnumber

    This is the local sales tax applied to the purchase.

    Example: 1500
    nationalTaxAmountnumber

    This is the national tax included in the transaction amount.

    Possible values: <= 99999999999

    Example: 0
    freightAmountnumber

    This is the freight or shipping portion of the total transaction amount.

    Possible values: <= 99999999999

    Example: 0
    dutyAmountnumber

    This is the duty associated with the import of the purchased goods.

    Possible values: <= 99999999999

    Example: 0
    destinationZipstring

    This is the postal/zip code of the address to which the purchased goods will be delivered. This field can be identical to the shipFromZip if the customer is present and takes immediate possession of the goods.

    Possible values: <= 10 characters

    Example: 90210
    destinationCountrystring

    This is the country to which the goods are being shipped. See Country Codes.

    Possible values: <= 2 characters

    Example: US
    shipFromZipstring

    This is the postal/zip code of the address from which the purchased goods are being shipped.

    Possible values: <= 10 characters

    Example: 90211
    lineItems object

    This is more detailed information about the items that are being purchased for Level2Level3 merchants

    descriptionstring

    This is a description of the item(s) being purchased.

    Possible values: <= 50 characters

    Example: Disney Cruise Line
    productCodestring

    This is a merchant-defined description code of the item being purchased.

    Possible values: <= 12 characters

    Example: DCL
    quantitynumber

    This is the quantity of the item.

    Note: Max 4 decimals is allowed.

    Possible values: <= 99999999999

    Example: 4
    unitAmountnumber

    This is the unit price of the item being purchased, in minor units. The currency will be based on the account setting.

    Possible values: <= 99999999999

    Example: 120000
    taxRatenumber

    This is the tax rate used to calculate the tax amount. For example, if the tax rate is 10.5%, this value should be 10.5.

    Note: Max 2 decimals allowed.

    Possible values: <= 100

    Example: 5
    taxAmountnumber

    This is the amount of any value-added taxes that can be associated with the purchased item, in minor units. The currency will be based on the account setting.

    Note: Our system will not validate the accuracy of this value. The merchant's application must calculate this value correctly.

    Possible values: <= 99999999999

    Example: 24000
    totalAmountnumber

    This is the total amount of the line item, typically calculated as price multiplied by quantity, in minor units. The currency is based on the account setting.

    Note: Our system will not validate the accuracy of this value. The merchant''s application must calculate this value correctly.

    Possible values: <= 99999999999

    accordD object

    These are parameters for financing plans supported for certain merchant configurations. Include this element only when instructed to do so by your account manager.

    Note: Not all processing gateways support this parameter. Contact your account manager for more information.

    financingTypestring

    This is the type of financing offered.

    • DEFERRED_PAYMENT – Deferred payment financing.
    • EQUAL_PAYMENT – Equal payment financing

    Possible values: [DEFERRED_PAYMENT, EQUAL_PAYMENT]

    planstring

    This is the plan number for this financing transaction.

    Possible values: <= 3 characters

    Example: 124
    gracePeriodnumber

    This is the grace period, in months, associated with deferred payment transactions.

    Possible values: <= 99

    Example: 12
    termnumber

    This is the number of payments, in months, for equal payment transactions.

    Possible values: <= 99

    Example: 12
    recipient object

    The recipient is deemed to be the person or party who has the contractual relationship with the merchant / financial institution. This may be different from the cardholder, e.g., in the case of a parent topping up a child's savings account. Therefore, the fields should not be collected on the same page as cardholder information, but instead be passed in the background from the merchant's records.

    Note: You can include recipient elements in your authorization request only if your Merchant Category Code is 6012 and your registered trading address is in the United Kingdom. All fields are optional. However, scheme fines may apply if data is consistently not supplied and chargebacks persist. If you have any questions, contact your account manager. If you are using a payment token for an Authorization request and there is already recipient data for the consumer profile associated with the payment token, then if you include the recipient object in the Authorization, this data will override the recipient data already in the profile.

    If you look up an authorization request that used the visaAdditionalAuthData parameter (now deprecated), the response will contain the relevant data in both the recipient and the visaAdditionalAuthData objects.

    dateOfBirth object

    This is the recipient's date of birth.

    daynumberrequired

    This is the day of birth.

    Possible values: <= 31

    Example: 6
    monthnumberrequired

    This is the month of birth.

    Possible values: <= 12

    Example: 5
    yearnumberrequired

    This is the year of birth.

    Possible values: >= 1900

    Example: 1998
    zipstring

    This is the zip/postal code of the recipient.

    Note: The last 3 characters are not sent to the banking network.

    Possible values: <= 10 characters

    Example: CB24 9AD
    lastNamestring

    This is the recipient's last name.

    Note: Only the first 6 characters are sent to the banking network.

    Possible values: <= 255 characters

    Example: Chagalamarri
    accountNumberstring

    This is the recipient's account number, e.g., a loan agreement number or customer ID. In the case where the recipient account is a prepaid card, the card number may be sent in full.

    Note: Only the first 6 and last 4 characters are sent to the banking network and will be masked accordingly within the back office and any other reports, to comply with PCI regulations.

    Possible values: <= 25 characters

    Example: ABC1234567890
    splitpay object

    This object should be used only for Splitpay transactions only, an array containing the linked accounts and the amount shared with each. You must include either amount or percent. However, you cannot include both values.

    linkedAccountstringrequired

    This is the ID of the linked account. This account must already be linked to the merchant account.

    Example: 123124124
    amountnumber

    This is the amount to transfer to the linked account in minor currency units. The total amount to all linked accounts cannot exceed the transaction total.

    Example: 505
    percentnumber

    This is the percentage of the total transaction amount to transfer to that account. The total percentage to all linked accounts cannot exceed 100%.

    Example: 5
    storedCredentialDetails object

    The storedCredential object is used to identify [authorization requests] that use stored credentials for a consumer, in order to improve authorization rates and reduce fraud. Stored credentials can be used in two cases:

    • Using a payment token – An authorization request that uses a paymentToken from the [Customer Vault API]

    • Using a card number – An authorization request that uses a credit card number stored by the merchant.

    Notes:

    • If you use a paymentToken in the authorization request but do not include the storedCredential object, Paysafe will provide default information taken from Customer Vault data.

    • You cannot include both the storedCredential object and the recurring parameter in the same authorization request. Paysafe recommends using the storedCredential object.

    • The cvv parameter of the [card object] is required when the occurrence parameteris set to INITIAL. However, cvv is not required when the occurrence parameter is set to SUBSEQUENT.

    • The storedCredential object cannot be used for Apple Pay or Google Pay transactions.

    typestring

    This specifies the type of request being made. Possible values are:

    • ADHOC – Ad hoc consumer-initiated request

    • TOPUP – Unscheduled merchant-iniitated request when a consumer balance is below a set limit.

    • RECURRING – Scheduled, merchant-initiated recurring request.

    Note: This value defaults to ADHOC.

    Possible values: [ADHOC, TOPUP, RECURRING]

    Default value: ADHOC
    occurrencestring

    This specifies whether this stored credential request is initial or recurring. Possible values are:

    • INITIAL – Used when this is the first time the consumer uses this credit card.

    • SUBSEQUENT – Used when the consumer uses this credit card for subsquent requests.

    Note: This value defaults to INITIAL.

    Possible values: [INITIAL, SUBSEQUENT]

    Default value: INITIAL
    initialTransactionIdstring

    Id of the initial Recurring Payment transaction. This id should be stored from the auth response of the transaction indicated as initial with the following: type=RECURRING/TOPUP, occurrence=INITIAL. This reference should be provided when:

    • type = RECURRING and occurrence = SUBSEQUENT -type = TOPUP and occurrence = SUBSEQUENT

    Note: This reference is a must to meet PSD 2 authentication process requirements for merchant initiated transactions successfully.

    Possible values: <= 36 characters

    externalInitialTransactionIdstring

    Id of the initial Recurring Payment transaction in case this transaction was processed through external PSP. This reference should be provided only when:

    • type=RECURRING and occurrence=SUBSEQUENT
    • type=TOPUP and occurrence=SUBSEQUENT Note: This reference cannot be provided along with initialTransactionId.

    Possible values: <= 256 characters

    airlineTravelDetails object

    Contains information about your airline travel.

    Note: This object is only for Airline Merchants.

    passengerNamestringrequired

    Name of the passenger to whom the ticket was issued.

    Possible values: <= 20 characters

    Example: Venkata Suresh
    departureDatedaterequired

    Date of passenger’s departure. Date format = YYYY-MM-DD, ISO 8601 expected. For example 2022-12-20.

    Example: 2022-12-20
    originstringrequired

    Departure Airport Code: IATA Airport Code.

    Possible values: >= 3 characters and <= 3 characters

    Example: SXF
    computerizedReservationSystemstring

    Indicates the computerized reservation system used to make the reservation and purchase the ticket. For tickets purchased in Germany, this field should one of these codes:

    • STRT - Start

    • PARS - TWA

    • DATS - Delta

    • SABR - Sabre

    • DALA - Covia-Apollo

    • BLAN - Dr. Blank

    • DERD - DER

    • TUID - TUI

    Note: Required only if the ticket is purchased in Germany. Otherwise it can be omitted.

    Possible values: [STRT, PARS, DATS, SABR, DALA, BLAN, DERD, TUID]

    Example: DATS
    ticket object

    Information about the Airline Ticket Number and if the ticket is restricted.

    ticketNumberstringrequired

    Airline ticket number

    Possible values: <= 20 characters

    Example: 1234567891011
    isRestrictedTicketboolean

    Indicates whether this ticket is non-refundable. This entry should be supplied on CPS/Passenger Transport 1 or 2 transactions if the ticket was purchased as a non-refundable ticket. Valid values are:

    • false - No restriction (default)

    • true - Restricted (non-refundable) ticket'

    customerReferenceNumberstring

    Contains the code that the cardholder supplied to the card acceptor.

    Possible values: <= 20 characters

    Example: 10987654321
    travelAgency object

    Information about the travel agency if the ticket was issued by a travel agency.

    codestring

    Code identifying travel agency if the ticket was issued by a travel agency..

    Possible values: <= 8 characters

    Example: MY AGENT
    namestring

    Information about the travel agency if the ticket was issued by a travel agency.

    Possible values: <= 25 characters

    Example: MYAGENT347
    tripLegs object

    A grouping of four separate trip segments. Each leg contains detailed itinerary information.

    leg1 object

    Contains detailed itinerary information for one of the trip legs

    flight object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCodestring

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    Possible values: >= 2 characters and <= 2 characters

    Example: LH
    flightNumberstring

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    Possible values: non-empty and <= 5 characters

    Example: 0799
    serviceClassstring

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Example: F
    isStopOverAllowedboolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destinationstring

    Destination Airport Code (IATA Airport Code).

    Possible values: >= 3 characters and <= 3 characters

    Example: SOF
    fareBasisstring

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    Possible values: non-empty and <= 6 characters

    Example: VMAY
    departureDatedate

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    Example: 2022-12-20
    leg2 object

    Contains detailed itinerary information for one of the trip legs

    flight object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCodestring

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    Possible values: >= 2 characters and <= 2 characters

    Example: LH
    flightNumberstring

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    Possible values: non-empty and <= 5 characters

    Example: 0799
    serviceClassstring

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Example: F
    isStopOverAllowedboolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destinationstring

    Destination Airport Code (IATA Airport Code).

    Possible values: >= 3 characters and <= 3 characters

    Example: SOF
    fareBasisstring

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    Possible values: non-empty and <= 6 characters

    Example: VMAY
    departureDatedate

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    Example: 2022-12-20
    leg3 object

    Contains detailed itinerary information for one of the trip legs

    flight object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCodestring

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    Possible values: >= 2 characters and <= 2 characters

    Example: LH
    flightNumberstring

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    Possible values: non-empty and <= 5 characters

    Example: 0799
    serviceClassstring

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Example: F
    isStopOverAllowedboolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destinationstring

    Destination Airport Code (IATA Airport Code).

    Possible values: >= 3 characters and <= 3 characters

    Example: SOF
    fareBasisstring

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    Possible values: non-empty and <= 6 characters

    Example: VMAY
    departureDatedate

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    Example: 2022-12-20
    leg4 object

    Contains detailed itinerary information for one of the trip legs

    flight object

    Operating Carrier Code and the Number of the airline flight to be taken on Leg of the trip (excluding the carrier code).

    carrierCodestring

    Operating Carrier Code; the standard abbreviation code indicating name of the operating carrier like United Airlines, Jet Blue, etc.

    Possible values: >= 2 characters and <= 2 characters

    Example: LH
    flightNumberstring

    Number of the airline flight to be taken on Leg of the trip excluding the carrier code.

    Possible values: non-empty and <= 5 characters

    Example: 0799
    serviceClassstring

    Indicates service class (first class, business class, etc.). Example values (not limited to):

    • F - first class

    • J - business class

    • W - premium economy class

    • Y - economy class

    Possible values: non-empty and <= 1 characters, [F, J, W, Y]

    Example: F
    isStopOverAllowedboolean

    Indicates whether a stopover is allowed on this ticket. Valid values are:

    • false - not allowed

    • true - allowed

    destinationstring

    Destination Airport Code (IATA Airport Code).

    Possible values: >= 3 characters and <= 3 characters

    Example: SOF
    fareBasisstring

    Contains a Fare Basis Code for Leg that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable.

    Possible values: non-empty and <= 6 characters

    Example: VMAY
    departureDatedate

    Date of passenger’s departure for this leg. Date format = YYYY-MM-DD, ISO 8601 expected. For example, 2014-01-26

    Example: 2022-12-20
    passengerNameRecordstring

    The airline company uses the passengerNameRecord as a reservation number.

    Possible values: <= 10 characters

    Example: ABCDE12345
    additionalBookingReferencestring

    BookingReference field. Typically used for the PNR, but should allow an airline to specify any other reference if they feel fit.

    Possible values: <= 50 characters

    totalFarenumber

    Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets

    totalFeenumber

    Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets.

    totalTaxesnumber

    Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets.

    passengersstring

    Information about the passengers reserved tickets with the same transaction.

    fundingTransaction object

    The fundingTransaction object is used to identify authorization requests that are categorized as funding transactions by the merchant in order to provide information. It can be used by merchants registered with MCC 4829, 6012, 6051 or 6540.

    • SVDW_FUNDS_TRANSFER - Applicable for 4829, 6012 and 6540.

    • SDW_WALLET_TRANSFER - Applicable for 6051 only.

    Notes:

    • If you want to support funding transactions for additional MCCs, please contact Paysafe's operational support.

    • If you send fundingTransaction type value in the authorization request, but youracquirer doesn't support funding transactions or your account is not configured, the transaction will be declined with error: 5040.

    • If you send fundingTransaction type in the authorization request with value not applicable for your MCC, the transaction will be declined with error: 3068.

    • If you send fundingTransaction type in the authorization request with value not part of the list below, the transaction will be declined with error: 5068.

    • If you send fundingTransaction type value in the authorization request and your account is configured to process funding transactions, but you are not registered to process funding transactions to specific card brand, the transaction will be successfully processed and the processorAppliedType in the response will be "NOT_APPLIED".

    • If you send fundingTransaction type value in the authorization request and your account is configured to process funding transactions and you are registered to process funding transactions to the respective card brand, the transaction will be successfully processed and the processorAppliedType will be equal to the fundingTransaction type, provided in the request.

    • Suppose you send fundingTransaction type value in the authorization request, andyour account is configured to process funding transactions. You are registered to process funding transactions to the respective card brand. In that case, the transaction will be successfully processed, and the processorAppliedType will be equal to the fundingTransaction type provided in the request.

    • To Process the transaction the below fields are mandatory in transaction:

    Profile

    • firstName
    • lastName
    • merchantCustomerId

    Billing Details

    • street
    • city
    • state (If US or Canada)
    • country
    • Zip
    typestring

    The fundingTransaction type is included in the request and set by the merchant.Supported funding transaction type values:

    Possible values: [SVDW_FUNDS_TRANSFER, SDW_WALLET_TRANSFER]

    processorAppliedTypestring

    The fundingTransaction processorAppliedType value is chosen by Paysafe based on the merchant configuration. It is either equal to the funding transaction type sent by the merchant or "NOT_APPLIED" in case the merchant is not registered in the relevant card scheme system. The processorAppliedType can be seen in the auth response.Supported funding transaction processorAppliedType values:

    Possible values: [SVDW_FUNDS_TRANSFER, SDW_WALLET_TRANSFER, NOT_APLLIED]

    payment
    {
      "id": "3aeb9c63-6386-46a3-9f8e-f452e722228a",
      "availableToSettle": 0,
      "childAccountNum": "3216549877",
      "txnTime": "2023-01-19T16:33:49Z",
      "paymentType": "CARD",
      "status": "RECEIVED",
      "gatewayResponse": {
        "id": "string",
        "processor": "string",
        "code": "string",
        "responseCode": "string",
        "avsCode": "string",
        "avsResponse": "MATCH",
        "balanceResponse": "string",
        "mid": "string",
        "terminalId": "string",
        "batchNumber": "string",
        "seqNumber": "string",
        "effectiveDate": "string",
        "financingType": "string",
        "plan": "string",
        "gracePeriod": "string",
        "term": "string",
        "responseId": "string",
        "requestId": "string",
        "description": "string",
        "authCode": "string",
        "txnDateTime": "string",
        "referenceNbr": "string",
        "responseReasonCode": "string",
        "cvvVerification": "MATCH",
        "cvv2Result": "string",
        "status": "string",
        "orderId": "string",
        "profile": {
          "id": "string",
          "status": "string",
          "merchantCustomerId": "string",
          "locale": "en_US",
          "firstName": "Venkata Suresh",
          "lastName": "Chagalamarri",
          "email": "paysafe@gmail.com",
          "phone": "1234567891",
          "dateOfBirth": {
            "day": 6,
            "month": 5,
            "year": 1998
          },
          "mobile": "9846573804",
          "gender": "M",
          "nationality": "Indian",
          "identityDocuments": [
            {
              "identityDocuments": [
                {
                  "type": "SOCIAL_SECURITY",
                  "documentNumber": "SSN123456"
                },
                {
                  "type": "PASSPORT",
                  "documentNumber": "1234567",
                  "issuingCountry": "USA",
                  "issuingCountrySubdvision": "SA",
                  "expiryDate": {
                    "month": 12,
                    "year": 2022
                  }
                }
              ]
            }
          ]
        }
      },
      "riskReasonCode": [
        1001
      ],
      "settlements": [
        {
          "id": "25f6dadf-176a-415f-95c9-6ff39ff697ba",
          "paymentType": "CARD",
          "availableToRefund": 0,
          "childAccountNum": "1234567898",
          "txnTime": "2024-07-29T15:51:28.071Z",
          "status": "RECEIVED",
          "error": {
            "code": "5068",
            "message": "Field error(s)",
            "details": [
              "Either you submitted a request that is missing a mandatory field or the value of a field does not match the format expected."
            ],
            "fieldErrors": [
              {
                "field": "accountId",
                "error": "AccountId is missing in the request. If multiple accounts are registered with same currency, accountId is mandatory."
              }
            ]
          },
          "riskReasonCode": [
            0
          ],
          "gatewayResponse": {
            "id": "string",
            "processor": "string",
            "code": "string",
            "responseCode": "string",
            "avsCode": "string",
            "avsResponse": "MATCH",
            "balanceResponse": "string",
            "mid": "string",
            "terminalId": "string",
            "batchNumber": "string",
            "seqNumber": "string",
            "effectiveDate": "string",
            "financingType": "string",
            "plan": "string",
            "gracePeriod": "string",
            "term": "string",
            "responseId": "string",
            "requestId": "string",
            "description": "string",
            "authCode": "string",
            "txnDateTime": "string",
            "referenceNbr": "string",
            "responseReasonCode": "string",
            "cvvVerification": "MATCH",
            "cvv2Result": "string",
            "status": "string",
            "orderId": "string",
            "profile": {
              "id": "string",
              "status": "string",
              "merchantCustomerId": "string",
              "locale": "en_US",
              "firstName": "Venkata Suresh",
              "lastName": "Chagalamarri",
              "email": "paysafe@gmail.com",
              "phone": "1234567891",
              "dateOfBirth": {
                "day": 6,
                "month": 5,
                "year": 1998
              },
              "mobile": "9846573804",
              "gender": "M",
              "nationality": "Indian",
              "identityDocuments": [
                {
                  "identityDocuments": [
                    {
                      "type": "SOCIAL_SECURITY",
                      "documentNumber": "SSN123456"
                    },
                    {
                      "type": "PASSPORT",
                      "documentNumber": "1234567",
                      "issuingCountry": "USA",
                      "issuingCountrySubdvision": "SA",
                      "expiryDate": {
                        "month": 12,
                        "year": 2022
                      }
                    }
                  ]
                }
              ]
            }
          },
          "gatewayReconciliationId": "a5c80e61-e747-455f-843d-2b9526f9963e",
          "liveMode": true,
          "updatedTime": "2023-01-19T10:48:04Z",
          "statusTime": "2023-01-19T10:48:04Z",
          "merchantRefNum": "string",
          "amount": 0,
          "dupCheck": true,
          "splitpay": [
            {
              "linkedAccount": "123124124",
              "amount": 505,
              "percent": 5
            }
          ],
          "airlineTravelDetails": {
            "passengerName": "Venkata Suresh",
            "departureDate": "2022-12-20",
            "origin": "SXF",
            "computerizedReservationSystem": "DATS",
            "ticket": {
              "ticketNumber": "1234567891011",
              "isRestrictedTicket": true
            },
            "customerReferenceNumber": "10987654321",
            "travelAgency": {
              "code": "MY AGENT",
              "name": "MYAGENT347"
            },
            "tripLegs": {
              "leg1": {
                "flight": {
                  "carrierCode": "LH",
                  "flightNumber": "0799"
                },
                "serviceClass": "F",
                "isStopOverAllowed": true,
                "destination": "SOF",
                "fareBasis": "VMAY",
                "departureDate": "2022-12-20"
              },
              "leg2": {
                "flight": {
                  "carrierCode": "LH",
                  "flightNumber": "0799"
                },
                "serviceClass": "F",
                "isStopOverAllowed": true,
                "destination": "SOF",
                "fareBasis": "VMAY",
                "departureDate": "2022-12-20"
              },
              "leg3": {
                "flight": {
                  "carrierCode": "LH",
                  "flightNumber": "0799"
                },
                "serviceClass": "F",
                "isStopOverAllowed": true,
                "destination": "SOF",
                "fareBasis": "VMAY",
                "departureDate": "2022-12-20"
              },
              "leg4": {
                "flight": {
                  "carrierCode": "LH",
                  "flightNumber": "0799"
                },
                "serviceClass": "F",
                "isStopOverAllowed": true,
                "destination": "SOF",
                "fareBasis": "VMAY",
                "departureDate": "2022-12-20"
              }
            },
            "passengerNameRecord": "ABCDE12345",
            "additionalBookingReference": "string",
            "totalFare": 0,
            "totalFee": 0,
            "totalTaxes": 0,
            "passengers": "string"
          }
        }
      ],
      "error": {
        "code": "5068",
        "message": "Field error(s)",
        "details": [
          "Either you submitted a request that is missing a mandatory field or the value of a field does not match the format expected."
        ],
        "fieldErrors": [
          {
            "field": "accountId",
            "error": "AccountId is missing in the request. If multiple accounts are registered with same currency, accountId is mandatory."
          }
        ]
      },
      "statusReason": "string",
      "authentication": {
        "id": "5d4db3bc-34c9-417f-a051-0d992ad9284e",
        "eci": 5,
        "cavv": "AAABBhkXYgAAAAACBxdiENhf7A+=",
        "xid": "aWg4N1ZZOE53TkFrazJuMmkyRDA=",
        "status": "COMPLETED ",
        "merchantRefNum": "merchantABC-123-authentications",
        "threeDEnrollment": "Y",
        "threeDResult": "Y",
        "signatureStatus": "Y",
        "error": {
          "code": "5068",
          "message": "Field error(s)",
          "details": [
            "Either you submitted a request that is missing a mandatory field or the value of a field does not match the format expected."
          ],
          "fieldErrors": [
            {
              "field": "accountId",
              "error": "AccountId is missing in the request. If multiple accounts are registered with same currency, accountId is mandatory."
            }
          ]
        }
      },
      "gatewayReconciliationId": "4bbfba66-a15b-4fa5-ad77-c209ffdb914f",
      "updatedTime": "2023-01-19T08:37:50Z",
      "statusTime": "2023-01-19T08:37:50Z",
      "availableToRefund": 0,
      "links": {
        "rel": "redirect_payment",
        "href": "http://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709",
        "method": "GET"
      },
      "liveMode": true,
      "billingDetails": {
        "id": "string",
        "status": "string",
        "nickName": "Home",
        "street": "Street",
        "street1": "street1",
        "street2": "street2",
        "city": "Toronto",
        "state": "ON",
        "country": "CA",
        "zip": "M5H 2N2",
        "phone": "8765846321"
      },
      "customerProfile": {
        "id": "string",
        "status": "string",
        "merchantCustomerId": "string",
        "locale": "en_US",
        "firstName": "Venkata Suresh",
        "lastName": "Chagalamarri",
        "email": "paysafe@gmail.com",
        "phone": "1234567891",
        "dateOfBirth": {
          "day": 6,
          "month": 5,
          "year": 1998
        },
        "mobile": "9846573804",
        "gender": "M",
        "nationality": "Indian",
        "identityDocuments": [
          {
            "identityDocuments": [
              {
                "type": "SOCIAL_SECURITY",
                "documentNumber": "SSN123456"
              },
              {
                "type": "PASSPORT",
                "documentNumber": "1234567",
                "issuingCountry": "USA",
                "issuingCountrySubdvision": "SA",
                "expiryDate": {
                  "month": 12,
                  "year": 2022
                }
              }
            ]
          }
        ]
      },
      "merchantRefNum": "445186567390019700",
      "amount": 500,
      "dupCheck": true,
      "settleWithAuth": true,
      "preAuth": true,
      "partialAuth": {
        "requested": true,
        "amountDue": 1000,
        "originalAmount": 2000
      },
      "paymentHandleToken": "SAJyTBzCvS8YHwwb",
      "customerIp": "172.0.0.1",
      "description": "Magazine subscription",
      "currencyCode": "USD",
      "level2level3": {
        "exemptLocalTax": true,
        "localTaxAmount": 1500,
        "nationalTaxAmount": 0,
        "freightAmount": 0,
        "dutyAmount": 0,
        "destinationZip": "90210",
        "destinationCountry": "US",
        "shipFromZip": "90211",
        "lineItems": {
          "description": "Disney Cruise Line",
          "productCode": "DCL",
          "quantity": 4,
          "unitAmount": 120000,
          "taxRate": 5,
          "taxAmount": 24000,
          "totalAmount": 0
        }
      },
      "accordD": {
        "financingType": "DEFERRED_PAYMENT",
        "plan": "124",
        "gracePeriod": 12,
        "term": 12
      },
      "recipient": {
        "dateOfBirth": {
          "day": 6,
          "month": 5,
          "year": 1998
        },
        "zip": "CB24 9AD",
        "lastName": "Chagalamarri",
        "accountNumber": "ABC1234567890"
      },
      "splitpay": {
        "linkedAccount": "123124124",
        "amount": 505,
        "percent": 5
      },
      "storedCredentialDetails": {
        "type": "ADHOC",
        "occurrence": "INITIAL",
        "initialTransactionId": "string",
        "externalInitialTransactionId": "string"
      },
      "airlineTravelDetails": {
        "passengerName": "Venkata Suresh",
        "departureDate": "2022-12-20",
        "origin": "SXF",
        "computerizedReservationSystem": "DATS",
        "ticket": {
          "ticketNumber": "1234567891011",
          "isRestrictedTicket": true
        },
        "customerReferenceNumber": "10987654321",
        "travelAgency": {
          "code": "MY AGENT",
          "name": "MYAGENT347"
        },
        "tripLegs": {
          "leg1": {
            "flight": {
              "carrierCode": "LH",
              "flightNumber": "0799"
            },
            "serviceClass": "F",
            "isStopOverAllowed": true,
            "destination": "SOF",
            "fareBasis": "VMAY",
            "departureDate": "2022-12-20"
          },
          "leg2": {
            "flight": {
              "carrierCode": "LH",
              "flightNumber": "0799"
            },
            "serviceClass": "F",
            "isStopOverAllowed": true,
            "destination": "SOF",
            "fareBasis": "VMAY",
            "departureDate": "2022-12-20"
          },
          "leg3": {
            "flight": {
              "carrierCode": "LH",
              "flightNumber": "0799"
            },
            "serviceClass": "F",
            "isStopOverAllowed": true,
            "destination": "SOF",
            "fareBasis": "VMAY",
            "departureDate": "2022-12-20"
          },
          "leg4": {
            "flight": {
              "carrierCode": "LH",
              "flightNumber": "0799"
            },
            "serviceClass": "F",
            "isStopOverAllowed": true,
            "destination": "SOF",
            "fareBasis": "VMAY",
            "departureDate": "2022-12-20"
          }
        },
        "passengerNameRecord": "ABCDE12345",
        "additionalBookingReference": "string",
        "totalFare": 0,
        "totalFee": 0,
        "totalTaxes": 0,
        "passengers": "string"
      },
      "fundingTransaction": {
        "type": "SVDW_FUNDS_TRANSFER",
        "processorAppliedType": "SVDW_FUNDS_TRANSFER"
      },
      "card": {
        "cardNum": "4111111111111111",
        "cardExpiry": {
          "month": 12,
          "year": 2022
        },
        "cvv": "string",
        "holderName": "Suresh's card",
        "cardType": "AM",
        "lastDigits": "string",
        "nickName": "string",
        "cardBin": "411111"
      }
    }