mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
Updated MarketPay API definitions
This commit is contained in:
aleksei
@@ -968,10 +968,6 @@
|
||||
"description" : "The registered name of the company (if it differs from the legal name of the company).",
|
||||
"type" : "string"
|
||||
},
|
||||
"incorporatedAt" : {
|
||||
"description" : "The jurisdiction of incorporation of the company. \n>Two (2) characters for a business in the USA or Canada, or a maximum of three (3) characters for an address in all other countries, or 'FEDERAL'",
|
||||
"type" : "string"
|
||||
},
|
||||
"legalBusinessName" : {
|
||||
"description" : "The legal name of the company.",
|
||||
"type" : "string"
|
||||
@@ -1087,6 +1083,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1167,6 +1164,8 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
@@ -1184,9 +1183,7 @@
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"accountHolderCode",
|
||||
"payoutSchedule",
|
||||
"payoutScheduleReason"
|
||||
"accountHolderCode"
|
||||
]
|
||||
},
|
||||
"CreateAccountResponse" : {
|
||||
@@ -1298,7 +1295,6 @@
|
||||
"ID_CARD",
|
||||
"ID_CARD_BACK",
|
||||
"ID_CARD_FRONT",
|
||||
"NHIS",
|
||||
"PASSPORT",
|
||||
"SSN",
|
||||
"SUPPORTING_DOCUMENTS"
|
||||
@@ -1368,6 +1364,7 @@
|
||||
"cardToken",
|
||||
"checkCode",
|
||||
"city",
|
||||
"companyRegistration",
|
||||
"country",
|
||||
"countryCode",
|
||||
"currency",
|
||||
@@ -1398,7 +1395,6 @@
|
||||
"idCardFront",
|
||||
"idNumber",
|
||||
"identityDocument",
|
||||
"incorporatedAt",
|
||||
"individualDetails",
|
||||
"lastName",
|
||||
"legalBusinessName",
|
||||
@@ -1438,6 +1434,7 @@
|
||||
"status",
|
||||
"store",
|
||||
"storeDetail",
|
||||
"storeName",
|
||||
"storeReference",
|
||||
"street",
|
||||
"taxId",
|
||||
@@ -1517,6 +1514,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1679,7 +1677,7 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The status of the check.\n>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"description" : "The status of the check.\n>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"enum" : [
|
||||
"AWAITING_DATA",
|
||||
"DATA_PROVIDED",
|
||||
@@ -1792,6 +1790,8 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
@@ -2126,6 +2126,8 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
|
||||
@@ -976,10 +976,6 @@
|
||||
"description" : "The registered name of the company (if it differs from the legal name of the company).",
|
||||
"type" : "string"
|
||||
},
|
||||
"incorporatedAt" : {
|
||||
"description" : "The jurisdiction of incorporation of the company. \n>Two (2) characters for a business in the USA or Canada, or a maximum of three (3) characters for an address in all other countries, or 'FEDERAL'",
|
||||
"type" : "string"
|
||||
},
|
||||
"legalBusinessName" : {
|
||||
"description" : "The legal name of the company.",
|
||||
"type" : "string"
|
||||
@@ -1103,6 +1099,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1158,6 +1155,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1206,6 +1204,8 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
@@ -1223,10 +1223,7 @@
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"accountHolderCode",
|
||||
"payoutSchedule",
|
||||
"payoutScheduleReason",
|
||||
"description"
|
||||
"accountHolderCode"
|
||||
]
|
||||
},
|
||||
"CreateAccountResponse" : {
|
||||
@@ -1342,7 +1339,6 @@
|
||||
"ID_CARD",
|
||||
"ID_CARD_BACK",
|
||||
"ID_CARD_FRONT",
|
||||
"NHIS",
|
||||
"PASSPORT",
|
||||
"SSN",
|
||||
"SUPPORTING_DOCUMENTS"
|
||||
@@ -1412,6 +1408,7 @@
|
||||
"cardToken",
|
||||
"checkCode",
|
||||
"city",
|
||||
"companyRegistration",
|
||||
"country",
|
||||
"countryCode",
|
||||
"currency",
|
||||
@@ -1442,7 +1439,6 @@
|
||||
"idCardFront",
|
||||
"idNumber",
|
||||
"identityDocument",
|
||||
"incorporatedAt",
|
||||
"individualDetails",
|
||||
"lastName",
|
||||
"legalBusinessName",
|
||||
@@ -1482,6 +1478,7 @@
|
||||
"status",
|
||||
"store",
|
||||
"storeDetail",
|
||||
"storeName",
|
||||
"storeReference",
|
||||
"street",
|
||||
"taxId",
|
||||
@@ -1569,6 +1566,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1735,7 +1733,7 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The status of the check.\n>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"description" : "The status of the check.\n>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"enum" : [
|
||||
"AWAITING_DATA",
|
||||
"DATA_PROVIDED",
|
||||
@@ -1848,6 +1846,8 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
@@ -2069,6 +2069,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -2213,6 +2214,8 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
|
||||
@@ -1084,10 +1084,6 @@
|
||||
"description" : "The registered name of the company (if it differs from the legal name of the company).",
|
||||
"type" : "string"
|
||||
},
|
||||
"incorporatedAt" : {
|
||||
"description" : "The jurisdiction of incorporation of the company. \n>Two (2) characters for a business in the USA or Canada, or a maximum of three (3) characters for an address in all other countries, or 'FEDERAL'",
|
||||
"type" : "string"
|
||||
},
|
||||
"legalBusinessName" : {
|
||||
"description" : "The legal name of the company.",
|
||||
"type" : "string"
|
||||
@@ -1160,6 +1156,10 @@
|
||||
},
|
||||
"CloseAccountResponse" : {
|
||||
"properties" : {
|
||||
"accountCode" : {
|
||||
"description" : "The account code of the account that is closed.",
|
||||
"type" : "string"
|
||||
},
|
||||
"invalidFields" : {
|
||||
"description" : "Contains field validation errors that would prevent requests from being processed.",
|
||||
"items" : {
|
||||
@@ -1215,6 +1215,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1270,6 +1271,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1321,6 +1323,8 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
@@ -1338,10 +1342,7 @@
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"accountHolderCode",
|
||||
"payoutSchedule",
|
||||
"payoutScheduleReason",
|
||||
"description"
|
||||
"accountHolderCode"
|
||||
]
|
||||
},
|
||||
"CreateAccountResponse" : {
|
||||
@@ -1481,9 +1482,9 @@
|
||||
"DRIVING_LICENCE",
|
||||
"DRIVING_LICENCE_BACK",
|
||||
"DRIVING_LICENCE_FRONT",
|
||||
"ID_CARD",
|
||||
"ID_CARD_BACK",
|
||||
"ID_CARD_FRONT",
|
||||
"NHIS",
|
||||
"PASSPORT",
|
||||
"SSN",
|
||||
"SUPPORTING_DOCUMENTS"
|
||||
@@ -1553,6 +1554,7 @@
|
||||
"cardToken",
|
||||
"checkCode",
|
||||
"city",
|
||||
"companyRegistration",
|
||||
"country",
|
||||
"countryCode",
|
||||
"currency",
|
||||
@@ -1583,7 +1585,6 @@
|
||||
"idCardFront",
|
||||
"idNumber",
|
||||
"identityDocument",
|
||||
"incorporatedAt",
|
||||
"individualDetails",
|
||||
"lastName",
|
||||
"legalBusinessName",
|
||||
@@ -1623,6 +1624,7 @@
|
||||
"status",
|
||||
"store",
|
||||
"storeDetail",
|
||||
"storeName",
|
||||
"storeReference",
|
||||
"street",
|
||||
"taxId",
|
||||
@@ -1719,6 +1721,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1889,7 +1892,7 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The status of the check.\n>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"description" : "The status of the check.\n>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"enum" : [
|
||||
"AWAITING_DATA",
|
||||
"DATA_PROVIDED",
|
||||
@@ -2026,6 +2029,8 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
@@ -2246,6 +2251,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -2295,6 +2301,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -2443,6 +2450,8 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
|
||||
@@ -155,9 +155,9 @@
|
||||
"/refundFundsTransfer" : {
|
||||
"post" : {
|
||||
"summary" : "Make a refund of the existing transfer funds transfer.",
|
||||
"description" : "This endpoint is used to refund funds from one account to another account. Both accounts must be in the same marketplace, but can have different account holders. ",
|
||||
"description" : "This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. ",
|
||||
"x-groupName" : "General",
|
||||
"x-sortIndex" : 4,
|
||||
"x-sortIndex" : 5,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
@@ -201,7 +201,7 @@
|
||||
"summary" : "Refund all transactions of an account since the most recent payout.",
|
||||
"description" : "This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a per-account basis (as opposed to a per-payment basis), so only the portion of the payment which was made to the specified account will be refunded. The commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment's split details.",
|
||||
"x-groupName" : "General",
|
||||
"x-sortIndex" : 6,
|
||||
"x-sortIndex" : 7,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
@@ -245,7 +245,7 @@
|
||||
"summary" : "Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.",
|
||||
"description" : "This endpoint is used to define a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it.",
|
||||
"x-groupName" : "General",
|
||||
"x-sortIndex" : 5,
|
||||
"x-sortIndex" : 6,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
@@ -410,11 +410,14 @@
|
||||
"ChargebackReversedReceived",
|
||||
"Converted",
|
||||
"CreditFailed",
|
||||
"CreditReversed",
|
||||
"CreditReversedReceived",
|
||||
"Credited",
|
||||
"DebitFailed",
|
||||
"DebitReversedReceived",
|
||||
"Debited",
|
||||
"DebitedReversed",
|
||||
"Fee",
|
||||
"FundTransfer",
|
||||
"FundTransferReversed",
|
||||
"ManualCorrected",
|
||||
@@ -680,8 +683,7 @@
|
||||
},
|
||||
"required" : [
|
||||
"pspReference",
|
||||
"submittedAsync",
|
||||
"bankAccountUUID"
|
||||
"submittedAsync"
|
||||
]
|
||||
},
|
||||
"RefundFundsTransferRequest" : {
|
||||
@@ -707,12 +709,14 @@
|
||||
"RefundFundsTransferResponse" : {
|
||||
"properties" : {
|
||||
"merchantReference" : {
|
||||
"description" : "The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.",
|
||||
"type" : "string"
|
||||
},
|
||||
"message" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"originalReference" : {
|
||||
"description" : "A PSP reference of the original fund transfer.",
|
||||
"type" : "string"
|
||||
},
|
||||
"pspReference" : {
|
||||
@@ -880,11 +884,14 @@
|
||||
"ChargebackReversedReceived",
|
||||
"Converted",
|
||||
"CreditFailed",
|
||||
"CreditReversed",
|
||||
"CreditReversedReceived",
|
||||
"Credited",
|
||||
"DebitFailed",
|
||||
"DebitReversedReceived",
|
||||
"Debited",
|
||||
"DebitedReversed",
|
||||
"Fee",
|
||||
"FundTransfer",
|
||||
"FundTransferReversed",
|
||||
"ManualCorrected",
|
||||
|
||||
@@ -155,9 +155,9 @@
|
||||
"/refundFundsTransfer" : {
|
||||
"post" : {
|
||||
"summary" : "Make a refund of the existing transfer funds transfer.",
|
||||
"description" : "This endpoint is used to refund funds from one account to another account. Both accounts must be in the same marketplace, but can have different account holders. ",
|
||||
"description" : "This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. ",
|
||||
"x-groupName" : "General",
|
||||
"x-sortIndex" : 4,
|
||||
"x-sortIndex" : 5,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
@@ -201,7 +201,7 @@
|
||||
"summary" : "Refund all transactions of an account since the most recent payout.",
|
||||
"description" : "This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a per-account basis (as opposed to a per-payment basis), so only the portion of the payment which was made to the specified account will be refunded. The commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment's split details.",
|
||||
"x-groupName" : "General",
|
||||
"x-sortIndex" : 6,
|
||||
"x-sortIndex" : 7,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
@@ -245,7 +245,7 @@
|
||||
"summary" : "Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.",
|
||||
"description" : "This endpoint is used to define a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it.",
|
||||
"x-groupName" : "General",
|
||||
"x-sortIndex" : 5,
|
||||
"x-sortIndex" : 6,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
@@ -412,11 +412,14 @@
|
||||
"ChargebackReversedReceived",
|
||||
"Converted",
|
||||
"CreditFailed",
|
||||
"CreditReversed",
|
||||
"CreditReversedReceived",
|
||||
"Credited",
|
||||
"DebitFailed",
|
||||
"DebitReversedReceived",
|
||||
"Debited",
|
||||
"DebitedReversed",
|
||||
"Fee",
|
||||
"FundTransfer",
|
||||
"FundTransferReversed",
|
||||
"ManualCorrected",
|
||||
@@ -685,6 +688,7 @@
|
||||
"cardToken",
|
||||
"checkCode",
|
||||
"city",
|
||||
"companyRegistration",
|
||||
"country",
|
||||
"countryCode",
|
||||
"currency",
|
||||
@@ -715,7 +719,6 @@
|
||||
"idCardFront",
|
||||
"idNumber",
|
||||
"identityDocument",
|
||||
"incorporatedAt",
|
||||
"individualDetails",
|
||||
"lastName",
|
||||
"legalBusinessName",
|
||||
@@ -755,6 +758,7 @@
|
||||
"status",
|
||||
"store",
|
||||
"storeDetail",
|
||||
"storeName",
|
||||
"storeReference",
|
||||
"street",
|
||||
"taxId",
|
||||
@@ -839,8 +843,7 @@
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"pspReference",
|
||||
"bankAccountUUID"
|
||||
"pspReference"
|
||||
]
|
||||
},
|
||||
"RefundFundsTransferRequest" : {
|
||||
@@ -873,12 +876,14 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"merchantReference" : {
|
||||
"description" : "The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.",
|
||||
"type" : "string"
|
||||
},
|
||||
"message" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"originalReference" : {
|
||||
"description" : "A PSP reference of the original fund transfer.",
|
||||
"type" : "string"
|
||||
},
|
||||
"pspReference" : {
|
||||
@@ -1045,11 +1050,14 @@
|
||||
"ChargebackReversedReceived",
|
||||
"Converted",
|
||||
"CreditFailed",
|
||||
"CreditReversed",
|
||||
"CreditReversedReceived",
|
||||
"Credited",
|
||||
"DebitFailed",
|
||||
"DebitReversedReceived",
|
||||
"Debited",
|
||||
"DebitedReversed",
|
||||
"Fee",
|
||||
"FundTransfer",
|
||||
"FundTransferReversed",
|
||||
"ManualCorrected",
|
||||
|
||||
261
json/HopService-v1.json
Normal file
261
json/HopService-v1.json
Normal file
@@ -0,0 +1,261 @@
|
||||
{
|
||||
"openapi" : "3.0.0",
|
||||
"servers" : [
|
||||
{
|
||||
"url" : "https://cal-test.adyen.com/cal/services/Hop/v1"
|
||||
}
|
||||
],
|
||||
"info" : {
|
||||
"version" : "1",
|
||||
"title" : "Adyen MarketPay Hop API",
|
||||
"description" : "The MarketPay Hop API provides endpoints for using the MarketPay Hosted Onboarding Page. The related entities include account holders only. \nFor more information, refer to the [MarketPay Hosted Onboarding Page documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/hosted-onboarding-page).\n## Authentication\nTo connect to the MarketPay API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nMarketPay API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl\n```",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Support",
|
||||
"url" : "https://support.adyen.com/",
|
||||
"email" : "support@adyen.com"
|
||||
}
|
||||
},
|
||||
"x-groups" : [
|
||||
"Hosted Onboarding Page"
|
||||
],
|
||||
"paths" : {
|
||||
"/getOnboardingUrl" : {
|
||||
"post" : {
|
||||
"summary" : "Get a new onboarding url for an account holder.",
|
||||
"description" : "This endpoint is used to get a new onboarding url for a specific account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. A returnUrl can also be specified as part of this request.",
|
||||
"x-groupName" : "Hosted Onboarding Page",
|
||||
"x-sortIndex" : 1,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/GetOnboardingUrlRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/GetOnboardingUrlResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
},
|
||||
"400" : {
|
||||
"description" : "Bad Request - a problem reading or understanding the request."
|
||||
},
|
||||
"422" : {
|
||||
"description" : "Unprocessable Entity - a request validation error."
|
||||
},
|
||||
"401" : {
|
||||
"description" : "Unauthorized - authentication required."
|
||||
},
|
||||
"500" : {
|
||||
"description" : "Internal Server Error - the server could not process the request."
|
||||
},
|
||||
"403" : {
|
||||
"description" : "Forbidden - insufficient permissions to process the request."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"components" : {
|
||||
"schemas" : {
|
||||
"ErrorFieldType" : {
|
||||
"properties" : {
|
||||
"errorCode" : {
|
||||
"description" : "The validation error code.",
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
},
|
||||
"errorDescription" : {
|
||||
"description" : "A description of the validation error.",
|
||||
"type" : "string"
|
||||
},
|
||||
"fieldType" : {
|
||||
"description" : "The type of error field.",
|
||||
"$ref" : "#/components/schemas/FieldType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"FieldType" : {
|
||||
"properties" : {
|
||||
"field" : {
|
||||
"description" : "The full name of the property.",
|
||||
"type" : "string"
|
||||
},
|
||||
"fieldName" : {
|
||||
"description" : "The type of the field.",
|
||||
"enum" : [
|
||||
"accountCode",
|
||||
"accountHolderCode",
|
||||
"accountHolderDetails",
|
||||
"accountNumber",
|
||||
"accountStateType",
|
||||
"accountStatus",
|
||||
"accountType",
|
||||
"address",
|
||||
"bankAccount",
|
||||
"bankAccountCode",
|
||||
"bankAccountName",
|
||||
"bankAccountUUID",
|
||||
"bankBicSwift",
|
||||
"bankCity",
|
||||
"bankCode",
|
||||
"bankName",
|
||||
"bankStatement",
|
||||
"branchCode",
|
||||
"businessContact",
|
||||
"cardToken",
|
||||
"checkCode",
|
||||
"city",
|
||||
"companyRegistration",
|
||||
"country",
|
||||
"countryCode",
|
||||
"currency",
|
||||
"currencyCode",
|
||||
"dateOfBirth",
|
||||
"description",
|
||||
"destinationAccountCode",
|
||||
"document",
|
||||
"documentExpirationDate",
|
||||
"documentIssuerCountry",
|
||||
"documentIssuerState",
|
||||
"documentName",
|
||||
"documentNumber",
|
||||
"documentType",
|
||||
"doingBusinessAs",
|
||||
"drivingLicence",
|
||||
"drivingLicenceBack",
|
||||
"drivingLicense",
|
||||
"email",
|
||||
"firstName",
|
||||
"fullPhoneNumber",
|
||||
"gender",
|
||||
"hopWebserviceUser",
|
||||
"houseNumberOrName",
|
||||
"iban",
|
||||
"idCard",
|
||||
"idCardBack",
|
||||
"idCardFront",
|
||||
"idNumber",
|
||||
"identityDocument",
|
||||
"individualDetails",
|
||||
"lastName",
|
||||
"legalBusinessName",
|
||||
"legalEntity",
|
||||
"legalEntityType",
|
||||
"merchantAccount",
|
||||
"merchantCategoryCode",
|
||||
"merchantReference",
|
||||
"microDeposit",
|
||||
"name",
|
||||
"nationality",
|
||||
"originalReference",
|
||||
"ownerCity",
|
||||
"ownerCountryCode",
|
||||
"ownerHouseNumberOrName",
|
||||
"ownerName",
|
||||
"ownerPostalCode",
|
||||
"ownerState",
|
||||
"ownerStreet",
|
||||
"passport",
|
||||
"passportNumber",
|
||||
"payoutMethodCode",
|
||||
"personalData",
|
||||
"phoneCountryCode",
|
||||
"phoneNumber",
|
||||
"postalCode",
|
||||
"primaryCurrency",
|
||||
"reason",
|
||||
"registrationNumber",
|
||||
"returnUrl",
|
||||
"schedule",
|
||||
"shareholder",
|
||||
"shareholderCode",
|
||||
"socialSecurityNumber",
|
||||
"sourceAccountCode",
|
||||
"stateOrProvince",
|
||||
"status",
|
||||
"store",
|
||||
"storeDetail",
|
||||
"storeName",
|
||||
"storeReference",
|
||||
"street",
|
||||
"taxId",
|
||||
"tier",
|
||||
"tierNumber",
|
||||
"transferCode",
|
||||
"unknown",
|
||||
"value",
|
||||
"virtualAccount",
|
||||
"visaNumber",
|
||||
"webAddress"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"shareholderCode" : {
|
||||
"description" : "The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetOnboardingUrlRequest" : {
|
||||
"properties" : {
|
||||
"accountHolderCode" : {
|
||||
"description" : "The account holder code you provided when you created the account holder.",
|
||||
"type" : "string"
|
||||
},
|
||||
"platformName" : {
|
||||
"description" : "The platform name which will show up in the welcome page.",
|
||||
"type" : "string"
|
||||
},
|
||||
"returnUrl" : {
|
||||
"description" : "The URL where the sub-merchant will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don't provide this, the sub-merchant will be redirected back to the default return URL configured in your platform account.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"accountHolderCode"
|
||||
]
|
||||
},
|
||||
"GetOnboardingUrlResponse" : {
|
||||
"properties" : {
|
||||
"invalidFields" : {
|
||||
"description" : "Contains field validation errors that would prevent requests from being processed.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/ErrorFieldType"
|
||||
},
|
||||
"type" : "array"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The reference of a request. Can be used to uniquely identify the request.",
|
||||
"type" : "string"
|
||||
},
|
||||
"redirectUrl" : {
|
||||
"description" : "The URL to the Hosted Onboarding Page where you should redirect your sub-merchant. This URL must be used within 15 seconds and can only be used once.",
|
||||
"type" : "string"
|
||||
},
|
||||
"resultCode" : {
|
||||
"description" : "The result code.",
|
||||
"type" : "string"
|
||||
},
|
||||
"submittedAsync" : {
|
||||
"description" : "Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied:\n* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.\n* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.\n* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.",
|
||||
"type" : "boolean"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"pspReference",
|
||||
"submittedAsync"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2,8 +2,8 @@
|
||||
"openapi" : "3.0.0",
|
||||
"info" : {
|
||||
"version" : "3",
|
||||
"title" : "Adyen Notification API",
|
||||
"description" : "The Notification Service sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).",
|
||||
"title" : "Adyen MarketPay Notifications",
|
||||
"description" : "The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Support",
|
||||
@@ -165,6 +165,64 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ACCOUNT_HOLDER_STORE_STATUS_CHANGE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon the status change of a store tied to an account holder.",
|
||||
"description" : "This notification is sent when the status of a store tied to an account holder has been changed.",
|
||||
"x-groupName" : "Account holders",
|
||||
"x-sortIndex" : 4,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ACCOUNT_HOLDER_UPCOMING_DEADLINE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon an upcoming deadline.",
|
||||
"description" : "This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.",
|
||||
"x-groupName" : "Account holders",
|
||||
"x-sortIndex" : 1,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ACCOUNT_HOLDER_UPDATED" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon the update of an account holder.",
|
||||
@@ -310,6 +368,35 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/DIRECT_DEBIT_INITIATED" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered when an automated direct debit is initiated.",
|
||||
"description" : "This notification is sent when an automated direct debit is initiated from the Adyen platform.",
|
||||
"x-groupName" : "Fund management",
|
||||
"x-sortIndex" : 7,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DirectDebitInitiatedNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/PAYMENT_FAILURE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon an account payment failure.",
|
||||
@@ -339,6 +426,35 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/REFUND_FUNDS_TRANSFER" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon the transfer refund of funds between accounts.",
|
||||
"description" : "This notification is sent when the refund of funds from an account have been transferred to another account.",
|
||||
"x-groupName" : "Fund management",
|
||||
"x-sortIndex" : 6,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/RefundFundsTransferNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/REPORT_AVAILABLE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered when a report is made available.",
|
||||
@@ -592,7 +708,8 @@
|
||||
},
|
||||
"required" : [
|
||||
"fullPhoneNumber",
|
||||
"email"
|
||||
"email",
|
||||
"webAddress"
|
||||
]
|
||||
},
|
||||
"AccountHolderPayoutNotification" : {
|
||||
@@ -637,11 +754,11 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"amount" : {
|
||||
"description" : "payout amount",
|
||||
"description" : "The payout amount.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"amounts" : {
|
||||
"description" : "payout amounts (per currency)",
|
||||
"description" : "The payout amounts (per currency).",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
@@ -656,18 +773,17 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"merchantReference" : {
|
||||
"description" : "merchant reference",
|
||||
"description" : "The merchant reference.",
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "payout status",
|
||||
"description" : "The payout status.",
|
||||
"$ref" : "#/components/schemas/OperationStatus"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"accountHolderCode",
|
||||
"accountCode",
|
||||
"bankAccountDetail"
|
||||
"accountCode"
|
||||
]
|
||||
},
|
||||
"AccountHolderStatus" : {
|
||||
@@ -766,6 +882,108 @@
|
||||
"reason"
|
||||
]
|
||||
},
|
||||
"AccountHolderStoreStatusChangeNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "The details of the Account Holder Store status change.",
|
||||
"$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotificationContent"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live"
|
||||
]
|
||||
},
|
||||
"AccountHolderStoreStatusChangeNotificationContent" : {
|
||||
|
||||
},
|
||||
"AccountHolderUpcomingDeadlineNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "The details of the upcoming event.",
|
||||
"$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live"
|
||||
]
|
||||
},
|
||||
"AccountHolderUpcomingDeadlineNotificationContent" : {
|
||||
"properties" : {
|
||||
"accountHolderCode" : {
|
||||
"description" : "The code of the account holder whom the event refers to.",
|
||||
"type" : "string"
|
||||
},
|
||||
"event" : {
|
||||
"description" : "The event name that will be trigger if no action is taken.",
|
||||
"enum" : [
|
||||
"AccessPii",
|
||||
"CloseAccount",
|
||||
"CloseStores",
|
||||
"DeleteBankAccounts",
|
||||
"DeletePayoutInstrumentTokens",
|
||||
"DeletePayoutMethods",
|
||||
"DeleteShareholders",
|
||||
"InactivateAccount",
|
||||
"RecalculateAccountStatusAndProcessingTier",
|
||||
"RefundNotPaidOutTransfers",
|
||||
"ResolveEvents",
|
||||
"SaveAccountHolder",
|
||||
"SaveKYCCheckStatus",
|
||||
"SuspendAccount",
|
||||
"UnSuspendAccount",
|
||||
"UpdateAccountHolderState",
|
||||
"Verification"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"executionDate" : {
|
||||
"description" : "The execution date scheduled for the event.",
|
||||
"$ref" : "#/components/schemas/LocalDate"
|
||||
},
|
||||
"reason" : {
|
||||
"description" : "The reason that leads to scheduling of the event.",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AccountHolderUpdateNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
@@ -1388,6 +1606,65 @@
|
||||
"status"
|
||||
]
|
||||
},
|
||||
"DirectDebitInitiatedNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "Details of the direct debit.",
|
||||
"$ref" : "#/components/schemas/DirectDebitInitiatedNotificationContent"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live"
|
||||
]
|
||||
},
|
||||
"DirectDebitInitiatedNotificationContent" : {
|
||||
"properties" : {
|
||||
"accountCode" : {
|
||||
"description" : "The code of the account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"amount" : {
|
||||
"description" : "The amount to be debited from the funding account.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"debitInitiationDate" : {
|
||||
"description" : "The date of the debit initiation.",
|
||||
"$ref" : "#/components/schemas/LocalDate"
|
||||
},
|
||||
"merchantAccountCode" : {
|
||||
"description" : "The code of the merchant account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "Direct debit status.",
|
||||
"$ref" : "#/components/schemas/OperationStatus"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"amount",
|
||||
"accountCode",
|
||||
"merchantAccountCode"
|
||||
]
|
||||
},
|
||||
"ErrorFieldType" : {
|
||||
"properties" : {
|
||||
"errorCode" : {
|
||||
@@ -1425,6 +1702,7 @@
|
||||
"bankAccount",
|
||||
"bankAccountCode",
|
||||
"bankAccountName",
|
||||
"bankAccountUUID",
|
||||
"bankBicSwift",
|
||||
"bankCity",
|
||||
"bankCode",
|
||||
@@ -1435,6 +1713,7 @@
|
||||
"cardToken",
|
||||
"checkCode",
|
||||
"city",
|
||||
"companyRegistration",
|
||||
"country",
|
||||
"countryCode",
|
||||
"currency",
|
||||
@@ -1457,6 +1736,7 @@
|
||||
"firstName",
|
||||
"fullPhoneNumber",
|
||||
"gender",
|
||||
"hopWebserviceUser",
|
||||
"houseNumberOrName",
|
||||
"iban",
|
||||
"idCard",
|
||||
@@ -1469,12 +1749,13 @@
|
||||
"legalBusinessName",
|
||||
"legalEntity",
|
||||
"legalEntityType",
|
||||
"merchantAccount",
|
||||
"merchantCategoryCode",
|
||||
"merchantCode",
|
||||
"merchantReference",
|
||||
"microDeposit",
|
||||
"name",
|
||||
"nationality",
|
||||
"originalReference",
|
||||
"ownerCity",
|
||||
"ownerCountryCode",
|
||||
"ownerHouseNumberOrName",
|
||||
@@ -1484,6 +1765,7 @@
|
||||
"ownerStreet",
|
||||
"passport",
|
||||
"passportNumber",
|
||||
"payoutMethodCode",
|
||||
"personalData",
|
||||
"phoneCountryCode",
|
||||
"phoneNumber",
|
||||
@@ -1491,6 +1773,7 @@
|
||||
"primaryCurrency",
|
||||
"reason",
|
||||
"registrationNumber",
|
||||
"returnUrl",
|
||||
"schedule",
|
||||
"shareholder",
|
||||
"shareholderCode",
|
||||
@@ -1498,11 +1781,13 @@
|
||||
"sourceAccountCode",
|
||||
"stateOrProvince",
|
||||
"status",
|
||||
"storeCode",
|
||||
"store",
|
||||
"storeDetail",
|
||||
"storeName",
|
||||
"storeReference",
|
||||
"street",
|
||||
"taxId",
|
||||
"tier",
|
||||
"tierNumber",
|
||||
"transferCode",
|
||||
"unknown",
|
||||
@@ -1587,7 +1872,7 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The status of the check.\n>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"description" : "The status of the check.\n>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"enum" : [
|
||||
"AWAITING_DATA",
|
||||
"DATA_PROVIDED",
|
||||
@@ -1686,6 +1971,18 @@
|
||||
"bankAccounts"
|
||||
]
|
||||
},
|
||||
"LocalDate" : {
|
||||
"properties" : {
|
||||
"month" : {
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
},
|
||||
"year" : {
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Message" : {
|
||||
"properties" : {
|
||||
"code" : {
|
||||
@@ -1785,6 +2082,9 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
"HOLD",
|
||||
@@ -1838,6 +2138,61 @@
|
||||
"number"
|
||||
]
|
||||
},
|
||||
"RefundFundsTransferNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "Details of the fund transfer refund.",
|
||||
"$ref" : "#/components/schemas/RefundFundsTransferNotificationContent"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live",
|
||||
"content"
|
||||
]
|
||||
},
|
||||
"RefundFundsTransferNotificationContent" : {
|
||||
"properties" : {
|
||||
"amount" : {
|
||||
"description" : "The amount to be refunded.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"merchantReference" : {
|
||||
"description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.",
|
||||
"type" : "string"
|
||||
},
|
||||
"originalReference" : {
|
||||
"description" : "A PSP reference of the original fund transfer.",
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The status of the fund transfer refund.",
|
||||
"$ref" : "#/components/schemas/OperationStatus"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"originalReference",
|
||||
"amount"
|
||||
]
|
||||
},
|
||||
"RefundResult" : {
|
||||
"properties" : {
|
||||
"originalTransaction" : {
|
||||
@@ -2001,7 +2356,7 @@
|
||||
"$ref" : "#/components/schemas/ViasPhoneNumber"
|
||||
},
|
||||
"shareholderCode" : {
|
||||
"description" : "The unique identifier (UUID) of the Shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Bank Account will be updated.**\n",
|
||||
"description" : "The unique identifier (UUID) of the Shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n",
|
||||
"type" : "string"
|
||||
},
|
||||
"webAddress" : {
|
||||
@@ -2073,17 +2428,23 @@
|
||||
"description" : "The status of the transaction.\n>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.",
|
||||
"enum" : [
|
||||
"Chargeback",
|
||||
"ChargebackCorrection",
|
||||
"ChargebackCorrectionReceived",
|
||||
"ChargebackReceived",
|
||||
"ChargebackReversed",
|
||||
"ChargebackReversedReceived",
|
||||
"Converted",
|
||||
"CreditFailed",
|
||||
"CreditReversed",
|
||||
"CreditReversedReceived",
|
||||
"Credited",
|
||||
"DebitFailed",
|
||||
"DebitReversedReceived",
|
||||
"Debited",
|
||||
"DebitedReversed",
|
||||
"Fee",
|
||||
"FundTransfer",
|
||||
"FundTransferReversed",
|
||||
"ManualCorrected",
|
||||
"Payout",
|
||||
"PayoutReversed",
|
||||
@@ -2255,7 +2616,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"country" : {
|
||||
"description" : "The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n> If you don't know the country or are not collecting the country from the shopper, provide `countryCode` as `ZZ`.",
|
||||
"description" : "The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
|
||||
"type" : "string"
|
||||
},
|
||||
"houseNumberOrName" : {
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
"openapi" : "3.0.0",
|
||||
"info" : {
|
||||
"version" : "4",
|
||||
"title" : "Adyen Notification API",
|
||||
"description" : "The Notification Service sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).",
|
||||
"title" : "Adyen MarketPay Notifications",
|
||||
"description" : "The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Support",
|
||||
@@ -165,6 +165,64 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ACCOUNT_HOLDER_STORE_STATUS_CHANGE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon the status change of a store tied to an account holder.",
|
||||
"description" : "This notification is sent when the status of a store tied to an account holder has been changed.",
|
||||
"x-groupName" : "Account holders",
|
||||
"x-sortIndex" : 4,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ACCOUNT_HOLDER_UPCOMING_DEADLINE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon an upcoming deadline.",
|
||||
"description" : "This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.",
|
||||
"x-groupName" : "Account holders",
|
||||
"x-sortIndex" : 1,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ACCOUNT_HOLDER_UPDATED" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon the update of an account holder.",
|
||||
@@ -310,6 +368,35 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/DIRECT_DEBIT_INITIATED" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered when an automated direct debit is initiated.",
|
||||
"description" : "This notification is sent when an automated direct debit is initiated from the Adyen platform.",
|
||||
"x-groupName" : "Fund management",
|
||||
"x-sortIndex" : 7,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DirectDebitInitiatedNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/PAYMENT_FAILURE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon an account payment failure.",
|
||||
@@ -339,6 +426,35 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/REFUND_FUNDS_TRANSFER" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon the transfer refund of funds between accounts.",
|
||||
"description" : "This notification is sent when the refund of funds from an account have been transferred to another account.",
|
||||
"x-groupName" : "Fund management",
|
||||
"x-sortIndex" : 6,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/RefundFundsTransferNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/REPORT_AVAILABLE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered when a report is made available.",
|
||||
@@ -610,7 +726,8 @@
|
||||
},
|
||||
"required" : [
|
||||
"fullPhoneNumber",
|
||||
"email"
|
||||
"email",
|
||||
"webAddress"
|
||||
]
|
||||
},
|
||||
"AccountHolderPayoutNotification" : {
|
||||
@@ -661,11 +778,11 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"amount" : {
|
||||
"description" : "payout amount",
|
||||
"description" : "The payout amount.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"amounts" : {
|
||||
"description" : "payout amounts (per currency)",
|
||||
"description" : "The payout amounts (per currency).",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
@@ -680,18 +797,17 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"merchantReference" : {
|
||||
"description" : "merchant reference",
|
||||
"description" : "The merchant reference.",
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "payout status",
|
||||
"description" : "The payout status.",
|
||||
"$ref" : "#/components/schemas/OperationStatus"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"accountHolderCode",
|
||||
"accountCode",
|
||||
"bankAccountDetail"
|
||||
"accountCode"
|
||||
]
|
||||
},
|
||||
"AccountHolderStatus" : {
|
||||
@@ -796,6 +912,120 @@
|
||||
"reason"
|
||||
]
|
||||
},
|
||||
"AccountHolderStoreStatusChangeNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "The details of the Account Holder Store status change.",
|
||||
"$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotificationContent"
|
||||
},
|
||||
"eventDate" : {
|
||||
"description" : "The date and time when an event has been completed.",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live",
|
||||
"eventDate"
|
||||
]
|
||||
},
|
||||
"AccountHolderStoreStatusChangeNotificationContent" : {
|
||||
|
||||
},
|
||||
"AccountHolderUpcomingDeadlineNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "The details of the upcoming event.",
|
||||
"$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent"
|
||||
},
|
||||
"eventDate" : {
|
||||
"description" : "The date and time when an event has been completed.",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live",
|
||||
"eventDate"
|
||||
]
|
||||
},
|
||||
"AccountHolderUpcomingDeadlineNotificationContent" : {
|
||||
"properties" : {
|
||||
"accountHolderCode" : {
|
||||
"description" : "The code of the account holder whom the event refers to.",
|
||||
"type" : "string"
|
||||
},
|
||||
"event" : {
|
||||
"description" : "The event name that will be trigger if no action is taken.",
|
||||
"enum" : [
|
||||
"AccessPii",
|
||||
"CloseAccount",
|
||||
"CloseStores",
|
||||
"DeleteBankAccounts",
|
||||
"DeletePayoutInstrumentTokens",
|
||||
"DeletePayoutMethods",
|
||||
"DeleteShareholders",
|
||||
"InactivateAccount",
|
||||
"RecalculateAccountStatusAndProcessingTier",
|
||||
"RefundNotPaidOutTransfers",
|
||||
"ResolveEvents",
|
||||
"SaveAccountHolder",
|
||||
"SaveKYCCheckStatus",
|
||||
"SuspendAccount",
|
||||
"UnSuspendAccount",
|
||||
"UpdateAccountHolderState",
|
||||
"Verification"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"executionDate" : {
|
||||
"description" : "The execution date scheduled for the event.",
|
||||
"$ref" : "#/components/schemas/LocalDate"
|
||||
},
|
||||
"reason" : {
|
||||
"description" : "The reason that leads to scheduling of the event.",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AccountHolderUpdateNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
@@ -1387,6 +1617,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1467,6 +1698,71 @@
|
||||
"status"
|
||||
]
|
||||
},
|
||||
"DirectDebitInitiatedNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "Details of the direct debit.",
|
||||
"$ref" : "#/components/schemas/DirectDebitInitiatedNotificationContent"
|
||||
},
|
||||
"eventDate" : {
|
||||
"description" : "The date and time when an event has been completed.",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live",
|
||||
"eventDate"
|
||||
]
|
||||
},
|
||||
"DirectDebitInitiatedNotificationContent" : {
|
||||
"properties" : {
|
||||
"accountCode" : {
|
||||
"description" : "The code of the account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"amount" : {
|
||||
"description" : "The amount to be debited from the funding account.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"debitInitiationDate" : {
|
||||
"description" : "The date of the debit initiation.",
|
||||
"$ref" : "#/components/schemas/LocalDate"
|
||||
},
|
||||
"merchantAccountCode" : {
|
||||
"description" : "The code of the merchant account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "Direct debit status.",
|
||||
"$ref" : "#/components/schemas/OperationStatus"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"amount",
|
||||
"accountCode",
|
||||
"merchantAccountCode"
|
||||
]
|
||||
},
|
||||
"ErrorFieldType" : {
|
||||
"properties" : {
|
||||
"errorCode" : {
|
||||
@@ -1504,6 +1800,7 @@
|
||||
"bankAccount",
|
||||
"bankAccountCode",
|
||||
"bankAccountName",
|
||||
"bankAccountUUID",
|
||||
"bankBicSwift",
|
||||
"bankCity",
|
||||
"bankCode",
|
||||
@@ -1514,6 +1811,7 @@
|
||||
"cardToken",
|
||||
"checkCode",
|
||||
"city",
|
||||
"companyRegistration",
|
||||
"country",
|
||||
"countryCode",
|
||||
"currency",
|
||||
@@ -1536,6 +1834,7 @@
|
||||
"firstName",
|
||||
"fullPhoneNumber",
|
||||
"gender",
|
||||
"hopWebserviceUser",
|
||||
"houseNumberOrName",
|
||||
"iban",
|
||||
"idCard",
|
||||
@@ -1548,12 +1847,13 @@
|
||||
"legalBusinessName",
|
||||
"legalEntity",
|
||||
"legalEntityType",
|
||||
"merchantAccount",
|
||||
"merchantCategoryCode",
|
||||
"merchantCode",
|
||||
"merchantReference",
|
||||
"microDeposit",
|
||||
"name",
|
||||
"nationality",
|
||||
"originalReference",
|
||||
"ownerCity",
|
||||
"ownerCountryCode",
|
||||
"ownerHouseNumberOrName",
|
||||
@@ -1563,6 +1863,7 @@
|
||||
"ownerStreet",
|
||||
"passport",
|
||||
"passportNumber",
|
||||
"payoutMethodCode",
|
||||
"personalData",
|
||||
"phoneCountryCode",
|
||||
"phoneNumber",
|
||||
@@ -1570,17 +1871,21 @@
|
||||
"primaryCurrency",
|
||||
"reason",
|
||||
"registrationNumber",
|
||||
"returnUrl",
|
||||
"schedule",
|
||||
"shareholder",
|
||||
"shareholderCode",
|
||||
"socialSecurityNumber",
|
||||
"sourceAccountCode",
|
||||
"stateOrProvince",
|
||||
"storeCode",
|
||||
"status",
|
||||
"store",
|
||||
"storeDetail",
|
||||
"storeName",
|
||||
"storeReference",
|
||||
"street",
|
||||
"taxId",
|
||||
"tier",
|
||||
"tierNumber",
|
||||
"transferCode",
|
||||
"unknown",
|
||||
@@ -1652,7 +1957,7 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The status of the check.\n>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"description" : "The status of the check.\n>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"enum" : [
|
||||
"AWAITING_DATA",
|
||||
"DATA_PROVIDED",
|
||||
@@ -1751,6 +2056,18 @@
|
||||
"bankAccounts"
|
||||
]
|
||||
},
|
||||
"LocalDate" : {
|
||||
"properties" : {
|
||||
"month" : {
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
},
|
||||
"year" : {
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Message" : {
|
||||
"properties" : {
|
||||
"code" : {
|
||||
@@ -1856,6 +2173,9 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
"HOLD",
|
||||
@@ -1909,6 +2229,67 @@
|
||||
"number"
|
||||
]
|
||||
},
|
||||
"RefundFundsTransferNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "Details of the fund transfer refund.",
|
||||
"$ref" : "#/components/schemas/RefundFundsTransferNotificationContent"
|
||||
},
|
||||
"eventDate" : {
|
||||
"description" : "The date and time when an event has been completed.",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live",
|
||||
"eventDate",
|
||||
"content"
|
||||
]
|
||||
},
|
||||
"RefundFundsTransferNotificationContent" : {
|
||||
"properties" : {
|
||||
"amount" : {
|
||||
"description" : "The amount to be refunded.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"merchantReference" : {
|
||||
"description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.",
|
||||
"type" : "string"
|
||||
},
|
||||
"originalReference" : {
|
||||
"description" : "A PSP reference of the original fund transfer.",
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The status of the fund transfer refund.",
|
||||
"$ref" : "#/components/schemas/OperationStatus"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"originalReference",
|
||||
"amount"
|
||||
]
|
||||
},
|
||||
"RefundResult" : {
|
||||
"properties" : {
|
||||
"originalTransaction" : {
|
||||
@@ -2084,7 +2465,7 @@
|
||||
"$ref" : "#/components/schemas/ViasPhoneNumber"
|
||||
},
|
||||
"shareholderCode" : {
|
||||
"description" : "The unique identifier (UUID) of the Shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Bank Account will be updated.**\n",
|
||||
"description" : "The unique identifier (UUID) of the Shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n",
|
||||
"type" : "string"
|
||||
},
|
||||
"webAddress" : {
|
||||
@@ -2156,17 +2537,23 @@
|
||||
"description" : "The status of the transaction.\n>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.",
|
||||
"enum" : [
|
||||
"Chargeback",
|
||||
"ChargebackCorrection",
|
||||
"ChargebackCorrectionReceived",
|
||||
"ChargebackReceived",
|
||||
"ChargebackReversed",
|
||||
"ChargebackReversedReceived",
|
||||
"Converted",
|
||||
"CreditFailed",
|
||||
"CreditReversed",
|
||||
"CreditReversedReceived",
|
||||
"Credited",
|
||||
"DebitFailed",
|
||||
"DebitReversedReceived",
|
||||
"Debited",
|
||||
"DebitedReversed",
|
||||
"Fee",
|
||||
"FundTransfer",
|
||||
"FundTransferReversed",
|
||||
"ManualCorrected",
|
||||
"Payout",
|
||||
"PayoutReversed",
|
||||
@@ -2286,6 +2673,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -2363,7 +2751,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"country" : {
|
||||
"description" : "The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n> If you don't know the country or are not collecting the country from the shopper, provide `countryCode` as `ZZ`.",
|
||||
"description" : "The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
|
||||
"type" : "string"
|
||||
},
|
||||
"houseNumberOrName" : {
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
"openapi" : "3.0.0",
|
||||
"info" : {
|
||||
"version" : "5",
|
||||
"title" : "Adyen Notification API",
|
||||
"description" : "The Notification Service sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).",
|
||||
"title" : "Adyen MarketPay Notifications",
|
||||
"description" : "The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Support",
|
||||
@@ -165,6 +165,64 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ACCOUNT_HOLDER_STORE_STATUS_CHANGE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon the status change of a store tied to an account holder.",
|
||||
"description" : "This notification is sent when the status of a store tied to an account holder has been changed.",
|
||||
"x-groupName" : "Account holders",
|
||||
"x-sortIndex" : 4,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ACCOUNT_HOLDER_UPCOMING_DEADLINE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon an upcoming deadline.",
|
||||
"description" : "This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.",
|
||||
"x-groupName" : "Account holders",
|
||||
"x-sortIndex" : 1,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ACCOUNT_HOLDER_UPDATED" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon the update of an account holder.",
|
||||
@@ -310,6 +368,35 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/DIRECT_DEBIT_INITIATED" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered when an automated direct debit is initiated.",
|
||||
"description" : "This notification is sent when an automated direct debit is initiated from the Adyen platform.",
|
||||
"x-groupName" : "Fund management",
|
||||
"x-sortIndex" : 7,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DirectDebitInitiatedNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/PAYMENT_FAILURE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon an account payment failure.",
|
||||
@@ -339,6 +426,35 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/REFUND_FUNDS_TRANSFER" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered upon the transfer refund of funds between accounts.",
|
||||
"description" : "This notification is sent when the refund of funds from an account have been transferred to another account.",
|
||||
"x-groupName" : "Fund management",
|
||||
"x-sortIndex" : 6,
|
||||
"requestBody" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/RefundFundsTransferNotification"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses" : {
|
||||
"200" : {
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/NotificationResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description" : "OK - the request has succeeded."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/REPORT_AVAILABLE" : {
|
||||
"post" : {
|
||||
"summary" : "Triggered when a report is made available.",
|
||||
@@ -629,7 +745,8 @@
|
||||
},
|
||||
"required" : [
|
||||
"fullPhoneNumber",
|
||||
"email"
|
||||
"email",
|
||||
"webAddress"
|
||||
]
|
||||
},
|
||||
"AccountHolderPayoutNotification" : {
|
||||
@@ -684,11 +801,11 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"amount" : {
|
||||
"description" : "payout amount",
|
||||
"description" : "The payout amount.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"amounts" : {
|
||||
"description" : "payout amounts (per currency)",
|
||||
"description" : "The payout amounts (per currency).",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
@@ -702,6 +819,10 @@
|
||||
"description" : "A description of the payout.",
|
||||
"type" : "string"
|
||||
},
|
||||
"estimatedArrivalDate" : {
|
||||
"description" : "The estimated date of arrival.",
|
||||
"$ref" : "#/components/schemas/LocalDate"
|
||||
},
|
||||
"invalidFields" : {
|
||||
"description" : "Invalid fields list.",
|
||||
"items" : {
|
||||
@@ -710,18 +831,21 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"merchantReference" : {
|
||||
"description" : "merchant reference",
|
||||
"description" : "The merchant reference.",
|
||||
"type" : "string"
|
||||
},
|
||||
"originalPspReference" : {
|
||||
"description" : "The PSP reference of the original payout.",
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "payout status",
|
||||
"description" : "The payout status.",
|
||||
"$ref" : "#/components/schemas/OperationStatus"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"accountHolderCode",
|
||||
"accountCode",
|
||||
"bankAccountDetail"
|
||||
"accountCode"
|
||||
]
|
||||
},
|
||||
"AccountHolderStatus" : {
|
||||
@@ -837,6 +961,182 @@
|
||||
"reason"
|
||||
]
|
||||
},
|
||||
"AccountHolderStoreStatusChangeNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "The details of the Account Holder Store status change.",
|
||||
"$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotificationContent"
|
||||
},
|
||||
"error" : {
|
||||
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
|
||||
"$ref" : "#/components/schemas/NotificationErrorContainer"
|
||||
},
|
||||
"eventDate" : {
|
||||
"description" : "The date and time when an event has been completed.",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live",
|
||||
"eventDate"
|
||||
]
|
||||
},
|
||||
"AccountHolderStoreStatusChangeNotificationContent" : {
|
||||
"properties" : {
|
||||
"accountHolderCode" : {
|
||||
"description" : "The code of the account holder.",
|
||||
"type" : "string"
|
||||
},
|
||||
"invalidFields" : {
|
||||
"description" : "In case the store status has not been updated, contains fields that did not pass the validation.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/ErrorFieldType"
|
||||
},
|
||||
"type" : "array"
|
||||
},
|
||||
"newStatus" : {
|
||||
"description" : "The new status of the account holder.",
|
||||
"enum" : [
|
||||
"Active",
|
||||
"Closed",
|
||||
"Inactive",
|
||||
"InactiveWithModifications",
|
||||
"Pending"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"oldStatus" : {
|
||||
"description" : "The former status of the account holder.",
|
||||
"enum" : [
|
||||
"Active",
|
||||
"Closed",
|
||||
"Inactive",
|
||||
"InactiveWithModifications",
|
||||
"Pending"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"reason" : {
|
||||
"description" : "The reason for the status change.",
|
||||
"type" : "string"
|
||||
},
|
||||
"store" : {
|
||||
"description" : "Alphanumeric identifier of the store.",
|
||||
"type" : "string"
|
||||
},
|
||||
"storeReference" : {
|
||||
"description" : "Store store reference.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"accountHolderCode",
|
||||
"store",
|
||||
"storeReference",
|
||||
"oldStatus",
|
||||
"newStatus",
|
||||
"reason"
|
||||
]
|
||||
},
|
||||
"AccountHolderUpcomingDeadlineNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "The details of the upcoming event.",
|
||||
"$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent"
|
||||
},
|
||||
"error" : {
|
||||
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
|
||||
"$ref" : "#/components/schemas/NotificationErrorContainer"
|
||||
},
|
||||
"eventDate" : {
|
||||
"description" : "The date and time when an event has been completed.",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live",
|
||||
"eventDate"
|
||||
]
|
||||
},
|
||||
"AccountHolderUpcomingDeadlineNotificationContent" : {
|
||||
"properties" : {
|
||||
"accountHolderCode" : {
|
||||
"description" : "The code of the account holder whom the event refers to.",
|
||||
"type" : "string"
|
||||
},
|
||||
"event" : {
|
||||
"description" : "The event name that will be trigger if no action is taken.",
|
||||
"enum" : [
|
||||
"AccessPii",
|
||||
"CloseAccount",
|
||||
"CloseStores",
|
||||
"DeleteBankAccounts",
|
||||
"DeletePayoutInstrumentTokens",
|
||||
"DeletePayoutMethods",
|
||||
"DeleteShareholders",
|
||||
"InactivateAccount",
|
||||
"RecalculateAccountStatusAndProcessingTier",
|
||||
"RefundNotPaidOutTransfers",
|
||||
"ResolveEvents",
|
||||
"SaveAccountHolder",
|
||||
"SaveKYCCheckStatus",
|
||||
"SuspendAccount",
|
||||
"UnSuspendAccount",
|
||||
"UpdateAccountHolderState",
|
||||
"Verification"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"executionDate" : {
|
||||
"description" : "The execution date scheduled for the event.",
|
||||
"$ref" : "#/components/schemas/LocalDate"
|
||||
},
|
||||
"reason" : {
|
||||
"description" : "The reason that leads to scheduling of the event.",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AccountHolderUpdateNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
@@ -1292,6 +1592,10 @@
|
||||
},
|
||||
"CloseAccountResponse" : {
|
||||
"properties" : {
|
||||
"accountCode" : {
|
||||
"description" : "The account code of the account that is closed.",
|
||||
"type" : "string"
|
||||
},
|
||||
"invalidFields" : {
|
||||
"description" : "Contains field validation errors that would prevent requests from being processed.",
|
||||
"items" : {
|
||||
@@ -1434,6 +1738,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -1521,6 +1826,75 @@
|
||||
"status"
|
||||
]
|
||||
},
|
||||
"DirectDebitInitiatedNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "Details of the direct debit.",
|
||||
"$ref" : "#/components/schemas/DirectDebitInitiatedNotificationContent"
|
||||
},
|
||||
"error" : {
|
||||
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
|
||||
"$ref" : "#/components/schemas/NotificationErrorContainer"
|
||||
},
|
||||
"eventDate" : {
|
||||
"description" : "The date and time when an event has been completed.",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live",
|
||||
"eventDate"
|
||||
]
|
||||
},
|
||||
"DirectDebitInitiatedNotificationContent" : {
|
||||
"properties" : {
|
||||
"accountCode" : {
|
||||
"description" : "The code of the account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"amount" : {
|
||||
"description" : "The amount to be debited from the funding account.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"debitInitiationDate" : {
|
||||
"description" : "The date of the debit initiation.",
|
||||
"$ref" : "#/components/schemas/LocalDate"
|
||||
},
|
||||
"merchantAccountCode" : {
|
||||
"description" : "The code of the merchant account.",
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "Direct debit status.",
|
||||
"$ref" : "#/components/schemas/OperationStatus"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"amount",
|
||||
"accountCode",
|
||||
"merchantAccountCode"
|
||||
]
|
||||
},
|
||||
"ErrorFieldType" : {
|
||||
"properties" : {
|
||||
"errorCode" : {
|
||||
@@ -1558,6 +1932,7 @@
|
||||
"bankAccount",
|
||||
"bankAccountCode",
|
||||
"bankAccountName",
|
||||
"bankAccountUUID",
|
||||
"bankBicSwift",
|
||||
"bankCity",
|
||||
"bankCode",
|
||||
@@ -1568,6 +1943,7 @@
|
||||
"cardToken",
|
||||
"checkCode",
|
||||
"city",
|
||||
"companyRegistration",
|
||||
"country",
|
||||
"countryCode",
|
||||
"currency",
|
||||
@@ -1590,6 +1966,7 @@
|
||||
"firstName",
|
||||
"fullPhoneNumber",
|
||||
"gender",
|
||||
"hopWebserviceUser",
|
||||
"houseNumberOrName",
|
||||
"iban",
|
||||
"idCard",
|
||||
@@ -1602,12 +1979,13 @@
|
||||
"legalBusinessName",
|
||||
"legalEntity",
|
||||
"legalEntityType",
|
||||
"merchantAccountCode",
|
||||
"merchantAccount",
|
||||
"merchantCategoryCode",
|
||||
"merchantReference",
|
||||
"microDeposit",
|
||||
"name",
|
||||
"nationality",
|
||||
"originalReference",
|
||||
"ownerCity",
|
||||
"ownerCountryCode",
|
||||
"ownerHouseNumberOrName",
|
||||
@@ -1617,6 +1995,7 @@
|
||||
"ownerStreet",
|
||||
"passport",
|
||||
"passportNumber",
|
||||
"payoutMethodCode",
|
||||
"personalData",
|
||||
"phoneCountryCode",
|
||||
"phoneNumber",
|
||||
@@ -1624,6 +2003,7 @@
|
||||
"primaryCurrency",
|
||||
"reason",
|
||||
"registrationNumber",
|
||||
"returnUrl",
|
||||
"schedule",
|
||||
"shareholder",
|
||||
"shareholderCode",
|
||||
@@ -1631,8 +2011,9 @@
|
||||
"sourceAccountCode",
|
||||
"stateOrProvince",
|
||||
"status",
|
||||
"storeCode",
|
||||
"store",
|
||||
"storeDetail",
|
||||
"storeName",
|
||||
"storeReference",
|
||||
"street",
|
||||
"taxId",
|
||||
@@ -1708,7 +2089,7 @@
|
||||
"type" : "array"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The status of the check.\n>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"description" : "The status of the check.\n>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.",
|
||||
"enum" : [
|
||||
"AWAITING_DATA",
|
||||
"DATA_PROVIDED",
|
||||
@@ -1804,6 +2185,18 @@
|
||||
"bankAccounts"
|
||||
]
|
||||
},
|
||||
"LocalDate" : {
|
||||
"properties" : {
|
||||
"month" : {
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
},
|
||||
"year" : {
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Message" : {
|
||||
"properties" : {
|
||||
"code" : {
|
||||
@@ -1952,6 +2345,9 @@
|
||||
"BIWEEKLY_ON_1ST_AND_15TH_AT_NOON",
|
||||
"DAILY",
|
||||
"DAILY_6PM",
|
||||
"DAILY_AU",
|
||||
"DAILY_EU",
|
||||
"DAILY_US",
|
||||
"DEFAULT",
|
||||
"EVERY_6_HOURS_FROM_MIDNIGHT",
|
||||
"HOLD",
|
||||
@@ -2005,6 +2401,78 @@
|
||||
"number"
|
||||
]
|
||||
},
|
||||
"RefundFundsTransferNotification" : {
|
||||
"properties" : {
|
||||
"content" : {
|
||||
"description" : "Details of the fund transfer refund.",
|
||||
"$ref" : "#/components/schemas/RefundFundsTransferNotificationContent"
|
||||
},
|
||||
"error" : {
|
||||
"description" : "Error information of failed request. No value provided here if no error occurred on processing.",
|
||||
"$ref" : "#/components/schemas/NotificationErrorContainer"
|
||||
},
|
||||
"eventDate" : {
|
||||
"description" : "The date and time when an event has been completed.",
|
||||
"format" : "date-time",
|
||||
"type" : "string"
|
||||
},
|
||||
"eventType" : {
|
||||
"description" : "The event type of the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"executingUserKey" : {
|
||||
"description" : "The user or process that has triggered the notification.",
|
||||
"type" : "string"
|
||||
},
|
||||
"live" : {
|
||||
"description" : "Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"pspReference" : {
|
||||
"description" : "The PSP reference of the request from which the notification originates.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"executingUserKey",
|
||||
"pspReference",
|
||||
"eventType",
|
||||
"live",
|
||||
"eventDate",
|
||||
"content"
|
||||
]
|
||||
},
|
||||
"RefundFundsTransferNotificationContent" : {
|
||||
"properties" : {
|
||||
"amount" : {
|
||||
"description" : "The amount to be refunded.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"invalidFields" : {
|
||||
"description" : "Invalid fields list.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/ErrorFieldType"
|
||||
},
|
||||
"type" : "array"
|
||||
},
|
||||
"merchantReference" : {
|
||||
"description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.",
|
||||
"type" : "string"
|
||||
},
|
||||
"originalReference" : {
|
||||
"description" : "A PSP reference of the original fund transfer.",
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The status of the fund transfer refund.",
|
||||
"$ref" : "#/components/schemas/OperationStatus"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"originalReference",
|
||||
"amount"
|
||||
]
|
||||
},
|
||||
"RefundResult" : {
|
||||
"properties" : {
|
||||
"originalTransaction" : {
|
||||
@@ -2195,10 +2663,11 @@
|
||||
"$ref" : "#/components/schemas/ViasPhoneNumber"
|
||||
},
|
||||
"shareholderCode" : {
|
||||
"description" : "The unique identifier (UUID) of the Shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Bank Account will be updated.**\n",
|
||||
"description" : "The unique identifier (UUID) of the Shareholder.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n",
|
||||
"type" : "string"
|
||||
},
|
||||
"shareholderReference" : {
|
||||
"description" : "Merchant reference to the Shareholder.",
|
||||
"type" : "string"
|
||||
},
|
||||
"webAddress" : {
|
||||
@@ -2270,17 +2739,23 @@
|
||||
"description" : "The status of the transaction.\n>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.",
|
||||
"enum" : [
|
||||
"Chargeback",
|
||||
"ChargebackCorrection",
|
||||
"ChargebackCorrectionReceived",
|
||||
"ChargebackReceived",
|
||||
"ChargebackReversed",
|
||||
"ChargebackReversedReceived",
|
||||
"Converted",
|
||||
"CreditFailed",
|
||||
"CreditReversed",
|
||||
"CreditReversedReceived",
|
||||
"Credited",
|
||||
"DebitFailed",
|
||||
"DebitReversedReceived",
|
||||
"Debited",
|
||||
"DebitedReversed",
|
||||
"Fee",
|
||||
"FundTransfer",
|
||||
"FundTransferReversed",
|
||||
"ManualCorrected",
|
||||
"Payout",
|
||||
"PayoutReversed",
|
||||
@@ -2411,6 +2886,7 @@
|
||||
"Business",
|
||||
"Individual",
|
||||
"NonProfit",
|
||||
"Partnership",
|
||||
"PublicCompany"
|
||||
],
|
||||
"type" : "string"
|
||||
@@ -2488,7 +2964,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"country" : {
|
||||
"description" : "The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n> If you don't know the country or are not collecting the country from the shopper, provide `countryCode` as `ZZ`.",
|
||||
"description" : "The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
|
||||
"type" : "string"
|
||||
},
|
||||
"houseNumberOrName" : {
|
||||
|
||||
@@ -284,6 +284,7 @@
|
||||
"cardToken",
|
||||
"checkCode",
|
||||
"city",
|
||||
"companyRegistration",
|
||||
"country",
|
||||
"countryCode",
|
||||
"currency",
|
||||
@@ -314,7 +315,6 @@
|
||||
"idCardFront",
|
||||
"idNumber",
|
||||
"identityDocument",
|
||||
"incorporatedAt",
|
||||
"individualDetails",
|
||||
"lastName",
|
||||
"legalBusinessName",
|
||||
@@ -354,6 +354,7 @@
|
||||
"status",
|
||||
"store",
|
||||
"storeDetail",
|
||||
"storeName",
|
||||
"storeReference",
|
||||
"street",
|
||||
"taxId",
|
||||
|
||||
@@ -792,11 +792,6 @@ components:
|
||||
doingBusinessAs:
|
||||
description: The registered name of the company (if it differs from the legal name of the company).
|
||||
type: string
|
||||
incorporatedAt:
|
||||
description: |-
|
||||
The jurisdiction of incorporation of the company.
|
||||
>Two (2) characters for a business in the USA or Canada, or a maximum of three (3) characters for an address in all other countries, or 'FEDERAL'
|
||||
type: string
|
||||
legalBusinessName:
|
||||
description: The legal name of the company.
|
||||
type: string
|
||||
@@ -902,6 +897,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
processingTier:
|
||||
@@ -968,6 +964,8 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
@@ -984,8 +982,6 @@ components:
|
||||
type: string
|
||||
required:
|
||||
- accountHolderCode
|
||||
- payoutSchedule
|
||||
- payoutScheduleReason
|
||||
CreateAccountResponse:
|
||||
properties:
|
||||
accountCode:
|
||||
@@ -1088,7 +1084,6 @@ components:
|
||||
- ID_CARD
|
||||
- ID_CARD_BACK
|
||||
- ID_CARD_FRONT
|
||||
- NHIS
|
||||
- PASSPORT
|
||||
- SSN
|
||||
- SUPPORTING_DOCUMENTS
|
||||
@@ -1149,6 +1144,7 @@ components:
|
||||
- cardToken
|
||||
- checkCode
|
||||
- city
|
||||
- companyRegistration
|
||||
- country
|
||||
- countryCode
|
||||
- currency
|
||||
@@ -1179,7 +1175,6 @@ components:
|
||||
- idCardFront
|
||||
- idNumber
|
||||
- identityDocument
|
||||
- incorporatedAt
|
||||
- individualDetails
|
||||
- lastName
|
||||
- legalBusinessName
|
||||
@@ -1219,6 +1214,7 @@ components:
|
||||
- status
|
||||
- store
|
||||
- storeDetail
|
||||
- storeName
|
||||
- storeReference
|
||||
- street
|
||||
- taxId
|
||||
@@ -1286,6 +1282,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
pspReference:
|
||||
@@ -1416,7 +1413,7 @@ components:
|
||||
status:
|
||||
description: |-
|
||||
The status of the check.
|
||||
>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
enum:
|
||||
- AWAITING_DATA
|
||||
- DATA_PROVIDED
|
||||
@@ -1505,6 +1502,8 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
@@ -1802,6 +1801,8 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
|
||||
@@ -798,11 +798,6 @@ components:
|
||||
doingBusinessAs:
|
||||
description: The registered name of the company (if it differs from the legal name of the company).
|
||||
type: string
|
||||
incorporatedAt:
|
||||
description: |-
|
||||
The jurisdiction of incorporation of the company.
|
||||
>Two (2) characters for a business in the USA or Canada, or a maximum of three (3) characters for an address in all other countries, or 'FEDERAL'
|
||||
type: string
|
||||
legalBusinessName:
|
||||
description: The legal name of the company.
|
||||
type: string
|
||||
@@ -914,6 +909,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
primaryCurrency:
|
||||
@@ -955,6 +951,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
pspReference:
|
||||
@@ -998,6 +995,8 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
@@ -1014,9 +1013,6 @@ components:
|
||||
type: string
|
||||
required:
|
||||
- accountHolderCode
|
||||
- payoutSchedule
|
||||
- payoutScheduleReason
|
||||
- description
|
||||
CreateAccountResponse:
|
||||
properties:
|
||||
accountCode:
|
||||
@@ -1122,7 +1118,6 @@ components:
|
||||
- ID_CARD
|
||||
- ID_CARD_BACK
|
||||
- ID_CARD_FRONT
|
||||
- NHIS
|
||||
- PASSPORT
|
||||
- SSN
|
||||
- SUPPORTING_DOCUMENTS
|
||||
@@ -1183,6 +1178,7 @@ components:
|
||||
- cardToken
|
||||
- checkCode
|
||||
- city
|
||||
- companyRegistration
|
||||
- country
|
||||
- countryCode
|
||||
- currency
|
||||
@@ -1213,7 +1209,6 @@ components:
|
||||
- idCardFront
|
||||
- idNumber
|
||||
- identityDocument
|
||||
- incorporatedAt
|
||||
- individualDetails
|
||||
- lastName
|
||||
- legalBusinessName
|
||||
@@ -1253,6 +1248,7 @@ components:
|
||||
- status
|
||||
- store
|
||||
- storeDetail
|
||||
- storeName
|
||||
- storeReference
|
||||
- street
|
||||
- taxId
|
||||
@@ -1326,6 +1322,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
primaryCurrency:
|
||||
@@ -1459,7 +1456,7 @@ components:
|
||||
status:
|
||||
description: |-
|
||||
The status of the check.
|
||||
>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
enum:
|
||||
- AWAITING_DATA
|
||||
- DATA_PROVIDED
|
||||
@@ -1548,6 +1545,8 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
@@ -1740,6 +1739,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
pspReference:
|
||||
@@ -1869,6 +1869,8 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
|
||||
@@ -875,11 +875,6 @@ components:
|
||||
doingBusinessAs:
|
||||
description: The registered name of the company (if it differs from the legal name of the company).
|
||||
type: string
|
||||
incorporatedAt:
|
||||
description: |-
|
||||
The jurisdiction of incorporation of the company.
|
||||
>Two (2) characters for a business in the USA or Canada, or a maximum of three (3) characters for an address in all other countries, or 'FEDERAL'
|
||||
type: string
|
||||
legalBusinessName:
|
||||
description: The legal name of the company.
|
||||
type: string
|
||||
@@ -931,6 +926,9 @@ components:
|
||||
- accountCode
|
||||
CloseAccountResponse:
|
||||
properties:
|
||||
accountCode:
|
||||
description: The account code of the account that is closed.
|
||||
type: string
|
||||
invalidFields:
|
||||
description: Contains field validation errors that would prevent requests from being processed.
|
||||
items:
|
||||
@@ -985,6 +983,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
primaryCurrency:
|
||||
@@ -1026,6 +1025,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
primaryCurrency:
|
||||
@@ -1070,6 +1070,8 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
@@ -1086,9 +1088,6 @@ components:
|
||||
type: string
|
||||
required:
|
||||
- accountHolderCode
|
||||
- payoutSchedule
|
||||
- payoutScheduleReason
|
||||
- description
|
||||
CreateAccountResponse:
|
||||
properties:
|
||||
accountCode:
|
||||
@@ -1205,9 +1204,9 @@ components:
|
||||
- DRIVING_LICENCE
|
||||
- DRIVING_LICENCE_BACK
|
||||
- DRIVING_LICENCE_FRONT
|
||||
- ID_CARD
|
||||
- ID_CARD_BACK
|
||||
- ID_CARD_FRONT
|
||||
- NHIS
|
||||
- PASSPORT
|
||||
- SSN
|
||||
- SUPPORTING_DOCUMENTS
|
||||
@@ -1268,6 +1267,7 @@ components:
|
||||
- cardToken
|
||||
- checkCode
|
||||
- city
|
||||
- companyRegistration
|
||||
- country
|
||||
- countryCode
|
||||
- currency
|
||||
@@ -1298,7 +1298,6 @@ components:
|
||||
- idCardFront
|
||||
- idNumber
|
||||
- identityDocument
|
||||
- incorporatedAt
|
||||
- individualDetails
|
||||
- lastName
|
||||
- legalBusinessName
|
||||
@@ -1338,6 +1337,7 @@ components:
|
||||
- status
|
||||
- store
|
||||
- storeDetail
|
||||
- storeName
|
||||
- storeReference
|
||||
- street
|
||||
- taxId
|
||||
@@ -1413,6 +1413,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
primaryCurrency:
|
||||
@@ -1536,7 +1537,7 @@ components:
|
||||
status:
|
||||
description: |-
|
||||
The status of the check.
|
||||
>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
enum:
|
||||
- AWAITING_DATA
|
||||
- DATA_PROVIDED
|
||||
@@ -1641,6 +1642,8 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
@@ -1829,6 +1832,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
primaryCurrency:
|
||||
@@ -1869,6 +1873,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
primaryCurrency:
|
||||
@@ -1995,6 +2000,8 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
|
||||
@@ -121,9 +121,9 @@ paths:
|
||||
/refundFundsTransfer:
|
||||
post:
|
||||
summary: Make a refund of the existing transfer funds transfer.
|
||||
description: 'This endpoint is used to refund funds from one account to another account. Both accounts must be in the same marketplace, but can have different account holders. '
|
||||
description: 'This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. '
|
||||
x-groupName: General
|
||||
x-sortIndex: 4
|
||||
x-sortIndex: 5
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -151,7 +151,7 @@ paths:
|
||||
summary: Refund all transactions of an account since the most recent payout.
|
||||
description: 'This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a per-account basis (as opposed to a per-payment basis), so only the portion of the payment which was made to the specified account will be refunded. The commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment''s split details.'
|
||||
x-groupName: General
|
||||
x-sortIndex: 6
|
||||
x-sortIndex: 7
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -179,7 +179,7 @@ paths:
|
||||
summary: Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.
|
||||
description: 'This endpoint is used to define a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it.'
|
||||
x-groupName: General
|
||||
x-sortIndex: 5
|
||||
x-sortIndex: 6
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -315,11 +315,14 @@ components:
|
||||
- ChargebackReversedReceived
|
||||
- Converted
|
||||
- CreditFailed
|
||||
- CreditReversed
|
||||
- CreditReversedReceived
|
||||
- Credited
|
||||
- DebitFailed
|
||||
- DebitReversedReceived
|
||||
- Debited
|
||||
- DebitedReversed
|
||||
- Fee
|
||||
- FundTransfer
|
||||
- FundTransferReversed
|
||||
- ManualCorrected
|
||||
@@ -604,7 +607,6 @@ components:
|
||||
required:
|
||||
- pspReference
|
||||
- submittedAsync
|
||||
- bankAccountUUID
|
||||
RefundFundsTransferRequest:
|
||||
properties:
|
||||
amount:
|
||||
@@ -622,10 +624,12 @@ components:
|
||||
RefundFundsTransferResponse:
|
||||
properties:
|
||||
merchantReference:
|
||||
description: The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
originalReference:
|
||||
description: A PSP reference of the original fund transfer.
|
||||
type: string
|
||||
pspReference:
|
||||
description: The reference of a request. Can be used to uniquely identify the request.
|
||||
@@ -763,11 +767,14 @@ components:
|
||||
- ChargebackReversedReceived
|
||||
- Converted
|
||||
- CreditFailed
|
||||
- CreditReversed
|
||||
- CreditReversedReceived
|
||||
- Credited
|
||||
- DebitFailed
|
||||
- DebitReversedReceived
|
||||
- Debited
|
||||
- DebitedReversed
|
||||
- Fee
|
||||
- FundTransfer
|
||||
- FundTransferReversed
|
||||
- ManualCorrected
|
||||
|
||||
@@ -121,9 +121,9 @@ paths:
|
||||
/refundFundsTransfer:
|
||||
post:
|
||||
summary: Make a refund of the existing transfer funds transfer.
|
||||
description: 'This endpoint is used to refund funds from one account to another account. Both accounts must be in the same marketplace, but can have different account holders. '
|
||||
description: 'This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. '
|
||||
x-groupName: General
|
||||
x-sortIndex: 4
|
||||
x-sortIndex: 5
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -151,7 +151,7 @@ paths:
|
||||
summary: Refund all transactions of an account since the most recent payout.
|
||||
description: 'This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a per-account basis (as opposed to a per-payment basis), so only the portion of the payment which was made to the specified account will be refunded. The commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment''s split details.'
|
||||
x-groupName: General
|
||||
x-sortIndex: 6
|
||||
x-sortIndex: 7
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -179,7 +179,7 @@ paths:
|
||||
summary: Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.
|
||||
description: 'This endpoint is used to define a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it.'
|
||||
x-groupName: General
|
||||
x-sortIndex: 5
|
||||
x-sortIndex: 6
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -312,11 +312,14 @@ components:
|
||||
- ChargebackReversedReceived
|
||||
- Converted
|
||||
- CreditFailed
|
||||
- CreditReversed
|
||||
- CreditReversedReceived
|
||||
- Credited
|
||||
- DebitFailed
|
||||
- DebitReversedReceived
|
||||
- Debited
|
||||
- DebitedReversed
|
||||
- Fee
|
||||
- FundTransfer
|
||||
- FundTransferReversed
|
||||
- ManualCorrected
|
||||
@@ -594,6 +597,7 @@ components:
|
||||
- cardToken
|
||||
- checkCode
|
||||
- city
|
||||
- companyRegistration
|
||||
- country
|
||||
- countryCode
|
||||
- currency
|
||||
@@ -624,7 +628,6 @@ components:
|
||||
- idCardFront
|
||||
- idNumber
|
||||
- identityDocument
|
||||
- incorporatedAt
|
||||
- individualDetails
|
||||
- lastName
|
||||
- legalBusinessName
|
||||
@@ -664,6 +667,7 @@ components:
|
||||
- status
|
||||
- store
|
||||
- storeDetail
|
||||
- storeName
|
||||
- storeReference
|
||||
- street
|
||||
- taxId
|
||||
@@ -735,7 +739,6 @@ components:
|
||||
type: string
|
||||
required:
|
||||
- pspReference
|
||||
- bankAccountUUID
|
||||
RefundFundsTransferRequest:
|
||||
properties:
|
||||
amount:
|
||||
@@ -758,10 +761,12 @@ components:
|
||||
$ref: '#/components/schemas/ErrorFieldType'
|
||||
type: array
|
||||
merchantReference:
|
||||
description: The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
originalReference:
|
||||
description: A PSP reference of the original fund transfer.
|
||||
type: string
|
||||
pspReference:
|
||||
description: The reference of a request. Can be used to uniquely identify the request.
|
||||
@@ -885,11 +890,14 @@ components:
|
||||
- ChargebackReversedReceived
|
||||
- Converted
|
||||
- CreditFailed
|
||||
- CreditReversed
|
||||
- CreditReversedReceived
|
||||
- Credited
|
||||
- DebitFailed
|
||||
- DebitReversedReceived
|
||||
- Debited
|
||||
- DebitedReversed
|
||||
- Fee
|
||||
- FundTransfer
|
||||
- FundTransferReversed
|
||||
- ManualCorrected
|
||||
|
||||
232
yaml/HopService-v1.yaml
Normal file
232
yaml/HopService-v1.yaml
Normal file
@@ -0,0 +1,232 @@
|
||||
openapi: 3.0.0
|
||||
servers:
|
||||
- url: 'https://cal-test.adyen.com/cal/services/Hop/v1'
|
||||
info:
|
||||
version: '1'
|
||||
title: Adyen MarketPay Hop API
|
||||
description: |-
|
||||
The MarketPay Hop API provides endpoints for using the MarketPay Hosted Onboarding Page. The related entities include account holders only.
|
||||
For more information, refer to the [MarketPay Hosted Onboarding Page documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/hosted-onboarding-page).
|
||||
## Authentication
|
||||
To connect to the MarketPay API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example:
|
||||
|
||||
```
|
||||
curl
|
||||
-U "ws@MarketPlace.YourMarketPlace":"YourWsPassword" \
|
||||
-H "Content-Type: application/json" \
|
||||
...
|
||||
```
|
||||
Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).
|
||||
|
||||
## Versioning
|
||||
MarketPay API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
|
||||
|
||||
For example:
|
||||
```
|
||||
https://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl
|
||||
```
|
||||
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
|
||||
contact:
|
||||
name: Adyen Support
|
||||
url: 'https://support.adyen.com/'
|
||||
email: support@adyen.com
|
||||
x-groups:
|
||||
- Hosted Onboarding Page
|
||||
paths:
|
||||
/getOnboardingUrl:
|
||||
post:
|
||||
summary: Get a new onboarding url for an account holder.
|
||||
description: 'This endpoint is used to get a new onboarding url for a specific account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. A returnUrl can also be specified as part of this request.'
|
||||
x-groupName: Hosted Onboarding Page
|
||||
x-sortIndex: 1
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/GetOnboardingUrlRequest'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/GetOnboardingUrlResponse'
|
||||
description: OK - the request has succeeded.
|
||||
'400':
|
||||
description: Bad Request - a problem reading or understanding the request.
|
||||
'401':
|
||||
description: Unauthorized - authentication required.
|
||||
'403':
|
||||
description: Forbidden - insufficient permissions to process the request.
|
||||
'422':
|
||||
description: Unprocessable Entity - a request validation error.
|
||||
'500':
|
||||
description: Internal Server Error - the server could not process the request.
|
||||
components:
|
||||
schemas:
|
||||
ErrorFieldType:
|
||||
properties:
|
||||
errorCode:
|
||||
description: The validation error code.
|
||||
format: int32
|
||||
type: integer
|
||||
errorDescription:
|
||||
description: A description of the validation error.
|
||||
type: string
|
||||
fieldType:
|
||||
description: The type of error field.
|
||||
$ref: '#/components/schemas/FieldType'
|
||||
FieldType:
|
||||
properties:
|
||||
field:
|
||||
description: The full name of the property.
|
||||
type: string
|
||||
fieldName:
|
||||
description: The type of the field.
|
||||
enum:
|
||||
- accountCode
|
||||
- accountHolderCode
|
||||
- accountHolderDetails
|
||||
- accountNumber
|
||||
- accountStateType
|
||||
- accountStatus
|
||||
- accountType
|
||||
- address
|
||||
- bankAccount
|
||||
- bankAccountCode
|
||||
- bankAccountName
|
||||
- bankAccountUUID
|
||||
- bankBicSwift
|
||||
- bankCity
|
||||
- bankCode
|
||||
- bankName
|
||||
- bankStatement
|
||||
- branchCode
|
||||
- businessContact
|
||||
- cardToken
|
||||
- checkCode
|
||||
- city
|
||||
- companyRegistration
|
||||
- country
|
||||
- countryCode
|
||||
- currency
|
||||
- currencyCode
|
||||
- dateOfBirth
|
||||
- description
|
||||
- destinationAccountCode
|
||||
- document
|
||||
- documentExpirationDate
|
||||
- documentIssuerCountry
|
||||
- documentIssuerState
|
||||
- documentName
|
||||
- documentNumber
|
||||
- documentType
|
||||
- doingBusinessAs
|
||||
- drivingLicence
|
||||
- drivingLicenceBack
|
||||
- drivingLicense
|
||||
- email
|
||||
- firstName
|
||||
- fullPhoneNumber
|
||||
- gender
|
||||
- hopWebserviceUser
|
||||
- houseNumberOrName
|
||||
- iban
|
||||
- idCard
|
||||
- idCardBack
|
||||
- idCardFront
|
||||
- idNumber
|
||||
- identityDocument
|
||||
- individualDetails
|
||||
- lastName
|
||||
- legalBusinessName
|
||||
- legalEntity
|
||||
- legalEntityType
|
||||
- merchantAccount
|
||||
- merchantCategoryCode
|
||||
- merchantReference
|
||||
- microDeposit
|
||||
- name
|
||||
- nationality
|
||||
- originalReference
|
||||
- ownerCity
|
||||
- ownerCountryCode
|
||||
- ownerHouseNumberOrName
|
||||
- ownerName
|
||||
- ownerPostalCode
|
||||
- ownerState
|
||||
- ownerStreet
|
||||
- passport
|
||||
- passportNumber
|
||||
- payoutMethodCode
|
||||
- personalData
|
||||
- phoneCountryCode
|
||||
- phoneNumber
|
||||
- postalCode
|
||||
- primaryCurrency
|
||||
- reason
|
||||
- registrationNumber
|
||||
- returnUrl
|
||||
- schedule
|
||||
- shareholder
|
||||
- shareholderCode
|
||||
- socialSecurityNumber
|
||||
- sourceAccountCode
|
||||
- stateOrProvince
|
||||
- status
|
||||
- store
|
||||
- storeDetail
|
||||
- storeName
|
||||
- storeReference
|
||||
- street
|
||||
- taxId
|
||||
- tier
|
||||
- tierNumber
|
||||
- transferCode
|
||||
- unknown
|
||||
- value
|
||||
- virtualAccount
|
||||
- visaNumber
|
||||
- webAddress
|
||||
type: string
|
||||
shareholderCode:
|
||||
description: 'The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.'
|
||||
type: string
|
||||
GetOnboardingUrlRequest:
|
||||
properties:
|
||||
accountHolderCode:
|
||||
description: The account holder code you provided when you created the account holder.
|
||||
type: string
|
||||
platformName:
|
||||
description: The platform name which will show up in the welcome page.
|
||||
type: string
|
||||
returnUrl:
|
||||
description: 'The URL where the sub-merchant will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don''t provide this, the sub-merchant will be redirected back to the default return URL configured in your platform account.'
|
||||
type: string
|
||||
required:
|
||||
- accountHolderCode
|
||||
GetOnboardingUrlResponse:
|
||||
properties:
|
||||
invalidFields:
|
||||
description: Contains field validation errors that would prevent requests from being processed.
|
||||
items:
|
||||
$ref: '#/components/schemas/ErrorFieldType'
|
||||
type: array
|
||||
pspReference:
|
||||
description: The reference of a request. Can be used to uniquely identify the request.
|
||||
type: string
|
||||
redirectUrl:
|
||||
description: The URL to the Hosted Onboarding Page where you should redirect your sub-merchant. This URL must be used within 15 seconds and can only be used once.
|
||||
type: string
|
||||
resultCode:
|
||||
description: The result code.
|
||||
type: string
|
||||
submittedAsync:
|
||||
description: |-
|
||||
Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
|
||||
* **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
|
||||
* **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received.
|
||||
* **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.
|
||||
type: boolean
|
||||
required:
|
||||
- pspReference
|
||||
- submittedAsync
|
||||
@@ -1,9 +1,9 @@
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
version: '3'
|
||||
title: Adyen Notification API
|
||||
title: Adyen MarketPay Notifications
|
||||
description: |-
|
||||
The Notification Service sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.
|
||||
The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.
|
||||
|
||||
For further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).
|
||||
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
|
||||
@@ -109,6 +109,42 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/ACCOUNT_HOLDER_STORE_STATUS_CHANGE:
|
||||
post:
|
||||
summary: Triggered upon the status change of a store tied to an account holder.
|
||||
description: This notification is sent when the status of a store tied to an account holder has been changed.
|
||||
x-groupName: Account holders
|
||||
x-sortIndex: 4
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AccountHolderStoreStatusChangeNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/ACCOUNT_HOLDER_UPCOMING_DEADLINE:
|
||||
post:
|
||||
summary: Triggered upon an upcoming deadline.
|
||||
description: 'This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.'
|
||||
x-groupName: Account holders
|
||||
x-sortIndex: 1
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/ACCOUNT_HOLDER_UPDATED:
|
||||
post:
|
||||
summary: Triggered upon the update of an account holder.
|
||||
@@ -199,6 +235,24 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/DIRECT_DEBIT_INITIATED:
|
||||
post:
|
||||
summary: Triggered when an automated direct debit is initiated.
|
||||
description: This notification is sent when an automated direct debit is initiated from the Adyen platform.
|
||||
x-groupName: Fund management
|
||||
x-sortIndex: 7
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DirectDebitInitiatedNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/PAYMENT_FAILURE:
|
||||
post:
|
||||
summary: Triggered upon an account payment failure.
|
||||
@@ -217,6 +271,24 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/REFUND_FUNDS_TRANSFER:
|
||||
post:
|
||||
summary: Triggered upon the transfer refund of funds between accounts.
|
||||
description: This notification is sent when the refund of funds from an account have been transferred to another account.
|
||||
x-groupName: Fund management
|
||||
x-sortIndex: 6
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/RefundFundsTransferNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/REPORT_AVAILABLE:
|
||||
post:
|
||||
summary: Triggered when a report is made available.
|
||||
@@ -415,6 +487,7 @@ components:
|
||||
required:
|
||||
- fullPhoneNumber
|
||||
- email
|
||||
- webAddress
|
||||
AccountHolderPayoutNotification:
|
||||
properties:
|
||||
content:
|
||||
@@ -447,10 +520,10 @@ components:
|
||||
description: The code of the Account Holder to which the payout was made.
|
||||
type: string
|
||||
amount:
|
||||
description: payout amount
|
||||
description: The payout amount.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
amounts:
|
||||
description: payout amounts (per currency)
|
||||
description: The payout amounts (per currency).
|
||||
items:
|
||||
$ref: '#/components/schemas/Amount'
|
||||
type: array
|
||||
@@ -461,15 +534,14 @@ components:
|
||||
description: A description of the payout.
|
||||
type: string
|
||||
merchantReference:
|
||||
description: merchant reference
|
||||
description: The merchant reference.
|
||||
type: string
|
||||
status:
|
||||
description: payout status
|
||||
description: The payout status.
|
||||
$ref: '#/components/schemas/OperationStatus'
|
||||
required:
|
||||
- accountHolderCode
|
||||
- accountCode
|
||||
- bankAccountDetail
|
||||
AccountHolderStatus:
|
||||
properties:
|
||||
events:
|
||||
@@ -543,6 +615,83 @@ components:
|
||||
- oldStatus
|
||||
- newStatus
|
||||
- reason
|
||||
AccountHolderStoreStatusChangeNotification:
|
||||
properties:
|
||||
content:
|
||||
description: The details of the Account Holder Store status change.
|
||||
$ref: '#/components/schemas/AccountHolderStoreStatusChangeNotificationContent'
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
AccountHolderStoreStatusChangeNotificationContent: {}
|
||||
AccountHolderUpcomingDeadlineNotification:
|
||||
properties:
|
||||
content:
|
||||
description: The details of the upcoming event.
|
||||
$ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent'
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
AccountHolderUpcomingDeadlineNotificationContent:
|
||||
properties:
|
||||
accountHolderCode:
|
||||
description: The code of the account holder whom the event refers to.
|
||||
type: string
|
||||
event:
|
||||
description: The event name that will be trigger if no action is taken.
|
||||
enum:
|
||||
- AccessPii
|
||||
- CloseAccount
|
||||
- CloseStores
|
||||
- DeleteBankAccounts
|
||||
- DeletePayoutInstrumentTokens
|
||||
- DeletePayoutMethods
|
||||
- DeleteShareholders
|
||||
- InactivateAccount
|
||||
- RecalculateAccountStatusAndProcessingTier
|
||||
- RefundNotPaidOutTransfers
|
||||
- ResolveEvents
|
||||
- SaveAccountHolder
|
||||
- SaveKYCCheckStatus
|
||||
- SuspendAccount
|
||||
- UnSuspendAccount
|
||||
- UpdateAccountHolderState
|
||||
- Verification
|
||||
type: string
|
||||
executionDate:
|
||||
description: The execution date scheduled for the event.
|
||||
$ref: '#/components/schemas/LocalDate'
|
||||
reason:
|
||||
description: The reason that leads to scheduling of the event.
|
||||
type: string
|
||||
AccountHolderUpdateNotification:
|
||||
properties:
|
||||
content:
|
||||
@@ -1100,6 +1249,49 @@ components:
|
||||
- accountHolderCode
|
||||
- accountCode
|
||||
- status
|
||||
DirectDebitInitiatedNotification:
|
||||
properties:
|
||||
content:
|
||||
description: Details of the direct debit.
|
||||
$ref: '#/components/schemas/DirectDebitInitiatedNotificationContent'
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
DirectDebitInitiatedNotificationContent:
|
||||
properties:
|
||||
accountCode:
|
||||
description: The code of the account.
|
||||
type: string
|
||||
amount:
|
||||
description: The amount to be debited from the funding account.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
debitInitiationDate:
|
||||
description: The date of the debit initiation.
|
||||
$ref: '#/components/schemas/LocalDate'
|
||||
merchantAccountCode:
|
||||
description: The code of the merchant account.
|
||||
type: string
|
||||
status:
|
||||
description: Direct debit status.
|
||||
$ref: '#/components/schemas/OperationStatus'
|
||||
required:
|
||||
- amount
|
||||
- accountCode
|
||||
- merchantAccountCode
|
||||
ErrorFieldType:
|
||||
properties:
|
||||
errorCode:
|
||||
@@ -1131,6 +1323,7 @@ components:
|
||||
- bankAccount
|
||||
- bankAccountCode
|
||||
- bankAccountName
|
||||
- bankAccountUUID
|
||||
- bankBicSwift
|
||||
- bankCity
|
||||
- bankCode
|
||||
@@ -1141,6 +1334,7 @@ components:
|
||||
- cardToken
|
||||
- checkCode
|
||||
- city
|
||||
- companyRegistration
|
||||
- country
|
||||
- countryCode
|
||||
- currency
|
||||
@@ -1163,6 +1357,7 @@ components:
|
||||
- firstName
|
||||
- fullPhoneNumber
|
||||
- gender
|
||||
- hopWebserviceUser
|
||||
- houseNumberOrName
|
||||
- iban
|
||||
- idCard
|
||||
@@ -1175,12 +1370,13 @@ components:
|
||||
- legalBusinessName
|
||||
- legalEntity
|
||||
- legalEntityType
|
||||
- merchantAccount
|
||||
- merchantCategoryCode
|
||||
- merchantCode
|
||||
- merchantReference
|
||||
- microDeposit
|
||||
- name
|
||||
- nationality
|
||||
- originalReference
|
||||
- ownerCity
|
||||
- ownerCountryCode
|
||||
- ownerHouseNumberOrName
|
||||
@@ -1190,6 +1386,7 @@ components:
|
||||
- ownerStreet
|
||||
- passport
|
||||
- passportNumber
|
||||
- payoutMethodCode
|
||||
- personalData
|
||||
- phoneCountryCode
|
||||
- phoneNumber
|
||||
@@ -1197,6 +1394,7 @@ components:
|
||||
- primaryCurrency
|
||||
- reason
|
||||
- registrationNumber
|
||||
- returnUrl
|
||||
- schedule
|
||||
- shareholder
|
||||
- shareholderCode
|
||||
@@ -1204,11 +1402,13 @@ components:
|
||||
- sourceAccountCode
|
||||
- stateOrProvince
|
||||
- status
|
||||
- storeCode
|
||||
- store
|
||||
- storeDetail
|
||||
- storeName
|
||||
- storeReference
|
||||
- street
|
||||
- taxId
|
||||
- tier
|
||||
- tierNumber
|
||||
- transferCode
|
||||
- unknown
|
||||
@@ -1271,7 +1471,7 @@ components:
|
||||
status:
|
||||
description: |-
|
||||
The status of the check.
|
||||
>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
enum:
|
||||
- AWAITING_DATA
|
||||
- DATA_PROVIDED
|
||||
@@ -1345,6 +1545,14 @@ components:
|
||||
- accountHolder
|
||||
- shareholders
|
||||
- bankAccounts
|
||||
LocalDate:
|
||||
properties:
|
||||
month:
|
||||
format: int32
|
||||
type: integer
|
||||
year:
|
||||
format: int32
|
||||
type: integer
|
||||
Message:
|
||||
properties:
|
||||
code:
|
||||
@@ -1419,6 +1627,9 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
- HOLD
|
||||
@@ -1464,6 +1675,46 @@ components:
|
||||
required:
|
||||
- type
|
||||
- number
|
||||
RefundFundsTransferNotification:
|
||||
properties:
|
||||
content:
|
||||
description: Details of the fund transfer refund.
|
||||
$ref: '#/components/schemas/RefundFundsTransferNotificationContent'
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
- content
|
||||
RefundFundsTransferNotificationContent:
|
||||
properties:
|
||||
amount:
|
||||
description: The amount to be refunded.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
merchantReference:
|
||||
description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
|
||||
type: string
|
||||
originalReference:
|
||||
description: A PSP reference of the original fund transfer.
|
||||
type: string
|
||||
status:
|
||||
description: The status of the fund transfer refund.
|
||||
$ref: '#/components/schemas/OperationStatus'
|
||||
required:
|
||||
- originalReference
|
||||
- amount
|
||||
RefundResult:
|
||||
properties:
|
||||
originalTransaction:
|
||||
@@ -1594,7 +1845,7 @@ components:
|
||||
|
||||
>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**
|
||||
|
||||
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Bank Account will be updated.**
|
||||
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**
|
||||
type: string
|
||||
webAddress:
|
||||
description: The URL of the website of the contact.
|
||||
@@ -1650,17 +1901,23 @@ components:
|
||||
>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.
|
||||
enum:
|
||||
- Chargeback
|
||||
- ChargebackCorrection
|
||||
- ChargebackCorrectionReceived
|
||||
- ChargebackReceived
|
||||
- ChargebackReversed
|
||||
- ChargebackReversedReceived
|
||||
- Converted
|
||||
- CreditFailed
|
||||
- CreditReversed
|
||||
- CreditReversedReceived
|
||||
- Credited
|
||||
- DebitFailed
|
||||
- DebitReversedReceived
|
||||
- Debited
|
||||
- DebitedReversed
|
||||
- Fee
|
||||
- FundTransfer
|
||||
- FundTransferReversed
|
||||
- ManualCorrected
|
||||
- Payout
|
||||
- PayoutReversed
|
||||
@@ -1799,7 +2056,7 @@ components:
|
||||
country:
|
||||
description: |-
|
||||
The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
|
||||
> If you don't know the country or are not collecting the country from the shopper, provide `countryCode` as `ZZ`.
|
||||
> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
|
||||
type: string
|
||||
houseNumberOrName:
|
||||
description: The number or name of the house.
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
version: '4'
|
||||
title: Adyen Notification API
|
||||
title: Adyen MarketPay Notifications
|
||||
description: |-
|
||||
The Notification Service sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.
|
||||
The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.
|
||||
|
||||
For further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).
|
||||
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
|
||||
@@ -109,6 +109,42 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/ACCOUNT_HOLDER_STORE_STATUS_CHANGE:
|
||||
post:
|
||||
summary: Triggered upon the status change of a store tied to an account holder.
|
||||
description: This notification is sent when the status of a store tied to an account holder has been changed.
|
||||
x-groupName: Account holders
|
||||
x-sortIndex: 4
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AccountHolderStoreStatusChangeNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/ACCOUNT_HOLDER_UPCOMING_DEADLINE:
|
||||
post:
|
||||
summary: Triggered upon an upcoming deadline.
|
||||
description: 'This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.'
|
||||
x-groupName: Account holders
|
||||
x-sortIndex: 1
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/ACCOUNT_HOLDER_UPDATED:
|
||||
post:
|
||||
summary: Triggered upon the update of an account holder.
|
||||
@@ -199,6 +235,24 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/DIRECT_DEBIT_INITIATED:
|
||||
post:
|
||||
summary: Triggered when an automated direct debit is initiated.
|
||||
description: This notification is sent when an automated direct debit is initiated from the Adyen platform.
|
||||
x-groupName: Fund management
|
||||
x-sortIndex: 7
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DirectDebitInitiatedNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/PAYMENT_FAILURE:
|
||||
post:
|
||||
summary: Triggered upon an account payment failure.
|
||||
@@ -217,6 +271,24 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/REFUND_FUNDS_TRANSFER:
|
||||
post:
|
||||
summary: Triggered upon the transfer refund of funds between accounts.
|
||||
description: This notification is sent when the refund of funds from an account have been transferred to another account.
|
||||
x-groupName: Fund management
|
||||
x-sortIndex: 6
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/RefundFundsTransferNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/REPORT_AVAILABLE:
|
||||
post:
|
||||
summary: Triggered when a report is made available.
|
||||
@@ -430,6 +502,7 @@ components:
|
||||
required:
|
||||
- fullPhoneNumber
|
||||
- email
|
||||
- webAddress
|
||||
AccountHolderPayoutNotification:
|
||||
properties:
|
||||
content:
|
||||
@@ -467,10 +540,10 @@ components:
|
||||
description: The code of the Account Holder to which the payout was made.
|
||||
type: string
|
||||
amount:
|
||||
description: payout amount
|
||||
description: The payout amount.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
amounts:
|
||||
description: payout amounts (per currency)
|
||||
description: The payout amounts (per currency).
|
||||
items:
|
||||
$ref: '#/components/schemas/Amount'
|
||||
type: array
|
||||
@@ -481,15 +554,14 @@ components:
|
||||
description: A description of the payout.
|
||||
type: string
|
||||
merchantReference:
|
||||
description: merchant reference
|
||||
description: The merchant reference.
|
||||
type: string
|
||||
status:
|
||||
description: payout status
|
||||
description: The payout status.
|
||||
$ref: '#/components/schemas/OperationStatus'
|
||||
required:
|
||||
- accountHolderCode
|
||||
- accountCode
|
||||
- bankAccountDetail
|
||||
AccountHolderStatus:
|
||||
properties:
|
||||
events:
|
||||
@@ -568,6 +640,93 @@ components:
|
||||
- oldStatus
|
||||
- newStatus
|
||||
- reason
|
||||
AccountHolderStoreStatusChangeNotification:
|
||||
properties:
|
||||
content:
|
||||
description: The details of the Account Holder Store status change.
|
||||
$ref: '#/components/schemas/AccountHolderStoreStatusChangeNotificationContent'
|
||||
eventDate:
|
||||
description: The date and time when an event has been completed.
|
||||
format: date-time
|
||||
type: string
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
- eventDate
|
||||
AccountHolderStoreStatusChangeNotificationContent: {}
|
||||
AccountHolderUpcomingDeadlineNotification:
|
||||
properties:
|
||||
content:
|
||||
description: The details of the upcoming event.
|
||||
$ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent'
|
||||
eventDate:
|
||||
description: The date and time when an event has been completed.
|
||||
format: date-time
|
||||
type: string
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
- eventDate
|
||||
AccountHolderUpcomingDeadlineNotificationContent:
|
||||
properties:
|
||||
accountHolderCode:
|
||||
description: The code of the account holder whom the event refers to.
|
||||
type: string
|
||||
event:
|
||||
description: The event name that will be trigger if no action is taken.
|
||||
enum:
|
||||
- AccessPii
|
||||
- CloseAccount
|
||||
- CloseStores
|
||||
- DeleteBankAccounts
|
||||
- DeletePayoutInstrumentTokens
|
||||
- DeletePayoutMethods
|
||||
- DeleteShareholders
|
||||
- InactivateAccount
|
||||
- RecalculateAccountStatusAndProcessingTier
|
||||
- RefundNotPaidOutTransfers
|
||||
- ResolveEvents
|
||||
- SaveAccountHolder
|
||||
- SaveKYCCheckStatus
|
||||
- SuspendAccount
|
||||
- UnSuspendAccount
|
||||
- UpdateAccountHolderState
|
||||
- Verification
|
||||
type: string
|
||||
executionDate:
|
||||
description: The execution date scheduled for the event.
|
||||
$ref: '#/components/schemas/LocalDate'
|
||||
reason:
|
||||
description: The reason that leads to scheduling of the event.
|
||||
type: string
|
||||
AccountHolderUpdateNotification:
|
||||
properties:
|
||||
content:
|
||||
@@ -1096,6 +1255,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
pspReference:
|
||||
@@ -1165,6 +1325,54 @@ components:
|
||||
- accountHolderCode
|
||||
- accountCode
|
||||
- status
|
||||
DirectDebitInitiatedNotification:
|
||||
properties:
|
||||
content:
|
||||
description: Details of the direct debit.
|
||||
$ref: '#/components/schemas/DirectDebitInitiatedNotificationContent'
|
||||
eventDate:
|
||||
description: The date and time when an event has been completed.
|
||||
format: date-time
|
||||
type: string
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
- eventDate
|
||||
DirectDebitInitiatedNotificationContent:
|
||||
properties:
|
||||
accountCode:
|
||||
description: The code of the account.
|
||||
type: string
|
||||
amount:
|
||||
description: The amount to be debited from the funding account.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
debitInitiationDate:
|
||||
description: The date of the debit initiation.
|
||||
$ref: '#/components/schemas/LocalDate'
|
||||
merchantAccountCode:
|
||||
description: The code of the merchant account.
|
||||
type: string
|
||||
status:
|
||||
description: Direct debit status.
|
||||
$ref: '#/components/schemas/OperationStatus'
|
||||
required:
|
||||
- amount
|
||||
- accountCode
|
||||
- merchantAccountCode
|
||||
ErrorFieldType:
|
||||
properties:
|
||||
errorCode:
|
||||
@@ -1196,6 +1404,7 @@ components:
|
||||
- bankAccount
|
||||
- bankAccountCode
|
||||
- bankAccountName
|
||||
- bankAccountUUID
|
||||
- bankBicSwift
|
||||
- bankCity
|
||||
- bankCode
|
||||
@@ -1206,6 +1415,7 @@ components:
|
||||
- cardToken
|
||||
- checkCode
|
||||
- city
|
||||
- companyRegistration
|
||||
- country
|
||||
- countryCode
|
||||
- currency
|
||||
@@ -1228,6 +1438,7 @@ components:
|
||||
- firstName
|
||||
- fullPhoneNumber
|
||||
- gender
|
||||
- hopWebserviceUser
|
||||
- houseNumberOrName
|
||||
- iban
|
||||
- idCard
|
||||
@@ -1240,12 +1451,13 @@ components:
|
||||
- legalBusinessName
|
||||
- legalEntity
|
||||
- legalEntityType
|
||||
- merchantAccount
|
||||
- merchantCategoryCode
|
||||
- merchantCode
|
||||
- merchantReference
|
||||
- microDeposit
|
||||
- name
|
||||
- nationality
|
||||
- originalReference
|
||||
- ownerCity
|
||||
- ownerCountryCode
|
||||
- ownerHouseNumberOrName
|
||||
@@ -1255,6 +1467,7 @@ components:
|
||||
- ownerStreet
|
||||
- passport
|
||||
- passportNumber
|
||||
- payoutMethodCode
|
||||
- personalData
|
||||
- phoneCountryCode
|
||||
- phoneNumber
|
||||
@@ -1262,17 +1475,21 @@ components:
|
||||
- primaryCurrency
|
||||
- reason
|
||||
- registrationNumber
|
||||
- returnUrl
|
||||
- schedule
|
||||
- shareholder
|
||||
- shareholderCode
|
||||
- socialSecurityNumber
|
||||
- sourceAccountCode
|
||||
- stateOrProvince
|
||||
- storeCode
|
||||
- status
|
||||
- store
|
||||
- storeDetail
|
||||
- storeName
|
||||
- storeReference
|
||||
- street
|
||||
- taxId
|
||||
- tier
|
||||
- tierNumber
|
||||
- transferCode
|
||||
- unknown
|
||||
@@ -1326,7 +1543,7 @@ components:
|
||||
status:
|
||||
description: |-
|
||||
The status of the check.
|
||||
>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
enum:
|
||||
- AWAITING_DATA
|
||||
- DATA_PROVIDED
|
||||
@@ -1400,6 +1617,14 @@ components:
|
||||
- accountHolder
|
||||
- shareholders
|
||||
- bankAccounts
|
||||
LocalDate:
|
||||
properties:
|
||||
month:
|
||||
format: int32
|
||||
type: integer
|
||||
year:
|
||||
format: int32
|
||||
type: integer
|
||||
Message:
|
||||
properties:
|
||||
code:
|
||||
@@ -1479,6 +1704,9 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
- HOLD
|
||||
@@ -1524,6 +1752,51 @@ components:
|
||||
required:
|
||||
- type
|
||||
- number
|
||||
RefundFundsTransferNotification:
|
||||
properties:
|
||||
content:
|
||||
description: Details of the fund transfer refund.
|
||||
$ref: '#/components/schemas/RefundFundsTransferNotificationContent'
|
||||
eventDate:
|
||||
description: The date and time when an event has been completed.
|
||||
format: date-time
|
||||
type: string
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
- eventDate
|
||||
- content
|
||||
RefundFundsTransferNotificationContent:
|
||||
properties:
|
||||
amount:
|
||||
description: The amount to be refunded.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
merchantReference:
|
||||
description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
|
||||
type: string
|
||||
originalReference:
|
||||
description: A PSP reference of the original fund transfer.
|
||||
type: string
|
||||
status:
|
||||
description: The status of the fund transfer refund.
|
||||
$ref: '#/components/schemas/OperationStatus'
|
||||
required:
|
||||
- originalReference
|
||||
- amount
|
||||
RefundResult:
|
||||
properties:
|
||||
originalTransaction:
|
||||
@@ -1664,7 +1937,7 @@ components:
|
||||
|
||||
>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**
|
||||
|
||||
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Bank Account will be updated.**
|
||||
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**
|
||||
type: string
|
||||
webAddress:
|
||||
description: The URL of the website of the contact.
|
||||
@@ -1720,17 +1993,23 @@ components:
|
||||
>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.
|
||||
enum:
|
||||
- Chargeback
|
||||
- ChargebackCorrection
|
||||
- ChargebackCorrectionReceived
|
||||
- ChargebackReceived
|
||||
- ChargebackReversed
|
||||
- ChargebackReversedReceived
|
||||
- Converted
|
||||
- CreditFailed
|
||||
- CreditReversed
|
||||
- CreditReversedReceived
|
||||
- Credited
|
||||
- DebitFailed
|
||||
- DebitReversedReceived
|
||||
- Debited
|
||||
- DebitedReversed
|
||||
- Fee
|
||||
- FundTransfer
|
||||
- FundTransferReversed
|
||||
- ManualCorrected
|
||||
- Payout
|
||||
- PayoutReversed
|
||||
@@ -1821,6 +2100,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
pspReference:
|
||||
@@ -1889,7 +2169,7 @@ components:
|
||||
country:
|
||||
description: |-
|
||||
The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
|
||||
> If you don't know the country or are not collecting the country from the shopper, provide `countryCode` as `ZZ`.
|
||||
> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
|
||||
type: string
|
||||
houseNumberOrName:
|
||||
description: The number or name of the house.
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
version: '5'
|
||||
title: Adyen Notification API
|
||||
title: Adyen MarketPay Notifications
|
||||
description: |-
|
||||
The Notification Service sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.
|
||||
The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.
|
||||
|
||||
For further information on MarketPay notifications, please visit the [MarketPay documentation](https://docs.adyen.com/marketpay).
|
||||
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
|
||||
@@ -109,6 +109,42 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/ACCOUNT_HOLDER_STORE_STATUS_CHANGE:
|
||||
post:
|
||||
summary: Triggered upon the status change of a store tied to an account holder.
|
||||
description: This notification is sent when the status of a store tied to an account holder has been changed.
|
||||
x-groupName: Account holders
|
||||
x-sortIndex: 4
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AccountHolderStoreStatusChangeNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/ACCOUNT_HOLDER_UPCOMING_DEADLINE:
|
||||
post:
|
||||
summary: Triggered upon an upcoming deadline.
|
||||
description: 'This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.'
|
||||
x-groupName: Account holders
|
||||
x-sortIndex: 1
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/ACCOUNT_HOLDER_UPDATED:
|
||||
post:
|
||||
summary: Triggered upon the update of an account holder.
|
||||
@@ -199,6 +235,24 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/DIRECT_DEBIT_INITIATED:
|
||||
post:
|
||||
summary: Triggered when an automated direct debit is initiated.
|
||||
description: This notification is sent when an automated direct debit is initiated from the Adyen platform.
|
||||
x-groupName: Fund management
|
||||
x-sortIndex: 7
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DirectDebitInitiatedNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/PAYMENT_FAILURE:
|
||||
post:
|
||||
summary: Triggered upon an account payment failure.
|
||||
@@ -217,6 +271,24 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/REFUND_FUNDS_TRANSFER:
|
||||
post:
|
||||
summary: Triggered upon the transfer refund of funds between accounts.
|
||||
description: This notification is sent when the refund of funds from an account have been transferred to another account.
|
||||
x-groupName: Fund management
|
||||
x-sortIndex: 6
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/RefundFundsTransferNotification'
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NotificationResponse'
|
||||
description: OK - the request has succeeded.
|
||||
/REPORT_AVAILABLE:
|
||||
post:
|
||||
summary: Triggered when a report is made available.
|
||||
@@ -447,6 +519,7 @@ components:
|
||||
required:
|
||||
- fullPhoneNumber
|
||||
- email
|
||||
- webAddress
|
||||
AccountHolderPayoutNotification:
|
||||
properties:
|
||||
content:
|
||||
@@ -487,10 +560,10 @@ components:
|
||||
description: The code of the Account Holder to which the payout was made.
|
||||
type: string
|
||||
amount:
|
||||
description: payout amount
|
||||
description: The payout amount.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
amounts:
|
||||
description: payout amounts (per currency)
|
||||
description: The payout amounts (per currency).
|
||||
items:
|
||||
$ref: '#/components/schemas/Amount'
|
||||
type: array
|
||||
@@ -500,21 +573,26 @@ components:
|
||||
description:
|
||||
description: A description of the payout.
|
||||
type: string
|
||||
estimatedArrivalDate:
|
||||
description: The estimated date of arrival.
|
||||
$ref: '#/components/schemas/LocalDate'
|
||||
invalidFields:
|
||||
description: Invalid fields list.
|
||||
items:
|
||||
$ref: '#/components/schemas/ErrorFieldType'
|
||||
type: array
|
||||
merchantReference:
|
||||
description: merchant reference
|
||||
description: The merchant reference.
|
||||
type: string
|
||||
originalPspReference:
|
||||
description: The PSP reference of the original payout.
|
||||
type: string
|
||||
status:
|
||||
description: payout status
|
||||
description: The payout status.
|
||||
$ref: '#/components/schemas/OperationStatus'
|
||||
required:
|
||||
- accountHolderCode
|
||||
- accountCode
|
||||
- bankAccountDetail
|
||||
AccountHolderStatus:
|
||||
properties:
|
||||
events:
|
||||
@@ -601,6 +679,142 @@ components:
|
||||
- oldStatus
|
||||
- newStatus
|
||||
- reason
|
||||
AccountHolderStoreStatusChangeNotification:
|
||||
properties:
|
||||
content:
|
||||
description: The details of the Account Holder Store status change.
|
||||
$ref: '#/components/schemas/AccountHolderStoreStatusChangeNotificationContent'
|
||||
error:
|
||||
description: Error information of failed request. No value provided here if no error occurred on processing.
|
||||
$ref: '#/components/schemas/NotificationErrorContainer'
|
||||
eventDate:
|
||||
description: The date and time when an event has been completed.
|
||||
format: date-time
|
||||
type: string
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
- eventDate
|
||||
AccountHolderStoreStatusChangeNotificationContent:
|
||||
properties:
|
||||
accountHolderCode:
|
||||
description: The code of the account holder.
|
||||
type: string
|
||||
invalidFields:
|
||||
description: 'In case the store status has not been updated, contains fields that did not pass the validation.'
|
||||
items:
|
||||
$ref: '#/components/schemas/ErrorFieldType'
|
||||
type: array
|
||||
newStatus:
|
||||
description: The new status of the account holder.
|
||||
enum:
|
||||
- Active
|
||||
- Closed
|
||||
- Inactive
|
||||
- InactiveWithModifications
|
||||
- Pending
|
||||
type: string
|
||||
oldStatus:
|
||||
description: The former status of the account holder.
|
||||
enum:
|
||||
- Active
|
||||
- Closed
|
||||
- Inactive
|
||||
- InactiveWithModifications
|
||||
- Pending
|
||||
type: string
|
||||
reason:
|
||||
description: The reason for the status change.
|
||||
type: string
|
||||
store:
|
||||
description: Alphanumeric identifier of the store.
|
||||
type: string
|
||||
storeReference:
|
||||
description: Store store reference.
|
||||
type: string
|
||||
required:
|
||||
- accountHolderCode
|
||||
- store
|
||||
- storeReference
|
||||
- oldStatus
|
||||
- newStatus
|
||||
- reason
|
||||
AccountHolderUpcomingDeadlineNotification:
|
||||
properties:
|
||||
content:
|
||||
description: The details of the upcoming event.
|
||||
$ref: '#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent'
|
||||
error:
|
||||
description: Error information of failed request. No value provided here if no error occurred on processing.
|
||||
$ref: '#/components/schemas/NotificationErrorContainer'
|
||||
eventDate:
|
||||
description: The date and time when an event has been completed.
|
||||
format: date-time
|
||||
type: string
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
- eventDate
|
||||
AccountHolderUpcomingDeadlineNotificationContent:
|
||||
properties:
|
||||
accountHolderCode:
|
||||
description: The code of the account holder whom the event refers to.
|
||||
type: string
|
||||
event:
|
||||
description: The event name that will be trigger if no action is taken.
|
||||
enum:
|
||||
- AccessPii
|
||||
- CloseAccount
|
||||
- CloseStores
|
||||
- DeleteBankAccounts
|
||||
- DeletePayoutInstrumentTokens
|
||||
- DeletePayoutMethods
|
||||
- DeleteShareholders
|
||||
- InactivateAccount
|
||||
- RecalculateAccountStatusAndProcessingTier
|
||||
- RefundNotPaidOutTransfers
|
||||
- ResolveEvents
|
||||
- SaveAccountHolder
|
||||
- SaveKYCCheckStatus
|
||||
- SuspendAccount
|
||||
- UnSuspendAccount
|
||||
- UpdateAccountHolderState
|
||||
- Verification
|
||||
type: string
|
||||
executionDate:
|
||||
description: The execution date scheduled for the event.
|
||||
$ref: '#/components/schemas/LocalDate'
|
||||
reason:
|
||||
description: The reason that leads to scheduling of the event.
|
||||
type: string
|
||||
AccountHolderUpdateNotification:
|
||||
properties:
|
||||
content:
|
||||
@@ -1019,6 +1233,9 @@ components:
|
||||
type: string
|
||||
CloseAccountResponse:
|
||||
properties:
|
||||
accountCode:
|
||||
description: The account code of the account that is closed.
|
||||
type: string
|
||||
invalidFields:
|
||||
description: Contains field validation errors that would prevent requests from being processed.
|
||||
items:
|
||||
@@ -1126,6 +1343,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
primaryCurrency:
|
||||
@@ -1191,6 +1409,57 @@ components:
|
||||
- accountHolderCode
|
||||
- accountCode
|
||||
- status
|
||||
DirectDebitInitiatedNotification:
|
||||
properties:
|
||||
content:
|
||||
description: Details of the direct debit.
|
||||
$ref: '#/components/schemas/DirectDebitInitiatedNotificationContent'
|
||||
error:
|
||||
description: Error information of failed request. No value provided here if no error occurred on processing.
|
||||
$ref: '#/components/schemas/NotificationErrorContainer'
|
||||
eventDate:
|
||||
description: The date and time when an event has been completed.
|
||||
format: date-time
|
||||
type: string
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
- eventDate
|
||||
DirectDebitInitiatedNotificationContent:
|
||||
properties:
|
||||
accountCode:
|
||||
description: The code of the account.
|
||||
type: string
|
||||
amount:
|
||||
description: The amount to be debited from the funding account.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
debitInitiationDate:
|
||||
description: The date of the debit initiation.
|
||||
$ref: '#/components/schemas/LocalDate'
|
||||
merchantAccountCode:
|
||||
description: The code of the merchant account.
|
||||
type: string
|
||||
status:
|
||||
description: Direct debit status.
|
||||
$ref: '#/components/schemas/OperationStatus'
|
||||
required:
|
||||
- amount
|
||||
- accountCode
|
||||
- merchantAccountCode
|
||||
ErrorFieldType:
|
||||
properties:
|
||||
errorCode:
|
||||
@@ -1222,6 +1491,7 @@ components:
|
||||
- bankAccount
|
||||
- bankAccountCode
|
||||
- bankAccountName
|
||||
- bankAccountUUID
|
||||
- bankBicSwift
|
||||
- bankCity
|
||||
- bankCode
|
||||
@@ -1232,6 +1502,7 @@ components:
|
||||
- cardToken
|
||||
- checkCode
|
||||
- city
|
||||
- companyRegistration
|
||||
- country
|
||||
- countryCode
|
||||
- currency
|
||||
@@ -1254,6 +1525,7 @@ components:
|
||||
- firstName
|
||||
- fullPhoneNumber
|
||||
- gender
|
||||
- hopWebserviceUser
|
||||
- houseNumberOrName
|
||||
- iban
|
||||
- idCard
|
||||
@@ -1266,12 +1538,13 @@ components:
|
||||
- legalBusinessName
|
||||
- legalEntity
|
||||
- legalEntityType
|
||||
- merchantAccountCode
|
||||
- merchantAccount
|
||||
- merchantCategoryCode
|
||||
- merchantReference
|
||||
- microDeposit
|
||||
- name
|
||||
- nationality
|
||||
- originalReference
|
||||
- ownerCity
|
||||
- ownerCountryCode
|
||||
- ownerHouseNumberOrName
|
||||
@@ -1281,6 +1554,7 @@ components:
|
||||
- ownerStreet
|
||||
- passport
|
||||
- passportNumber
|
||||
- payoutMethodCode
|
||||
- personalData
|
||||
- phoneCountryCode
|
||||
- phoneNumber
|
||||
@@ -1288,6 +1562,7 @@ components:
|
||||
- primaryCurrency
|
||||
- reason
|
||||
- registrationNumber
|
||||
- returnUrl
|
||||
- schedule
|
||||
- shareholder
|
||||
- shareholderCode
|
||||
@@ -1295,8 +1570,9 @@ components:
|
||||
- sourceAccountCode
|
||||
- stateOrProvince
|
||||
- status
|
||||
- storeCode
|
||||
- store
|
||||
- storeDetail
|
||||
- storeName
|
||||
- storeReference
|
||||
- street
|
||||
- taxId
|
||||
@@ -1354,7 +1630,7 @@ components:
|
||||
status:
|
||||
description: |-
|
||||
The status of the check.
|
||||
>Permitted Values: `UNCHECKED`, `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
>Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`.
|
||||
enum:
|
||||
- AWAITING_DATA
|
||||
- DATA_PROVIDED
|
||||
@@ -1426,6 +1702,14 @@ components:
|
||||
- accountHolder
|
||||
- shareholders
|
||||
- bankAccounts
|
||||
LocalDate:
|
||||
properties:
|
||||
month:
|
||||
format: int32
|
||||
type: integer
|
||||
year:
|
||||
format: int32
|
||||
type: integer
|
||||
Message:
|
||||
properties:
|
||||
code:
|
||||
@@ -1534,6 +1818,9 @@ components:
|
||||
- BIWEEKLY_ON_1ST_AND_15TH_AT_NOON
|
||||
- DAILY
|
||||
- DAILY_6PM
|
||||
- DAILY_AU
|
||||
- DAILY_EU
|
||||
- DAILY_US
|
||||
- DEFAULT
|
||||
- EVERY_6_HOURS_FROM_MIDNIGHT
|
||||
- HOLD
|
||||
@@ -1579,6 +1866,59 @@ components:
|
||||
required:
|
||||
- type
|
||||
- number
|
||||
RefundFundsTransferNotification:
|
||||
properties:
|
||||
content:
|
||||
description: Details of the fund transfer refund.
|
||||
$ref: '#/components/schemas/RefundFundsTransferNotificationContent'
|
||||
error:
|
||||
description: Error information of failed request. No value provided here if no error occurred on processing.
|
||||
$ref: '#/components/schemas/NotificationErrorContainer'
|
||||
eventDate:
|
||||
description: The date and time when an event has been completed.
|
||||
format: date-time
|
||||
type: string
|
||||
eventType:
|
||||
description: The event type of the notification.
|
||||
type: string
|
||||
executingUserKey:
|
||||
description: The user or process that has triggered the notification.
|
||||
type: string
|
||||
live:
|
||||
description: 'Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment.'
|
||||
type: boolean
|
||||
pspReference:
|
||||
description: The PSP reference of the request from which the notification originates.
|
||||
type: string
|
||||
required:
|
||||
- executingUserKey
|
||||
- pspReference
|
||||
- eventType
|
||||
- live
|
||||
- eventDate
|
||||
- content
|
||||
RefundFundsTransferNotificationContent:
|
||||
properties:
|
||||
amount:
|
||||
description: The amount to be refunded.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
invalidFields:
|
||||
description: Invalid fields list.
|
||||
items:
|
||||
$ref: '#/components/schemas/ErrorFieldType'
|
||||
type: array
|
||||
merchantReference:
|
||||
description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
|
||||
type: string
|
||||
originalReference:
|
||||
description: A PSP reference of the original fund transfer.
|
||||
type: string
|
||||
status:
|
||||
description: The status of the fund transfer refund.
|
||||
$ref: '#/components/schemas/OperationStatus'
|
||||
required:
|
||||
- originalReference
|
||||
- amount
|
||||
RefundResult:
|
||||
properties:
|
||||
originalTransaction:
|
||||
@@ -1730,9 +2070,10 @@ components:
|
||||
|
||||
>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**
|
||||
|
||||
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Bank Account will be updated.**
|
||||
>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**
|
||||
type: string
|
||||
shareholderReference:
|
||||
description: Merchant reference to the Shareholder.
|
||||
type: string
|
||||
webAddress:
|
||||
description: The URL of the website of the contact.
|
||||
@@ -1788,17 +2129,23 @@ components:
|
||||
>Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.
|
||||
enum:
|
||||
- Chargeback
|
||||
- ChargebackCorrection
|
||||
- ChargebackCorrectionReceived
|
||||
- ChargebackReceived
|
||||
- ChargebackReversed
|
||||
- ChargebackReversedReceived
|
||||
- Converted
|
||||
- CreditFailed
|
||||
- CreditReversed
|
||||
- CreditReversedReceived
|
||||
- Credited
|
||||
- DebitFailed
|
||||
- DebitReversedReceived
|
||||
- Debited
|
||||
- DebitedReversed
|
||||
- Fee
|
||||
- FundTransfer
|
||||
- FundTransferReversed
|
||||
- ManualCorrected
|
||||
- Payout
|
||||
- PayoutReversed
|
||||
@@ -1897,6 +2244,7 @@ components:
|
||||
- Business
|
||||
- Individual
|
||||
- NonProfit
|
||||
- Partnership
|
||||
- PublicCompany
|
||||
type: string
|
||||
primaryCurrency:
|
||||
@@ -1956,7 +2304,7 @@ components:
|
||||
country:
|
||||
description: |-
|
||||
The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
|
||||
> If you don't know the country or are not collecting the country from the shopper, provide `countryCode` as `ZZ`.
|
||||
> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
|
||||
type: string
|
||||
houseNumberOrName:
|
||||
description: The number or name of the house.
|
||||
|
||||
@@ -210,6 +210,7 @@ components:
|
||||
- cardToken
|
||||
- checkCode
|
||||
- city
|
||||
- companyRegistration
|
||||
- country
|
||||
- countryCode
|
||||
- currency
|
||||
@@ -240,7 +241,6 @@ components:
|
||||
- idCardFront
|
||||
- idNumber
|
||||
- identityDocument
|
||||
- incorporatedAt
|
||||
- individualDetails
|
||||
- lastName
|
||||
- legalBusinessName
|
||||
@@ -280,6 +280,7 @@ components:
|
||||
- status
|
||||
- store
|
||||
- storeDetail
|
||||
- storeName
|
||||
- storeReference
|
||||
- street
|
||||
- taxId
|
||||
|
||||
Reference in New Issue
Block a user