Jay API- OAS Sample File
OAS Sample file
5 subscribers
31 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Jay API- OAS Sample File endpoints
| Method | Endpoint | Description |
|---|---|---|
| Platform | ||
| GET |
get-balancePlatforms-id /balancePlatforms/{id} |
Returns a balance platform. |
| GET |
get-balancePlatforms-id-accountHolders /balancePlatforms/{id}/accountHolders |
Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. For example, to limit the page to 5… |
| Grant offers | ||
| GET |
get-grantOffers /grantOffers |
Returns a list of all [grant offers](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-offers) available for `accountHolderId` specified as a query parameter. |
| GET |
get-grantOffers-grantOfferId /grantOffers/{grantOfferId} |
Returns the details of a single grant offer. |
| Payment instrument groups | ||
| GET |
get-paymentInstrumentGroups-id-transactionRules /paymentInstrumentGroups/{id}/transactionRules |
Returns a list of all the transaction rules associated with a payment instrument group. |
| GET |
get-paymentInstrumentGroups-id /paymentInstrumentGroups/{id} |
Returns the details of a payment instrument group. |
| POST |
post-paymentInstrumentGroups /paymentInstrumentGroups |
Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group. |
| Account holders | ||
| PATCH |
patch-accountHolders-id /accountHolders/{id} |
Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged. |
| POST |
post-accountHolders /accountHolders |
Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). |
| GET |
get-accountHolders-id /accountHolders/{id} |
Returns an account holder. |
| GET |
get-accountHolders-id-balanceAccounts /accountHolders/{id}/balanceAccounts |
Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 balance… |
| Payment instruments | ||
| PATCH |
patch-paymentInstruments-id /paymentInstruments/{id} |
Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still… |
| GET |
get-paymentInstruments-id-reveal /paymentInstruments/{id}/reveal |
Returns the primary account number (PAN) of a payment instrument. To make this request, your API credential must have the following… |
| GET |
get-paymentInstruments-id-transactionRules /paymentInstruments/{id}/transactionRules |
Returns a list of transaction rules associated with a payment instrument. |
| GET |
get-paymentInstruments-id /paymentInstruments/{id} |
Returns the details of a payment instrument. |
| POST |
post-paymentInstruments /paymentInstruments |
Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue… |
| Grant accounts | ||
| GET |
get-grantAccounts-id /grantAccounts/{id} |
Returns the details of the [grant account](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-account). |
| Bank account validation | ||
| POST |
post-validateBankAccountIdentification /validateBankAccountIdentification |
Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a… |
| Balance accounts | ||
| GET |
get-balanceAccounts-balanceAccountId-sweeps-sweepId /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} |
Returns a sweep. |
| PATCH |
patch-balanceAccounts-id /balanceAccounts/{id} |
Updates a balance account. |
| GET |
get-balanceAccounts-balanceAccountId-sweeps /balanceAccounts/{balanceAccountId}/sweeps |
Returns a list of the sweeps configured for a balance account. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first… |
| GET |
get-balanceAccounts-id /balanceAccounts/{id} |
Returns a balance account and its balances for the default currency and other currencies with a non-zero balance. |
| GET |
get-balanceAccounts-id-paymentInstruments /balanceAccounts/{id}/paymentInstruments |
Returns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3… |
| PATCH |
patch-balanceAccounts-balanceAccountId-sweeps-sweepId /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} |
Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged. |
| DELETE |
delete-balanceAccounts-balanceAccountId-sweeps-sweepId /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} |
Deletes a sweep for a balance account. |
| POST |
post-balanceAccounts-balanceAccountId-sweeps /balanceAccounts/{balanceAccountId}/sweeps |
Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a… |
| POST |
post-balanceAccounts /balanceAccounts |
Creates a balance account that holds the funds of the associated account holder. |
| Transaction rules | ||
| DELETE |
delete-transactionRules-transactionRuleId /transactionRules/{transactionRuleId} |
Deletes a transaction rule. |
| PATCH |
patch-transactionRules-transactionRuleId /transactionRules/{transactionRuleId} |
Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left… |
| POST |
post-transactionRules /transactionRules |
Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or… |
| GET |
get-transactionRules-transactionRuleId /transactionRules/{transactionRuleId} |
Returns the details of a transaction rule. |
Jay API- OAS Sample File pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
