Sign in
Partners
Admin

Update a partner by ID

Update a partner by ID

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

Path parameters

idstring uuid required

The unique identifier of the partner

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

Changed in 3 of the 8 revisions of this API.2110

  • b372e7d5563d119See the full diff
    • ▲

      the error/code response's property type/format changed from string/ to / for status 400

      response-property-type-changed

    • ●

      removed the optional property error/errors from the response with the 400 status

      response-optional-property-removed

    • ○

      added the new optional request property payment_providers

      new-optional-request-property

    • ○

      added the new optional request property website

      new-optional-request-property

    • ○

      added the optional property error/metadata to the response with the 400 status

      response-optional-property-added

    • ○

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

      response-property-all-of-added

    • ○

      the response property data/created_at became required for the status 200

      response-property-became-required

    • ○

      the response property data/updated_at became required for the status 200

      response-property-became-required

    • ○

      added the required property data/has_client_secret to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/payment_providers to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/website to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6637b341d86d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog