Find payments by parameters

get

https://public-api.mx.clara.com/api/v2/payments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

Defaults to 0

Zero-based page index (0..N)

size

integer

Defaults to 100

The size of the page to be returned

string

Id of the payment

batchId

string

BatchId of the payments

externalId

string

External Id of the optional boleto

barcode

string

Bar code number that describes the payment

digitableLine

string

Number sequence that describes the payment

creationStartDate

string

Creation start date of the payment

creationEndDate

string

Creation end date of the payment

transactionId

string

The transaction ID related to the receipt

beneficiaryDocumentNumber

string

Document number of the beneficiary

beneficiaryName

string

Name of the beneficiary

paymentDateStart

string

Start date of the payment

paymentDateEnd

string

End date of the payment

status

string

Status of the payment

latestStatus

string

Last status of the payment by barcode/digitableLine

Responses

204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

200Successful operation