Retrieve a beneficiary

Changed on
get/beneficiaries/{id}

Request

  • Base URL
    https://api.notchpay.co
  • URL
    https://api.notchpay.co/beneficiaries/{id}
  • Auth
    • API key in header Authorization
    • or API key in header X-Grant
    • or API key in header X-Sync

Path parameters

idstring required

Unique identifier of the beneficiary

Response

Beneficiary retrieved

statusstring required
messagestring required
codeinteger required
beneficiaryBeneficiary required(unresolved $ref)

Changes

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional 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

    • 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

    • 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

    • info

      added the required property to the response with the status