Skip to main content

Get Payments

GET 
/v1/payments/:paymentId

Click on Send API Request after entering the required data, to look up a Payment using the ID returned in the response of the original request.

Request​

Path Parameters

    paymentId stringrequired

    This is the ID returned in the response of the Payments request.

Responses​

OK

Response Headers

  • Content-Type

    string

Schema

    oneOf

    card

    object

    Card details to be used for the transaction

    cardNum stringrequired

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

    This is the card number used for the request.

    cardExpiry

    object

    This is the card's expiry date.

    month numberrequired

    Possible values: <= 12

    This is the card expiry month.

    year numberrequired

    Possible values: <= 9999

    This is the card expiry year.

    cvv string

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

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

    holderName string

    Possible values: <= 50 characters

    This is the name of the card holder.

    cardType string

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

    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

    lastDigits string

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

    nickName string

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

    cardBin string

    Possible values: <= 6 characters

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

    id string

    Possible values: <= 36 characters

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

    availableToSettle number

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

    childAccountNum string

    Possible values: <= 10 characters

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

    txnTime date-time

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

    paymentType string

    Possible values: [CARD, PAYSAFECARD, RAPID_TRANSFER, ACH]

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

    status string

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

    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.

    gatewayResponse

    object

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

    id string

    This is the response id returned by the processor

    processor string

    This is the processor code of the transaction at Paysafe side

    code string

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

    responseCode string

    This is the raw response returned by the acquirer.

    avsCode string

    This is the raw AVS code returned by the acquirer.

    avsResponse string

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

    This is the AVS response returned from the card issuer.

    balanceResponse string

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

    mid string

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

    terminalId string

    This is the merchant's terminal ID.

    batchNumber string

    This is the batch number.

    seqNumber string

    This is the merchant's sequence number.

    effectiveDate string

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

    financingType string

    This is the type of financing offered.

    plan string

    This is the plan number for this financing transaction.

    gracePeriod string

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

    term string

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

    responseId string

    This is the response ID assigned by Credorax.

    requestId string

    This is the request ID assigned by Paysafe.

    description string

    This is a description of the response.

    authCode string

    This is the authorization code.

    txnDateTime string

    This is the transaction date and time.

    referenceNbr string

    This is the Bank net transaction ID/Merch Tran Ref

    responseReasonCode string

    This is the raw response reason code returned by Credorax.

    cvvVerification string

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

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

    cvv2Result string

    This is the raw cvv2 result code.

    status string

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

    orderId string

    Unique NETELLER reference for the order.

    profile

    object

    This is customer's profile details.

    id string

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

    status string

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

    merchantCustomerId string

    Possible values: <= 10 characters

    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.

    locale stringrequired

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

    This indicates the customer's locale preference.

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

    firstName stringrequired

    Possible values: <= 80 characters

    This is the customer’s first name.

    lastName stringrequired

    Possible values: <= 80 characters

    This is the customer’s last name.

    email stringrequired

    Possible values: <= 255 characters

    This is the customer's email address.

    phone string

    Possible values: <= 40 characters

    This is the customer's phone number.

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

    dateOfBirth

    object

    This is the recipient's date of birth.

    day numberrequired

    Possible values: <= 31

    This is the day of birth.

    month numberrequired

    Possible values: <= 12

    This is the month of birth.

    year numberrequired

    Possible values: >= 1900

    This is the year of birth.

    mobile string

    Possible values: <= 40 characters

    Customer's mobile number.

    gender string

    Possible values: [M, F]

    This field indicates the Customer's gender.

    M - Male

    F - Female

    nationality string

    Possible values: <= 30 characters

    This field indicates the Customer's nationality.

    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

    type stringrequired

    Possible values: [SOCIAL_SECURITY]

    Default value: SOCIAL_SECURITY

    Value will always be "SOCIAL_SECURITY" This is part of 1st JSON object.

    documentNumber stringrequired

    Possible values: <= 9 characters

    The customer’s social security number.

  • ]

  • ]

    • riskReasonCode integer[]

    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 [

    • id string

    Possible values: <= 36 characters

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

    paymentType string

    Possible values: [CARD, PAYSAFECARD]

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

    availableToRefund number

    Possible values: <= 99999999999

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

    childAccountNum string

    Possible values: <= 10 characters

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

    txnTime date-time

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

    status string

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

    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.

    error

    object

    Details of the error.

    code string

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

    message string

    A description of the error.

    details string[]

    Details of any parameter value errors.

    fieldErrors

    object[]

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

  • Array [

    • field string

    Identifies the JSON request field.

    error string

    The problem associated with field.

  • ]

    • riskReasonCode integer[]

    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.

    id string

    This is the response id returned by the processor

    processor string

    This is the processor code of the transaction at Paysafe side

    code string

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

    responseCode string

    This is the raw response returned by the acquirer.

    avsCode string

    This is the raw AVS code returned by the acquirer.

    avsResponse string

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

    This is the AVS response returned from the card issuer.

    balanceResponse string

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

    mid string

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

    terminalId string

    This is the merchant's terminal ID.

    batchNumber string

    This is the batch number.

    seqNumber string

    This is the merchant's sequence number.

    effectiveDate string

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

    financingType string

    This is the type of financing offered.

    plan string

    This is the plan number for this financing transaction.

    gracePeriod string

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

    term string

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

    responseId string

    This is the response ID assigned by Credorax.

    requestId string

    This is the request ID assigned by Paysafe.

    description string

    This is a description of the response.

    authCode string

    This is the authorization code.

    txnDateTime string

    This is the transaction date and time.

    referenceNbr string

    This is the Bank net transaction ID/Merch Tran Ref

    responseReasonCode string

    This is the raw response reason code returned by Credorax.

    cvvVerification string

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

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

    cvv2Result string

    This is the raw cvv2 result code.

    status string

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

    orderId string

    Unique NETELLER reference for the order.

    profile

    object

    This is customer's profile details.

    id string

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

    status string

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

    merchantCustomerId string

    Possible values: <= 10 characters

    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.

    locale stringrequired

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

    This indicates the customer's locale preference.

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

    firstName stringrequired

    Possible values: <= 80 characters

    This is the customer’s first name.

    lastName stringrequired

    Possible values: <= 80 characters

    This is the customer’s last name.

    email stringrequired

    Possible values: <= 255 characters

    This is the customer's email address.

    phone string

    Possible values: <= 40 characters

    This is the customer's phone number.

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

    dateOfBirth

    object

    This is the recipient's date of birth.

    day numberrequired

    Possible values: <= 31

    This is the day of birth.

    month numberrequired

    Possible values: <= 12

    This is the month of birth.

    year numberrequired

    Possible values: >= 1900

    This is the year of birth.

    mobile string

    Possible values: <= 40 characters

    Customer's mobile number.

    gender string

    Possible values: [M, F]

    This field indicates the Customer's gender.

    M - Male

    F - Female

    nationality string

    Possible values: <= 30 characters

    This field indicates the Customer's nationality.

    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

    type stringrequired

    Possible values: [SOCIAL_SECURITY]

    Default value: SOCIAL_SECURITY

    Value will always be "SOCIAL_SECURITY" This is part of 1st JSON object.

    documentNumber stringrequired

    Possible values: <= 9 characters

    The customer’s social security number.

  • ]

  • ]

    • gatewayReconciliationId string

    Possible values: <= 36 characters

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

    liveMode boolean

    This flag indicates the envrionment.

    • true - Production
    • false - Non-Production
    updatedTime date-time

    Indicates the last updated time for the resource.

    statusTime date-time

    Indicates the last updated time for the resource.

    merchantRefNum stringrequired

    Possible values: <= 255 characters

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

    amount number

    Possible values: <= 99999999999

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

    dupCheck boolean

    Default value: true

    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

    splitpay

    object[]

  • Array [

    • linkedAccount stringrequired

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

    amount number

    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.

    percent number

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

  • ]

    • airlineTravelDetails

    object

    Contains information about your airline travel.

    Note: This object is only for Airline Merchants.

    passengerName stringrequired

    Possible values: <= 20 characters

    Name of the passenger to whom the ticket was issued.

    departureDate daterequired

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

    origin stringrequired

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

    Departure Airport Code: IATA Airport Code.

    computerizedReservationSystem string

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

    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.

    ticket

    object

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

    ticketNumber stringrequired

    Possible values: <= 20 characters

    Airline ticket number

    isRestrictedTicket boolean

    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'

    customerReferenceNumber string

    Possible values: <= 20 characters

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

    travelAgency

    object

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

    code string

    Possible values: <= 8 characters

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

    name string

    Possible values: <= 25 characters

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

    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).

    carrierCode string

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

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

    flightNumber string

    Possible values: non-empty and <= 5 characters

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

    serviceClass string

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

    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

    isStopOverAllowed boolean

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

    • false - not allowed

    • true - allowed

    destination string

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

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

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

    departureDate date

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

    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).

    carrierCode string

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

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

    flightNumber string

    Possible values: non-empty and <= 5 characters

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

    serviceClass string

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

    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

    isStopOverAllowed boolean

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

    • false - not allowed

    • true - allowed

    destination string

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

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

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

    departureDate date

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

    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).

    carrierCode string

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

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

    flightNumber string

    Possible values: non-empty and <= 5 characters

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

    serviceClass string

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

    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

    isStopOverAllowed boolean

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

    • false - not allowed

    • true - allowed

    destination string

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

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

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

    departureDate date

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

    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).

    carrierCode string

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

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

    flightNumber string

    Possible values: non-empty and <= 5 characters

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

    serviceClass string

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

    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

    isStopOverAllowed boolean

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

    • false - not allowed

    • true - allowed

    destination string

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

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

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

    departureDate date

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

    passengerNameRecord string

    Possible values: <= 10 characters

    The airline company uses the passengerNameRecord as a reservation number.

    additionalBookingReference string

    Possible values: <= 50 characters

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

    totalFare number

    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

    totalFee number

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

    totalTaxes number

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

    passengers string

    Information about the passengers reserved tickets with the same transaction.

  • ]

    • error

    object

    Details of the error.

    code string

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

    message string

    A description of the error.

    details string[]

    Details of any parameter value errors.

    fieldErrors

    object[]

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

  • Array [

    • field string

    Identifies the JSON request field.

    error string

    The problem associated with field.

  • ]

    • statusReason string

    Possible values: <= 255 characters

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

    authentication

    object

    3D Secure authentication details.

    id string

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

    eci number

    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.

    cavv string

    Possible values: <= 80 characters

    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.

    xid string

    Possible values: <= 40 characters

    This is the transaction identifier returned by the card issuer.

    status string

    Possible values: [COMPLETED , FAILED]

    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.

    merchantRefNum string

    Possible values: <= 255 characters

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

    threeDEnrollment string

    Possible values: [Y, N, U]

    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

    threeDResult string

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

    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.

    signatureStatus string

    Possible values: [Y, N]

    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.

    error

    object

    Details of the error.

    code string

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

    message string

    A description of the error.

    details string[]

    Details of any parameter value errors.

    fieldErrors

    object[]

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

  • Array [

    • field string

    Identifies the JSON request field.

    error string

    The problem associated with field.

  • ]

    • gatewayReconciliationId string

    Possible values: <= 36 characters

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

    updatedTime date-time

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

    statusTime date-time

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

    availableToRefund number

    Possible values: <= 99999999999

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

    links

    object

    URL links to redirect customer during transaction flow

    rel string

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

    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.

    href string

    The url to be used for further actions.

    method string

    The corresponding HTTP request method to be invoked on url.

    liveMode boolean

    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.

    id string

    Possible values: <= 36 characters

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

    status string

    This is the status of the address.

    nickName string

    Possible values: <= 50 characters

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

    street stringrequired

    Possible values: <= 50 characters

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

    street1 string

    Possible values: <= 50 characters

    This is the first line of the street address.

    Note: Mandatory for VIPPreferred

    street2 string

    Possible values: <= 50 characters

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

    city stringrequired

    Possible values: <= 40 characters

    This is the city where the address is located.

    state string

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

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

    country stringrequired

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

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

    zip stringrequired

    Possible values: <= 10 characters

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

    phone string

    Possible values: <= 40 characters

    This is the customer's telephone number.

    customerProfile

    object

    This is customer's profile details.

    id string

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

    status string

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

    merchantCustomerId string

    Possible values: <= 10 characters

    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.

    locale stringrequired

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

    This indicates the customer's locale preference.

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

    firstName stringrequired

    Possible values: <= 80 characters

    This is the customer’s first name.

    lastName stringrequired

    Possible values: <= 80 characters

    This is the customer’s last name.

    email stringrequired

    Possible values: <= 255 characters

    This is the customer's email address.

    phone string

    Possible values: <= 40 characters

    This is the customer's phone number.

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

    dateOfBirth

    object

    This is the recipient's date of birth.

    day numberrequired

    Possible values: <= 31

    This is the day of birth.

    month numberrequired

    Possible values: <= 12

    This is the month of birth.

    year numberrequired

    Possible values: >= 1900

    This is the year of birth.

    mobile string

    Possible values: <= 40 characters

    Customer's mobile number.

    gender string

    Possible values: [M, F]

    This field indicates the Customer's gender.

    M - Male

    F - Female

    nationality string

    Possible values: <= 30 characters

    This field indicates the Customer's nationality.

    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

    type stringrequired

    Possible values: [SOCIAL_SECURITY]

    Default value: SOCIAL_SECURITY

    Value will always be "SOCIAL_SECURITY" This is part of 1st JSON object.

    documentNumber stringrequired

    Possible values: <= 9 characters

    The customer’s social security number.

  • ]

  • ]

    • merchantRefNum stringrequired

    Possible values: <= 255 characters

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

    amount numberrequired

    Possible values: <= 99999999999

    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.

    dupCheck boolean

    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.

    settleWithAuth boolean

    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.

    preAuth boolean

    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.

    requested boolean

    This specifies whether or not a partial authorization was requested.

    amountDue number

    Possible values: <= 99999999999

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

    originalAmount number

    Possible values: <= 99999999999

    This is the actual amount of the full authorization.

    paymentHandleToken stringrequired

    Possible values: <= 36 characters

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

    customerIp string

    Possible values: <= 39 characters

    This is the customer's IP address.

    description string

    Possible values: <= 255 characters

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

    currencyCode stringrequired

    Possible values: <= 3 characters

    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.

    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.

    exemptLocalTax boolean

    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

    localTaxAmount number

    This is the local sales tax applied to the purchase.

    nationalTaxAmount number

    Possible values: <= 99999999999

    This is the national tax included in the transaction amount.

    freightAmount number

    Possible values: <= 99999999999

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

    dutyAmount number

    Possible values: <= 99999999999

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

    destinationZip string

    Possible values: <= 10 characters

    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.

    destinationCountry string

    Possible values: <= 2 characters

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

    shipFromZip string

    Possible values: <= 10 characters

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

    lineItems

    object

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

    description string

    Possible values: <= 50 characters

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

    productCode string

    Possible values: <= 12 characters

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

    quantity number

    Possible values: <= 99999999999

    This is the quantity of the item.

    Note: Max 4 decimals is allowed.

    unitAmount number

    Possible values: <= 99999999999

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

    taxRate number

    Possible values: <= 100

    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.

    taxAmount number

    Possible values: <= 99999999999

    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.

    totalAmount number

    Possible values: <= 99999999999

    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.

    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.

    financingType string

    Possible values: [DEFERRED_PAYMENT, EQUAL_PAYMENT]

    This is the type of financing offered.

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

    Possible values: <= 3 characters

    This is the plan number for this financing transaction.

    gracePeriod number

    Possible values: <= 99

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

    term number

    Possible values: <= 99

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

    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.

    day numberrequired

    Possible values: <= 31

    This is the day of birth.

    month numberrequired

    Possible values: <= 12

    This is the month of birth.

    year numberrequired

    Possible values: >= 1900

    This is the year of birth.

    zip string

    Possible values: <= 10 characters

    This is the zip/postal code of the recipient.

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

    lastName string

    Possible values: <= 255 characters

    This is the recipient's last name.

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

    accountNumber string

    Possible values: <= 25 characters

    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.

    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.

    linkedAccount stringrequired

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

    amount number

    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.

    percent number

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

    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.

    type string

    Possible values: [ADHOC, TOPUP, RECURRING]

    Default value: ADHOC

    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.

    occurrence string

    Possible values: [INITIAL, SUBSEQUENT]

    Default value: INITIAL

    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.

    initialTransactionId string

    Possible values: <= 36 characters

    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.

    externalInitialTransactionId string

    Possible values: <= 256 characters

    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.

    airlineTravelDetails

    object

    Contains information about your airline travel.

    Note: This object is only for Airline Merchants.

    passengerName stringrequired

    Possible values: <= 20 characters

    Name of the passenger to whom the ticket was issued.

    departureDate daterequired

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

    origin stringrequired

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

    Departure Airport Code: IATA Airport Code.

    computerizedReservationSystem string

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

    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.

    ticket

    object

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

    ticketNumber stringrequired

    Possible values: <= 20 characters

    Airline ticket number

    isRestrictedTicket boolean

    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'

    customerReferenceNumber string

    Possible values: <= 20 characters

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

    travelAgency

    object

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

    code string

    Possible values: <= 8 characters

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

    name string

    Possible values: <= 25 characters

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

    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).

    carrierCode string

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

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

    flightNumber string

    Possible values: non-empty and <= 5 characters

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

    serviceClass string

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

    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

    isStopOverAllowed boolean

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

    • false - not allowed

    • true - allowed

    destination string

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

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

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

    departureDate date

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

    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).

    carrierCode string

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

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

    flightNumber string

    Possible values: non-empty and <= 5 characters

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

    serviceClass string

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

    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

    isStopOverAllowed boolean

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

    • false - not allowed

    • true - allowed

    destination string

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

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

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

    departureDate date

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

    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).

    carrierCode string

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

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

    flightNumber string

    Possible values: non-empty and <= 5 characters

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

    serviceClass string

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

    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

    isStopOverAllowed boolean

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

    • false - not allowed

    • true - allowed

    destination string

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

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

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

    departureDate date

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

    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).

    carrierCode string

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

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

    flightNumber string

    Possible values: non-empty and <= 5 characters

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

    serviceClass string

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

    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

    isStopOverAllowed boolean

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

    • false - not allowed

    • true - allowed

    destination string

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

    Destination Airport Code (IATA Airport Code).

    fareBasis string

    Possible values: non-empty and <= 6 characters

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

    departureDate date

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

    passengerNameRecord string

    Possible values: <= 10 characters

    The airline company uses the passengerNameRecord as a reservation number.

    additionalBookingReference string

    Possible values: <= 50 characters

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

    totalFare number

    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

    totalFee number

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

    totalTaxes number

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

    passengers string

    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

    type string

    Possible values: [SVDW_FUNDS_TRANSFER, SDW_WALLET_TRANSFER]

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

    processorAppliedType string

    Possible values: [SVDW_FUNDS_TRANSFER, SDW_WALLET_TRANSFER, NOT_APLLIED]

    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:

Loading...