4.0.0 • Published 5 years ago

@datafire/adyen_paymentservice v4.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/adyen_paymentservice

Client library for Adyen Payment API

Installation and Usage

npm install --save @datafire/adyen_paymentservice
let adyen_paymentservice = require('@datafire/adyen_paymentservice').create({
  ApiKeyAuth: "",
  username: "",
  password: ""
});

.then(data => {
  console.log(data);
});

Description

A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.

To learn more about the API, visit Classic integration.

Authentication

To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in How to get the WS user password. Then use its credentials to authenticate your request, for example:

curl
-U "ws@Company.YourCompany":"YourWsPassword" \
-H "Content-Type: application/json" \
...

Note that when going live, you need to generate new web service user credentials to access the live endpoints.

Versioning

Payments API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://pal-test.adyen.com/pal/servlet/Payment/v40/authorise

Actions

adjustAuthorisation.post

Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables tipping, improving the chances your authorisation will be valid, charging the shopper when they have already left the merchant premises, etc.

For more information, refer to Adjust Authorisation.

adyen_paymentservice.adjustAuthorisation.post({}, context)

Input

Output

authorise.post

Creates a payment with a unique reference (pspReference) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.

For more information, refer to Classic integration.

adyen_paymentservice.authorise.post({}, context)

Input

Output

authorise3d.post

For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the md and paResponse parameters that you get from the card issuer after a shopper pays via 3D Secure.

For more information, refer to 3D Secure.

adyen_paymentservice.authorise3d.post({}, context)

Input

Output

authorise3ds2.post

For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the threeDS2Token and threeDS2Result parameters.

For more information, refer to 3D Secure 2.

adyen_paymentservice.authorise3ds2.post({}, context)

Input

Output

cancel.post

Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.

For more information, refer to Cancel.

adyen_paymentservice.cancel.post({}, context)

Input

Output

cancelOrRefund.post

Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).

Do not use this request for payments that involve (multiple) partial captures.

For more information, refer to Cancel or refund.

adyen_paymentservice.cancelOrRefund.post({}, context)

Input

Output

capture.post

Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.

Payment methods, which automatically capture as part of authorisation, don't need to be captured, but submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.

For more information, refer to Capture.

adyen_paymentservice.capture.post({}, context)

Input

Output

donate.post

Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.

For more information, see Donate.

adyen_paymentservice.donate.post({}, context)

Input

Output

refund.post

Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.

Some payment methods/gateways do not support partial/multiple refunds. A margin above the captured limit can be configured to cover shipping/handling costs.

For more information, refer to Refund.

adyen_paymentservice.refund.post({}, context)

Input

Output

retrieve3ds2Result.post

Retrieves the threeDS2Result after doing a 3D Secure 2 authentication only.

adyen_paymentservice.retrieve3ds2Result.post({}, context)

Input

Output

technicalCancel.post

This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available.

In your call, refer to the original payment by using the reference that you specified in your payment request.

For more information, see Technical cancel.

adyen_paymentservice.technicalCancel.post({}, context)

Input

Output

voidPendingRefund.post

This endpoint allows you to cancel the refund request before it has been completed.

In your call, you can refer to the original refund request either by using the tenderReference, or the pspReference. We recommend implementing based on the tenderReference, as this is generated for both offline and online transactions.

For more information, refer to Cancel a refund.

adyen_paymentservice.voidPendingRefund.post({}, context)

Input

Output

Definitions

AccountInfo

  • AccountInfo object
    • accountAgeIndicator string (values: notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator for the length of time since this shopper account was created in the merchant's environment.
    • accountChangeDate string: Date when the shopper's account was last changed.
    • accountChangeIndicator string (values: thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator for the length of time since the shopper's account was last updated.
    • accountCreationDate string: Date when the shopper's account was created.
    • addCardAttemptsDay integer: Number of attempts the shopper tried to add a card to their account in the last day.
    • deliveryAddressUsageDate string: Date the selected delivery address was first used.
    • deliveryAddressUsageIndicator string (values: thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator for the length of time since this delivery address was first used.
    • homePhone string: Shopper's home phone number (including the country code).
    • mobilePhone string: Shopper's mobile phone number (including the country code).
    • passwordChangeDate string: Date when the shopper last changed their password.
    • passwordChangeIndicator string (values: notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator when the shopper has changed their password.
    • pastTransactionsDay integer: Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.
    • pastTransactionsYear integer: Number of all transactions (successful and abandoned) from this shopper in the past year.
    • paymentAccountAge string: Date this payment method was added to the shopper's account.
    • paymentAccountIndicator string (values: notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator for the length of time since this payment method was added to this shopper's account.
    • purchasesLast6Months integer: Number of successful purchases in the last six months.
    • suspiciousActivity boolean: Whether suspicious activity was recorded on this account.
    • workPhone string: Shopper's work phone number (including the country code).

AdditionalData3DSecure

  • AdditionalData3DSecure object
    • allow3DS2 string: This parameter indicates that you are able to process 3D Secure 2 transactions natively on your payment page. Send this field when you are using /payments endpoint with any of our native 3D Secure 2 solutions, such as Components or Drop-in. Possible values:
    • executeThreeD string: This parameter indicates if you want to perform 3D Secure authentication on a transaction or not. Allowed values:
    • mpiImplementationType string: In case of Secure+, this field must be set to CUPSecurePlus.
    • scaExemption string: Indicates the exemption type that you want to request for the transaction. Possible values:

AdditionalDataAirline

  • AdditionalDataAirline object
    • airline.agency_invoice_number string: Reference number for the invoice, issued by the agency.
    • airline.agency_plan_name string: 2-letter agency plan identifier; alphabetical.
    • airline.airline_code string: IATA 3-digit accounting code (PAX); numeric. It identifies the carrier.
    • airline.airline_designator_code string: IATA 2-letter accounting code (PAX); alphabetical. It identifies the carrier.
    • airline.boarding_fee string: Chargeable amount for boarding the plane.
    • airline.computerized_reservation_system string: The CRS used to make the reservation and purchase the ticket.
    • airline.customer_reference_number string: Reference number; alphanumeric.
    • airline.document_type string: Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.
    • airline.flight_date string: Flight departure date. Local time (HH:mm) is optional.
    • airline.leg.carrier_code string: IATA 2-letter accounting code (PAX); alphabetical. It identifies the carrier.
    • airline.leg.class_of_travel string: 1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:
    • airline.leg.date_of_travel string:
    • airline.leg.depart_airport string: Alphabetical identifier of the departure airport.
    • airline.leg.depart_tax string: Departure tax. Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the following table.
    • airline.leg.destination_code string: Alphabetical identifier of the destination/arrival airport.
    • airline.leg.fare_base_code string: Fare basis code; alphanumeric.
    • airline.leg.flight_number string: The flight identifier.
    • airline.leg.stop_over_code string: 1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:
    • airline.passenger.date_of_birth string: Date of birth of the passenger.
    • airline.passenger.first_name string: Passenger first name/given name.
    • airline.passenger.last_name string: Passenger last name/family name.
    • airline.passenger.telephone_number string: Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.
    • airline.passenger.traveller_type string: Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.
    • airline.passenger_name required string: Passenger name, initials, and a title.
    • airline.ticket_issue_address string: Address of the place/agency that issued the ticket.
    • airline.ticket_number string: The ticket's unique identifier.
    • airline.travel_agency_code string: IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.
    • airline.travel_agency_name string: The name of the travel agency.

AdditionalDataCarRental

  • AdditionalDataCarRental object
    • carRental.checkOutDate string: Pick-up date.
    • carRental.customerServiceTollFreeNumber string: The customer service phone number of the car rental company.
    • carRental.daysRented string: Number of days for which the car is being rented.
    • carRental.fuelCharges string: Any fuel charges associated with the rental.
    • carRental.insuranceCharges string: Any insurance charges associated with the rental.
    • carRental.locationCity string: The city from which the car is rented.
    • carRental.locationCountry string: The country from which the car is rented.
    • carRental.locationStateProvince string: The state or province from where the car is rented.
    • carRental.noShowIndicator string: Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
    • carRental.oneWayDropOffCharges string: Charge associated with not returning a vehicle to the original rental location.
    • carRental.rate string: Daily rental rate.
    • carRental.rateIndicator string: Specifies whether the given rate is applied daily or weekly.
    • carRental.rentalAgreementNumber string: The rental agreement number associated with this car rental.
    • carRental.rentalClassId string: Daily rental rate.
    • carRental.renterName string: The name of the person renting the car.
    • carRental.returnCity string: The city where the car must be returned.
    • carRental.returnCountry string: The country where the car must be returned.
    • carRental.returnDate string: The last date to return the car by.
    • carRental.returnLocationId string: Agency code, phone number, or address abbreviation
    • carRental.returnStateProvince string: The state or province where the car must be returned.
    • carRental.taxExemptIndicator string: Indicates whether the goods or services were tax-exempt, or tax was not collected.
    • travelEntertainmentAuthData.duration string: Number of nights. This should be included in the auth message.
    • travelEntertainmentAuthData.market string: Indicates what market-specific dataset will be submitted or is being submitted. Value should be "A" for Car rental. This should be included in the auth message.

AdditionalDataCommon

  • AdditionalDataCommon object
    • RequestedTestErrorResponseCode string: Triggers test scenarios that allow to replicate certain communication errors.
    • authorisationType string: Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to Authorisation types.
    • customRoutingFlag string: Allows you to determine or override the acquirer account that should be used for the transaction.
    • networkTxReference string: Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.
    • overwriteBrand string: Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the selectedBrand value to specify how to process the transaction.
    • subMerchantCity string: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.
    • subMerchantCountry string: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.
    • subMerchantID string: This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.
    • subMerchantName string: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.
    • subMerchantPostalCode string: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.
    • subMerchantState string: This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.
    • subMerchantStreet string: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.
    • subMerchantTaxId string: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.

AdditionalDataLevel23

  • AdditionalDataLevel23 object
    • enhancedSchemeData.customerReference string: Customer code, if supplied by a customer.
    • enhancedSchemeData.destinationCountryCode string: Destination country code.
    • enhancedSchemeData.destinationPostalCode string: The postal code of a destination address.
    • enhancedSchemeData.destinationStateProvinceCode string: Destination state or province code.
    • enhancedSchemeData.dutyAmount string: Duty amount, in minor units.
    • enhancedSchemeData.freightAmount string: Shipping amount, in minor units.
    • enhancedSchemeData.itemDetailLineitemNr.commodityCode string: Item commodity code.
    • enhancedSchemeData.itemDetailLineitemNr.description string: Item description.
    • enhancedSchemeData.itemDetailLineitemNr.discountAmount string: Discount amount, in minor units.
    • enhancedSchemeData.itemDetailLineitemNr.productCode string: Product code.
    • enhancedSchemeData.itemDetailLineitemNr.quantity string: Quantity, specified as an integer value.
    • enhancedSchemeData.itemDetailLineitemNr.totalAmount string: Total amount, in minor units.
    • enhancedSchemeData.itemDetailLineitemNr.unitOfMeasure string: Item unit of measurement.
    • enhancedSchemeData.itemDetailLineitemNr.unitPrice string: Unit price, specified in minor units.
    • enhancedSchemeData.orderDate string: Order date.
    • enhancedSchemeData.shipFromPostalCode string: The postal code of a "ship-from" address.
    • enhancedSchemeData.totalTaxAmount string: Total tax amount, in minor units.

AdditionalDataLodging

  • AdditionalDataLodging object
    • lodging.checkInDate string: The arrival date.
    • lodging.checkOutDate string: The departure date.
    • lodging.customerServiceTollFreeNumber string: The toll free phone number for the hotel/lodgings.
    • lodging.fireSafetyActIndicator string: Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.
    • lodging.folioCashAdvances string: The folio cash advances.
    • lodging.folioNumber string: Card acceptor’s internal invoice or billing ID reference number.
    • lodging.foodBeverageCharges string: Any charges for food and beverages associated with the booking.
    • lodging.noShowIndicator string: Indicates if the customer was a "no-show" (neither keeps nor cancels their booking).
    • lodging.prepaidExpenses string: Prepaid expenses for the booking.
    • lodging.propertyPhoneNumber string: Identifies specific lodging property location by its local phone number.
    • lodging.room1.numberOfNights string: Total number of nights the room will be rented.
    • lodging.room1.rate string: The rate of the room.
    • lodging.room1.tax string: The total amount of tax to be paid.
    • lodging.totalRoomTax string: Total room tax amount.
    • lodging.totalTax string: Total tax amount.
    • travelEntertainmentAuthData.duration string: Number of nights. This should be included in the auth message.
    • travelEntertainmentAuthData.market string: Indicates what market-specific dataset will be submitted or is being submitted. Value should be "H" for Hotel. This should be included in the auth message.

AdditionalDataModifications

  • AdditionalDataModifications object
    • installmentPaymentData.selectedInstallmentOption string: This is the installment option selected by the shopper. It is required only if specified by the user.

AdditionalDataOpenInvoice

  • AdditionalDataOpenInvoice object
    • openinvoicedata.merchantData string: Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.
    • openinvoicedata.numberOfLines string: The number of invoice lines included in openinvoicedata.
    • openinvoicedataLineitemNr.currencyCode string: The three-character ISO currency code.
    • openinvoicedataLineitemNr.description string: A text description of the product the invoice line refers to.
    • openinvoicedataLineitemNr.itemAmount string: The price for one item in the invoice line, represented in minor units.
    • openinvoicedataLineitemNr.itemId string: A unique id for this item. Required for RatePay if the description of each item is not unique.
    • openinvoicedataLineitemNr.itemVatAmount string: The VAT due for one item in the invoice line, represented in minor units.
    • openinvoicedataLineitemNr.itemVatPercentage string: The VAT percentage for one item in the invoice line, represented in minor units.
    • openinvoicedataLineitemNr.numberOfItems string: The number of units purchased of a specific product.
    • openinvoicedataLineitemNr.vatCategory string: Required for AfterPay. The country-specific VAT category a product falls under.

AdditionalDataOpi

  • AdditionalDataOpi object
    • opi.includeTransToken string: Optional boolean indicator. Set to true if you want an ecommerce transaction to return an opi.transToken as additional data in the response.

AdditionalDataRatepay

  • AdditionalDataRatepay object
    • ratepay.installmentAmount string: Amount the customer has to pay each month.
    • ratepay.interestRate string: Interest rate of this installment.
    • ratepay.lastInstallmentAmount string: Amount of the last installment.
    • ratepay.paymentFirstday string: Calendar day of the first payment.
    • ratepaydata.deliveryDate string: Date the merchant delivered the goods to the customer.
    • ratepaydata.dueDate string: Date by which the customer must settle the payment.
    • ratepaydata.invoiceDate string: Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.
    • ratepaydata.invoiceId string: Identification name or number for the invoice, defined by the merchant.

AdditionalDataRetry

  • AdditionalDataRetry object
    • retry.chainAttemptNumber string: The number of times the transaction (not order) has been retried between different payment service providers. For instance, the chainAttemptNumber set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.
    • retry.orderAttemptNumber string: The index of the attempt to bill a particular order, which is identified by the merchantOrderReference field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.
    • retry.skipRetry string: The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.

AdditionalDataRisk

  • AdditionalDataRisk object
    • riskdata.customFieldName string: The data for your custom risk field. For more information, refer to Create custom risk fields.
    • riskdata.basket.itemitemNr.amountPerItem string: The price of item in the basket, represented in minor units.
    • riskdata.basket.itemitemNr.brand string: Brand of the item.
    • riskdata.basket.itemitemNr.category string: Category of the item.
    • riskdata.basket.itemitemNr.color string: Color of the item.
    • riskdata.basket.itemitemNr.currency string: The three-character ISO currency code.
    • riskdata.basket.itemitemNr.itemID string: ID of the item.
    • riskdata.basket.itemitemNr.manufacturer string: Manufacturer of the item.
    • riskdata.basket.itemitemNr.productTitle string: A text description of the product the invoice line refers to.
    • riskdata.basket.itemitemNr.quantity string: Quantity of the item purchased.
    • riskdata.basket.itemitemNr.receiverEmail string: Email associated with the given product in the basket (usually in electronic gift cards).
    • riskdata.basket.itemitemNr.size string: Size of the item.
    • riskdata.basket.itemitemNr.sku string: Stock keeping unit.
    • riskdata.basket.itemitemNr.upc string: Universal Product Code.
    • riskdata.promotions.promotionitemNr.promotionCode string: Code of the promotion.
    • riskdata.promotions.promotionitemNr.promotionDiscountAmount string: The discount amount of the promotion, represented in minor units.
    • riskdata.promotions.promotionitemNr.promotionDiscountCurrency string: The three-character ISO currency code.
    • riskdata.promotions.promotionitemNr.promotionDiscountPercentage string: Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.
    • riskdata.promotions.promotionitemNr.promotionName string: Name of the promotion.

AdditionalDataRiskStandalone

  • AdditionalDataRiskStandalone object
    • PayPal.CountryCode string: Shopper's country of residence in the form of ISO standard 3166 2-character country codes.
    • PayPal.EmailId string: Shopper's email.
    • PayPal.FirstName string: Shopper's first name.
    • PayPal.LastName string: Shopper's last name.
    • PayPal.PayerId string: Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.
    • PayPal.Phone string: Shopper's phone number.
    • PayPal.ProtectionEligibility string: Allowed values:
    • PayPal.TransactionId string: Unique transaction ID of the payment.
    • avsResultRaw string: Raw AVS result received from the acquirer, where available. Example: D
    • bin string: The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for tokenized card request.
    • cvcResultRaw string: Raw CVC result received from the acquirer, where available. Example: 1
    • riskToken string: Unique identifier or token for the shopper's card details.
    • threeDAuthenticated string: A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
    • threeDOffered string: A Boolean value indicating whether 3DS was offered for this payment. Example: true
    • tokenDataType string: Required for PayPal payments only. The only supported value is: paypal.

AdditionalDataTemporaryServices

  • AdditionalDataTemporaryServices object
    • enhancedSchemeData.customerReference string: Customer code, if supplied by a customer.
    • enhancedSchemeData.employeeName string: Name or ID associated with the individual working in a temporary capacity.
    • enhancedSchemeData.jobDescription string: Description of the job or task of the individual working in a temporary capacity.
    • enhancedSchemeData.regularHoursRate string: Amount paid per regular hours worked, minor units.
    • enhancedSchemeData.regularHoursWorked string: Amount of time worked during a normal operation for the task or job.
    • enhancedSchemeData.requestName string: Name of the individual requesting temporary services.
    • enhancedSchemeData.tempStartDate string: Date for the beginning of the pay period.
    • enhancedSchemeData.tempWeekEnding string: Date of the end of the billing cycle.
    • enhancedSchemeData.totalTaxAmount string: Total tax amount, in minor units. For example, 2000 means USD 20.00

AdditionalDataWallets

  • AdditionalDataWallets object
    • androidpay.token string: The Android Pay token retrieved from the SDK.
    • masterpass.transactionId string: The Mastercard Masterpass Transaction ID retrieved from the SDK.
    • payment.token string: The Apple Pay token retrieved from the SDK.
    • paywithgoogle.token string: The Google Pay token retrieved from the SDK.
    • samsungpay.token string: The Samsung Pay token retrieved from the SDK.
    • visacheckout.callId string: The Visa Checkout Call ID retrieved from the SDK.

Address

  • Address object
    • city required string: The name of the city.
    • country required string: The two-character country code as defined in ISO-3166-1 alpha-2. For example, US.
    • houseNumberOrName required string: The number or name of the house.
    • postalCode required string: A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
    • stateOrProvince string: State or province codes as defined in ISO 3166-2. For example, CA in the US or ON in Canada.
    • street required string: The name of the street.

Amount

  • Amount object

ApplicationInfo

BankAccount

  • BankAccount object
    • bankAccountNumber string: The bank account number (without separators).
    • bankCity string: The bank city.
    • bankLocationId string: The location id of the bank. The field value is nil in most cases.
    • bankName string: The name of the bank.
    • bic string: The Business Identifier Code (BIC) is the SWIFT address assigned to a bank. The field value is nil in most cases.
    • countryCode string: Country code where the bank is located.
    • iban string: The International Bank Account Number (IBAN).
    • ownerName string: The name of the bank account holder.
    • taxId string: The bank account holder's tax ID.

BrowserInfo

  • BrowserInfo object
    • acceptHeader required string: The accept header value of the shopper's browser.
    • colorDepth required integer: The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.
    • javaEnabled required boolean: Boolean value indicating if the shopper's browser is able to execute Java.
    • javaScriptEnabled boolean: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.
    • language required string: The navigator.language value of the shopper's browser (as defined in IETF BCP 47).
    • screenHeight required integer: The total height of the shopper's device screen in pixels.
    • screenWidth required integer: The total width of the shopper's device screen in pixels.
    • timeZoneOffset required integer: Time difference between UTC time and the shopper's browser local time, in minutes.
    • userAgent required string: The user agent value of the shopper's browser.

Card

  • Card object
    • cvc string: The card verification code (1-20 characters). Depending on the card brand, it is known also as:
    • expiryMonth required string: The card expiry month.
    • expiryYear required string: The card expiry year.
    • holderName required string: The name of the cardholder, as printed on the card.
    • issueNumber string: The issue number of the card (for some UK debit cards only).
    • number required string: The card number (4-19 characters). Do not use any separators.
    • startMonth string: The month component of the start date (for some UK debit cards only).
    • startYear string: The year component of the start date (for some UK debit cards only).

CommonField

  • CommonField object
    • name string: Name of the field. For example, Name of External Platform.
    • version string: Version of the field. For example, Version of External Platform.

DeviceRenderOptions

  • DeviceRenderOptions object
    • sdkInterface string (values: native, html, both): Supported SDK interface types.
    • sdkUiType array: UI types supported for displaying specific challenges.
      • items string (values: multiSelect, otherHtml, outOfBand, singleSelect, text)

DonationRequest

  • DonationRequest object
    • donationAccount required string: The Adyen account name of the charity.
    • merchantAccount required string: The merchant account that is used to process the payment.
    • modificationAmount Amount
    • originalReference required string: The original pspReference of the payment to modify.
    • reference string: Optionally, you can specify your reference for the payment modification. This reference is visible in Customer Area and in reports.

ExternalPlatform

  • ExternalPlatform object
    • integrator string: External platform integrator.
    • name string: Name of the field. For example, Name of External Platform.
    • version string: Version of the field. For example, Version of External Platform.

ForexQuote

  • ForexQuote object
    • account string: The account name.
    • accountType string: The account type.
    • baseAmount Amount
    • basePoints required integer: The base points.
    • buy Amount
    • interbank Amount
    • reference string: The reference assigned to the forex quote request.
    • sell Amount
    • signature string: The signature to validate the integrity.
    • source string: The source of the forex quote.
    • type string: The type of forex.
    • validTill required string: The date until which the forex quote is valid.

FraudCheckResult

  • FraudCheckResult object
    • accountScore required integer: The fraud score generated by the risk check.
    • checkId required integer: The ID of the risk check.
    • name required string: The name of the risk check.

FraudResult

  • FraudResult object
    • accountScore required integer: The total fraud score generated by the risk checks.
    • results array: The result of the individual risk checks.

Installments

  • Installments object
    • value required integer: Defines the number of installments. Its value needs to be greater than zero.

MerchantDevice

  • MerchantDevice object
    • os string: Operating system running on the merchant device.
    • osVersion string: Version of the operating system on the merchant device.
    • reference string: Merchant device reference.

MerchantRiskIndicator

  • MerchantRiskIndicator object
    • addressMatch boolean: Whether the chosen delivery address is identical to the billing address.
    • deliveryAddressIndicator string (values: shipToBillingAddress, shipToVerifiedAddress, shipToNewAddress, shipToStore, digitalGoods, goodsNotShipped, other): Indicator regarding the delivery address.
    • deliveryEmail string: The delivery email address (for digital goods).
    • deliveryTimeframe string (values: electronicDelivery, sameDayShipping, overnightShipping, twoOrMoreDaysShipping): The estimated delivery time for the shopper to receive the goods.
    • giftCardAmount Amount
    • giftCardCount integer: For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    • preOrderDate string: For pre-order purchases, the expected date this product will be available to the shopper.
    • preOrderPurchase boolean: Indicator for whether this transaction is for pre-ordering a product.
    • reorderItems boolean: Indicator for whether the shopper has already purchased the same items in the past.

ModificationRequest

  • ModificationRequest object
    • merchantAccount required string: The merchant account that is used to process the payment.
    • modificationAmount Amount
    • originalMerchantReference string: The original merchant reference to cancel.
    • originalReference required string: The original pspReference of the payment to modify.
    • reference string: Optionally, you can specify your reference for the payment modification. This reference is visible in Customer Area and in reports.
    • splits array: Information on how the payment should be split between accounts when using Adyen for Platforms.
    • tenderReference string: The transaction reference provided by the PED. For point-of-sale integrations only.
    • uniqueTerminalId string: Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.

ModificationResult

Name

  • Name object
    • firstName required string: The first name.
    • gender required string (values: MALE, FEMALE, UNKNOWN): The gender.
    • infix string: The name's infix, if applicable.
    • lastName required string: The last name.

PaymentRequest

  • PaymentRequest object
    • accountInfo AccountInfo
    • additionalAmount Amount
    • amount required Amount
    • applicationInfo ApplicationInfo
    • bankAccount BankAccount
    • billingAddress Address
    • browserInfo BrowserInfo
    • captureDelayHours integer: The delay between the authorisation and scheduled auto-capture, specified in hours.
    • card Card
    • dateOfBirth string: The shopper's date of birth.
    • dccQuote ForexQuote
    • deliveryAddress Address
    • deliveryDate string: The date and time the purchased goods should be delivered.
    • deviceFingerprint string: A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.
    • entityType string (values: NaturalPerson, CompanyName): The type of the entity the payment is processed for.
    • fraudOffset integer: An integer value that is added to the normal fraud score. The value can be either positive or negative.
    • installments Installments
    • mcc string: The merchant category code (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
    • merchantAccount required string: The merchant account identifier, with which you want to process the transaction.
    • merchantOrderReference string: This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.
    • merchantRiskIndicator MerchantRiskIndicator
    • metadata object: Metadata consists of entries, each of which includes a key and a value.
    • mpiData ThreeDSecureData
    • nationality string: The two-character country code of the shopper's nationality.
    • orderReference string: When you are doing multiple partial (gift card) payments, this is the pspReference of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the merchantOrderReferenceinstead.
    • recurring Recurring
    • recurringProcessingModel string (values: CardOnFile, Subscription, UnscheduledCardOnFile): Defines a recurring payment type.
    • reference required string: The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.
    • selectedBrand string: Some payment methods require defining a value for this field to specify how to process the transaction.
    • selectedRecurringDetailReference string: The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.
    • sessionId string: A session ID used to identify a payment session.
    • shopperEmail string: The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.
    • shopperIP string: The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).
    • shopperInteraction string (values: Ecommerce, ContAuth, Moto, POS): Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
    • shopperLocale string: The combination of a language code and a country code to specify the language to be used in the payment.
    • shopperName Name
    • shopperReference string: The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
    • shopperStatement string: The text to be shown on the shopper's bank statement. To enable this field, contact our Support Team.
    • socialSecurityNumber string: The shopper's social security number.
    • splits array: Information on how the payment should be split between accounts when using Adyen for Platforms.
    • store string: The physical store, for which this payment is processed.
    • telephoneNumber string: The shopper's telephone number.
    • threeDS2RequestData ThreeDS2RequestData
    • totalsGroup string: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
    • trustedShopper boolean: Set to true if the payment should be routed to a trusted MID.

PaymentRequest3d

  • PaymentRequest3d object
    • accountInfo AccountInfo
    • additionalAmount Amount
    • amount Amount
    • applicationInfo ApplicationInfo
    • billingAddress Address
    • browserInfo BrowserInfo
    • captureDelayHours integer: The delay between the authorisation and scheduled auto-capture, specified in hours.
    • dateOfBirth string: The shopper's date of birth.
    • dccQuote ForexQuote
    • deliveryAddress Address
    • deliveryDate string: The date and time the purchased goods should be delivered.
    • deviceFingerprint string: A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.
    • fraudOffset integer: An integer value that is added to the normal fraud score. The value can be either positive or negative.
    • installments Installments
    • mcc string: The merchant category code (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
    • md required string: The payment session identifier returned by the card issuer.
    • merchantAccount required string: The merchant account identifier, with which you want to process the transaction.
    • merchantOrderReference string: This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.
    • merchantRiskIndicator MerchantRiskIndicator
    • metadata object: Metadata consists of entries, each of which includes a key and a value.
    • orderReference string: When you are doing multiple partial (gift card) payments, this is the pspReference of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the merchantOrderReferenceinstead.
    • paResponse required string: Payment authorisation response returned by the card issuer. The paResponse field holds the PaRes value received from the card issuer.
    • recurring Recurring
    • recurringProcessingModel string (values: CardOnFile, Subscription, UnscheduledCardOnFile): Defines a recurring payment type.
    • reference string: The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.
    • selectedBrand string: Some payment methods require defining a value for this field to specify how to process the transaction.
    • selectedRecurringDetailReference string: The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.
    • sessionId string: A session ID used to identify a payment session.
    • shopperEmail string: The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.
    • shopperIP string: The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).
    • shopperInteraction string (values: Ecommerce, ContAuth, Moto, POS): Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
    • shopperLocale string: The combination of a language code and a country code to specify the language to be used in the payment.
    • shopperName Name
    • shopperReference string: The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
    • shopperStatement string: The text to be shown on the shopper's bank statement. To enable this field, contact our Support Team.
    • socialSecurityNumber string: The shopper's social security number.
    • splits array: Information on how the payment should be split between accounts when using Adyen for Platforms.
    • store string: The physical store, for which this payment is processed.
    • telephoneNumber string: The shopper's telephone number.
    • threeDS2RequestData ThreeDS2RequestData
    • totalsGroup string: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
    • trustedShopper boolean: Set to true if the payment should be routed to a trusted MID.

PaymentRequest3ds2

  • PaymentRequest3ds2 object
    • accountInfo AccountInfo
    • additionalAmount Amount
    • amount required Amount
    • applicationInfo ApplicationInfo
    • billingAddress Address
    • browserInfo BrowserInfo
    • captureDelayHours integer: The delay between the authorisation and scheduled auto-capture, specified in hours.
    • dateOfBirth string: The shopper's date of birth.
    • dccQuote ForexQuote
    • deliveryAddress Address
    • deliveryDate string: The date and time the purchased goods should be delivered.
    • deviceFingerprint string: A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.
    • fraudOffset integer: An integer value that is added to the normal fraud score. The value can be either positive or negative.
    • installments Installments
    • mcc string: The merchant category code (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
    • merchantAccount required string: The merchant account identifier, with which you want to process the transaction.
    • merchantOrderReference string: This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.
    • merchantRiskIndicator MerchantRiskIndicator
    • metadata object: Metadata consists of entries, each of which includes a key and a value.
    • orderReference string: When you are doing multiple partial (gift card) payments, this is the pspReference of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the merchantOrderReferenceinstead.
    • recurring Recurring
    • recurringProcessingModel string (values: CardOnFile, Subscription, UnscheduledCardOnFile): Defines a recurring payment type.
    • reference required string: The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.
    • selectedBrand string: Some payment methods require defining a value for this field to specify how to process the transaction.
    • selectedRecurringDetailReference string: The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.
    • sessionId string: A session ID used to identify a payment session.
    • shopperEmail string: The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.
    • shopperIP string: The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).
    • shopperInteraction string (values: Ecommerce, ContAuth, Moto, POS): Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
    • shopperLocale string: The combination of a language code and a country code to specify the language to be used in the payment.
    • shopperName Name
    • shopperReference string: The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
    • shopperStatement string: The text to be shown on the shopper's bank statement. To enable this field, contact our Support Team.
    • socialSecurityNumber string: The shopper's social security number.
    • splits array: Information on how the payment should be split between accounts when using Adyen for Platforms.
    • store string: The physical store, for which this payment is processed.
    • telephoneNumber string: The shopper's telephone number.
    • threeDS2RequestData ThreeDS2RequestData
    • threeDS2Result ThreeDS2Result
    • threeDS2Token string: The ThreeDS2Token that was returned in the /authorise call.
    • totalsGroup string: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
    • trustedShopper boolean: Set to true if the payment should be routed to a trusted MID.

PaymentResult

  • PaymentResult object
    • authCode string: Authorisation code:
    • dccAmount Amount
    • dccSignature string: Cryptographic signature used to verify dccQuote.
    • fraudResult FraudResult
    • issuerUrl string: The URL to direct the shopper to.
    • md string: The payment session.
    • paRequest string: The 3D request data for the issuer.
    • pspReference string: Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
    • refusalReason string: If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes resultCode and refusalReason values.
    • resultCode string (values: AuthenticationFinished, Authorised, Cancelled, ChallengeShopper, Error, IdentifyShopper, Pending, PresentToShopper, Received, RedirectShopper, Refused): The result of the payment. For more information, see Result codes.

Recurring

  • Recurring object
    • contract string (values: ONECLICK, RECURRING, PAYOUT): The type of recurring contract to be used.
    • recurringDetailName string: A descriptive name for this detail.
    • recurringExpiry string: Date after which no further authorisations shall be performed. Only for 3D Secure 2.
    • recurringFrequency string: Minimum number of days between authorisations. Only for 3D Secure 2.
    • tokenService string (values: VISATOKENSERVICE, MCTOKENSERVICE): The name of the token service.

ResponseAdditionalDataBillingAddress

  • ResponseAdditionalDataBillingAddress object
    • billingAddress.city string: The billing address city passed in the payment request.
    • billingAddress.country string: The billing address country passed in the payment request.
    • billingAddress.houseNumberOrName string: The billing address house number or name passed in the payment request.
    • billingAddress.postalCode string: The billing address postal code passed in the payment request.
    • billingAddress.stateOrProvince string: The billing address state or province passed in the payment request.
    • billingAddress.street string: The billing address street passed in the payment request.

ResponseAdditionalDataCard

  • ResponseAdditionalDataCard object
    • cardBin string: The Bank Identification Number of a credit card, which is the first six digits of a card number.
    • cardHolderName string: The cardholder name passed in the payment request.
    • cardIssuingBank string: The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available.
    • cardIssuingCountry string: The country where the card was issued.
    • cardIssuingCurrency string: The currency in which the card is issued, if this information is available. Provided as the currency code or currency number from the ISO-4217 standard.
    • cardPaymentMethod string: The card payment method used for the transaction.
    • cardSummary string: The last four digits of a card number.

ResponseAdditionalDataCommon

  • ResponseAdditionalDataCommon object
    • acquirerAccountCode string: The name of the Adyen acquirer account.
    • acquirerCode string: The name of the acquirer processing the payment request.
    • acquirerReference string: The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement.
    • alias string: The Adyen alias of the card.
    • aliasType string: The type of the card alias.
    • authCode string: Authorisation code:
    • authorisedAmountCurrency string: The currency of the authorised amount, as a three-character ISO currency code.
    • authorisedAmountValue string: Value of the amount authorised.
    • avsResult string: The AVS result code of the payment, which provides information about the outcome of the AVS check.
    • avsResultRaw string: Raw AVS result received from the acquirer, where available.
    • bic string: BIC of a bank account.
    • dsTransID string: Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.
    • eci string: The Electronic Commerce Indicator returned from the schemes for the 3DS payment session.
    • expiryDate string: The expiry date on the card.
    • extraCostsCurrency string: The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request.
    • extraCostsValue string: The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units.
    • fraudCheck-itemNr-FraudCheckname string: The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.
    • fundingSource string: Information regarding the funding type of the card. The possible return values are:
    • fundsAvailability string: Indicates availability of funds.
    • inferredRefusalReason string: Provides the more granular indication of why a transaction was refused. When a transaction fails with either "Refused", "Restricted Card", "Transaction Not Permitted", "Not supported" or "DeclinedNon Generic" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the inferredRefusalReason, field is populated and the refusalReason, is set to "Not Supported".
    • issuerCountry string: The issuing country of the card based on the BIN list that Adyen maintains.
    • mcBankNetReferenceNumber string: The mcBankNetReferenceNumber, is a minimum of six characters and a maximum of nine characters long.
    • networkTxReference string: Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.
    • ownerName string: The owner name of a bank account.
    • paymentAccountReference string: The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters.
    • paymentMethodVariant string: The Adyen sub-variant of the payment method used for the payment request.
    • payoutEligible string: Indicates whether a payout is eligible or not for this card.
    • realtimeAccountUpdaterStatus string: The response code from the Real Time Account Updater service.
    • receiptFreeText string: Message to be displayed on the terminal.
    • recurring.firstPspReference string: The pspReference, of the first recurring payment that created the recurring detail.
    • recurring.recurringDetailReference string: The reference that uniquely identifies the recurring transaction.
    • referred string: If the payment is referred, this field is set to true.
    • refusalReasonRaw string: Raw refusal reason received from the acquirer, where available.
    • shopperInteraction string: The shopper interaction type of the payment request.
    • shopperReference string: The shopperReference passed in the payment request.
    • terminalId string: The terminal ID used in a point-of-sale payment.
    • threeDAuthenticated string: A Boolean value indicating whether 3DS authentication was completed on this payment.
    • threeDAuthenticatedResponse string: The raw 3DS authentication result from the card issuer.
    • threeDOffered string: A Boolean value indicating whether 3DS was offered for this payment.
    • threeDOfferedResponse string: The raw enrollment result from the 3DS directory services of the card schemes.
    • threeDSVersion string: The 3D Secure 2 version.
    • visaTransactionId string: The visaTransactionId, has a fixed length of 15 numeric characters.
    • xid string: The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use
datafire
@infinitebrahmanuniverse/nolb-_datafire_ad@everything-registry/sub-chunk-220
4.0.0

5 years ago

3.0.0

7 years ago