Search process jobs

1 curl -G https://api.mercoa.com/payment-gateway/process-jobs \ 2 -H "Authorization: Bearer <token>" \ 3 -d status=FAILED \ 4 --data-urlencode startDate=2024-01-01T00:00:00Z \ 5 --data-urlencode endDate=2024-12-31T23:59:59Z

1 { 2 "jobs": [ 3 { 4 "jobStatus": "pending", 5 "jobId": "pgp_8f86116b-3b4d-4ded-99ef-3bc929d8c33c" 6 }, 7 { 8 "jobStatus": "success", 9 "jobId": "pgp_8f86116b-3b4d-4ded-99ef-3bc929d8c33c", 10 "receiptUrl": "https://www.payment-gateway.com/receipt/123123" 11 }, 12 { 13 "jobStatus": "failed", 14 "errorType": "NO_VALID_PAYMENT_GATEWAY_FOUND", 15 "jobId": "pgp_8f86116b-3b4d-4ded-99ef-3bc929d8c33c", 16 "errorMessage": "No valid payment gateway was found in the document or HTML" 17 } 18 ], 19 "hasMore": true 20 }

Search payment gateway process jobs for the organization

Query parameters

statusenumOptional

Filter jobs by status

Allowed values:

startDatedatetimeOptional

Start date filter for job creation time

endDatedatetimeOptional

End date filter for job creation time

orderByenumOptional

Field to order jobs by. Defaults to CREATED_AT.

Allowed values:

orderDirectionenumOptional

Direction to order jobs by. Defaults to desc.

Allowed values:

limitintegerOptional

Number of jobs to return. Limit can range between 1 and 100, and the default is 10.

startingAfterstringOptional

The ID of the job to start after. If not provided, the first page of jobs will be returned.

Response

This endpoint returns an object.

jobslist of objects

List of payment gateway process jobs matching the search criteria

hasMoreboolean

Whether there are more jobs available beyond the current page

Headers

Query parameters

Response

Errors