gatewayResponse

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

MOD1
MOD2

]

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
            }
          }
        ]
      }
    ]
  }
}