{ "opencollection": "1.0.0", "info": { "name": "Adyen Account acceptDispute Payments API", "version": "6" }, "items": [ { "info": { "name": "Payments", "type": "folder" }, "items": [ { "info": { "name": "Adyen Create a Payment Link", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentLinks", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." }, { "info": { "name": "Adyen Get a Payment Link", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentLinks/:linkId", "params": [ { "name": "linkId", "value": "", "type": "path", "description": "Unique identifier of the payment link." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the payment link details using the payment link `id`." }, { "info": { "name": "Adyen Update the Status of a Payment Link", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentLinks/:linkId", "params": [ { "name": "linkId", "value": "", "type": "path", "description": "Unique identifier of the payment link." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status)." }, { "info": { "name": "Adyen Get a List of Available Payment Methods", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentMethods", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paym" }, { "info": { "name": "Adyen Get the Balance of a Gift Card", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentMethods/balance", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object." }, { "info": { "name": "Adyen Create a Payment Session", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentSession", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." }, { "info": { "name": "Adyen Start a Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/payments", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Auth" }, { "info": { "name": "Adyen Submit Details for a Payment", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/payments/details", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n" }, { "info": { "name": "Adyen Verify a Payment Result", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/payments/result", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." }, { "info": { "name": "Adyen Update an Authorised Amount", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/payments/:paymentPspReference/amountUpdates", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "params": [ { "name": "paymentPspReference", "value": "", "type": "path", "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in " }, { "info": { "name": "Adyen Cancel an Authorised Payment", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/payments/:paymentPspReference/cancels", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "params": [ { "name": "paymentPspReference", "value": "", "type": "path", "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutServic" }, { "info": { "name": "Adyen Capture an Authorised Payment", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/payments/:paymentPspReference/captures", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "params": [ { "name": "paymentPspReference", "value": "", "type": "path", "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports mu" }, { "info": { "name": "Adyen Refund a Captured Payment", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/payments/:paymentPspReference/refunds", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "params": [ { "name": "paymentPspReference", "value": "", "type": "path", "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't ex" }, { "info": { "name": "Adyen Refund or Cancel a Payment", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/payments/:paymentPspReference/reversals", "headers": [ { "name": "Idempotency-Key", "value": "37ca9c97-d1d1-4c62-89e8-706891a563ed" } ], "params": [ { "name": "paymentPspReference", "value": "", "type": "path", "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse" }, { "info": { "name": "Adyen Get Tokens for Stored Payment Details", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/storedPaymentMethods", "params": [ { "name": "shopperReference", "value": "", "type": "query", "description": "Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address." }, { "name": "merchantAccount", "value": "", "type": "query", "description": "Your merchant account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper's payment. A summary of the stored details is included.\n\n" }, { "info": { "name": "Adyen Delete a Token for Stored Payment Details", "type": "http" }, "http": { "method": "DELETE", "url": "https://cal-test.adyen.com/cal/services/Account/v6/storedPaymentMethods/:storedPaymentMethodId", "params": [ { "name": "storedPaymentMethodId", "value": "", "type": "path", "description": "The unique identifier of the token." }, { "name": "shopperReference", "value": "", "type": "query", "description": "Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address." }, { "name": "merchantAccount", "value": "", "type": "query", "description": "Your merchant account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes the token identified in the path. The token can no longer be used with payment requests." }, { "info": { "name": "Adyen Create a Payment Instrument Group", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentInstrumentGroups", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group." }, { "info": { "name": "Adyen Get a Payment Instrument Group", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentInstrumentGroups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the payment instrument group." } ] }, "docs": "Returns the details of a payment instrument group." }, { "info": { "name": "Adyen Get All Transaction Rules for a Payment Instrument Group", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentInstrumentGroups/:id/transactionRules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the payment instrument group." } ] }, "docs": "Returns a list of all the transaction rules associated with a payment instrument group." }, { "info": { "name": "Adyen Create a Payment Instrument", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentInstruments", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user.\n\n For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." }, { "info": { "name": "Adyen Get a Payment Instrument", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentInstruments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the payment instrument." } ] }, "docs": "Returns the details of a payment instrument." }, { "info": { "name": "Adyen Update a Payment Instrument", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentInstruments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the payment instrument." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 update the balance account associated with the card." }, { "info": { "name": "Adyen List Network Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentInstruments/:id/networkTokens", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the payment instrument." } ] }, "docs": "List the network tokens connected to a payment instrument." }, { "info": { "name": "Adyen Get the PAN of a Payment Instrument", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentInstruments/:id/reveal", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the payment instrument." } ] }, "docs": "Returns the primary account number (PAN) of a payment instrument.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions):\n\n* Balance Platform BCL PCI role" }, { "info": { "name": "Adyen Get All Transaction Rules for a Payment Instrument", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/paymentInstruments/:id/transactionRules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the payment instrument." } ] }, "docs": "Returns a list of transaction rules associated with a payment instrument." } ] } ], "bundled": true }