Get payment purpose codes by country

GET /api-v1/list/purpose-codes

Headers

  • TARGET-ORGANIZATION-ID integer(int32)

    ID of organization, for which the operation must be performed

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

Query parameters

  • countryCode2 string Required

    countryCode2

Responses

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • code string
    • countryId integer
    • id integer
    • purpose object
      Hide purpose attributes Show purpose attributes object
      • de string
      • en string
      • fr string
      • it string
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

GET /api-v1/list/purpose-codes
curl \
 --request GET 'https://wyzio.app/api-v1/list/purpose-codes?countryCode2=string' \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string"
Response examples (200)
[
  {
    "code": "string",
    "countryId": 42,
    "id": 42,
    "purpose": {
      "de": "string",
      "en": "string",
      "fr": "string",
      "it": "string"
    }
  }
]