Payments
Transactions
Reads the payments recorded against your business. This is also the endpoint you call to verify a webhook event before acting on it.
GET
/v1/transaction
Headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| api-key | Your business API key |
| secret-key | Your business secret key |
Request body
| Field | Type | Required | Notes |
|---|---|---|---|
| transaction_reference | string | Yes | Narrows the result to one transaction. Use the reference from the webhook event. |
Verifying one payment
{
"transaction_reference": "VOLC_695E476DC77BB"
}
Response
| Field | Type | Notes |
|---|---|---|
| status | string | Outcome of the call. |
| message | string | Human readable result. |
| count | number | How many records came back. |
| data | array | The records, each carrying the account they were paid into and its references. |
Verify before you credit. Treat a webhook as a nudge, not
as proof. Call this endpoint with the reference from the event and act on
what it returns, so a forged POST to your URL cannot move anything in your
system.
Errors
400 with Email parameter is required when the email is
missing. See Errors.
Volboo