Get invoice payment by ID

GET

https://integrators.prod.api.tabsplatform.com/v3/customers/:id/invoices/:invoiceId/payments/:paymentId

GET

/v3/customers/:id/invoices/:invoiceId/payments/:paymentId

$ curl https://integrators.prod.api.tabsplatform.com/v3/customers/123e4567-e89b-12d3-a456-426614174000/invoices/123e4567-e89b-12d3-a456-426614174000/payments/123e4567-e89b-12d3-a456-426614174000 \
>      -H "Authorization: <apiKey>"

1 {
2   "payload": {
3     "id": "123e4567-e89b-12d3-a456-426614174000",
4     "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
5     "total": 99.99,
6     "stripeId": "pi_1234567890",
7     "receivedAt": "2023-01-01T00:00:00.000Z",
8     "status": "COMPLETED",
9     "type": "MANUAL",
10     "reference": "REF123456",
11     "method": "CREDIT_CARD",
12     "externalIds": [
13       {
14         "type": "QUICKBOOKS",
15         "id": "pi_1234567890"
16       }
17     ]
18   },
19   "success": true,
20   "message": "string",
21   "error": {
22     "code": 1.1,
23     "message": "string",
24     "details": {}
25   }
26 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Customer Id

invoiceIdstringRequired

Invoice Id

paymentIdstringRequired

Payment Id

Response

The payment

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings

Errors

404

Not Found Error