Adyen

ÜCRETSİZ
Taraf Igor Zakutynsky | Güncelleyen hace 10 meses | Payments

Adyen Ürününe Genel Bakış

Takipçi Sayısı: 5
Kaynaklar:
Ürün Web Sitesi
API Üreticisi:
avatar
Igor Zakutynsky
zakutynsky
API'yi Değerlendirin:
API'yi Değerlendirme İçin Giriş Yapın

README

Making payments easy gives you a competitive edge. Adyen’s platform lets you expand quickly, manage risk, and track results – one platform, one partner, no hassle.

Adyen Package

Making payments easy gives you a competitive edge. Adyen’s platform lets you expand quickly, manage risk, and track results – one platform, one partner, no hassle.

  • Domain: adyen.com
  • Credentials: username, password

How to get credentials:

  1. Sign in https://ca-test.adyen.com/ca/ca/login.shtml
  2. Navigate to Settings -> User
  3. Copy your credentials

Adyen.authorise

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.

Field Type Description
username credentials Your username into adyen system.
password String Your password.
additionalData JSON This field contains additional data, which may be required for a particular payment request.
amountCurrency String The three-character ISO currency code.
amountValue Number The payable amount that can be charged for the transaction.
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. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations.
taxId String The bank account holder’s tax ID.
billingAddress JSON The address where to send the invoice.
browserInfo JSON The shopper’s browser information.
captureDelayHours Number The delay between the authorisation and scheduled auto-capture, specified in hours.
card JSON A container for card data.
dateOfBirth DatePicker The shopper’s date of birth.
dccQuote JSON The forex quote as returned in the response of the forex service.
deliveryAddress JSON The address where the purchased goods should be delivered.
deliveryDate DatePicker 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 The type of the entity the payment is processed for.
fraudOffset Number An integer value that is added to the normal fraud score. The value can be either positive or negative.
installments JSON Contains installment settings. For more information, refer to 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 String The merchant account identifier, with which you want to process the transaction.
merchantOrderReference String This reference allows linking multiple transactions to each other.
metadata JSON Metadata consists of entries, each of which includes a key and a value.
mpiData JSON Authentication data produced by an MPI (Mastercard SecureCode or Verified By Visa).
nationality String The two-character country code of the shopper’s nationality.
orderReference String The order reference to link multiple partial payments.
recurring JSON The recurring settings for the payment. Use this property when you want to enable recurring payments.
recurringProcessingModel Select Defines a recurring payment type. Must be: Subscription, CardOnFile
reference String The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status.
selectedBrand Select Some payment methods require defining a value for this field to specify how to process the transaction. Must be maestro, bcmc
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. 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 Select Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default.
shopperLocale String The combination of a language code and a country code to specify the language to be used in the payment.
shopperName JSON The shopper’s full name and gender (if specified).
shopperReference String The shopper’s reference to uniquely identify this shopper (e.g. user ID or account ID).
shopperStatement String The text to appear on the shopper’s bank statement.
socialSecurityNumber String The shopper’s social security number.
store String The physical store, for which this payment is processed.
telephoneNumber String The shopper’s telephone number.
totalsGroup String The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).

Adyen.authorise3D

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.

Field Type Description
username credentials Your username into adyen system.
password String Your password.
additionalData JSON This field contains additional data, which may be required for a particular payment request.
amountCurrency String The three-character ISO currency code.
amountValue Number The payable amount that can be charged for the transaction.
billingAddress JSON The address where to send the invoice.
browserInfo JSON The shopper’s browser information.
captureDelayHours Number The delay between the authorisation and scheduled auto-capture, specified in hours.
dateOfBirth DatePicker The shopper’s date of birth.
dccQuote JSON The forex quote as returned in the response of the forex service.
deliveryAddress JSON The address where the purchased goods should be delivered.
deliveryDate DatePicker 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 Number An integer value that is added to the normal fraud score. The value can be either positive or negative.
installments JSON Contains installment settings. For more information, refer to 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 String The payment session identifier returned by the card issuer.
merchantAccount String The merchant account identifier, with which you want to process the transaction.
merchantOrderReference String This reference allows linking multiple transactions to each other.
metadata JSON Metadata consists of entries, each of which includes a key and a value.
orderReference String The order reference to link multiple partial payments.
paResponse String Payment authorisation response returned by the card issuer. The paResponse field holds the PaRes value received from the card issuer.
recurring JSON The recurring settings for the payment. Use this property when you want to enable recurring payments.
recurringProcessingModel Select Defines a recurring payment type. Must be: Subscription, CardOnFile
reference String The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status.
selectedBrand Select Some payment methods require defining a value for this field to specify how to process the transaction. Must be maestro, bcmc
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. 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 Select Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default.
shopperLocale String The combination of a language code and a country code to specify the language to be used in the payment.
shopperName JSON The shopper’s full name and gender (if specified).
shopperReference String The shopper’s reference to uniquely identify this shopper (e.g. user ID or account ID).
shopperStatement String The text to appear on the shopper’s bank statement.
socialSecurityNumber String The shopper’s social security number.
store String The physical store, for which this payment is processed.
telephoneNumber String The shopper’s telephone number.
totalsGroup String The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).

Adyen.capture

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.

Field Type Description
username credentials Your username into adyen system.
password String Your password.
additionalData JSON This field contains additional data, which may be required for a particular payment request.
merchantAccount String The merchant account identifier, with which you want to process the transaction.
modificationAmount JSON The amount that needs to be captured/refunded. Required for /capture and /refund, not allowed for /cancel. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
originalMerchantReference String The original merchant reference to cancel.
originalReference 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. Maximum length: 80 characters.
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.

Adyen.cancel

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.

Field Type Description
username credentials Your username into adyen system.
password String Your password.
additionalData JSON This field contains additional data, which may be required for a particular payment request.
merchantAccount String The merchant account identifier, with which you want to process the transaction.
modificationAmount JSON The amount that needs to be captured/refunded. Required for /capture and /refund, not allowed for /cancel. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
originalMerchantReference String The original merchant reference to cancel.
originalReference 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. Maximum length: 80 characters.
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.

Adyen.refund

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.

Field Type Description
username credentials Your username into adyen system.
password String Your password.
additionalData JSON This field contains additional data, which may be required for a particular payment request.
merchantAccount String The merchant account identifier, with which you want to process the transaction.
modificationAmount JSON The amount that needs to be captured/refunded. Required for /capture and /refund, not allowed for /cancel. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
originalMerchantReference String The original merchant reference to cancel.
originalReference 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. Maximum length: 80 characters.
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.

Adyen.cancelOrRefund

Cancels a payment if it has not yet 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).

Field Type Description
username credentials Your username into adyen system.
password String Your password.
additionalData JSON This field contains additional data, which may be required for a particular payment request.
merchantAccount String The merchant account identifier, with which you want to process the transaction.
modificationAmount JSON The amount that needs to be captured/refunded. Required for /capture and /refund, not allowed for /cancel. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
originalMerchantReference String The original merchant reference to cancel.
originalReference 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. Maximum length: 80 characters.
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.

Adyen.adjustAuthorisation

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.

Field Type Description
username credentials Your username into adyen system.
password String Your password.
additionalData JSON This field contains additional data, which may be required for a particular payment request.
merchantAccount String The merchant account identifier, with which you want to process the transaction.
modificationAmount JSON The amount that needs to be captured/refunded. Required for /capture and /refund, not allowed for /cancel. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
originalMerchantReference String The original merchant reference to cancel.
originalReference 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. Maximum length: 80 characters.
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.

Adyen.getRecurringDetailsList

Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper.

Field Type Description
username credentials Your username into adyen system.
password String Your password.
merchantAccount String The merchant account identifier, with which you want to process the transaction.
recurring JSON A container for the type of a recurring contract to be retrieved.
shopperReference String The reference you use to uniquely identify the shopper (e.g. user ID or account ID).

Adyen.disablesStoredPaymentDetails

Disables stored payment details to stop charging a shopper with this particular recurring detail ID.

Field Type Description
username credentials Your username into adyen system.
password String Your password.
contract List Specify the contract if you only want to disable a specific use. Must be: PAYOUT, RECURRING, ONECLICK
merchantAccount String The merchant account identifier, with which you want to process the transaction.
recurringDetailReference String The ID that uniquely identifies the recurring detail reference.
shopperReference String The reference you use to uniquely identify the shopper (e.g. user ID or account ID).
Değerlendirme: 5 - Oy Sayısı: 1