Verify a payment consent

post

https://api.stage.payouts.com/payment-consents/update/{id}

Required permissions for this API:

WRITE:FINANCE

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

descriptor

string

Descriptor that may be displayed to the customer during the verification.

deviceData

object

Client device information. It is recommended to provide this data to increase the odds of having frictionless 3DS.

paymentMethod

object

required

PaymentMethod information that will be used for subsequent payments. When payment_method.type is set to card, ach_direct_debit, bacs_direct_debit, becs_direct_debit, sepa_direct_debit googlepay, applepay, caller must provide either the payment_method.id of an existing PaymentMethod or the full payload of payment method information with which we will generate a new PaymentMethod.

requestId

string

Client-generated idempotency key. Must be unique per request attempt. Conversion requests with the same request_id will be rejected. Parameter supports a maximum of 64 characters.

returnUrl

string

The URL to which your customer will be redirected after they verify PaymentConsent on the PaymentMethod’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively provide an application URI scheme.

riskControlOptions

object

required

verificationOptions

object

Responses

200

401A response indicating that the provided api token is invalid or has already expired