Query Payment Sources

Return a paginated list of matching payment sources.

SecurityMarketplace Api Key | Merchant Secret Token | Admin JWT | Customer JWT
Request
query Parameters
limit
integer <int32>

Maximum results per page. Default to 20, must be between 1 and 500.

page
integer <int32>

Page number of results to show (starting at page 1).

sort
string

Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a - character.

customerId
string

Filter by customer identifier. Required unless usageScope is 'ScopeBilling'

usageScope
string (PaymentSourceUsageScope)

Filter by usage scope

Enum: "ScopeOrganisation" "ScopeDelegate" "ScopeBilling"
Responses
200

Matching items sorted as specified

400
401
403
404
405
406
409
422
429
500
503
get/sources
Request samples
Response samples
application/json
[
  • {
    }
]
Copyright © April Solutions 2023. All right reserved.