Skip to main content

settlement

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.

    settlement
    {
      "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"
      }
    }