Payments
Reverse a purchase
Marks the payment refunded. Idempotent if already refunded.
Marks the payment refunded. Idempotent if already refunded.
x-api-key<token>
In: header
Path Parameters
externalRef*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/purchases/string/reverse" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "string", "amount": 0, "status": "string", "paidAt": "2019-08-24T14:15:22Z", "note": "string", "invoiceId": "string", "currency": "string", "source": "INVOICE", "sourceLabel": "string", "externalRef": "string", "contactId": "string", "opportunityId": "string", "items": [ { "name": "string", "sku": "string", "quantity": 0, "unitAmount": 0 } ], "metaEventId": "string", "metaSend": true, "reversedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "customer": { "id": "string", "name": "string", "email": "string", "company": "string" }, "invoice": { "id": "string", "invoiceNumber": "string" }, "metaConversion": { "id": "string", "siteId": "string", "paymentId": "string", "eventName": "string", "eventId": "string", "contactId": "string", "value": 0, "currency": "string", "eventTime": "2019-08-24T14:15:22Z", "status": "QUEUED", "skipReason": "string", "reversed": true, "attempts": 0, "lastError": "string", "sentAt": "2019-08-24T14:15:22Z", "exportedAt": "2019-08-24T14:15:22Z" } }}
Planeward Docs