Skip to content
BoxBilling

Get payment

GET
/v1/payments/{payment_id}

Get a payment by ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
payment_id
required
Payment Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

PaymentResponse

Schema for payment response.

object
id
required
Id
string format: uuid
invoice_id
required
Invoice Id
string format: uuid
customer_id
required
Customer Id
string format: uuid
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
currency
required
Currency
string
status
required
Status
string
provider
required
Provider
string
provider_payment_id
Any of:
string
provider_checkout_id
Any of:
string
provider_checkout_url
Any of:
string
failure_reason
Any of:
string
payment_metadata
Any of:
object
key
additional properties
any
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
completed_at
Any of:
string format: date-time

401

Section titled “401 ”

Unauthorized – invalid or missing API key

404

Section titled “404 ”

Payment not found

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object