For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Run a credit authorization

Create an authorization transaction.

These solutions are available in US and Canada only. For all other regions, please contact us for support.

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.

To run a credit authorization, send a POST request to the relevant endpoint. Because the card is not present, the request must include the customer's payment details. Use the creditauth_id or reference_id from this request to capture the credit authorization.

Endpoints

The endpoint you POST to depends on whether you identify the authorization using the creditauth_id (generated by the gateway) or the reference_id (generated by the merchant’s POS).

Environment	HTTP Method	URL
Partner Integration Test	POST	https://api.pit.paygateway.com/transactions/creditauths
Production	POST	https://api.paygateway.com/transactions/creditauths

Sample request

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-Source-App-Name: {Name of integrating application}
{
    "reference_id": "MER-26395a60-08db-4eb3-b5ba-42275c281e72",
    "card": {
        "card_number":"4761739001010010",
        "expiry_month":"12",
        "expiry_year":"25",
        "cardholder_name":"test name"
    },
    "payment": {
        "amount": "50.00",        
        "currency_code": "840"
    },
    "transaction": {
        "country_code": "840",
        "processing_indicators":{
        	"create_token":true            
        }
    }
}

Sample response

{
    "creditauth_id": "000000000497",
    "status": "approved",
    "approval_code": "557789",
    "processor_response": "DEVELOPMENT APPROVAL",
    "card": {
        "masked_card_number": "476173XXXXXX0010",
        "cardholder_name": "test name",
        "expiry_month": "12",
        "expiry_year": "25",
        "token": "VYN0H8bQS4",
        "type": "visa"
    },
    "payment": {
        "amount": "9.07",
        "currency_code": "840",
        "type": "credit"
    },
    "transaction": {
        "entry_type": "keyed",
        "language": "en-US"
    },
    "reference_id": "MER-04885eb0-4d22-45a1-a4f8-6f620909d473"
}