mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
Updated JSON specs
This commit is contained in:
aleksei
@@ -220,6 +220,109 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/debitAccountHolder" : {
|
||||
"post" : {
|
||||
"tags" : [
|
||||
"General"
|
||||
],
|
||||
"summary" : "Send a direct debit request.",
|
||||
"description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about use cases, refer to [Top up accounts](https://docs.adyen.com/platforms/top-up-accounts).",
|
||||
"operationId" : "post-debitAccountHolder",
|
||||
"x-groupName" : "General",
|
||||
"x-sortIndex" : 8,
|
||||
"security" : [
|
||||
{
|
||||
"BasicAuth" : [
|
||||
]
|
||||
},
|
||||
{
|
||||
"ApiKeyAuth" : [
|
||||
]
|
||||
}
|
||||
],
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DebitAccountHolderRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DebitAccountHolderResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
},
|
||||
"202" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DebitAccountHolderResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Accepted - the request has been accepted for processing, but the processing has not been completed."
|
||||
},
|
||||
"400" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/ServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Bad Request - a problem reading or understanding the request."
|
||||
},
|
||||
"401" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/ServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Unauthorized - authentication required."
|
||||
},
|
||||
"403" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/ServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Forbidden - insufficient permissions to process the request."
|
||||
},
|
||||
"422" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/ServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Unprocessable Entity - a request validation error."
|
||||
},
|
||||
"500" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/ServiceError"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "Internal Server Error - the server could not process the request."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/payoutAccountHolder" : {
|
||||
"post" : {
|
||||
"tags" : [
|
||||
@@ -1059,6 +1162,80 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"DebitAccountHolderRequest" : {
|
||||
"properties" : {
|
||||
"accountHolderCode" : {
|
||||
"description" : "The code of the account holder.",
|
||||
"type" : "string"
|
||||
},
|
||||
"amount" : {
|
||||
"description" : "The amount to be debited from the account holder's bank account.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"bankAccountUUID" : {
|
||||
"description" : "The Adyen-generated unique alphanumeric identifier (UUID) of the account holder's bank account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"description" : {
|
||||
"description" : "A description of the direct debit. Maximum length: 35 characters.\n\nAllowed characters: **a-z**, **A-Z**, **0-9**, and special characters **/?:().,'+ \";**.",
|
||||
"maxLength" : 35,
|
||||
"type" : "string"
|
||||
},
|
||||
"merchantAccount" : {
|
||||
"description" : "Your merchant account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"splits" : {
|
||||
"description" : "Contains instructions on how to split the funds between the accounts in your platform. The request must have at least one split item.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/Split"
|
||||
},
|
||||
"type" : "array"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"accountHolderCode",
|
||||
"bankAccountUUID",
|
||||
"amount",
|
||||
"splits",
|
||||
"merchantAccount"
|
||||
]
|
||||
},
|
||||
"DebitAccountHolderResponse" : {
|
||||
"properties" : {
|
||||
"accountHolderCode" : {
|
||||
"description" : "The code of the account holder.",
|
||||
"type" : "string"
|
||||
},
|
||||
"bankAccountUUID" : {
|
||||
"description" : "The Adyen-generated unique alphanumeric identifier (UUID) of the account holder's bank account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"invalidFields" : {
|
||||
"x-addedInVersion" : "5",
|
||||
"description" : "Contains field validation errors that would prevent requests from being processed.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/ErrorFieldType"
|
||||
},
|
||||
"type" : "array"
|
||||
},
|
||||
"merchantReferences" : {
|
||||
"description" : "List of the `reference` values from the `split` array in the request.",
|
||||
"items" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : "array"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The reference of a request. Can be used to uniquely identify the request.",
|
||||
"type" : "string"
|
||||
},
|
||||
"resultCode" : {
|
||||
"description" : "The result code.",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DetailBalance" : {
|
||||
"properties" : {
|
||||
"balance" : {
|
||||
@@ -1511,6 +1688,61 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"Split" : {
|
||||
"properties" : {
|
||||
"account" : {
|
||||
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
|
||||
"type" : "string"
|
||||
},
|
||||
"amount" : {
|
||||
"description" : "The amount of this split.",
|
||||
"$ref" : "#/components/schemas/SplitAmount"
|
||||
},
|
||||
"description" : {
|
||||
"description" : "A description of this split.",
|
||||
"type" : "string"
|
||||
},
|
||||
"reference" : {
|
||||
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**.",
|
||||
"enum" : [
|
||||
"BalanceAccount",
|
||||
"Commission",
|
||||
"Default",
|
||||
"MarketPlace",
|
||||
"PaymentFee",
|
||||
"VAT",
|
||||
"Verification"
|
||||
],
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"amount",
|
||||
"type"
|
||||
]
|
||||
},
|
||||
"SplitAmount" : {
|
||||
"properties" : {
|
||||
"currency" : {
|
||||
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
|
||||
"maxLength" : 3,
|
||||
"minLength" : 3,
|
||||
"type" : "string"
|
||||
},
|
||||
"value" : {
|
||||
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
|
||||
"format" : "int64",
|
||||
"type" : "integer"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"value"
|
||||
]
|
||||
},
|
||||
"Transaction" : {
|
||||
"properties" : {
|
||||
"amount" : {
|
||||
|
||||
Reference in New Issue
Block a user