Create a setup intent

Creates a setup intent. If successfully created, it returns a SetupIntent object that contains information related to the setup intent.

SecurityOAuth2
Request
Request Body schema: application/json
customerId
required
string <uuid>

The unique identifier for the customer record.

externalReferenceId
string

The unique identifier for the setup intent generated by the location or the integration partner.

standingInstructionType
string

The instruction type used by the merchant and sent to the payment processor.

  • INSTALLMENT - The total purchase amount split into a fixed number of payments.

  • RECURRING - A series of set payments charged at regular intervals.

  • UNSCHEDULED - A single merchant-initiated payment.

Enum: "UNSCHEDULED" "INSTALLMENT" "RECURRING"
Responses
201

Successful operation. Setup intent created.

400

Bad request / Missing required fields.

401

Unauthorized.

403

Forbidden.

500

Internal server error.

post/v1/setup-intents
Request samples
application/json
{
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "standingInstructionType": "UNSCHEDULED",
  • "externalReferenceId": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "sessionSecret": "string",
  • "externalReferenceId": "string",
  • "mandateId": "d4dbf0da-b5aa-43ae-b9db-c2aff331d3ad",
  • "paymentMethodTypes": [ ],
  • "creationDate": "2023-07-07T14:01:27Z"
}