mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
255 lines
9.4 KiB
JSON
255 lines
9.4 KiB
JSON
{
|
|
"openapi" : "3.1.0",
|
|
"info" : {
|
|
"version" : "4",
|
|
"x-publicVersion" : true,
|
|
"title" : "Transaction webhooks",
|
|
"description" : "Adyen sends webhooks to inform your system about incoming and outgoing transfers in your platform.\n\nYou can use these webhooks to build your implementation. For example, you can use this information to update balances in your own dashboards or to keep track of incoming funds.",
|
|
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
|
"contact" : {
|
|
"name" : "Adyen Developer Experience team",
|
|
"url" : "https://github.com/Adyen/adyen-openapi"
|
|
}
|
|
},
|
|
"x-groups" : [
|
|
"General"
|
|
],
|
|
"tags" : [
|
|
{
|
|
"name" : "General"
|
|
}
|
|
],
|
|
"x-staticResponse" : "response.json",
|
|
"webhooks" : {
|
|
"balancePlatform.transaction.created" : {
|
|
"post" : {
|
|
"tags" : [
|
|
"General"
|
|
],
|
|
"summary" : "Transaction created",
|
|
"description" : "Adyen sends this webhook when there are new fund transfers.",
|
|
"x-addedInVersion" : "1",
|
|
"operationId" : "post-balancePlatform.transaction.created",
|
|
"x-groupName" : "General",
|
|
"x-sortIndex" : 0,
|
|
"x-methodName" : "transactionCreated",
|
|
"security" : [
|
|
{
|
|
"BasicAuth" : [
|
|
]
|
|
}
|
|
],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/TransactionNotificationRequestV4"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"200" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
|
|
}
|
|
}
|
|
},
|
|
"description" : "OK - the request has succeeded."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components" : {
|
|
"schemas" : {
|
|
"Amount" : {
|
|
"properties" : {
|
|
"currency" : {
|
|
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
|
|
"maxLength" : 3,
|
|
"minLength" : 3,
|
|
"type" : "string"
|
|
},
|
|
"value" : {
|
|
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
|
|
"format" : "int64",
|
|
"type" : "integer"
|
|
}
|
|
},
|
|
"required" : [
|
|
"value",
|
|
"currency"
|
|
],
|
|
"type" : "object"
|
|
},
|
|
"BalancePlatformNotificationResponse" : {
|
|
"properties" : {
|
|
"notificationResponse" : {
|
|
"description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"type" : "object"
|
|
},
|
|
"Resource" : {
|
|
"properties" : {
|
|
"balancePlatform" : {
|
|
"description" : "The unique identifier of the balance platform.",
|
|
"type" : "string"
|
|
},
|
|
"creationDate" : {
|
|
"description" : "The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.",
|
|
"format" : "date-time",
|
|
"type" : "string"
|
|
},
|
|
"id" : {
|
|
"description" : "The ID of the resource.",
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"type" : "object"
|
|
},
|
|
"ResourceReference" : {
|
|
"properties" : {
|
|
"description" : {
|
|
"description" : "The description of the resource.",
|
|
"type" : "string"
|
|
},
|
|
"id" : {
|
|
"description" : "The unique identifier of the resource.",
|
|
"type" : "string"
|
|
},
|
|
"reference" : {
|
|
"description" : "The reference for the resource.",
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"type" : "object"
|
|
},
|
|
"Transaction" : {
|
|
"properties" : {
|
|
"accountHolder" : {
|
|
"x-addedInVersion" : "4",
|
|
"description" : "Contains information about the account holder associated with the `balanceAccount`.",
|
|
"$ref" : "#/components/schemas/ResourceReference"
|
|
},
|
|
"amount" : {
|
|
"x-addedInVersion" : "1",
|
|
"description" : "Contains information about the amount of the transaction.",
|
|
"$ref" : "#/components/schemas/Amount"
|
|
},
|
|
"balanceAccount" : {
|
|
"x-addedInVersion" : "4",
|
|
"description" : "Contains information about the balance account involved in the transaction.",
|
|
"$ref" : "#/components/schemas/ResourceReference"
|
|
},
|
|
"balancePlatform" : {
|
|
"x-addedInVersion" : "1",
|
|
"description" : "The unique identifier of the balance platform.",
|
|
"type" : "string"
|
|
},
|
|
"bookingDate" : {
|
|
"x-addedInVersion" : "1",
|
|
"description" : "The date the transaction was booked into the balance account.",
|
|
"format" : "date-time",
|
|
"type" : "string"
|
|
},
|
|
"creationDate" : {
|
|
"description" : "The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.",
|
|
"format" : "date-time",
|
|
"type" : "string"
|
|
},
|
|
"id" : {
|
|
"x-addedInVersion" : "1",
|
|
"description" : "The unique identifier of the transaction.",
|
|
"type" : "string"
|
|
},
|
|
"status" : {
|
|
"x-addedInVersion" : "1",
|
|
"description" : "The status of the transaction.\n\n Possible values:\n\n* **pending**: The transaction is still pending.\n\n* **booked**: The transaction has been booked to the balance account.\n\n",
|
|
"enum" : [
|
|
"booked",
|
|
"pending"
|
|
],
|
|
"type" : "string"
|
|
},
|
|
"transfer" : {
|
|
"x-addedInVersion" : "4",
|
|
"description" : "Contains information about the transfer related to the transaction.",
|
|
"$ref" : "#/components/schemas/TransferData"
|
|
},
|
|
"valueDate" : {
|
|
"x-addedInVersion" : "1",
|
|
"description" : "The date the transfer amount becomes available in the balance account.",
|
|
"format" : "date-time",
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"required" : [
|
|
"id",
|
|
"accountHolder",
|
|
"balanceAccount",
|
|
"amount",
|
|
"status",
|
|
"bookingDate",
|
|
"valueDate",
|
|
"balancePlatform"
|
|
],
|
|
"type" : "object"
|
|
},
|
|
"TransactionNotificationRequestV4" : {
|
|
"properties" : {
|
|
"data" : {
|
|
"description" : "Contains details about the event.",
|
|
"$ref" : "#/components/schemas/Transaction"
|
|
},
|
|
"environment" : {
|
|
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
|
|
"type" : "string"
|
|
},
|
|
"type" : {
|
|
"description" : "Type of the webhook.",
|
|
"enum" : [
|
|
"balancePlatform.transaction.created"
|
|
],
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"required" : [
|
|
"environment",
|
|
"data"
|
|
],
|
|
"type" : "object"
|
|
},
|
|
"TransferData" : {
|
|
"properties" : {
|
|
"id" : {
|
|
"description" : "The ID of the resource.",
|
|
"type" : "string"
|
|
},
|
|
"reference" : {
|
|
"x-addedInVersion" : "4",
|
|
"description" : "The [`reference`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers__reqParam_reference) from the `/transfers` request. If you haven't provided any, Adyen generates a unique reference.",
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"required" : [
|
|
"reference"
|
|
],
|
|
"type" : "object"
|
|
}
|
|
},
|
|
"securitySchemes" : {
|
|
"BasicAuth" : {
|
|
"scheme" : "basic",
|
|
"type" : "http"
|
|
}
|
|
},
|
|
"examples" : {
|
|
|
|
}
|
|
}
|
|
} |