Skip to content

Checkout API Migration v70 ‐ v71

Jump to bottom
jillingk edited this page Nov 7, 2023 · 1 revision

What's Changed Checkout API v70 -> v71

POST /donations
Request:

Changed content type : application/json

  • Deleted property additionalAmount (object)

  • Deleted property allowedPaymentMethods (object)

    List of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type.

    Example: "allowedPaymentMethods":["ideal","giropay"]

  • Deleted property blockedPaymentMethods (object)

    List of payment methods to be hidden from the shopper. To refer to payment methods, use their payment method type.

    Example: "blockedPaymentMethods":["ideal","giropay"]

  • Deleted property captureDelayHours (object)

    The delay between the authorisation and scheduled auto-capture, specified in hours.

  • Deleted property company (object)

  • Deleted property dccQuote (object)

  • Deleted property deliveryDate (object)

    The date and time the purchased goods should be delivered.

    Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

    Example: 2017-07-17T13:42:40.428+01:00

  • Deleted property enableOneClick (object)

    When true and shopperReference is provided, the shopper will be asked if the payment details should be stored for future one-click payments.

  • Deleted property enablePayOut (object)

    When true and shopperReference is provided, the payment details will be tokenized for payouts.

  • Deleted property enableRecurring (object)

    When true and shopperReference is provided, the payment details will be tokenized for recurring payments.

  • Deleted property entityType (object)

    The type of the entity the payment is processed for.

  • Deleted property fraudOffset (object)

    An integer value that is added to the normal fraud score. The value can be either positive or negative.

  • Deleted property fundOrigin (object)

  • Deleted property fundRecipient (object)

  • Deleted property fundingSource (object)

    The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to debit.

  • Deleted property industryUsage (object)

    The reason for the amount update. Possible values:

    • delayedCharge
    • noShow
    • installment

  • Deleted property installments (object)

  • Deleted property localizedShopperStatement (object)

    The localizedShopperStatement field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, shopperStatement is used.

    Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:

    • UTF-8 based Katakana, capital letters, numbers and special characters.
    • Half-width or full-width characters.

  • Deleted property mandate (object)

  • Deleted property mcc (object)

    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.

  • Deleted property merchantOrderReference (object)

    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. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.

    We strongly recommend you send the merchantOrderReference value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide retry.orderAttemptNumber, retry.chainAttemptNumber, and retry.skipRetry values in PaymentRequest.additionalData.

  • Deleted property order (object)

  • Deleted property orderReference (object)

    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.

  • Deleted property platformChargebackLogic (object)

  • Deleted property recurringExpiry (object)

    Date after which no further authorisations shall be performed. Only for 3D Secure 2.

  • Deleted property recurringFrequency (object)

    Minimum number of days between authorisations. Only for 3D Secure 2.

  • Deleted property riskData (object)

  • Deleted property selectedRecurringDetailReference (object)

    The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.

  • Deleted property shopperStatement (object)

    The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.

  • Deleted property splits (object)

    An array of objects specifying how to split a payment when using Adyen for Platforms, Classic Platforms integration, or Issuing.

  • Deleted property store (object)

    The ecommerce or point-of-sale store that is processing the payment. Used in:

  • Deleted property storePaymentMethod (object)

    When true and shopperReference is provided, the payment details will be stored.

  • Deleted property trustedShopper (object)

    Set to true if the payment should be routed to a trusted MID.

POST /paymentLinks
Request:

Changed content type : application/json

  • Changed property expiresAt (object -> object)

    The date when the payment link expires.

    ISO 8601 format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.

    The maximum expiry date is 70 days after the payment link is created.

    If not provided, the payment link expires 24 hours after it was created.

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

  • Changed content type : application/json

    • Changed property expiresAt (object -> object)

      The date when the payment link expires.

      ISO 8601 format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.

      The maximum expiry date is 70 days after the payment link is created.

      If not provided, the payment link expires 24 hours after it was created.

Changed response : 201 Created

Created - the request has succeeded.

  • Changed content type : application/json

    • Changed property expiresAt (object -> object)

      The date when the payment link expires.

      ISO 8601 format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.

      The maximum expiry date is 70 days after the payment link is created.

      If not provided, the payment link expires 24 hours after it was created.

GET /paymentLinks/{linkId}
Return Type:

Changed response : 200 OK

OK - the request has succeeded.

  • Changed content type : application/json

    • Changed property expiresAt (object -> object)

      The date when the payment link expires.

      ISO 8601 format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.

      The maximum expiry date is 70 days after the payment link is created.

      If not provided, the payment link expires 24 hours after it was created.

PATCH /paymentLinks/{linkId}
Return Type:

Changed response : 200 OK

OK - the request has succeeded.

  • Changed content type : application/json

    • Changed property expiresAt (object -> object)

      The date when the payment link expires.

      ISO 8601 format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.

      The maximum expiry date is 70 days after the payment link is created.

      If not provided, the payment link expires 24 hours after it was created.

POST /payments/{paymentPspReference}/amountUpdates
Return Type:

Changed response : 201 Created

Created - the request has been fulfilled and has resulted in one or more new resources being created.

  • Changed content type : application/json

    • Added property lineItems (object)

      Price and product information of the refunded items, required for partial refunds.

      This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.

Clone this wiki locally