Create Agreement

post

https://sandbox.pingpayments.com/payments/api/v1/agreements

Create Agreement

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create Agreement request body

Request body for creating agreement

agreement_template_id

string

required

The agreement template that should be used to create the agreement.
Available agreement templates can be seen through GET agreement_templates endpoint

event_callback_url

string | null

The url that agreement events will be sent to,
only use this if you are interested in every change that happens to the agreement.
How the callback looks will be dependant on the provider

merchant_id

string

required

ID of the merchant that the agreement is created for

name

string

required

Name of the agreement

provider_parameters

required

status_callback_url

string | null

The URL that will be called when the status of the agreement is updated

Headers

tenant_id

uuid

required

Tenant ID header

x-api-version

date

API version for the specific endpoint

Responses

Callbacks

200CreateAgreementResponseBody

400API Error

403API Error

404API Error

422Validation Error