GET
/
beneficiaries
/
organizations
/
recipients
curl --request GET \
  --url https://api.paysway.dev/beneficiaries/organizations/recipients \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "country": "<string>",
      "currency": "<string>",
      "method": "BANK_ACCOUNT",
      "isDefault": true,
      "creditor": {
        "name": "<string>",
        "address": {
          "addressLine1": "<string>",
          "addressLine2": "<string>",
          "addressLine3": "<string>",
          "department": "<string>",
          "streetName": "<string>",
          "buildingNumber": "<string>",
          "buildingName": "<string>",
          "floor": "<string>",
          "room": "<string>",
          "townName": "<string>",
          "townLocationName": "<string>",
          "districtName": "<string>",
          "postBox": "<string>",
          "postCode": "<string>",
          "countrySubdivision": "<string>",
          "country": "<string>"
        },
        "contactDetails": {
          "email": "<string>",
          "phone": "<string>"
        },
        "dateOfBirth": "2023-12-25",
        "taxId": "<string>",
        "documents": [
          {
            "value": "<string>",
            "type": "NATIONAL_ID"
          }
        ],
        "type": "INDIVIDUAL"
      },
      "creditorAccount": {
        "id": {
          "value": "<string>",
          "type": "IBAN"
        },
        "type": "CHECKING"
      },
      "creditorAgent": {
        "bic": "<string>",
        "clearingSystemMemberId": {
          "memberId": "<string>"
        },
        "branchId": "<string>"
      },
      "remittance": {
        "creditorReference": {
          "value": "<string>"
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

externalUserId
string
required

Response

200 - application/json

Recipients list returned successfully

The response is of type object.