younifyd
Menu

Submit details for a payment

Submit details for a payment

POST/payments/details

Use it in a workflow

  1. Add a step and choose the Adyen connector.
  2. Pick the Submit details for a payment action (under Payments).
  3. Fill in the fields below, then reference the result from later steps as {{submitDetailsForAPayment.response.data}}.

Request

Headers

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body

Enter the body as JSON in the step's Body field.

authenticationDataobject
authenticationOnlyboolean

Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**.

Default false

detailsobjectrequired
MDstring

A payment session identifier returned by the card issuer.

PaReqstring

(3D) Payment Authentication Request data for the card issuer.

PaResstring

(3D) Payment Authentication Response data by the card issuer.

authorization_tokenstring
billingTokenstring

PayPal-generated token for recurring payments.

cupsecureplus.smscodestring

The SMS verification code collected from the shopper.

facilitatorAccessTokenstring

PayPal-generated third party access token.

oneTimePasscodestring

A random number sent to the mobile phone number of the shopper to verify the payment.

orderIDstring

PayPal-assigned ID for the order.

payerIDstring

PayPal-assigned ID for the payer (shopper).

payloadstring

Payload appended to the `returnURL` as a result of the redirect.

paymentIDstring

PayPal-generated ID for the payment.

paymentStatusstring

Value passed from the WeChat MiniProgram `wx.requestPayment` **complete** callback. Possible values: any value starting with `requestPayment:`.

redirectResultstring

The result of the redirect as appended to the `returnURL`.

resultCodestring

Value you received from the WeChat Pay SDK.

returnUrlQueryStringstring

The query string as appended to the `returnURL` when using direct issuer links .

threeDSResultstring

Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.

threeds2.challengeResultstring

Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.

threeds2.fingerprintstring

Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.

vaultTokenstring

PayPalv2-generated token for recurring payments.

paymentDatastring

Encoded payment data. For [authorizing a payment after using 3D Secure 2 Authentication-only](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only/#authorise-the-payment-with-adyen): If you received `resultCode`: **AuthenticationNotRequired** in the `/payments` response, use the `threeDSPaymentData` from the same response. If you received `resultCode`: **AuthenticationFinished** in the `/payments` response, use the `action.paymentData` from the same response.

threeDSAuthenticationOnlyboolean

Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.

json
{
  "details": {
    "MD": "string",
    "PaReq": "string",
    "PaRes": "string",
    "authorization_token": "string",
    "billingToken": "string",
    "cupsecureplus.smscode": "string",
    "facilitatorAccessToken": "string",
    "oneTimePasscode": "string",
    "orderID": "string",
    "payerID": "string",
    "payload": "string",
    "paymentID": "string"
  },
  "authenticationData": {
    "authenticationOnly": false
  },
  "paymentData": "string",
  "threeDSAuthenticationOnly": false
}

Response

Returns 200 with an object. Read it in later steps with {{submitDetailsForAPayment.response.data.<field>}}.

actiononeOf

Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.

additionalDataobject

Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.

amountobject
currencystringrequired

The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.

valueinteger (int64)required

The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).

donationTokenstring

Donation Token containing payment details for Adyen Giving.

fraudResultobject
accountScoreinteger (int32)required

The total fraud score generated by the risk checks.

resultsarray<object>3 fields

The result of the individual risk checks.

merchantReferencestring

The reference used during the /payments request.

opiobject
issuerIdstring

The OPI issuer id.

transTokenstring

The OPI transaction token.

orderobject
amountobject2 fields
expiresAtstring

The expiry date for the order.

orderDatastring

The encrypted order data.

pspReferencestringrequired

The `pspReference` that belongs to the order.

referencestring

The merchant reference for the order.

remainingAmountobject2 fields
paymentMethodobject
brandstring

The card brand that the shopper used to pay. Only returned if `paymentMethod.type` is **scheme**.

typestring

The `paymentMethod.type` value used in the request.

paymentValidationsobject
nameobject3 fields
pspReferencestring

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.

refusalReasonstring

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. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).

refusalReasonCodestring

Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).

resultCodestring

The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.

One ofAuthenticationFinishedAuthenticationNotRequiredAuthorisedCancelledChallengeShopperErrorIdentifyShopperPartiallyAuthorisedPendingPresentToShopperReceivedRedirectShopperRefusedSuccess

shopperLocalestring

The shopperLocale.

threeDS2ResponseDataobject
acsChallengeMandatedstring
acsOperatorIDstring
acsReferenceNumberstring
acsSignedContentstring
acsTransIDstring
acsURLstring
authenticationTypestring
cardHolderInfostring
cavvAlgorithmstring
challengeIndicatorstring
dsReferenceNumberstring
dsTransIDstring
exemptionIndicatorstring
messageVersionstring
riskScorestring
sdkEphemPubKeystring
threeDSServerTransIDstring
transStatusstring
transStatusReasonstring
threeDS2Resultobject
authenticationValuestring

The `authenticationValue` value as defined in the 3D Secure 2 specification.

cavvAlgorithmstring

The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.

challengeCancelstring

Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).

One of01020304050607

dsTransIDstring

The `dsTransID` value as defined in the 3D Secure 2 specification.

ecistring

The `eci` value as defined in the 3D Secure 2 specification.

exemptionIndicatorstring

Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` * `transactionRiskAnalysis`

One oflowValuesecureCorporatetrustedBeneficiarytransactionRiskAnalysis

messageVersionstring

The `messageVersion` value as defined in the 3D Secure 2 specification.

riskScorestring

Risk score calculated by Cartes Bancaires Directory Server (DS).

threeDSRequestorChallengeIndstring

Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only

One of010203040506

threeDSServerTransIDstring

The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.

timestampstring

The `timestamp` value of the 3D Secure 2 authentication.

transStatusstring

The `transStatus` value as defined in the 3D Secure 2 specification.

transStatusReasonstring

Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).

whiteListStatusstring

The `whiteListStatus` value as defined in the 3D Secure 2 specification.

threeDSPaymentDatastring

When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.

json
{
  "action": null,
  "additionalData": {},
  "amount": {
    "currency": "string",
    "value": 0
  },
  "donationToken": "string",
  "fraudResult": {
    "accountScore": 0,
    "results": [
      {
        "accountScore": 0,
        "checkId": 0,
        "name": "string"
      }
    ]
  },
  "merchantReference": "string",
  "opi": {
    "issuerId": "string",
    "transToken": "string"
  },
  "order": {
    "pspReference": "string",
    "amount": {
      "currency": "string",
      "value": 0
    },
    "expiresAt": "string",
    "orderData": "string",
    "reference": "string",
    "remainingAmount": {
      "currency": "string",
      "value": 0
    }
  },
  "paymentMethod": {
    "brand": "string",
    "type": "string"
  },
  "paymentValidations": {
    "name": {
      "rawResponse": {
        "firstName": "string",
        "fullName": "string",
        "lastName": "string",
        "middleName": "string",
        "status": "string"
      },
      "result": {
        "firstName": "string",
        "fullName": "string",
        "lastName": "string",
        "middleName": "string"
      },
      "status": "notPerformed"
    }
  },
  "pspReference": "string",
  "refusalReason": "string"
}

Need more? See the Adyen guide for connection setup and behaviour shared by every action.

Submit details for a payment — Adyen — Documentation