mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
spec release
This commit is contained in:
Adyen Automation
@@ -16,12 +16,14 @@
|
||||
} ],
|
||||
"tags" : [ {
|
||||
"name" : "Platform"
|
||||
}, {
|
||||
"name" : "Authorized card users"
|
||||
}, {
|
||||
"name" : "Account holders"
|
||||
}, {
|
||||
"name" : "Balance accounts"
|
||||
}, {
|
||||
"name" : "Balances"
|
||||
}, {
|
||||
"name" : "Balance accounts"
|
||||
}, {
|
||||
"name" : "Payment instruments"
|
||||
}, {
|
||||
@@ -6524,6 +6526,478 @@
|
||||
"x-methodName" : "validateBankAccountIdentification"
|
||||
}
|
||||
},
|
||||
"/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers" : {
|
||||
"get" : {
|
||||
"tags" : [ "Authorized card users" ],
|
||||
"summary" : "Get authorized users for a card.",
|
||||
"description" : "Returns the authorized users for a card.",
|
||||
"operationId" : "get-paymentInstruments-paymentInstrumentId-authorisedCardUsers",
|
||||
"parameters" : [ {
|
||||
"name" : "paymentInstrumentId",
|
||||
"in" : "path",
|
||||
"required" : true,
|
||||
"style" : "simple",
|
||||
"explode" : false,
|
||||
"schema" : {
|
||||
"type" : "string"
|
||||
}
|
||||
} ],
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"description" : "Successful operation",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/AuthorisedCardUsers"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers" : {
|
||||
"summary" : "List of authorised users of the payment instrument.",
|
||||
"description" : "The response returned the list of authorised users of the payment instrument.",
|
||||
"value" : {
|
||||
"legalEntityIds" : [ "LE328V522322685LV3KTNF35M", "LE328SW223226B5LWVWNQ8THN" ]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401" : {
|
||||
"description" : "Unauthorized",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-401" : {
|
||||
"summary" : "Unauthorized",
|
||||
"description" : "Authentication failed.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/unauthorized",
|
||||
"title" : "Unauthorized",
|
||||
"status" : 401,
|
||||
"errorCode" : "00_401"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403" : {
|
||||
"description" : "Forbidden",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-403" : {
|
||||
"summary" : "Forbidden",
|
||||
"description" : "Most commonly happens when user does not have sufficient roles or doesn't own requested resource.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/forbidden",
|
||||
"errorCode" : "00_403",
|
||||
"title" : "Forbidden",
|
||||
"detail" : "Not allowed for card partner yet.",
|
||||
"requestId" : "d42c493b5176df89e51516c6060cc34c",
|
||||
"status" : 403
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404" : {
|
||||
"description" : "Not Found",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-404" : {
|
||||
"summary" : "Entity not found",
|
||||
"description" : "Given payment instrument or legal entities not found.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/not-found",
|
||||
"errorCode" : "999_404_001",
|
||||
"title" : "Entity not found",
|
||||
"detail" : "Given payment instrument does not exist in our system. PI: PI3222722322935MDMZ9J83KH",
|
||||
"requestId" : "2fd2bd9cd4739575c5c562f0ff1e7396",
|
||||
"status" : 404
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422" : {
|
||||
"description" : "Unprocessable Entity - a request validation error.",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-422" : {
|
||||
"summary" : "Business constraint violation",
|
||||
"description" : "Response returned when request fields were invalid.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/unprocessable-entity",
|
||||
"errorCode" : "999_422_002",
|
||||
"title" : "Business constraint violation",
|
||||
"detail" : "There is not any legal entity tied to this payment instrument.",
|
||||
"requestId" : "4949a74bb7be732e559808a8ac3a86fc",
|
||||
"status" : 422
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 2
|
||||
},
|
||||
"post" : {
|
||||
"tags" : [ "Authorized card users" ],
|
||||
"summary" : "Create authorized users for a card.",
|
||||
"description" : "Assigns authorized users to a card. Users must have the **authorisedPaymentInstrumentUser** capability to be able to use the card.",
|
||||
"operationId" : "post-paymentInstruments-paymentInstrumentId-authorisedCardUsers",
|
||||
"parameters" : [ {
|
||||
"name" : "paymentInstrumentId",
|
||||
"in" : "path",
|
||||
"required" : true,
|
||||
"style" : "simple",
|
||||
"explode" : false,
|
||||
"schema" : {
|
||||
"type" : "string"
|
||||
}
|
||||
} ],
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/AuthorisedCardUsers"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers" : {
|
||||
"summary" : "Assigns authorised users to the payment instrument.",
|
||||
"description" : "The request to assign given authorised users to the payment instrument.",
|
||||
"value" : {
|
||||
"legalEntityIds" : [ "LE328V522322685LV3KTNF35M", "LE328SW223226B5LWVWNQ8THN" ]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required" : true
|
||||
},
|
||||
"responses" : {
|
||||
"204" : {
|
||||
"description" : "Successful operation"
|
||||
},
|
||||
"400" : {
|
||||
"description" : "Bad request",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-post-400" : {
|
||||
"summary" : "Bad request",
|
||||
"description" : "Response returned when request parsing has failed or some request fields were invalid.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/bad-request",
|
||||
"errorCode" : "999_400_000",
|
||||
"title" : "Bad request",
|
||||
"detail" : "Payment instrument already linked with legal entities. Please use patch method.",
|
||||
"requestId" : "24433d4ef9de1fa82be15274638f5d49",
|
||||
"status" : 400
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401" : {
|
||||
"description" : "Unauthorized",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-401" : {
|
||||
"summary" : "Unauthorized",
|
||||
"description" : "Authentication failed.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/unauthorized",
|
||||
"title" : "Unauthorized",
|
||||
"status" : 401,
|
||||
"errorCode" : "00_401"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403" : {
|
||||
"description" : "Forbidden",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-403" : {
|
||||
"summary" : "Forbidden",
|
||||
"description" : "Most commonly happens when user does not have sufficient roles or doesn't own requested resource.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/forbidden",
|
||||
"errorCode" : "00_403",
|
||||
"title" : "Forbidden",
|
||||
"detail" : "Not allowed for card partner yet.",
|
||||
"requestId" : "d42c493b5176df89e51516c6060cc34c",
|
||||
"status" : 403
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422" : {
|
||||
"description" : "Unprocessable Entity - a request validation error.",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-post-422" : {
|
||||
"summary" : "Business constraint violation",
|
||||
"description" : "Response returned when request fields were invalid.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/unprocessable-entity",
|
||||
"errorCode" : "999_422_002",
|
||||
"title" : "Business constraint violation",
|
||||
"detail" : "Given payment instrument is not a multi use payment instrument.",
|
||||
"requestId" : "4a7beaa203f673074e029916d4325602",
|
||||
"status" : 422
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 1
|
||||
},
|
||||
"delete" : {
|
||||
"tags" : [ "Authorized card users" ],
|
||||
"summary" : "Delete the authorized users for a card.",
|
||||
"description" : "Deletes the list of authorized users assigned to a card.",
|
||||
"operationId" : "delete-paymentInstruments-paymentInstrumentId-authorisedCardUsers",
|
||||
"parameters" : [ {
|
||||
"name" : "paymentInstrumentId",
|
||||
"in" : "path",
|
||||
"required" : true,
|
||||
"style" : "simple",
|
||||
"explode" : false,
|
||||
"schema" : {
|
||||
"type" : "string"
|
||||
}
|
||||
} ],
|
||||
"responses" : {
|
||||
"204" : {
|
||||
"description" : "Successful operation"
|
||||
},
|
||||
"401" : {
|
||||
"description" : "Unauthorized",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-401" : {
|
||||
"summary" : "Unauthorized",
|
||||
"description" : "Authentication failed.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/unauthorized",
|
||||
"title" : "Unauthorized",
|
||||
"status" : 401,
|
||||
"errorCode" : "00_401"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403" : {
|
||||
"description" : "Forbidden",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-403" : {
|
||||
"summary" : "Forbidden",
|
||||
"description" : "Most commonly happens when user does not have sufficient roles or doesn't own requested resource.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/forbidden",
|
||||
"errorCode" : "00_403",
|
||||
"title" : "Forbidden",
|
||||
"detail" : "Not allowed for card partner yet.",
|
||||
"requestId" : "d42c493b5176df89e51516c6060cc34c",
|
||||
"status" : 403
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 4
|
||||
},
|
||||
"patch" : {
|
||||
"tags" : [ "Authorized card users" ],
|
||||
"summary" : "Update the authorized users for a card.",
|
||||
"description" : "Updates the list of authorized users for a card.\n\n>This request replaces all existing authorized users for the card.",
|
||||
"operationId" : "patch-paymentInstruments-paymentInstrumentId-authorisedCardUsers",
|
||||
"parameters" : [ {
|
||||
"name" : "paymentInstrumentId",
|
||||
"in" : "path",
|
||||
"required" : true,
|
||||
"style" : "simple",
|
||||
"explode" : false,
|
||||
"schema" : {
|
||||
"type" : "string"
|
||||
}
|
||||
} ],
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/AuthorisedCardUsers"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers" : {
|
||||
"summary" : "Updates authorised users of the payment instrument.",
|
||||
"description" : "The request replaces existing authorised users of the payment instrument with the ones in the request.",
|
||||
"value" : {
|
||||
"legalEntityIds" : [ "LE328V522322685LV3KTNF35M", "LE328SW223226B5LWVWNQ8THN" ]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required" : true
|
||||
},
|
||||
"responses" : {
|
||||
"204" : {
|
||||
"description" : "Successful operation"
|
||||
},
|
||||
"400" : {
|
||||
"description" : "Bad request",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-patch-400" : {
|
||||
"summary" : "Bad request",
|
||||
"description" : "Response returned when request parsing has failed or some request fields were invalid.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/bad-request",
|
||||
"errorCode" : "999_400_000",
|
||||
"title" : "Bad request",
|
||||
"detail" : "Payment instrument hasn't linked with any legal entity reference Please use post method.",
|
||||
"requestId" : "a852d1b1c0fcbb7177b3bd16a0a2f6d7",
|
||||
"status" : 400
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401" : {
|
||||
"description" : "Unauthorized",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-401" : {
|
||||
"summary" : "Unauthorized",
|
||||
"description" : "Authentication failed.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/unauthorized",
|
||||
"title" : "Unauthorized",
|
||||
"status" : 401,
|
||||
"errorCode" : "00_401"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403" : {
|
||||
"description" : "Forbidden",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-403" : {
|
||||
"summary" : "Forbidden",
|
||||
"description" : "Most commonly happens when user does not have sufficient roles or doesn't own requested resource.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/forbidden",
|
||||
"errorCode" : "00_403",
|
||||
"title" : "Forbidden",
|
||||
"detail" : "Not allowed for card partner yet.",
|
||||
"requestId" : "d42c493b5176df89e51516c6060cc34c",
|
||||
"status" : 403
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422" : {
|
||||
"description" : "Unprocessable Entity - a request validation error.",
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DefaultErrorResponseEntity"
|
||||
},
|
||||
"examples" : {
|
||||
"authorisedCardUsers-patch-422" : {
|
||||
"summary" : "Business constraint violation",
|
||||
"description" : "Response returned when request fields were invalid.",
|
||||
"value" : {
|
||||
"type" : "https://docs.adyen.com/errors/unprocessable-entity",
|
||||
"errorCode" : "999_422_002",
|
||||
"title" : "Business constraint violation",
|
||||
"detail" : "Request must have maximum 10 legal entity reference.",
|
||||
"requestId" : "aeadb5646efe065f5e027d2fb6b137ec",
|
||||
"status" : 422
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 3
|
||||
}
|
||||
},
|
||||
"/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings" : {
|
||||
"get" : {
|
||||
"tags" : [ "Balances" ],
|
||||
@@ -11787,6 +12261,63 @@
|
||||
},
|
||||
"required" : [ "operation" ]
|
||||
},
|
||||
"AuthorisedCardUsers" : {
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"legalEntityIds" : {
|
||||
"type" : "array",
|
||||
"description" : "The legal entity IDs of the authorized card users linked to the specified payment instrument.",
|
||||
"items" : {
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"DefaultErrorResponseEntity" : {
|
||||
"type" : "object",
|
||||
"description" : "Standardized error response following RFC-7807 format",
|
||||
"externalDocs" : {
|
||||
"url" : "https://www.rfc-editor.org/rfc/rfc7807"
|
||||
},
|
||||
"properties" : {
|
||||
"detail" : {
|
||||
"type" : "string",
|
||||
"description" : "A human-readable explanation specific to this occurrence of the problem."
|
||||
},
|
||||
"errorCode" : {
|
||||
"type" : "string",
|
||||
"description" : "Unique business error code."
|
||||
},
|
||||
"instance" : {
|
||||
"type" : "string",
|
||||
"description" : "A URI that identifies the specific occurrence of the problem if applicable."
|
||||
},
|
||||
"invalidFields" : {
|
||||
"type" : "array",
|
||||
"description" : "Array of fields with validation errors when applicable.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/InvalidField"
|
||||
}
|
||||
},
|
||||
"requestId" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique reference for the request."
|
||||
},
|
||||
"status" : {
|
||||
"type" : "integer",
|
||||
"format" : "int32",
|
||||
"description" : "The HTTP status code."
|
||||
},
|
||||
"title" : {
|
||||
"type" : "string",
|
||||
"description" : "A short, human-readable summary of the problem type."
|
||||
},
|
||||
"type" : {
|
||||
"type" : "string",
|
||||
"description" : "A URI that identifies the validation error type. It points to human-readable documentation for the problem type."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BalanceWebhookSettingInfo" : {
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
@@ -11914,51 +12445,6 @@
|
||||
},
|
||||
"required" : [ "currency", "id", "status", "target", "type" ]
|
||||
},
|
||||
"DefaultErrorResponseEntity" : {
|
||||
"type" : "object",
|
||||
"description" : "Standardized error response following RFC-7807 format",
|
||||
"externalDocs" : {
|
||||
"url" : "https://www.rfc-editor.org/rfc/rfc7807"
|
||||
},
|
||||
"properties" : {
|
||||
"detail" : {
|
||||
"type" : "string",
|
||||
"description" : "A human-readable explanation specific to this occurrence of the problem."
|
||||
},
|
||||
"errorCode" : {
|
||||
"type" : "string",
|
||||
"description" : "Unique business error code."
|
||||
},
|
||||
"instance" : {
|
||||
"type" : "string",
|
||||
"description" : "A URI that identifies the specific occurrence of the problem if applicable."
|
||||
},
|
||||
"invalidFields" : {
|
||||
"type" : "array",
|
||||
"description" : "Array of fields with validation errors when applicable.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/InvalidField"
|
||||
}
|
||||
},
|
||||
"requestId" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique reference for the request."
|
||||
},
|
||||
"status" : {
|
||||
"type" : "integer",
|
||||
"format" : "int32",
|
||||
"description" : "The HTTP status code."
|
||||
},
|
||||
"title" : {
|
||||
"type" : "string",
|
||||
"description" : "A short, human-readable summary of the problem type."
|
||||
},
|
||||
"type" : {
|
||||
"type" : "string",
|
||||
"description" : "A URI that identifies the validation error type. It points to human-readable documentation for the problem type."
|
||||
}
|
||||
}
|
||||
},
|
||||
"WebhookSettings" : {
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
|
||||
@@ -29,9 +29,10 @@ servers:
|
||||
- url: https://balanceplatform-api-test.adyen.com/bcl/v2
|
||||
tags:
|
||||
- name: Platform
|
||||
- name: Authorized card users
|
||||
- name: Account holders
|
||||
- name: Balance accounts
|
||||
- name: Balances
|
||||
- name: Balance accounts
|
||||
- name: Payment instruments
|
||||
- name: Payment instrument groups
|
||||
- name: Transaction rules
|
||||
@@ -4428,6 +4429,365 @@ paths:
|
||||
x-addedInVersion: '1'
|
||||
x-sortIndex: 1
|
||||
x-methodName: validateBankAccountIdentification
|
||||
/paymentInstruments/{paymentInstrumentId}/authorisedCardUsers:
|
||||
get:
|
||||
tags:
|
||||
- Authorized card users
|
||||
summary: Get authorized users for a card.
|
||||
description: Returns the authorized users for a card.
|
||||
operationId: get-paymentInstruments-paymentInstrumentId-authorisedCardUsers
|
||||
parameters:
|
||||
- name: paymentInstrumentId
|
||||
in: path
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: Successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AuthorisedCardUsers'
|
||||
examples:
|
||||
authorisedCardUsers:
|
||||
summary: List of authorised users of the payment instrument.
|
||||
description: The response returned the list of authorised users
|
||||
of the payment instrument.
|
||||
value:
|
||||
legalEntityIds:
|
||||
- LE328V522322685LV3KTNF35M
|
||||
- LE328SW223226B5LWVWNQ8THN
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-401:
|
||||
summary: Unauthorized
|
||||
description: Authentication failed.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/unauthorized
|
||||
title: Unauthorized
|
||||
status: 401
|
||||
errorCode: '00_401'
|
||||
'403':
|
||||
description: Forbidden
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-403:
|
||||
summary: Forbidden
|
||||
description: Most commonly happens when user does not have sufficient
|
||||
roles or doesn't own requested resource.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/forbidden
|
||||
errorCode: '00_403'
|
||||
title: Forbidden
|
||||
detail: Not allowed for card partner yet.
|
||||
requestId: d42c493b5176df89e51516c6060cc34c
|
||||
status: 403
|
||||
'404':
|
||||
description: Not Found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-404:
|
||||
summary: Entity not found
|
||||
description: Given payment instrument or legal entities not found.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/not-found
|
||||
errorCode: '999_404_001'
|
||||
title: Entity not found
|
||||
detail: 'Given payment instrument does not exist in our system.
|
||||
PI: PI3222722322935MDMZ9J83KH'
|
||||
requestId: 2fd2bd9cd4739575c5c562f0ff1e7396
|
||||
status: 404
|
||||
'422':
|
||||
description: Unprocessable Entity - a request validation error.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-422:
|
||||
summary: Business constraint violation
|
||||
description: Response returned when request fields were invalid.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/unprocessable-entity
|
||||
errorCode: '999_422_002'
|
||||
title: Business constraint violation
|
||||
detail: There is not any legal entity tied to this payment instrument.
|
||||
requestId: 4949a74bb7be732e559808a8ac3a86fc
|
||||
status: 422
|
||||
x-sortIndex: 2
|
||||
post:
|
||||
tags:
|
||||
- Authorized card users
|
||||
summary: Create authorized users for a card.
|
||||
description: Assigns authorized users to a card. Users must have the **authorisedPaymentInstrumentUser**
|
||||
capability to be able to use the card.
|
||||
operationId: post-paymentInstruments-paymentInstrumentId-authorisedCardUsers
|
||||
parameters:
|
||||
- name: paymentInstrumentId
|
||||
in: path
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AuthorisedCardUsers'
|
||||
examples:
|
||||
authorisedCardUsers:
|
||||
summary: Assigns authorised users to the payment instrument.
|
||||
description: The request to assign given authorised users to the payment
|
||||
instrument.
|
||||
value:
|
||||
legalEntityIds:
|
||||
- LE328V522322685LV3KTNF35M
|
||||
- LE328SW223226B5LWVWNQ8THN
|
||||
required: true
|
||||
responses:
|
||||
'204':
|
||||
description: Successful operation
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-post-400:
|
||||
summary: Bad request
|
||||
description: Response returned when request parsing has failed or
|
||||
some request fields were invalid.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/bad-request
|
||||
errorCode: '999_400_000'
|
||||
title: Bad request
|
||||
detail: Payment instrument already linked with legal entities.
|
||||
Please use patch method.
|
||||
requestId: 24433d4ef9de1fa82be15274638f5d49
|
||||
status: 400
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-401:
|
||||
summary: Unauthorized
|
||||
description: Authentication failed.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/unauthorized
|
||||
title: Unauthorized
|
||||
status: 401
|
||||
errorCode: '00_401'
|
||||
'403':
|
||||
description: Forbidden
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-403:
|
||||
summary: Forbidden
|
||||
description: Most commonly happens when user does not have sufficient
|
||||
roles or doesn't own requested resource.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/forbidden
|
||||
errorCode: '00_403'
|
||||
title: Forbidden
|
||||
detail: Not allowed for card partner yet.
|
||||
requestId: d42c493b5176df89e51516c6060cc34c
|
||||
status: 403
|
||||
'422':
|
||||
description: Unprocessable Entity - a request validation error.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-post-422:
|
||||
summary: Business constraint violation
|
||||
description: Response returned when request fields were invalid.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/unprocessable-entity
|
||||
errorCode: '999_422_002'
|
||||
title: Business constraint violation
|
||||
detail: Given payment instrument is not a multi use payment instrument.
|
||||
requestId: 4a7beaa203f673074e029916d4325602
|
||||
status: 422
|
||||
x-sortIndex: 1
|
||||
delete:
|
||||
tags:
|
||||
- Authorized card users
|
||||
summary: Delete the authorized users for a card.
|
||||
description: Deletes the list of authorized users assigned to a card.
|
||||
operationId: delete-paymentInstruments-paymentInstrumentId-authorisedCardUsers
|
||||
parameters:
|
||||
- name: paymentInstrumentId
|
||||
in: path
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'204':
|
||||
description: Successful operation
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-401:
|
||||
summary: Unauthorized
|
||||
description: Authentication failed.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/unauthorized
|
||||
title: Unauthorized
|
||||
status: 401
|
||||
errorCode: '00_401'
|
||||
'403':
|
||||
description: Forbidden
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-403:
|
||||
summary: Forbidden
|
||||
description: Most commonly happens when user does not have sufficient
|
||||
roles or doesn't own requested resource.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/forbidden
|
||||
errorCode: '00_403'
|
||||
title: Forbidden
|
||||
detail: Not allowed for card partner yet.
|
||||
requestId: d42c493b5176df89e51516c6060cc34c
|
||||
status: 403
|
||||
x-sortIndex: 4
|
||||
patch:
|
||||
tags:
|
||||
- Authorized card users
|
||||
summary: Update the authorized users for a card.
|
||||
description: 'Updates the list of authorized users for a card.
|
||||
|
||||
|
||||
>This request replaces all existing authorized users for the card.'
|
||||
operationId: patch-paymentInstruments-paymentInstrumentId-authorisedCardUsers
|
||||
parameters:
|
||||
- name: paymentInstrumentId
|
||||
in: path
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AuthorisedCardUsers'
|
||||
examples:
|
||||
authorisedCardUsers:
|
||||
summary: Updates authorised users of the payment instrument.
|
||||
description: The request replaces existing authorised users of the
|
||||
payment instrument with the ones in the request.
|
||||
value:
|
||||
legalEntityIds:
|
||||
- LE328V522322685LV3KTNF35M
|
||||
- LE328SW223226B5LWVWNQ8THN
|
||||
required: true
|
||||
responses:
|
||||
'204':
|
||||
description: Successful operation
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-patch-400:
|
||||
summary: Bad request
|
||||
description: Response returned when request parsing has failed or
|
||||
some request fields were invalid.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/bad-request
|
||||
errorCode: '999_400_000'
|
||||
title: Bad request
|
||||
detail: Payment instrument hasn't linked with any legal entity
|
||||
reference Please use post method.
|
||||
requestId: a852d1b1c0fcbb7177b3bd16a0a2f6d7
|
||||
status: 400
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-401:
|
||||
summary: Unauthorized
|
||||
description: Authentication failed.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/unauthorized
|
||||
title: Unauthorized
|
||||
status: 401
|
||||
errorCode: '00_401'
|
||||
'403':
|
||||
description: Forbidden
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-403:
|
||||
summary: Forbidden
|
||||
description: Most commonly happens when user does not have sufficient
|
||||
roles or doesn't own requested resource.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/forbidden
|
||||
errorCode: '00_403'
|
||||
title: Forbidden
|
||||
detail: Not allowed for card partner yet.
|
||||
requestId: d42c493b5176df89e51516c6060cc34c
|
||||
status: 403
|
||||
'422':
|
||||
description: Unprocessable Entity - a request validation error.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DefaultErrorResponseEntity'
|
||||
examples:
|
||||
authorisedCardUsers-patch-422:
|
||||
summary: Business constraint violation
|
||||
description: Response returned when request fields were invalid.
|
||||
value:
|
||||
type: https://docs.adyen.com/errors/unprocessable-entity
|
||||
errorCode: '999_422_002'
|
||||
title: Business constraint violation
|
||||
detail: Request must have maximum 10 legal entity reference.
|
||||
requestId: aeadb5646efe065f5e027d2fb6b137ec
|
||||
status: 422
|
||||
x-sortIndex: 3
|
||||
/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings:
|
||||
get:
|
||||
tags:
|
||||
@@ -10643,6 +11003,51 @@ components:
|
||||
- WEARABLE
|
||||
required:
|
||||
- operation
|
||||
AuthorisedCardUsers:
|
||||
type: object
|
||||
properties:
|
||||
legalEntityIds:
|
||||
type: array
|
||||
description: The legal entity IDs of the authorized card users linked to
|
||||
the specified payment instrument.
|
||||
items:
|
||||
type: string
|
||||
DefaultErrorResponseEntity:
|
||||
type: object
|
||||
description: Standardized error response following RFC-7807 format
|
||||
externalDocs:
|
||||
url: https://www.rfc-editor.org/rfc/rfc7807
|
||||
properties:
|
||||
detail:
|
||||
type: string
|
||||
description: A human-readable explanation specific to this occurrence of
|
||||
the problem.
|
||||
errorCode:
|
||||
type: string
|
||||
description: Unique business error code.
|
||||
instance:
|
||||
type: string
|
||||
description: A URI that identifies the specific occurrence of the problem
|
||||
if applicable.
|
||||
invalidFields:
|
||||
type: array
|
||||
description: Array of fields with validation errors when applicable.
|
||||
items:
|
||||
$ref: '#/components/schemas/InvalidField'
|
||||
requestId:
|
||||
type: string
|
||||
description: The unique reference for the request.
|
||||
status:
|
||||
type: integer
|
||||
format: int32
|
||||
description: The HTTP status code.
|
||||
title:
|
||||
type: string
|
||||
description: A short, human-readable summary of the problem type.
|
||||
type:
|
||||
type: string
|
||||
description: A URI that identifies the validation error type. It points
|
||||
to human-readable documentation for the problem type.
|
||||
BalanceWebhookSettingInfo:
|
||||
type: object
|
||||
properties:
|
||||
@@ -10843,42 +11248,6 @@ components:
|
||||
- status
|
||||
- target
|
||||
- type
|
||||
DefaultErrorResponseEntity:
|
||||
type: object
|
||||
description: Standardized error response following RFC-7807 format
|
||||
externalDocs:
|
||||
url: https://www.rfc-editor.org/rfc/rfc7807
|
||||
properties:
|
||||
detail:
|
||||
type: string
|
||||
description: A human-readable explanation specific to this occurrence of
|
||||
the problem.
|
||||
errorCode:
|
||||
type: string
|
||||
description: Unique business error code.
|
||||
instance:
|
||||
type: string
|
||||
description: A URI that identifies the specific occurrence of the problem
|
||||
if applicable.
|
||||
invalidFields:
|
||||
type: array
|
||||
description: Array of fields with validation errors when applicable.
|
||||
items:
|
||||
$ref: '#/components/schemas/InvalidField'
|
||||
requestId:
|
||||
type: string
|
||||
description: The unique reference for the request.
|
||||
status:
|
||||
type: integer
|
||||
format: int32
|
||||
description: The HTTP status code.
|
||||
title:
|
||||
type: string
|
||||
description: A short, human-readable summary of the problem type.
|
||||
type:
|
||||
type: string
|
||||
description: A URI that identifies the validation error type. It points
|
||||
to human-readable documentation for the problem type.
|
||||
WebhookSettings:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in New Issue
Block a user