Fleet Management API Beta

Sections

Theme switcher

Get information about a payment

Header Parameters

Authorizationstring

Query Parameters

account_idstring Required
Min length
1

Path Parameters

payment-idstring Required

Response

200
Object

Payment information.

Response Attributes

_linksobject

HATEOAS links to payment-related resources

Show child attributes

payment_amountnumber

Amount that will be processed for this payment.

payment_idstring

Unique identifier for a payment.

payment_statusstring

Indicates where in the payment lifecycle a payment is.

Enum values:
AUTO_PAYCANCELLEDCOMPLETEDIN_PROGRESSNONEOVER_RIDESCHEDULED
payment_typestring

The type of payment.

Enum values:
CURRENT_BALANCEMINIMUM_BALANCESTATEMENT_BALANCEOTHER_AMOUNT
scheduled_bank_idinteger

Id of the bank this payment is scheduled to be pulled from.

scheduled_datestring

Day payment is scheduled to be processed.

400
Object

400 (Bad Request)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object

401 (Unauthorized)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object

403 (Forbidden)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
404
Object

404 (Not Found)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object

500 (Internal Server Error)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?