Skip to main content
GET
/
api
/
v1
/
payment
List payments
curl --request GET \
  --url http://localhost:45000/api/v1/payment \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "customerId": "<string>",
      "beneficiaryId": "<string>",
      "amount": "<string>",
      "currencyCode": "<string>",
      "internalReference": "<string>",
      "invoiceNumber": "<string>",
      "purposeOfPayment": "<string>",
      "memo": "<string>",
      "paymentToken": "<string>",
      "paymentNetwork": "<string>",
      "paymentQuoteId": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "customer": {
        "companyName": "<string>",
        "status": "<string>",
        "orgId": "<string>"
      },
      "beneficiary": {
        "companyName": "<string>",
        "bankBic": "<string>",
        "status": "<string>"
      },
      "sourceFunding": {
        "type": "<string>",
        "bankAccountId": "<string>",
        "bankName": "<string>",
        "countryCode": "<string>",
        "currencyCode": "<string>",
        "accountNumber": "<string>",
        "iban": "<string>"
      },
      "rail": {
        "method": "<string>",
        "countryCode": "<string>"
      },
      "receiptUrl": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

Authorizations

​
x-api-key
string
header
required

Nuvera API application secret key

​
Authorization
string
header
required

RS256 per-request signed JWT

Query Parameters

​
status
enum<string>
Available options:
PENDING_REVIEW,
CORRECTION_NEEDED,
APPROVED,
PROCESSING,
COMPLETED,
REJECTED,
CANCELLED
​
customerId
string
​
beneficiaryId
string
​
dateFrom
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
dateTo
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
cursor
string
​
limit
integer
default:20
Required range: 1 <= x <= 100

Response

default - application/json
​
items
object[]
required
​
nextCursor
string | null
required
​
hasMore
boolean
required