{
  "opencollection": "1.0.0",
  "info": {
    "name": "3DS 3DS actions Get payouts API",
    "version": "3"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Get payouts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve payout details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://try.access.worldpay.com/accountPayouts/events",
            "headers": [
              {
                "name": "WP-CorrelationId",
                "value": "15cd16b2-7b82-41cb-9b11-21be9dacad88"
              },
              {
                "name": "WP-Timestamp",
                "value": ""
              },
              {
                "name": "WP-Api-Version",
                "value": "2025-01-01"
              },
              {
                "name": "Idempotency-Key",
                "value": "mustBeUnique12345"
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "narrative",
                "value": "",
                "type": "query",
                "description": "Reference that may appear on beneficiary statements."
              },
              {
                "name": "transactionReference",
                "value": "",
                "type": "query",
                "description": "Unique reference provided by you."
              },
              {
                "name": "accountNumber",
                "value": "",
                "type": "query",
                "description": "Beneficiary bank account number."
              },
              {
                "name": "payoutInstrumentId",
                "value": "",
                "type": "query",
                "description": "A unique ID generated by us, holding the beneficiary bank details. You receive this in the response after successfully creating a payout instrument in our <a href=\"/products/parties/openapi/payout-instruments\">Parties API</a>."
              },
              {
                "name": "payoutInstrumentReference",
                "value": "",
                "type": "query",
                "description": "A reference of the payoutInstrument created by you. This field holds the beneficiary bank details."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Positive whole number indicating the number of payouts to return in each page."
              },
              {
                "name": "entity",
                "value": "",
                "type": "query",
                "description": "Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay."
              },
              {
                "name": "countryCode",
                "value": "",
                "type": "query",
                "description": "<a href=\"/products/reference/supported-countries-currencies#iso-country-codes\">ISO 3166-1 Alpha-2 country code</a> of the payout destination."
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Positive whole number indicating which page of the statement to return."
              },
              {
                "name": "paymentState",
                "value": "",
                "type": "query"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Posting start date for the payout. This is the start of a time window. This must be before the current date and before the end date, as well as being after the minimum date (0001-01-01). The difference between start and end dates should not exceed 31 days. \tMust be a Gregorian calendar date with ISO 8601 format YYYY-MM-DD."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "Posting end date for the payout. This is the end of a time window. This must be before the current date, as well as after the start date and the minimum date (0001-01-01)."
              },
              {
                "name": "payeeName",
                "value": "",
                "type": "query",
                "description": "Complete payee name for the payout. This will be one of the following (depending on the beneficiary type): fullName - concatenated value from title + firstName + middleName + lastName; companyName"
              },
              {
                "name": "sourceCurrency",
                "value": "",
                "type": "query",
                "description": "Source <a href=\"/products/reference/supported-countries-currencies#currency-codes\">ISO 4217 alpha-3 currency codes</a> for the payout."
              },
              {
                "name": "sourceAmount",
                "value": "",
                "type": "query",
                "description": "Source amount. 18 digit precision including 2 decimal places"
              },
              {
                "name": "targetCurrency",
                "value": "",
                "type": "query",
                "description": "Target <a href=\"/products/reference/supported-countries-currencies#currency-codes\">ISO 4217 alpha-3 currency codes</a> for the payout."
              },
              {
                "name": "targetAmount",
                "value": "",
                "type": "query",
                "description": "18 digit precision including 2 decimal places"
              }
            ]
          },
          "docs": "Retrieve payout details"
        }
      ]
    }
  ],
  "bundled": true
}