Batch Retrieve Payment Objects Paginated

post

https://api-sandbox.complypay.com/v1/payment-objects/batch-retrieve

List all Payment Objects where filters can be added to the request body to filter out any unwanted payment objects. If an empty body is sent then no filters will be used and all payment objects will be returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

Page

limit

int32

Limit

Body Params

int32

Unique identifier of the payment object

group_id

string

Group identifier associated with the payment object

amount

int32

Amount of the payment

currency

string

Currency of the payment

payer

string

Payer identifier

payee

string

Payee identifier

iban_memo

string

Memo for the IBAN transaction

creator_user

string

User who created the payment object

approved_by_user

string

User who approved the payment object

transaction_id

string

Transaction identifier

supporting_document_key

string

Key of the supporting document

date_created

date-time

Date when the payment object was created

date_modified

date-time

Date when the payment object was last modified

date_rejected

date-time

Date when the payment object was rejected

date_approved

date-time

Date when the payment object was approved

transaction_date

date-time

Date of the transaction

placed_at_date

date-time

Date when the payment object was placed

processed_at_date

date-time

Date when the payment object was processed

Headers

string

enum

Defaults to applicatioan/json

Generated from available response content types

Allowed:

Responses

400

Invalid request parameters

404

Payment Objects not found

500

Internal server error

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

applicatioan/json

*/*

200Payment Objects retrieved

406Not Acceptable

409Conflict