API Reference

Order Payment Created

The Task Payment Created callback occurs when a payment is done via a POS or other middelware. This callback returns detailed information describing the task payment; including payment method, amount paid, and identifiers.

📘

Register Your URL for this Webhook

To start receiving webhooks from Bringg, you must first register a URL. Detailed guidance on setting up and managing Bringg webhooks is available in the following resources:


Response

{ 
   "task_id":10450647,
   "description":"Payment for task 10450647",
   "reference_id":"123456",
   "success":false,
   "amount":13,
   "payment_method":2,
   "request_id":"P10450647-1",
   "created_at":"2020-02-02T08:45:54.867Z",
   "task_external_id":"Pick up task Bank"
 }

Output Params

task_id

Int32

Bringg task Id of the order to which the payment is associated.

description

string

Free text.

reference_id

string

Transaction ID.

success

boolean

Indicates payment success or failure.

amount

float

Indicates amount received.

payment_method

Int32

See values in Task Payment Details API call.

request_id

string

Uniqe request ID from API request Header.

created_at

datetime

The date and time the payment was attempted.

task_external_id

string

Task ID assigned by the merchant.