paymentResponse

The paymentResponse object contains transaction details.

Table 1. paymentResponse object
paymentResponse Format
transactionUuid

Unique transaction reference number generated by the payment gateway.

string

ans32

transactionId

Transaction reference when creating or updating a payment transaction.

Its value is unique on a given day.

  • This identifier can either be generated by the gateway.
  • Or by the merchant website.

an..6
amount

Transaction amount in the smallest currency unit (cents for euro) (cents for Swiss franc) (cents for Brazilian real) (cents for US dollar) (paisa for Indian rupee).

n..12
currency

Currency code of the transaction (ISO 4217 standard).

E.g.: 978 for euro (EUR)953 for CFP Franc (XPF)756 for Swiss Franc (CHF)986 for Brazilian Real (BRL)840 for US Dollar (USD)952 for CFA Franc (XOF) or 324 for Guinea Franc (GNF)356 forINR

n3
effectiveAmount

Transaction amount in the currency used for the capture in the bank.

n..12
effectiveCurrency

Currency used for the capture in the bank.

n3
expectedCaptureDate

Desired capture date.

Note: if the capture delay is higher than 365 days in the payment request, it will be automatically reset to 365 days.

dateTime ans..40
operationType

Type of operation.

The possible values are:

  • 0 for a debit operation.
  • 1 for a refund operation.
  • 5 for a VERIFICATION type transaction.
n1
creationDate

Transaction registration date and time in W3C format.

dateTime ans..40
externalTransactionId

Reference provided by a third party: transaction number for PayPal, Boleto, RRN for Prism, etc.

string
liabilityShift

Liability shift.

The possible values are:

  • YES when the payment is guaranteed.
  • NO when the payment is not guaranteed.
string
paymentType

Payment type

The possible values are:

  • SINGLE
    Immediate payment.
  • INSTALLMENT
    Installment payment.
  • SPLIT
    Payment performed with several payment methods.
  • SUBSCRIPTION
    Payment by token or recurring payment.Also applies to Verification type transactions (token creation and update).
  • RETRY
    When a payment is declined, it is possible to retry the payment request. In case of a reiteration, the payment is set with this value.

Note:

The INSTALLMENT and SPLIT values can be returned only if some payments have been created via the payment form.

string

(enum)

sequenceNumber
Sequence number of the transaction. Its value depends on the context of the payment:
  • It is set to "1" for a single payment.
  • It is set to "2" for a retry of an initially rejected payment.
  • Takes the value of the sequence number in case of installment payment created via a payment form.
n..3
paymentError

More information on the technical error. Returns the error code associated with the technical error (see chapter Error codes that can occur during the payment).

n..3
nsu

Appears when isNsuRequested is set to 1 in the query.

string