Logo
Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
Sign inBook a demo
API ReferencePayment GatewayValidate

Get Validation Job

GET
https://api.mercoa.com/payment-gateway/validate/:jobId
GET
/payment-gateway/validate/:jobId
1curl https://api.mercoa.com/payment-gateway/validate/job_1a92b5f7-f522-435e-a953-fd649363730a \
2     -H "Authorization: Bearer <token>"
Try it
200Default
1{
2  "jobStatus": "success",
3  "createdAt": "2024-01-01T00:00:00Z",
4  "jobId": "pgv_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
5  "updatedAt": "2024-01-01T00:00:00Z",
6  "card": {
7    "eligibility": "ACCEPTED",
8    "fee": {
9      "type": "percentage",
10      "value": 2.5
11    }
12  },
13  "gatewayAmount": 155.5,
14  "invoiceAmount": 150.75,
15  "paymentGatewayUrl": "https://www.payment-gateway.com/invoice/pgv_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
16  "vendorName": "Acme Corporation"
17}
Get the status of a payment gateway validation job

Path parameters

jobIdstringRequired
The ID of the payment gateway validation job

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Response

This endpoint returns an object.
pendingobject
OR
successobject
OR
failedobject

Errors

Was this page helpful?
Previous

Find

Next
Built with
The ID of the payment gateway validation job

Bearer authentication of the form Bearer <token>, where token is your auth token.