NOnotchpay

Create a beneficiary

Changed on
post/beneficiaries

Request

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

Request body

OR

Example request

{
  "channel": "cm.mtn",
  "name": "John Doe",
  "email": "john@example.com",
  "description": "Employé",
  "country": "CM",
  "reference": "ref_123456789"
}

Response

Beneficiary created

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

Changes

  • 171d0769b265Revision 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