POST /payments/details

Submits details for a payment created using /payments. This step is only needed when no final state has been reached on the /payments request, for example when the shopper was redirected to another page to complete the payment.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Idempotency-Key String No

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

Request body fields

Name Type Required Description
authenticationData Object No

Data for 3DS authentication.

authenticationData.authenticationOnly Boolean No

If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation. Default: false*.

Default value: false

threeDSAuthenticationOnly Boolean No

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

paymentData String No

Encoded payment data. For authorizing a payment after using 3D Secure 2 Authentication-only:

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.

details Object Yes

Use this collection to submit the details that were returned as a result of the /payments call.

details.paymentID String No

PayPal-generated ID for the payment.

details.vaultToken String No

PayPalv2-generated token for recurring payments.

details.facilitatorAccessToken String No

PayPal-generated third party access token.

details.paymentStatus String No

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

details.MD String No

A payment session identifier returned by the card issuer.

details.authorization_token String No
details.PaRes String No

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

details.threeds2.challengeResult String No

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

details.orderID String No

PayPal-assigned ID for the order.

details.PaReq String No

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

details.cupsecureplus.smscode String No

The SMS verification code collected from the shopper.

details.payload String No

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

details.billingToken String No

PayPal-generated token for recurring payments.

details.redirectResult String No

The result of the redirect as appended to the returnURL.

details.threeds2.fingerprint String No

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

details.payerID String No

PayPal-assigned ID for the payer (shopper).

details.resultCode String No

Value you received from the WeChat Pay SDK.

details.threeDSResult String No

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

details.oneTimePasscode String No

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

details.returnUrlQueryString String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.