API Reference

Create a Payment Method

post
https://api-dev.prolifepayments.com/payments/v1/setup-requests
Body Params
string
required

The customer ID that the paymentToken or paymentMethod belongs to. If both the paymentToken and the setupFutureUsage fields are provided, the customer will be attached to the paymentMethod.

string
required

The Payment Token received from the Pro-Life Payments.js SDK.

string
enum
required

Specifies the intended use of the created payment method.

Allowed:
string

A description for the Setup Request.

boolean

Set to true when the customer provides their payment method offline.

paymentMethod
object

The ID of the payment method associated with the Customer used in this PaymentRequest.

Headers
string

A unique identifier to ensure the same operation isn't processed multiple times, preventing duplicate transactions.

string

Specifies the account for which the Setup Request is intended. This is used for scenarios where one partner processes payments on behalf of another partner, such as in PayFac or related partner relationships.

Responses

Updated 6 months ago

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

Updated 6 months ago