NOnotchpay

Initialize a payment

Changed on
post/payments

Request

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

Request body

OR
OR

Example request

{
  "amount": 5000,
  "currency": "XAF",
  "email": "john@example.com",
  "customer": "cus_123456789",
  "description": "Paiement pour commande",
  "reference": "order_123",
  "callback": "https://example.com/callback",
  "locked_currency": "XAF",
  "locked_channel": "cm.mtn",
  "locked_country": "CM"
}

Response

Payment initialized

statusstring required
messagestring required
codeinteger required
transactionPayment required(unresolved $ref)
authorization_urlstring

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

    • 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