v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Customers

Get invoice payment by ID

get/v3/customers/{id}/invoices/{invoiceId}/payments/{paymentId}

Path parameters

idstring required

Example:123e4567-e89b-12d3-a456-426614174000

Customer Id

invoiceIdstring required

Example:123e4567-e89b-12d3-a456-426614174000

Invoice Id

paymentIdstring required

Example:123e4567-e89b-12d3-a456-426614174000

Payment Id

Response

The payment

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "total": 99.99,
    "stripeId": "pi_1234567890",
    "receivedAt": "2023-01-01T00:00:00.000Z",
    "status": "COMPLETED",
    "type": "MANUAL",
    "reference": "REF123456",
    "method": "CREDIT_CARD",
    "externalIds": [
      {
        "id": "pi_1234567890"
      }
    ]
  }
}