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
Files
68a6f20331f902ae8ca6abe3229c39ae7bf445b7
adyen-openapi/yaml/BalancePlatformConfigurationNotification-v1.yaml
Adyen Automation 6042268809 spec release
2022-11-17 10:08:29 +00:00

1828 lines
69 KiB
YAML
Raw Blame History

openapi: 3.1.0
info:
version: '1'
x-publicVersion: true
title: Configuration notifications
description: "Adyen sends notifications through webhooks to inform your system about\
\ events that occur in your platform. These events include, for example, when\
\ an account holder's capabilities are updated, or when a sweep configuration\
\ is created or updated. \nWhen an event occurs, Adyen makes an HTTP POST request\
\ to a URL on your server and includes the details of the event in the request\
\ body.\n\nYou can use these webhooks to build your implementation. For example,\
\ you can use this information to update internal statuses when the status of\
\ a capability is changed."
x-timestamp: '2022-11-14T18:27:39Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://www.adyen.help/hc/en-us/community/topics
email: developer-experience@adyen.com
x-groups:
- Account holder
- Balance account
- Payment instrument
tags: []
x-staticResponse: response.json
webhooks:
balancePlatform.accountHolder.created:
post:
tags:
- Account holder
summary: Account holder created
description: Adyen sends this webhook when you successfully [create an account
holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders).
operationId: post-balancePlatform.accountHolder.created
x-groupName: Account holder
x-sortIndex: 1
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-accountHolder-created:
$ref: '#/components/examples/post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created'
schema:
$ref: '#/components/schemas/AccountHolderNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-accountHolder-created:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.accountHolder.updated:
post:
tags:
- Account holder
summary: Account holder updated
description: Adyen sends this webhook when you successfully [update an account
holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/patch/accountHolders/{id}).
operationId: post-balancePlatform.accountHolder.updated
x-groupName: Account holder
x-sortIndex: 2
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-accountHolder-updated:
$ref: '#/components/examples/post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated'
schema:
$ref: '#/components/schemas/AccountHolderNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-accountHolder-updated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.balanceAccount.created:
post:
tags:
- Balance account
summary: Balance account created
description: Adyen sends this webhook when you successfully [create a balance
account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts).
operationId: post-balancePlatform.balanceAccount.created
x-groupName: Balance account
x-sortIndex: 1
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-balanceAccount-created:
$ref: '#/components/examples/post-balancePlatform.balanceAccount.created-balancePlatform-balanceAccount-created'
schema:
$ref: '#/components/schemas/BalanceAccountNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-balanceAccount-created:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.balanceAccount.updated:
post:
tags:
- Balance account
summary: Balance account updated
description: Adyen sends this webhook when you successfully [update a balance
account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/patch/balanceAccounts/{id}).
operationId: post-balancePlatform.balanceAccount.updated
x-groupName: Balance account
x-sortIndex: 2
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-balanceAccount-updated:
$ref: '#/components/examples/post-balancePlatform.balanceAccount.updated-balancePlatform-balanceAccount-updated'
schema:
$ref: '#/components/schemas/BalanceAccountNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-balanceAccount-updated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.balanceAccountSweep.created:
post:
tags:
- Balance account
summary: Sweep created
description: Adyen sends this webhook when you successfully [create a sweep](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts/{balanceAccountId}/sweeps).
operationId: post-balancePlatform.balanceAccountSweep.created
x-groupName: Balance account
x-sortIndex: 3
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-sweep-created:
$ref: '#/components/examples/post-balancePlatform.balanceAccountSweep.created-balancePlatform-sweep-created'
schema:
$ref: '#/components/schemas/SweepConfigurationNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-sweep-created:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.balanceAccountSweep.deleted:
post:
tags:
- Balance account
summary: Sweep deleted
description: Adyen sends this webhook when you successfully [delete a sweep](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/delete/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}).
operationId: post-balancePlatform.balanceAccountSweep.deleted
x-groupName: Balance account
x-sortIndex: 5
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-sweep-deleted:
$ref: '#/components/examples/post-balancePlatform.balanceAccountSweep.deleted-balancePlatform-sweep-deleted'
schema:
$ref: '#/components/schemas/SweepConfigurationNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-sweep-deleted:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.balanceAccountSweep.updated:
post:
tags:
- Balance account
summary: Sweep updated
description: Adyen sends this webhook when you successfully [update a sweep](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/patch/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}).
operationId: post-balancePlatform.balanceAccountSweep.updated
x-groupName: Balance account
x-sortIndex: 4
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-sweep-updated:
$ref: '#/components/examples/post-balancePlatform.balanceAccountSweep.updated-balancePlatform-sweep-updated'
schema:
$ref: '#/components/schemas/SweepConfigurationNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-sweep-updated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.paymentInstrument.created:
post:
tags:
- Payment instrument
summary: Payment instrument created
description: "Adyen sends this webhook when you successfully [create a payment\
\ instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments).\
\ \n>The notification does not include the card number when creating virtual\
\ cards. You can only get the card number in the response of the POST [/paymentInstruments](https://docs.adyen.com/api-explorer/balanceplatform/2/post/paymentInstruments#responses-200-card-number)\
\ request."
operationId: post-balancePlatform.paymentInstrument.created
x-groupName: Payment instrument
x-sortIndex: 1
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-paymentInstrument-created:
$ref: '#/components/examples/post-balancePlatform.paymentInstrument.created-balancePlatform-paymentInstrument-created'
schema:
$ref: '#/components/schemas/PaymentNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-paymentInstrument-created:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
balancePlatform.paymentInstrument.updated:
post:
tags:
- Payment instrument
summary: Payment instrument updated
description: 'Adyen sends this webhook when you successfully [update a payment
instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/patch/paymentInstruments/{id}). '
operationId: post-balancePlatform.paymentInstrument.updated
x-groupName: Payment instrument
x-sortIndex: 2
security:
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
balancePlatform-paymentInstrument-updated:
$ref: '#/components/examples/post-balancePlatform.paymentInstrument.updated-balancePlatform-paymentInstrument-updated'
schema:
$ref: '#/components/schemas/PaymentNotificationRequest'
responses:
'200':
content:
application/json:
examples:
balancePlatform-paymentInstrument-updated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
components:
schemas:
AccountHolder:
properties:
balancePlatform:
description: The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id)
to which the account holder belongs. Required in the request if your API
credentials can be used for multiple balance platforms.
type: string
capabilities:
additionalProperties:
$ref: '#/components/schemas/AccountHolderCapability'
description: Contains key-value pairs that specify the actions that an account
holder can do in your platform. The key is a capability required for your
integration. For example, **issueCard** for Issuing. The value is an object
containing the settings for the capability.
type: object
closureReason:
description: "Contains the reason for which an account is closed i.e. AccountStatus\
\ is Closed. Can be one of the following: \"fraud\u201D, \u201CviolatedTerms\u201D\
, \u201CfinancialRequirements\u201D, \"byUserRequest\""
enum:
- byUserRequest
- financialLiability
- fraud
- termsOfService
type: string
contactDetails:
description: Contact details of the account holder.
$ref: '#/components/schemas/ContactDetails'
description:
description: Your description for the account holder, maximum 300 characters.
maxLength: 300
type: string
id:
description: The unique identifier of the account holder.
type: string
legalEntityId:
description: The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id)
associated with the account holder. Adyen performs a verification process
against the legal entity of the account holder.
type: string
primaryBalanceAccount:
description: The ID of the account holder's primary balance account. By
default, this is set to the first balance account that you create for
the account holder. To assign a different balance account, send a PATCH
request.
type: string
reference:
description: Your reference for the account holder, maximum 150 characters.
maxLength: 150
type: string
status:
description: "The status of the account holder.\n\nPossible values: \n\n\
\ * **Active**: The account holder is active. This is the default status\
\ when creating an account holder. \n\n * **Inactive**: The account holder\
\ is temporarily inactive due to missing KYC details. You can set the\
\ account back to active by providing the missing KYC details. \n\n *\
\ **Suspended**: The account holder is permanently deactivated by Adyen.\
\ This action cannot be undone. \n\n* **Closed**: The account holder is\
\ permanently deactivated by you. This action cannot be undone."
enum:
- Active
- Closed
- Inactive
- Suspended
type: string
timeZone:
description: 'The [time zone](https://www.iana.org/time-zones) of the account
holder. For example, **Europe/Amsterdam**.
If not set, the time zone of the balance account will be used. For possible
values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).'
type: string
verificationDeadlines:
description: List of the verification deadlines for capabilities for the
legal entity.
items:
$ref: '#/components/schemas/VerificationDeadline'
type: array
required:
- legalEntityId
- id
AccountHolderCapability:
properties:
allowed:
description: Indicates whether the capability is allowed. Adyen sets this
to **true** if the verification is successful and the account holder is
permitted to use the capability.
type: boolean
allowedLevel:
description: 'The capability level that is allowed for the account holder.
Possible values: **notApplicable**, **low**, **medium**, **high**.'
enum:
- high
- low
- medium
- notApplicable
type: string
allowedSettings:
description: A JSON object containing the settings that are allowed for
the account holder.
$ref: '#/components/schemas/JSONObject'
enabled:
description: Indicates whether the capability is enabled. If **false**,
the capability is temporarily disabled for the account holder.
type: boolean
problems:
description: Contains verification errors and the actions that you can take
to resolve them.
items:
$ref: '#/components/schemas/CapabilityProblem'
type: array
requested:
description: Indicates whether the capability is requested. To check whether
the account holder is permitted to use the capability, refer to the `allowed`
field.
type: boolean
requestedLevel:
description: 'The requested level of the capability. Some capabilities,
such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels),
have different levels. Levels increase the capability, but also require
additional checks and increased monitoring.
Possible values: **notApplicable**, **low**, **medium**, **high**.'
enum:
- high
- low
- medium
- notApplicable
type: string
requestedSettings:
description: A JSON object containing the settings that were requested for
the account holder.
$ref: '#/components/schemas/JSONObject'
transferInstruments:
description: 'Contains the status of the transfer instruments associated
with this capability. '
items:
$ref: '#/components/schemas/AccountSupportingEntityCapability'
type: array
verificationStatus:
description: 'The status of the verification checks for the capability.
Possible values:
* **pending**: Adyen is running the verification.
* **invalid**: The verification failed. Check if the `errors` array contains
more information.
* **valid**: The verification has been successfully completed.
* **rejected**: Adyen has verified the information, but found reasons
to not allow the capability.
'
enum:
- invalid
- pending
- rejected
- valid
type: string
AccountHolderNotificationData:
properties:
accountHolder:
description: Contains information about the account holder resource that
triggered the event.
$ref: '#/components/schemas/AccountHolder'
balancePlatform:
description: Unique identifier of the balance platform.
type: string
AccountHolderNotificationRequest:
properties:
data:
description: Contains event details.
$ref: '#/components/schemas/AccountHolderNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
enum:
- balancePlatform.accountHolder.updated
- balancePlatform.accountHolder.created
type: string
required:
- environment
- type
- data
AccountSupportingEntityCapability:
properties:
allowed:
description: Indicates whether the supporting entity capability is allowed.
Adyen sets this to **true** if the verification is successful and the
account holder is permitted to use the capability.
type: boolean
allowedLevel:
description: 'The capability level that is allowed for the account holder.
Possible values: **notApplicable**, **low**, **medium**, **high**.'
enum:
- high
- low
- medium
- notApplicable
type: string
enabled:
description: Indicates whether the capability is enabled. If **false**,
the capability is temporarily disabled for the account holder.
type: boolean
id:
description: The ID of the supporting entity.
type: string
problems:
description: Contains verification errors and the actions that you can take
to resolve them.
items:
$ref: '#/components/schemas/CapabilityProblem'
type: array
requested:
description: Indicates whether the capability is requested. To check whether
the account holder is permitted to use the capability, refer to the `allowed`
field.
type: boolean
requestedLevel:
description: 'The requested level of the capability. Some capabilities,
such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels),
have different levels. Levels increase the capability, but also require
additional checks and increased monitoring.
Possible values: **notApplicable**, **low**, **medium**, **high**.'
enum:
- high
- low
- medium
- notApplicable
type: string
verificationStatus:
description: 'The status of the verification checks for the supporting entity
capability.
Possible values:
* **pending**: Adyen is running the verification.
* **invalid**: The verification failed. Check if the `errors` array contains
more information.
* **valid**: The verification has been successfully completed.
* **rejected**: Adyen has verified the information, but found reasons
to not allow the capability.
'
enum:
- invalid
- pending
- rejected
- valid
type: string
Address:
properties:
city:
description: 'The name of the city. Maximum length: 3000 characters.'
maxLength: 3000
type: string
country:
description: 'The two-character ISO-3166-1 alpha-2 country code. For example,
**US**.
> 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. Maximum length: 3000 characters.'
maxLength: 3000
type: string
postalCode:
description: A maximum of five digits for an address in the US, or a maximum
of ten characters for an address in all other countries.
type: string
stateOrProvince:
description: 'The two-character ISO 3166-2 state or province code. For example,
**CA** in the US or **ON** in Canada.
> Required for the US and Canada.'
type: string
street:
description: 'The name of the street. Maximum length: 3000 characters.
> The house number should not be included in this field; it should be
separately provided via `houseNumberOrName`.'
maxLength: 3000
type: string
required:
- street
- houseNumberOrName
- city
- postalCode
- country
Amount:
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
maxLength: 3
minLength: 3
type: string
value:
description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
- value
- currency
Authentication:
properties:
email:
description: The email address where the one-time password (OTP) is sent.
type: string
password:
description: "The password used for 3D Secure password-based authentication.\
\ The value must be between 1 to 30 characters and must only contain the\
\ following supported characters.\n\n* Characters between **a-z**, **A-Z**,\
\ and **0-9**\n\n* Special characters: **\xE4\xF6\xFC\xDF\xC4\xD6\xDC\
+-*/\xE7%()=?!~#'\",;:$&\xE0\xF9\xF2\xE2\xF4\xFB\xE1\xFA\xF3**"
maxLength: 30
minLength: 1
type: string
phone:
description: 'The phone number where the one-time password (OTP) is sent.
This object must have:
* A `type` set to **mobile**.
* A `number` with a valid country code.
* A `number` with more than 4 digits, excluding the country code.
>Make sure to verify that the card user owns the phone number.'
$ref: '#/components/schemas/Phone'
Balance:
properties:
available:
description: The remaining amount available for spending.
format: int64
type: integer
balance:
description: The total amount in the balance.
format: int64
type: integer
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
of the balance.
type: string
reserved:
description: The amount reserved for payments that have been authorised,
but have not been captured yet.
format: int64
type: integer
required:
- currency
- balance
- reserved
- available
BalanceAccount:
properties:
accountHolderId:
description: The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id)
associated with the balance account.
type: string
balances:
description: List of balances with the amount and currency.
items:
$ref: '#/components/schemas/Balance'
type: array
defaultCurrencyCode:
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
of the balance account.
The default value is **EUR**.'
type: string
description:
description: A human-readable description of the balance account, maximum
300 characters. You can use this parameter to distinguish between multiple
balance accounts under an account holder.
maxLength: 300
type: string
id:
description: The unique identifier of the balance account.
type: string
paymentInstruments:
description: List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments)
associated with the balance account.
items:
$ref: '#/components/schemas/PaymentInstrumentReference'
type: array
reference:
description: Your reference for the balance account, maximum 150 characters.
maxLength: 150
type: string
status:
description: "The status of the balance account, set to **Active** by default.\
\ \n"
enum:
- Active
- Closed
- Inactive
- Suspended
type: string
sweepConfigurations:
additionalProperties:
$ref: '#/components/schemas/SweepConfiguration'
description: 'Contains key-value pairs that specify configurations for balance
sweeps per currency code. A sweep pulls in or pushes out funds based on
a defined schedule, amount, and a source (for pulling funds) or a destination
(for pushing funds).
The key must be a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
in uppercase. For example, **EUR**. The value must be an object containing
the sweep configuration.'
type: object
timeZone:
description: 'The [time zone](https://www.iana.org/time-zones) of the balance
account. For example, **Europe/Amsterdam**.
If not set, the time zone of the account holder will be used. For possible
values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).'
type: string
required:
- accountHolderId
- id
BalanceAccountNotificationData:
properties:
balanceAccount:
$ref: '#/components/schemas/BalanceAccount'
balancePlatform:
description: Unique identifier of the balance platform.
type: string
BalanceAccountNotificationRequest:
properties:
data:
description: Contains event details.
$ref: '#/components/schemas/BalanceAccountNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
enum:
- balancePlatform.balanceAccount.updated
- balancePlatform.balanceAccount.created
type: string
required:
- environment
- type
- data
BalancePlatformNotificationResponse:
properties:
notificationResponse:
description: Respond with **HTTP 200 OK** and `[accepted]` in the response
body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
type: string
BankAccount:
properties:
iban:
description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number)
(IBAN).
type: string
required:
- iban
BulkAddress:
properties:
city:
description: The name of the city.
type: string
company:
description: The name of the company.
type: string
country:
description: The two-character ISO-3166-1 alpha-2 country code. For example,
**US**.
type: string
email:
description: The email address.
type: string
houseNumberOrName:
description: The house number or name.
type: string
mobile:
description: The full telephone number.
type: string
postalCode:
description: 'The postal code.
Maximum length:
* 5 digits for addresses in the US.
* 10 characters for all other countries.'
type: string
stateOrProvince:
description: 'The two-letter ISO 3166-2 state or province code.
Maximum length: 2 characters for addresses in the US.'
type: string
street:
description: The streetname of the house.
type: string
required:
- country
CapabilityProblem: {}
Card:
properties:
authentication:
description: Contains the card user's password and mobile phone number.
This is required when you issue cards that can be used to make online
payments within the EEA and the UK, or can be added to digital wallets.
Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets)
for more information.
$ref: '#/components/schemas/Authentication'
bin:
description: The bank identification number (BIN) of the card number.
type: string
brand:
description: 'The brand of the payment instrument.
Possible values: **visa**, **mc**.'
type: string
brandVariant:
description: 'The brand variant of the payment instrument.
>Contact your Adyen Implementation Manager to get the values that are
relevant to your integration. Examples: **visadebit**, **mcprepaid**.'
type: string
cardholderName:
description: "The name of the cardholder.\n Maximum length: 26 characters."
maxLength: 26
type: string
configuration:
description: "Settings required when creating a physical card. \n\nReach\
\ out to your Adyen contact to get the values that you can send in this\
\ object."
$ref: '#/components/schemas/CardConfiguration'
cvc:
description: 'The CVC2 value of the card.
> The CVC2 is not sent by default. This is only returned in the `POST`
response for single-use virtual cards.'
type: string
deliveryContact:
description: The delivery contact (name and address) for physical card delivery.
$ref: '#/components/schemas/Contact'
expiration:
description: The expiration date of the card.
$ref: '#/components/schemas/Expiry'
formFactor:
description: 'The form factor of the card.
Possible values: **virtual**, **physical**.'
enum:
- physical
- unknown
- virtual
type: string
lastFour:
description: Last last four digits of the card number.
type: string
number:
description: 'The primary account number (PAN) of the card.
> The PAN is masked by default and returned only for single-use virtual
cards.'
type: string
required:
- formFactor
- cardholderName
- brand
- brandVariant
- number
CardConfiguration:
properties:
activation:
description: Overrides the activation label design ID defined in the `configurationProfileId`.
The activation label is attached to the card and contains the activation
instructions.
type: string
activationUrl:
description: "Your app's URL, if you want to activate cards through your\
\ app. For example, **my-app://ref1236a7d**. A QR code is created based\
\ on this URL, and is included in the carrier. Before you use this field,\
\ reach out to your Adyen contact to set up the QR code process. \n\n\
Maximum length: 255 characters."
maxLength: 255
type: string
bulkAddress:
description: Overrides the shipment bulk address defined in the `configurationProfileId`.
$ref: '#/components/schemas/BulkAddress'
cardImageId:
description: The ID of the card image. This is the image that will be printed
on the full front of the card.
type: string
carrier:
description: Overrides the carrier design ID defined in the `configurationProfileId`.
The carrier is the letter or packaging to which the card is attached.
type: string
carrierImageId:
description: The ID of the carrier image. This is the image that will printed
on the letter to which the card is attached.
type: string
configurationProfileId:
description: 'The ID of the card configuration profile that contains the
settings of the card. For example, the envelope and PIN mailer designs
or the logistics company handling the shipment. All the settings in the
profile are applied to the card, unless you provide other fields to override
them.
For example, send the `shipmentMethod` to override the logistics company
defined in the card configuration profile.'
type: string
currency:
description: The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217)
currency code of the card. For example, **EUR**.
type: string
envelope:
description: 'Overrides the envelope design ID defined in the `configurationProfileId`. '
type: string
insert:
description: Overrides the insert design ID defined in the `configurationProfileId`.
An insert is any additional material, such as marketing materials, that
are shipped together with the card.
type: string
language:
description: The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
language code of the card. For example, **en**.
type: string
logoImageId:
description: The ID of the logo image. This is the image that will be printed
on the partial front of the card, such as a logo on the upper right corner.
type: string
pinMailer:
description: Overrides the PIN mailer design ID defined in the `configurationProfileId`.
The PIN mailer is the letter on which the PIN is printed.
type: string
shipmentMethod:
description: Overrides the logistics company defined in the `configurationProfileId`.
type: string
required:
- configurationProfileId
Contact:
properties:
address:
description: The address of the contact.
$ref: '#/components/schemas/Address'
email:
description: The e-mail address of the contact.
type: string
fullPhoneNumber:
description: 'The phone number of the contact provided as a single string. It
will be handled as a landline phone.
**Examples:** "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"'
type: string
name:
description: The name of the contact.
$ref: '#/components/schemas/Name'
personalData:
description: Personal data of the contact.
$ref: '#/components/schemas/PersonalData'
phoneNumber:
description: The phone number of the contact.
$ref: '#/components/schemas/PhoneNumber'
webAddress:
description: The URL of the website of the contact.
type: string
ContactDetails:
properties:
address:
description: The address of the account holder.
$ref: '#/components/schemas/Address'
email:
description: The email address of the account holder.
type: string
phone:
description: The phone number of the account holder.
$ref: '#/components/schemas/Phone'
webAddress:
description: The URL of the account holder's website.
type: string
required:
- email
- phone
- address
CronSweepSchedule:
additionalProperties: false
properties:
cronExpression:
description: 'A [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression)
that is used to set the sweep schedule. The schedule uses the time zone
of the balance account. For example, **30 17 * * MON** schedules a sweep
every Monday at 17:30.
The expression must have five values separated by a single space in the
following order:
* Minute: **0-59**
* Hour: **0-23**
* Day of the month: **1-31**
* Month: **1-12** or **JAN-DEC**
* Day of the week: **0-7** (0 and 7 are Sunday) or **MON-SUN**.
The following non-standard characters are supported: *****, **L**,
**#**, **W** and **/**. See [crontab guru](https://crontab.guru/) for
more examples.'
type: string
type:
description: 'The schedule type.
Possible values:
* **cron**: push out funds based on a cron expression.
* **daily**: push out funds daily at 07:00 AM CET.
* **weekly**: push out funds every Monday at 07:00 AM CET.
* **monthly**: push out funds every first of the month at 07:00 AM CET.
* **balance**: pull in funds instantly if the balance is less than or
equal to the `triggerAmount`. You can only use this for sweeps of `type`
**pull** and when the source is a `merchantAccount` or `transferInstrument`.'
enum:
- daily
- weekly
- monthly
- balance
- cron
type: string
required:
- cronExpression
Expiry:
properties:
month:
description: The month in which the card will expire.
type: string
year:
description: The year in which the card will expire.
type: string
JSONObject:
properties:
paths:
items:
$ref: '#/components/schemas/JSONPath'
type: array
rootPath:
$ref: '#/components/schemas/JSONPath'
JSONPath:
properties:
content:
items:
type: string
type: array
Name:
properties:
firstName:
description: The first name.
type: string
lastName:
description: The last name.
type: string
required:
- firstName
- lastName
PaymentInstrument:
properties:
balanceAccountId:
description: The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id)
associated with the payment instrument.
type: string
bankAccount:
description: Contains the business account details. Returned when you create
a payment instrument with `type` **bankAccount**.
$ref: '#/components/schemas/BankAccount'
card:
description: Contains information about the card payment instrument. Returned
when you create a payment instrument with `type` **card**.
$ref: '#/components/schemas/Card'
description:
description: Your description for the payment instrument, maximum 300 characters.
maxLength: 300
type: string
id:
description: The unique identifier of the payment instrument.
type: string
issuingCountryCode:
description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
country code where the payment instrument is issued. For example, **NL**
or **US**.
type: string
paymentInstrumentGroupId:
description: The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id)
to which the payment instrument belongs.
type: string
reference:
description: Your reference for the payment instrument, maximum 150 characters.
maxLength: 150
type: string
status:
x-enum:
- description: The payment instrument has been requested. This state is
applicable when creating physical cards.
value: Requested
- description: The payment instrument is active and can be used to make
payments.
value: Active
- description: The payment instrument is inactive and cannot be used to
make payments.
value: Inactive
- description: The payment instrument is temporarily suspended and cannot
be used to make payments.
value: Suspended
- description: The payment instrument is permanently closed. This action
cannot be undone.
value: Closed
- description: The payment instrument is suspended. Either because it was
stolen or lost.
value: blocked
- description: The payment instrument is permanently closed. This action
cannot be undone.
value: discarded
description: "The status of the payment instrument. If a status is not specified\
\ when creating a payment instrument, it is set to **Active** by default.\
\ However, there can be exceptions for cards based on the `card.formFactor`\
\ and the `issuingCountryCode`. For example, when issuing physical cards\
\ in the US, the default status is **Requested**.\n\nPossible values:\
\ \n\n * **Active**: The payment instrument is active and can be used\
\ to make payments. \n\n * **Requested**: The payment instrument has been\
\ requested. This state is applicable for physical cards. \n\n* **Inactive**:\
\ The payment instrument is inactive and cannot be used to make payments.\
\ \n\n * **Suspended**: The payment instrument is temporarily suspended\
\ and cannot be used to make payments. \n\n * **Closed**: The payment\
\ instrument is permanently closed. This action cannot be undone. \n\n\
* **Stolen** \n\n * **Lost**\n\n "
enum:
- Active
- Closed
- Inactive
- Lost
- Requested
- Stolen
- Suspended
- blocked
- discarded
type: string
type:
description: 'Type of payment instrument.
Possible value: **card**, **bankAccount**. '
enum:
- bankAccount
- card
type: string
required:
- balanceAccountId
- issuingCountryCode
- type
- id
PaymentInstrumentNotificationData:
properties:
balancePlatform:
description: Unique identifier of the balance platform.
type: string
paymentInstrument:
description: Contains information about the payment instrument resource
that triggered the event.
$ref: '#/components/schemas/PaymentInstrument'
PaymentInstrumentReference:
properties:
id:
description: The unique identifier of the payment instrument.
type: string
required:
- id
PaymentNotificationRequest:
properties:
data:
description: Contains event details.
$ref: '#/components/schemas/PaymentInstrumentNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
enum:
- balancePlatform.paymentInstrument.created
- balancePlatform.paymentInstrument.updated
type: string
required:
- environment
- type
- data
PersonalData:
properties:
dateOfBirth:
description: 'The date of birth of the person.
The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).'
type: string
idNumber:
description: An ID number of the person.
type: string
nationality:
description: 'The nationality of the person represented by a two-character
country code.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').'
maxLength: 2
minLength: 2
type: string
Phone:
properties:
number:
description: "The full phone number provided as a single string. \nFor example,\
\ **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, \n\n or **\"(0031)\
\ 611223344\"**."
type: string
type:
description: "Type of phone number.\nPossible values: \n**Landline**, **Mobile**.\n"
enum:
- Landline
- Mobile
type: string
required:
- number
- type
PhoneNumber:
properties:
phoneCountryCode:
description: 'The two-character ISO-3166-1 alpha-2 country code of the phone
number.
For example, **US** or **NL**.'
type: string
phoneNumber:
description: 'The phone number.
The inclusion of the phone number country code is not necessary.'
type: string
phoneType:
description: 'The type of the phone number.
Possible values: **Landline**, **Mobile**, **SIP**, **Fax**.'
enum:
- Fax
- Landline
- Mobile
- SIP
type: string
required:
- phoneCountryCode
- phoneNumber
Resource:
properties:
balancePlatform:
description: Unique identifier of the balance platform.
type: string
creationDate:
description: Date and time when the event was triggered, in ISO 8601 extended
format. For example, **2020-12-18T10:15:30+01:00**.
format: date-time
type: string
id:
description: The ID of the resource.
type: string
SweepConfiguration:
properties:
balanceAccountId:
description: "The unique identifier of the destination or source [balance\
\ account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).\n\
\n You can only use this for periodic sweep schedules such as `schedule.type`\
\ **daily** or **monthly**."
type: string
id:
description: The unique identifier of the sweep.
type: string
merchantAccount:
description: The merchant account that will be the source of funds. You
can only use this if you are processing payments with Adyen. This can
only be used for sweeps of `type` **pull** and `schedule.type` **balance**.
type: string
schedule:
description: The schedule when the `triggerAmount` is evaluated. If the
balance meets the threshold, funds are pushed out of or pulled in to the
balance account.
oneOf:
- $ref: '#/components/schemas/CronSweepSchedule'
- $ref: '#/components/schemas/SweepSchedule'
status:
x-enum:
- description: The sweep is enabled and funds will be pulled in or pushed
out based on the defined configuration
value: active
- description: The sweep is disabled and cannot be triggered.
value: inactive
description: "The status of the sweep. If not provided, by default, this\
\ is set to **active**.\n\nPossible values: \n\n * **active**: the sweep\
\ is enabled and funds will be pulled in or pushed out based on the defined\
\ configuration. \n\n * **inactive**: the sweep is disabled and cannot\
\ be triggered. \n\n"
enum:
- active
- inactive
type: string
sweepAmount:
description: The amount that must be pushed out or pulled in. You can configure
either `sweepAmount` or `targetAmount`, not both.
$ref: '#/components/schemas/Amount'
targetAmount:
description: The amount that must be available in the balance account after
the sweep. You can configure either `sweepAmount` or `targetAmount`, not
both.
$ref: '#/components/schemas/Amount'
transferInstrumentId:
description: 'The unique identifier of the destination or source [transfer
instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments__resParam_id).
You can also use this in combination with a `merchantAccount` and a `type`
**pull** to start a direct debit request from the source transfer instrument.
To use this feature, reach out to your Adyen contact.'
type: string
triggerAmount:
description: 'The threshold amount that triggers the sweep. If not provided,
by default, the amount is set to zero. The `triggerAmount` is evaluated
according to the specified `schedule.type`.
* For `type` **pull**, if the balance is less than or equal to the `triggerAmount`,
funds are pulled in to the balance account.
* For `type` **push**, if the balance is more than or equal to the `triggerAmount`,
funds are pushed out of the balance account.'
$ref: '#/components/schemas/Amount'
type:
default: push
description: "The direction of sweep, whether pushing out or pulling in\
\ funds to the balance account. If not provided, by default, this is set\
\ to **push**.\n\nPossible values:\n\n * **push**: _push out funds_ to\
\ a destination balance account or transfer instrument.\n\n * **pull**:\
\ _pull in funds_ from a source merchant account, transfer instrument,\
\ or balance account."
enum:
- pull
- push
type: string
required:
- id
- schedule
SweepConfigurationNotificationData:
properties:
accountId:
description: The unique identifier of the balance account for which the
sweep was configured.
type: string
balancePlatform:
description: Unique identifier of the balance platform.
type: string
sweep:
description: Contains information about the sweep resource that triggered
the event.
$ref: '#/components/schemas/SweepConfigurationV2'
SweepConfigurationNotificationRequest:
properties:
data:
description: Contains event details.
$ref: '#/components/schemas/SweepConfigurationNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
enum:
- balancePlatform.balanceAccountSweep.created
- balancePlatform.balanceAccountSweep.updated
- balancePlatform.balanceAccountSweep.deleted
type: string
required:
- environment
- type
- data
SweepConfigurationV2:
properties:
counterparty:
description: 'The destination or the source of the funds, depending on the
`type`.
Either a `balanceAccountId`, `transferInstrumentId`, or `merchantAccount`
is required.'
$ref: '#/components/schemas/SweepCounterparty'
currency:
description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
in uppercase. For example, **EUR**.
The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).'
type: string
description:
description: 'The message that will be used in the sweep transfer''s description
body with a maximum length of 140 characters.
If the message is longer after replacing placeholders, the message will
be cut off at 140 characters.'
type: string
id:
description: The unique identifier of the sweep.
type: string
schedule:
description: The schedule when the `triggerAmount` is evaluated. If the
balance meets the threshold, funds are pushed out of or pulled in to the
balance account.
oneOf:
- $ref: '#/components/schemas/CronSweepSchedule'
- $ref: '#/components/schemas/SweepSchedule'
status:
x-enum:
- description: The sweep is enabled and funds will be pulled in or pushed
out based on the defined configuration
value: active
- description: The sweep is disabled and cannot be triggered.
value: inactive
description: "The status of the sweep. If not provided, by default, this\
\ is set to **active**.\n\nPossible values: \n\n * **active**: the sweep\
\ is enabled and funds will be pulled in or pushed out based on the defined\
\ configuration. \n\n * **inactive**: the sweep is disabled and cannot\
\ be triggered. \n\n"
enum:
- active
- inactive
type: string
sweepAmount:
description: The amount that must be pushed out or pulled in. You can configure
either `sweepAmount` or `targetAmount`, not both.
$ref: '#/components/schemas/Amount'
targetAmount:
description: The amount that must be available in the balance account after
the sweep. You can configure either `sweepAmount` or `targetAmount`, not
both.
$ref: '#/components/schemas/Amount'
triggerAmount:
description: 'The threshold amount that triggers the sweep. If not provided,
by default, the amount is set to zero. The `triggerAmount` is evaluated
according to the specified `schedule.type`.
* For `type` **pull**, if the balance is less than or equal to the `triggerAmount`,
funds are pulled in to the balance account.
* For `type` **push**, if the balance is more than or equal to the `triggerAmount`,
funds are pushed out of the balance account.'
$ref: '#/components/schemas/Amount'
type:
default: push
description: "The direction of sweep, whether pushing out or pulling in\
\ funds to the balance account. If not provided, by default, this is set\
\ to **push**.\n\nPossible values:\n\n * **push**: _push out funds_ to\
\ a destination balance account or transfer instrument.\n\n * **pull**:\
\ _pull in funds_ from a source merchant account, transfer instrument,\
\ or balance account."
enum:
- pull
- push
type: string
required:
- id
- schedule
- currency
- counterparty
SweepCounterparty:
properties:
balanceAccountId:
description: "The unique identifier of the destination or source [balance\
\ account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).\n\
\n You can only use this for periodic sweep schedules such as `schedule.type`\
\ **daily** or **monthly**."
type: string
merchantAccount:
description: The merchant account that will be the source of funds, if you
are processing payments with Adyen. You can only use this with sweeps
of `type` **pull** and `schedule.type` **balance**.
type: string
transferInstrumentId:
description: 'The unique identifier of the destination or source [transfer
instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments__resParam_id).
You can also use this in combination with a `merchantAccount` and a `type`
**pull** to start a direct debit request from the source transfer instrument.
To use this feature, reach out to your Adyen contact.'
type: string
SweepSchedule:
additionalProperties: false
properties:
type:
description: 'The schedule type.
Possible values:
* **cron**: push out funds based on a cron expression.
* **daily**: push out funds daily at 07:00 AM CET.
* **weekly**: push out funds every Monday at 07:00 AM CET.
* **monthly**: push out funds every first of the month at 07:00 AM CET.
* **balance**: pull in funds instantly if the balance is less than or
equal to the `triggerAmount`. You can only use this for sweeps of `type`
**pull** and when the source is a `merchantAccount` or `transferInstrument`.'
enum:
- daily
- weekly
- monthly
- balance
- cron
type: string
VerificationDeadline:
properties:
date:
description: The date that verification is due by before capabilities are
disallowed.
format: date-time
type: string
required:
- date
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-Key
type: apiKey
BasicAuth:
scheme: basic
type: http
examples:
WebhookAck:
summary: Acknowledge Webhook
value:
notificationResponse: '[accepted]'
post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created:
summary: Account holder created
description: Example webhook when an account holder was created
value:
data:
balancePlatform: YOUR_BALANCE_PLATFORM
accountHolder:
contactDetails: {}
description: Shelly Eller
legalEntityId: LE43319330319C8AYX89L2V59
reference: YOUR_REFERENCE-2412C
capabilities:
issueCard:
enabled: 'true'
requested: 'true'
allowed: 'false'
verificationStatus: pending
receiveFromTransferInstrument:
enabled: 'true'
requested: 'true'
allowed: 'false'
verificationStatus: pending
sendToTransferInstrument:
enabled: 'true'
requested: 'true'
allowed: 'false'
verificationStatus: pending
sendToBalanceAccount:
enabled: 'true'
requested: 'true'
allowed: 'false'
verificationStatus: pending
receiveFromBalanceAccount:
enabled: 'true'
requested: 'true'
allowed: 'false'
verificationStatus: pending
id: AH32272223222B5CZW6QZ2V34
status: Active
environment: test
type: balancePlatform.accountHolder.created
post-balancePlatform.accountHolder.updated-balancePlatform-accountHolder-updated:
summary: Account holder updated
description: Example webhook when an account holder was updated
value:
data:
balancePlatform: YOUR_BALANCE_PLATFORM
accountHolder:
description: Shelly Eller
legalEntityId: LE43319330319C8AYX89L2V59
reference: YOUR_REFERENCE-2412C
capabilities:
sendToTransferInstrument:
enabled: 'true'
requested: 'true'
allowed: 'false'
problems:
- entity:
id: LE43319330319C8AYX89L2V59
type: LegalEntity
verificationErrors:
- code: '2_8037'
message: No bankStatement available to perform verification.
remediatingActions:
- code: '1_703'
message: Upload a bank statement
type: dataMissing
verificationStatus: invalid
id: AH32272223222B5CZW6QZ2V34
status: Active
environment: test
type: balancePlatform.accountHolder.updated
post-balancePlatform.balanceAccount.created-balancePlatform-balanceAccount-created:
summary: Balance account created
description: Example webhook when a balance account was created
value:
data:
balancePlatform: YOUR_BALANCE_PLATFORM
balanceAccount:
accountHolderId: AH3227C223222B5CZW72CCC73
defaultCurrencyCode: EUR
id: BA3227C223222B5CZW72VCC75
status: Active
environment: test
type: balancePlatform.balanceAccount.created
post-balancePlatform.balanceAccount.updated-balancePlatform-balanceAccount-updated:
summary: Balance account updated
description: Example webhook when a balance account was updated
value:
data:
balancePlatform: YOUR_BALANCE_PLATFORM
balanceAccount:
accountHolderId: AH3227C223222B5CZW72CCC73
defaultCurrencyCode: EUR
id: BA3227C223222B5CZW72VCC75
status: Active
timeZone: Europe/Amsterdam
environment: test
type: balancePlatform.balanceAccount.updated
post-balancePlatform.balanceAccountSweep.created-balancePlatform-sweep-created:
summary: Sweep created
description: Example webhook when a sweep was created
value:
data:
balancePlatform: YOUR_BALANCE_PLATFORM
accountId: BA3227C223222B5FTD99V8GRS
sweep:
id: SWPC4227C224555B5FTD2NT2JV4WN5
schedule:
type: weekly
status: active
targetAmount:
currency: EUR
value: 0
triggerAmount:
currency: EUR
value: 0
type: push
counterparty:
balanceAccountId: BA32272223222B5FTD2KR6TJD
currency: EUR
environment: test
type: balancePlatform.balanceAccountSweep.created
post-balancePlatform.balanceAccountSweep.deleted-balancePlatform-sweep-deleted:
summary: Sweep deleted
description: Example webhook when a sweep was deleted
value:
data:
balancePlatform: YOUR_BALANCE_PLATFORM
accountId: BA3227C223222B5FTD99V8GRS
sweep:
id: SWPC4227C224555B5FTD2NT2JV4WN5
schedule:
type: weekly
status: active
targetAmount:
currency: EUR
value: 0
triggerAmount:
currency: EUR
value: 0
type: push
counterparty:
balanceAccountId: BA32272223222B5FTD2KR6TJD
currency: EUR
environment: test
type: balancePlatform.balanceAccountSweep.deleted
post-balancePlatform.balanceAccountSweep.updated-balancePlatform-sweep-updated:
summary: Sweep updated
description: Example webhook when a sweep was updated
value:
data:
balancePlatform: YOUR_BALANCE_PLATFORM
accountId: BA3227C223222B5FTD99V8GRS
sweep:
id: SWPC4227C224555B5FTD2NT2JV4WN5
schedule:
type: weekly
status: inactive
targetAmount:
currency: EUR
value: 0
triggerAmount:
currency: EUR
value: 0
type: push
counterparty:
balanceAccountId: BA32272223222B5FTD2KR6TJD
currency: EUR
environment: test
type: balancePlatform.balanceAccountSweep.created
post-balancePlatform.paymentInstrument.created-balancePlatform-paymentInstrument-created:
summary: Card updated
description: Example webhook when a card was updated
value:
data:
balancePlatform: YOUR_BALANCE_PLATFORM
paymentInstrument:
balanceAccountId: BA3227C223222B5CZW72VCC75
description: C. Holden - card
issuingCountryCode: GB
status: Suspended
type: card
card:
cardholderName: Carl Holden
formFactor: virtual
bin: '555544'
expiration:
month: '04'
year: '2024'
lastFour: '2732'
id: PI32272223222B5CZW7BQ2V3T
environment: test
type: balancePlatform.paymentInstrument.updated
post-balancePlatform.paymentInstrument.updated-balancePlatform-paymentInstrument-updated:
summary: Card created
description: Example webhook when a card was created
value:
data:
balancePlatform: YOUR_BALANCE_PLATFORM
paymentInstrument:
balanceAccountId: BA3227C223222B5CZW72VCC75
description: C. Holden - card
issuingCountryCode: GB
status: Active
type: card
card:
cardholderName: Carl Holden
formFactor: virtual
bin: '555544'
expiration:
month: '04'
year: '2024'
lastFour: '2732'
id: PI32272223222B5CZW7BQ2V3T
environment: test
type: balancePlatform.paymentInstrument.created
Reference in New Issue View Git Blame Copy Permalink