BAbanqzinc
Partners
Admin

Update a partner by ID

Changed on

Update a partner by ID

put/api/v1/admin/partners/{id}

Request

Path parameters

idstring uuid required

The unique identifier of the partner

Request body

namestring

The updated name of the partner

emailstring email

The updated email of the partner

websitestring nullable

The updated website URL of the partner (protocol optional, will be normalized)

payment_providersobject nullable

Per-country payment provider routing overrides. Keys are ISO 3166-1 alpha-2 country codes, values are provider names. Null to use system defaults.

Example request

{
  "name": "BarclayCard International",
  "email": "argo.international@barclaycard.com",
  "website": "barclaycard-international.com",
  "payment_providers": {
    "GB": "fumopay"
  }
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "name": "Barclaycard",
    "email": "argo@barclaycard.com",
    "client_id": "partner_123",
    "client_secret": "$2b$10$...",
    "has_client_secret": true,
    "website": "https://transfermate.com",
    "payment_providers": {
      "GB": "fumopay"
    },
    "created_at": "2024-03-19T12:00:00Z",
    "updated_at": "2024-03-19T12:00:00Z"
  }
}

Changes

  • b372e7d5563dRevision changes
    • breaking

      the / response's property type changed from string to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 6637b341d86dRevision changes
    • info

      endpoint added