Adyen

Online payments. Take card and wallet payments, capture or cancel an authorization, refund a shopper, and send payment links.

Measured routing accuracy

40 golden cases replayed through the router over the whole index: measured over corpus ea4f12ad2948 (65 toolkits, 2283 tools indexed and 13 declared uncallable), 27 cases written by hand and 13 cases from the paraphrase pass. A case counts as top-1 when its gold tool ranked first and top-8 when it reached the slate at all.

The sweep is offline: the reranker is a deterministic identity fake that returns candidates in the order retrieval produced them, so top-1 measures retrieval order rather than a reranked slate. just eval-live measures the same cases through the live reranker.

Authentication

Connect an entity with ConnectionsService.InitiateConnection, naming this toolkit's slug. Credentials stay in the connections vault; callers hold connected-account ids only.

api_key

Submit the key with ConnectionsService rather than putting it in a request; it is sealed at rest and never returned.

Tools

27 action tools. The catalog-wide slug is adyen_checkout.<tool>, which is what search_tools returns and call_tool takes.

adyen_checkout.post_apple_pay_sessions

Get an Apple Pay session. You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. Calls POST /applePay/sessions.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /applePay/sessions.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "start an apple pay merchant validation", "get the wallet handshake for our own certificate", "open a session so the pay sheet can show".

adyen_checkout.post_cancels

Cancel an authorised Adyen payment before capture using the pspReference in the request body rather than the URL: void a hold so it never settles. The body-reference form of the cancel operation. Calls POST /cancels.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /cancels.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "void a hold using the reference in the body", "reverse an authorisation without the url id", "undo an authorised charge by body reference".

adyen_checkout.post_card_details

Look up an Adyen card's brand and details from its number or BIN: tell which network or scheme a card belongs to and whether it is eligible. Calls POST /cardDetails.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /cardDetails.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "which brand does this card number belong to", "identify the scheme from a bin", "tell what network a card is on".

adyen_checkout.post_donation_campaigns

Get a list of donation campaigns. Queries the available donation campaigns for a donation based on the donation context (like merchant account, currency, and locale). Calls POST /donationCampaigns.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /donationCampaigns.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "which charities can a shopper give to", "available giving options for this account and currency", "list the causes offered at checkout".

adyen_checkout.post_donations

Add a charitable donation to an Adyen checkout: use a donation token from a payment to give a contribution to a cause on top of an order. Calls POST /donations.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /donations.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "add a charitable gift to this checkout", "let the shopper give to a cause", "include a contribution with the order".

adyen_checkout.post_forward

Forward stored payment details. Forwards the payment details you stored with Adyen to a third-party that you specify and returns the response from the third-party. Calls POST /forward.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /forward.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "send a saved card to a third party", "pass vaulted details on to another processor", "relay stored credentials outside adyen".

adyen_checkout.post_orders

Open an Adyen order for a partial or split payment: a basket that several payments, such as a gift card plus a card, can each pay toward until the total is covered. Calls POST /orders.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /orders.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "open a basket for a split payment", "let a gift card and a card both cover it", "start a partial payment container".

adyen_checkout.post_orders_cancel

Cancel an order. Cancels an order. Calls POST /orders/cancel.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /orders/cancel.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "stop an order", "call off an order", "back out of an order".

adyen_checkout.post_origin_keys

Create originKey values for domains. This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. Calls POST /originKeys.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /originKeys.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "keys that let our domains load the web components", "authorise a site to run the checkout widget", "issue browser-side identifiers per origin".

adyen_checkout.post_payment_links

Create an Adyen Pay by Link page: a hosted checkout URL you send a shopper so they can pay online without card entry in your own app. Use to bill someone by sending them a link. Calls POST /paymentLinks.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /paymentLinks.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "send the buyer a page to pay on", "bill someone with a hosted link", "share a checkout url with a shopper".

adyen_checkout.get_payment_links_link_id

Check an Adyen payment link by its id: whether the shopper opened it and finished paying, its current status and amount. Use to see if a link you sent was paid. Calls GET /paymentLinks/{linkId}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /paymentLinks/{{params.linkId}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "did the buyer pay on the link we sent", "status of the link we shared", "check if that hosted page was paid".

adyen_checkout.patch_payment_links_link_id

Update the status of a payment link. Updates the status of a payment link. Calls PATCH /paymentLinks/{linkId}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PATCH /paymentLinks/{{params.linkId}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "expire a pay-by-link url", "mark a shared payment request as no longer usable", "change whether a link still accepts money".

adyen_checkout.post_payment_methods

List the Adyen payment methods available for a checkout: the cards, wallets, and local options a buyer in a given country and currency can choose from. Use to show a shopper how they can pay. Calls POST /paymentMethods.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /paymentMethods.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "which ways can a buyer pay here", "what options does a shopper have at checkout", "show the wallets and cards for this country".

adyen_checkout.post_payment_methods_balance

Get the balance of a gift card. Retrieves the balance remaining on a shopper's gift card. Calls POST /paymentMethods/balance.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /paymentMethods/balance.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "how much is left on a gift card", "remaining value on a shopper's voucher", "check funds before splitting a payment".

adyen_checkout.post_payments

Start an Adyen payment: charge a shopper's card or wallet for an amount in a currency, taking money for a checkout or order. Use when someone wants to bill a buyer, collect a payment, or run a transaction. Calls POST /payments.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /payments.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "charge this shopper's card", "take money for the order", "bill the buyer for the total".

adyen_checkout.post_payments_details

Submit details for a payment. Submits details for a payment created using /payments. Calls POST /payments/details.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /payments/details.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "finish a payment after 3d secure", "send back the redirect result", "complete an authentication step the shopper did".

adyen_checkout.post_payments_payment_psp_reference_amount_updates

Update an authorised amount. Increases or decreases the authorised payment amount and returns a unique reference for this request. Calls POST /payments/{paymentPspReference}/amountUpdates.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /payments/{{params.paymentPspReference}}/amountUpdates.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "raise or lower an authorisation", "adjust the amount we are holding on a card", "change how much was reserved before capture".

adyen_checkout.post_payments_payment_psp_reference_cancels

Cancel an authorised Adyen payment before it is captured, by its pspReference from the original /payments call: void the hold so the shopper is never charged. Calls POST /payments/{paymentPspReference}/cancels.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /payments/{{params.paymentPspReference}}/cancels.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "call off that hold before it settles", "void the authorisation by its reference", "stop a charge we authorised earlier".

adyen_checkout.post_payments_payment_psp_reference_captures

Capture an authorised Adyen payment: take the funds that were held or reserved earlier so the money actually settles, by its pspReference. Use to collect on an authorisation. Calls POST /payments/{paymentPspReference}/captures.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /payments/{{params.paymentPspReference}}/captures.

Arguments: