customer/v1/payments
[GET] customer/v1/payments
Get recent payments
Utilizing limit
, before
, after
, page
, and status
optional query parameters, call the recent payments endpoint to return a list of a customer's recent payments.
Example [GET] Request
{{avenu_base_url}}/customer/v1/payments?limit=10&after=2023-02-09&before=&status=SETTLED
Query Parameters
Parameter | Format | Required |
---|---|---|
"limit" | Double | N |
"after" | String; ISO 8601 YYYY-MM-DD | N |
"before" | String; ISO 8601 YYYY-MM-DD | N |
"page" | Integer | N |
"status" | String; [PENDING, SETTLED, CANCELLED, DECLINED, or FAILED] | N |
Example Response
{
"pagination": "",
"payments": [
{
"paymentType": "",
"recipientAccount": {
"customerAccountNumber": xxx,
"achAccountNumber": "",
"debitCardNumber": "",
"debitCardExpiration": "",
"debitCardCvv": ""
},
"amount": "",
"currency": "",
"memo": "",
"paymentId": "",
"status": "",
"dateUpdated": ""
}
]
}
Response Elements
Element | Details |
---|---|
pagination | The current page of transactions |
paymentType | The type of payment for the transaction. See Payments Overview |
recipientAccount | Array with details of the account receiving the payment |
customerAccountNumber | Account number of the recipient |
achAccountNumber | ACH account number of the recipient |
debitCardNumber | Debit card number of the recipient |
debitCardExpiration | Debit card expiration of the recipient |
debitCardCvv | Debit card security code (CVV / CVC) of the recipient |
amount | The amount of the payment in the lowest currency. e.g. cents |
currency | The currency of the payment |
memo | Any memo attached to the payment |
paymentId | The identification number for the payment. |
status | The current status of the transaction. See Payments Overview |
dateUpdated | Date of last status update in format ISO 8601 YYYY-MM-DD |
Updated 10 months ago