POST /createPermit
Create permits for a recurring contract, including support for defining restrictions.
Servers
- https://pal-test.adyen.com/pal/servlet/Recurring/v68
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
permits[] |
Array | Yes |
The permits to create for this recurring contract. |
permits[].partnerId |
String | No |
Partner ID (when using the permit-per-partner token sharing model). |
permits[].profileReference |
String | No |
The profile to apply to this permit (when using the shared permits model). |
permits[].restriction |
Object | No |
Permit level restriction overrides. |
permits[].restriction.maxAmount |
Object | No |
The total sum amount of one or more payments made using this permit may not exceed this amount if set. |
permits[].restriction.maxAmount.value |
Integer | Yes |
The amount of the transaction, in minor units. |
permits[].restriction.maxAmount.currency |
String | Yes |
The three-character ISO currency code. |
permits[].restriction.singleTransactionLimit |
Object | No |
The amount of any single payment using this permit may not exceed this amount if set. |
permits[].restriction.singleTransactionLimit.value |
Integer | Yes |
The amount of the transaction, in minor units. |
permits[].restriction.singleTransactionLimit.currency |
String | Yes |
The three-character ISO currency code. |
permits[].restriction.singleUse |
Boolean | No |
Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed. |
permits[].resultKey |
String | No |
The key to link permit requests to permit results. |
permits[].validTillDate |
String | No |
The expiry date for this permit. |
shopperReference |
String | Yes |
The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). |
recurringDetailReference |
String | Yes |
The recurring contract the new permits will use. |
merchantAccount |
String | Yes |
The merchant account identifier, with which you want to process the transaction. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.