{
  "opencollection": "1.0.0",
  "info": {
    "name": "Business Accounting Payout links API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Payout links",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a list of payout links",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://b2b.revolut.com/api/1.0/payout-links",
            "params": [
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Retrieves links in the specified state(s). Possible states are:\n- `created`: The payout link has been created, but the amount has not yet been [blocked](https://developer.revolut.com/docs/guides/manage-accounts/transfers/payout-links#sender-link-generation).\n- `failed`: The payout link couldn't be generated due to a failure during transaction booking.\n- `awaiting`: The payout link is awaiting approval.\n- `active`: The payout link can be redeemed.\n- `expired`: The payout link cannot be redeemed because it wasn't claimed before its expiry date.\n- `cancelled`: The payout link cannot be redeemed because it was cancelled.\n- `processing`: The payout link has been redeemed and is being processed.\n- `processed`: The payout link has been redeemed and the money has been transferred to the recipient.\n\nUse for filtering to retrieve only links in specified states.\nTo specify multiple values, follow this pattern: `state={VALUE1}&state={VALUE2}`."
              },
              {
                "name": "created_before",
                "value": "",
                "type": "query",
                "description": "Retrieves links with `created_at` < `created_before`.\nThe default value is the current date and time at which you are calling the endpoint.\n\nProvided in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of links returned per page.\n\nTo get to the next page, make a new request and use the `created_at` date of the last payout link returned in the previous response as the value for `created_before`."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get all the links that you have created, or use the query parameters to filter the results.\n\nThe links are sorted by the `created_at` date in reverse chronological order.\n\nThe returned links are **paginated**. \nThe maximum number of payout links returned per page is specified by the `limit` parameter.\nTo get to the next page, make a new request and use the `created_at` date of the last payout link returned in the previous response.\n\n:::note\nThis feature is available in the UK, the EEA, AU, and S"
        },
        {
          "info": {
            "name": "Create a payout link",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://b2b.revolut.com/api/1.0/payout-links",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a payout link to send money even when you don't have the full banking details of the counterparty.  \nAfter you have created the link, send it to the recipient so that they can claim the payment.\n\n:::note\nThis feature is available in the UK, the EEA, AU, and SG.\n:::\n\nFor more information, see the guides: [Send money via payout link](https://developer.revolut.com/docs/guides/manage-accounts/transfers/payout-links)."
        },
        {
          "info": {
            "name": "Retrieve a payout link",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://b2b.revolut.com/api/1.0/payout-links/:payout_link_id",
            "params": [
              {
                "name": "payout_link_id",
                "value": "",
                "type": "path",
                "description": "The ID of the link to retrieve."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get the information about a specific link by its ID.\n\n:::note\nThis feature is available in the UK, the EEA, AU, and SG.\n:::\n\nFor more information, see the guides: [Send money via payout link](https://developer.revolut.com/docs/guides/manage-accounts/transfers/payout-links)."
        },
        {
          "info": {
            "name": "Cancel a payout link",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://b2b.revolut.com/api/1.0/payout-links/:payout_link_id/cancel",
            "params": [
              {
                "name": "payout_link_id",
                "value": "",
                "type": "path",
                "description": "The ID of the link to cancel."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Cancel a payout link. You can only cancel a link that hasn't been claimed yet. \nA successful request does not get any content in response.\n\n:::note\nThis feature is available in the UK, the EEA, AU, and SG.\n:::\n\nFor more information, see the guides: [Send money via payout link](https://developer.revolut.com/docs/guides/manage-accounts/transfers/payout-links)."
        },
        {
          "info": {
            "name": "Get transfer reasons",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://b2b.revolut.com/api/1.0/transfer-reasons",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "In order to initiate a transfer in certain currencies and countries, you must provide a transfer reason. \nWith this endpoint you can retrieve all transfer reasons available to your business account per country and currency.\n\nAfter you retrieve the results, use the appropriate reason code in the `transfer_reason_code` field when [making a transfer to a counterparty](https://developer.revolut.com/docs/api/business#create-payment) or [creating a payout link](https://developer.revolut.com/docs/api/b"
        }
      ]
    }
  ],
  "bundled": true
}