Get information about a payment.
Authentication
Bearer Token
Standard HTTP Bearer token. Enter the 'access_token' value.
TokenstringRequired
Header Parameters
Authorizationstring
This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.
Access Tokens have a lifespan of 15 minutes.
Requesting an access token
Parameters:
- client_id = my-client-id
- client_secret = my-client-secret
- [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...
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_RIDESCHEDULEDpayment_typestring
The type of payment.
Enum values:
CURRENT_BALANCEMINIMUM_BALANCESTATEMENT_BALANCEOTHER_AMOUNTscheduled_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?
Response
Was this section helpful?