Loading...
Important: For authentication, you must include the required HTTPS headers in each request. For more information about the authentication HTTPS headers, see Authenticating Your Requests.
You must save the reference_id that you create in your request. To run follow-on transactions that link to the original transaction, you must include the reference_id as part of the endpoint URL.
To take the dollar amount for the transaction using the token for the saved checking account, send a Sale request to the relevant endpoint.
| Environment | HTTP Method | URL |
|---|---|---|
| Partner Integration Test | POST | https://api.pit.paygateway.com/transactions/checksales |
| Production | POST | https://api.paygateway.com/transactions/checksales |
Content-Type: application/json
Authorization: AuthToken {AuthTokenV2}
X-GP-Request-Id: {request_id}
X-GP-Version: 2021-04-08
X-GP-Api-Key: {API Key}
X-GP-Partner-App-Name: {Name of integrating application}
{
"reference_id": "MER-41e40db1-02c8-4214-b2c8-1399aea79afa",
"check": {
"account_type": "Checking",
"token": "xxXXXxXXxX"
},
"customer": {
"first_name": "Joe",
"last_name": "Doe"
},
"payment": {
"amount": "23.09",
"currency_code": "840"
},
"transaction": {
"country_code": "840",
"entry_class": "PPD"
}
}{
"checksale_id": "000000084350",
"status": "check_submitted",
"check": {
"masked_account_number": "X2121",
"routing_number": "112000066",
"check_number": "999000000084350"
},
"payment": {
"amount": "3.89",
"currency_code": "840",
"type": "check"
},
"transaction": {
"entry_class": "PPD",
"language": "en-US"
},
"links": [
{
"checksale_id": [
{
"href": "https://api.pit.paygateway.com/transactions/checksales/000000084350",
"relation": "self",
"method": "GET",
"description": "Use this endpoint to retrieve a check sales transaction."
},
{
"href": "https://api.pit.paygateway.com/transactions/checksales/000000084350/checkrefunds",
"relation": "refund",
"method": "POST",
"description": "Use this endpoint to create a check refunds transaction associated with a prior check sale using checksale id."
}
]
},
{
"reference_id": [
{
"href": "https://api.pit.paygateway.com/transactions/checksales/reference_id/MER-6a738380-d5b6-49f8-a80a-c078b67e32cf",
"relation": "self",
"method": "GET",
"description": "Use this endpoint to retrieve a check sales transaction using reference_id."
},
{
"href": "https://api.pit.paygateway.com/transactions/checksales/reference_id/MER-6a738380-d5b6-49f8-a80a-c078b67e32cf/checkrefunds",
"relation": "refund",
"method": "POST",
"description": "Use this endpoint to create a check refund transaction associated with a prior check sale using reference id."
}
]
}
],
"reference_id": "MER-6a738380-d5b6-49f8-a80a-c078b67e32cf"
}For details regarding each API field for both a request and a response, refer to the API Reference.