jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated specification for the Recurring API

Browse Source
This commit is contained in:
Aleksei Akimov
2018-04-01 14:53:39 +02:00
committed by GitHub
parent 0deaf58747
commit 93bb2fedc6
1 changed files with 35 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
specs/3.0/RecurringService-V25.json
View File

@@ -108,34 +108,31 @@
"Address" : { "Address" : {
"properties" : { "properties" : {
"city" : { "city" : {
"description" : "The city name.", "description" : "The name of the city.\n>Required if either houseNumberOrName, street, postalCode, or stateOrProvince are provided.",
"type" : "string" "type" : "string"
}, },
"country" : { "country" : {
"description" : "A valid value is an ISO two-character country code (e.g. 'NL').", "description" : "The two-character country code of the address\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",
"type" : "string" "type" : "string"
}, },
"houseNumberOrName" : { "houseNumberOrName" : {
"description" : "The house number or name.", "description" : "The number or name of the house.",
"type" : "string" "type" : "string"
}, },
"postalCode" : { "postalCode" : {
"description" : "The postal code with a maximum of 5 characters for USA and maximum of 10 characters for any other country.", "description" : "The postal code.\n>A maximum of five (5) digits for an address in the USA, or a maximum of ten (10) characters for an address in all other countries.\n>Required if either houseNumberOrName, street, city, or stateOrProvince are provided.",
"type" : "string" "type" : "string"
}, },
"stateOrProvince" : { "stateOrProvince" : {
"description" : "For USA or Canada, a valid 2-character abbreviation for the state or province respectively. For other countries any abbreviation with maximum 3 characters for the state or province.", "description" : "The abbreviation of the state or province.\n>Two (2) characters for an address in the USA or Canada, or a maximum of three (3) characters for an address in all other countries.\n>Required for an address in the USA or Canada if either houseNumberOrName, street, city, or postalCode are provided.",
"type" : "string" "type" : "string"
}, },
"street" : { "street" : {
"description" : "The street name.\n> Don't append the house number to this field. Instead, pass the house number separately as `houseNumberOrName`.\n", "description" : "The name of the street.\n>The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.\n>Required if either houseNumberOrName, city, postalCode, or stateOrProvince are provided.",
"type" : "string" "type" : "string"
} }
}, },
"required" : [ "required" : [
"street",
"houseNumberOrName",
"city",
"country" "country"
] ]
}, },
@@ -263,46 +260,20 @@
}, },
"DisableResult" : { "DisableResult" : {
"properties" : { "properties" : {
"details" : {
"description" : "A list of one or more recurring payment details that were disabled.",
"items" : {
"$ref" : "#/components/schemas/RecurringDetail"
},
"type" : "array"
},
"response" : { "response" : {
"description" : "Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].", "description" : "Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].",
"type" : "string" "type" : "string"
} }
} }
}, },
"ELV" : {
"properties" : {
"accountHolderName" : {
"type" : "string"
},
"bankAccountNumber" : {
"type" : "string"
},
"bankLocation" : {
"type" : "string"
},
"bankLocationId" : {
"type" : "string"
},
"bankName" : {
"type" : "string"
}
}
},
"Name" : { "Name" : {
"properties" : { "properties" : {
"firstName" : { "firstName" : {
"description" : "A person's first name.", "description" : "The first name.",
"type" : "string" "type" : "string"
}, },
"gender" : { "gender" : {
"description" : "A person's gender (can be unknown).", "description" : "The gender.\n>The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`.",
"enum" : [ "enum" : [
"MALE", "MALE",
"FEMALE", "FEMALE",
@@ -313,11 +284,11 @@
"type" : "string" "type" : "string"
}, },
"infix" : { "infix" : {
"description" : "A person name's infix, if applicable. Maximum length: 20 characters.", "description" : "The name's infix, if applicable.\n>A maximum length of twenty (20) characters is imposed.",
"type" : "string" "type" : "string"
}, },
"lastName" : { "lastName" : {
"description" : "A person's last name.", "description" : "The last name.",
"type" : "string" "type" : "string"
} }
}, },
@@ -330,7 +301,7 @@
"Recurring" : { "Recurring" : {
"properties" : { "properties" : {
"contract" : { "contract" : {
"description" : "The type of recurring contract to be used.\nPossible values:\n* `ONECLICK` – The shopper opts to store their card details for future use. The shopper is present for the subsequent transaction, for cards the security code (CVC/CVV) is required.\n* `RECURRING` – Payment details are stored for future use. For cards, the security code (CVC/CVV) is not required for subsequent payments. This is used for shopper not present transactions.\n* `ONECLICK,RECURRING` – Payment details are stored for future use. This allows the use of the stored payment details regardless of whether the shopper is on your site or not.", "description" : "The type of recurring contract to be used.\nPossible values:\n* `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/developers/payment-glossary#cardsecuritycodecvccvvcid).\n* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/developers/payment-glossary#cardnotpresentcnp).\n* `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not.\n* `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/developers/features/third-party-payouts).",
"enum" : [ "enum" : [
"ONECLICK", "ONECLICK",
"RECURRING", "RECURRING",
@@ -345,7 +316,8 @@
"tokenService" : { "tokenService" : {
"description" : "The name of the token service.", "description" : "The name of the token service.",
"enum" : [ "enum" : [
"VISATOKENSERVICE" "VISATOKENSERVICE",
"MCTOKENSERVICE"
], ],
"type" : "string" "type" : "string"
} }
@@ -353,73 +325,78 @@
}, },
"RecurringDetail" : { "RecurringDetail" : {
"properties" : { "properties" : {
"acquirer" : {
"type" : "string"
},
"acquirerAccount" : {
"type" : "string"
},
"additionalData" : { "additionalData" : {
"additionalProperties" : { "additionalProperties" : {
"type" : "string" "type" : "string"
}, },
"description" : "This field contains additional data, which may be returned in a particular response.\n\nThe additionalData object consists of entries, each of which includes the key and value. For more information on possible key-value pairs, refer to [RecurringDetail.additionalData](https://docs.adyen.com/developers/api-reference/recurring-api#recurringdetailadditionaldata).",
"type" : "object" "type" : "object"
}, },
"alias" : { "alias" : {
"description" : "The alias of the credit card number.\n\nApplies only to recurring contracts storing credit card details",
"type" : "string" "type" : "string"
}, },
"aliasType" : { "aliasType" : {
"description" : "The alias type of the credit card number.\n\nApplies only to recurring contracts storing credit card details.",
"type" : "string" "type" : "string"
}, },
"bank" : { "bank" : {
"description" : "A container for bank account data.",
"$ref" : "#/components/schemas/BankAccount" "$ref" : "#/components/schemas/BankAccount"
}, },
"billingAddress" : { "billingAddress" : {
"description" : "The billing address.",
"$ref" : "#/components/schemas/Address" "$ref" : "#/components/schemas/Address"
}, },
"card" : { "card" : {
"description" : "A container for card data.",
"$ref" : "#/components/schemas/Card" "$ref" : "#/components/schemas/Card"
}, },
"contractTypes" : { "contractTypes" : {
"description" : "Types of recurring contracts.",
"items" : { "items" : {
"type" : "string" "type" : "string"
}, },
"type" : "array" "type" : "array"
}, },
"creationDate" : { "creationDate" : {
"description" : "The date when the recurring details were created.",
"format" : "date-time", "format" : "date-time",
"type" : "string" "type" : "string"
}, },
"elv" : {
"$ref" : "#/components/schemas/ELV"
},
"firstPspReference" : { "firstPspReference" : {
"description" : "The `pspReference` of the first recurring payment that created the recurring detail.",
"type" : "string" "type" : "string"
}, },
"name" : { "name" : {
"description" : "An optional descriptive name for this recurring detail", "description" : "An optional descriptive name for this recurring detail.",
"type" : "string" "type" : "string"
}, },
"paymentMethodVariant" : { "paymentMethodVariant" : {
"description" : "The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/developers/api-reference/common-api/paymentmethodvariant).",
"type" : "string" "type" : "string"
}, },
"recurringDetailReference" : { "recurringDetailReference" : {
"description" : "The reference that uniquely identifies the recurring detail", "description" : "The reference that uniquely identifies the recurring detail.",
"type" : "string" "type" : "string"
}, },
"shopperName" : { "shopperName" : {
"description" : "The name of the shopper.",
"$ref" : "#/components/schemas/Name" "$ref" : "#/components/schemas/Name"
}, },
"socialSecurityNumber" : { "socialSecurityNumber" : {
"description" : "A shopper's social security number (only in countries where it is legal to collect).",
"type" : "string" "type" : "string"
}, },
"tokenDetails" : {
"$ref" : "#/components/schemas/TokenDetails"
},
"variant" : { "variant" : {
"description" : "The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\".",
"type" : "string" "type" : "string"
} }
} },
"required" : [
"recurringDetailReference",
"variant"
]
}, },
"RecurringDetailsRequest" : { "RecurringDetailsRequest" : {
"properties" : { "properties" : {
@@ -449,15 +426,12 @@
"type" : "string" "type" : "string"
}, },
"details" : { "details" : {
"description" : "A list of one or more recurring payment details.", "description" : "Payment details stored for recurring payments.",
"items" : { "items" : {
"$ref" : "#/components/schemas/RecurringDetail" "$ref" : "#/components/schemas/RecurringDetail"
}, },
"type" : "array" "type" : "array"
}, },
"invalidOneclickContracts" : {
"type" : "boolean"
},
"lastKnownShopperEmail" : { "lastKnownShopperEmail" : {
"description" : "The most recent email for this shopper (if available).", "description" : "The most recent email for this shopper (if available).",
"type" : "string" "type" : "string"
@@ -467,20 +441,7 @@
"type" : "string" "type" : "string"
} }
} }
},
"TokenDetails" : {
"properties" : {
"tokenData" : {
"additionalProperties" : {
"type" : "string"
},
"type" : "object"
},
"tokenDataType" : {
"type" : "string"
}
}
} }
} }
} }
} }