Create payment

Create payment

POST https://api.notify.cm/v2/payments

Path Parameters

Name	Type	Description
Authorization	string	Your test or live API key

Request Body

Name	Type	Description
Invoice	string	The unique Notify invoice id
Date	string	European format: 28-01-2021
Amount	string	Number format: 1100.00
Method	string	Payment method code. See documentation

201

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "resource": "payment",
    "id": "07d125ef-8e59-4629-8ef5-5c82de9979e9",
    "invoice":"a0f0660d-6c8d-422b-8114-e363b260521e",
    "date":"21-01-2021",
    "amount":"100.00",
    "invoiceTotal":"480.00",
    "invoiceBalance":"380.00"
}

400

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "status": 400,
    "title": "Bad Request",
    "detail": "Field date in wrong format"
}

404

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "status": 404,
    "title": "Not Found",
    "detail": "No invoice exists with id I_dont_exist."
}

Example

curl -X POST https://api.notify.cm/v2/payments \
   -H "Authorization: Bearer test_R7HQ9QpXgx8J32rW9X9UyXjgfNk6C7TQ2UD8M5rwf8vVnYxnSETvSuEC6SKFW8Ug" \
   -d "invoice=a0f0660d-6c8d-422b-8114-e363b260521e" \
   -d "date=21-01-2021" \
   -d "amount=100.00" \
   -d "method=banktransfer"

Request

HTTP/1.1 201 Created
Content-Type: application/hal+json

{
    "resource": "payment",
    "id": "07d125ef-8e59-4629-8ef5-5c82de9979e9",
    "invoice":"a0f0660d-6c8d-422b-8114-e363b260521e",
    "date":"21-01-2021",
    "amount":"100.00",
    "invoiceTotal":"480.00",
    "invoiceBalance":"380.00"
}