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

ParameterFormatRequired
"paymentId"StringY

Example Response

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

Response Elements

ElementDetails
paymentIdUUID payment identifier
statusStatus of payment at end of transaction. See below.
transactionResponseTypeThe type of transaction response. See below.
descriptionFurther details regarding the transaction response.
dateUpdatedThe date of last update for the transaction

Statuses

CodeDescription
CodeDescription
PENDINGA pending settlement
FAILEDThe payment failed
SETTLEDThe payment has been settled
DECLINEDThe payment has been declined
CANCELEDThe payment has been canceled
AUTHORIZEDThe debit card funding has been authorized

Transaction Response Types

ValueDescription
CAPTUREDDebit card captured response
AUTHORIZEDDebit card authorized response
PAYMENTPayment transaction initiated
TRANSACTIONPayment transaction is in process

Error Codes

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