Confirm Payment Instrument Mandate

Preview: This endpoint is a preview API and may change without a deprecation period.

Confirms a mandate the customer accepted, so that it can be used for collections. On success, the mandate changes from created to confirmed and sca is no longer returned. The timestamp of the confirmed status is the mandate signing date.

When the mandate was created with sca.required = true, send the customer's signature over sca.challenge in sca. Otherwise, send an empty object ({}).

Confirming an already confirmed mandate returns it unchanged.

An event with type payment_instrument_mandate.confirmed will be created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

An account identifier.

string
required

A payment instrument mandate identifier.

Body Params
sca
object

The proof of Strong Customer Authentication. Required when the mandate was created with sca.required = true.

Headers
string
required
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json