customer/v1/payment/status

[GET] customer/v1/payment/status

Get payment status

The payment status endpoint will return the current status of the payment id provided in the request parameter.

Example [GET] Request

{{avenu_base_url}}/customer/v1/payments/status/{{paymentId}}

Request Parameter

Parameter	Format	Required
"paymentId"	String	Y

Example Response

{
    "paymentId": "",
    "status": "",
    "transactionResponse": {
        "transactionResponseType": "",
        "description": "",
        "dateUpdated": ""
    }
}

Response Elements

Element	Details
paymentId	UUID payment identifier
status	Status of payment at end of transaction. See below.
transactionResponseType	The type of transaction response. See below.
description	Further details regarding the transaction response.
dateUpdated	The date of last update for the transaction

Statuses

Code	Description
PENDING	A pending settlement
FAILED	The payment failed
SETTLED	The payment has been settled
DECLINED	The payment has been declined
CANCELED	The payment has been canceled

Transaction Response Types

Value	Description
CAPTURED	Debit card captured response
AUTHORIZED	Debit card authorized response
PAYMENT	Payment transaction initiated
TRANSACTION	Payment transaction is in process

Error Codes

Code	Message
1001	"Missing required field"
1002	"Invalid data type"
1003	"Invalid data"
1004	"Account validation failed"