Resources & Actions

The API is structured around resources and their associated actions. Resources are created, edited, and reported on by executing actions using the API. For example, a /transactions resource is created by authorizing a card for a specific amount. It is edited by subsequently reversing it.

This table outlines some example resources and their associated actions.

Resource IDs

For every instance of a resource, we create an ID that uniquely identifies that instance. These IDs are important as they are used to reference an instance of a resource when actioning in.

IDs are structured using the first three characters to represent the type of resource the instance refers to, followed by an underscore and then a unique string. For example, TRN_C0kt6GatzZLsC0kt6GatzZLsmyhvBX is an unique ID for a transaction.

IDs are created when the instance of the resource is created.

Sample request

curl -v -X POST https://apis.globalpay.com/ucp/transactions 
    -H "Content-type: application/json" 
    -H "X-GP-Version: 2021-03-22" 
    -H "Authorization: Bearer KnxbvhyY4GgBYq6mV64uEGLzotrw"
    -d '
{
    "account_name": "transaction_processing",
    "channel": "CP",
    "type": "SALE",
    "amount": "20045",
    "currency": "CAD",
    "reference": "my-trans-ref",
    "payment_method": {
        "name": "Jane Doe",
        "entry_mode": "MANUAL",
        "card": {        
            "number": "4242424242424242",
            "expiry_month": "12",
            "expiry_year": "20" 
        }
    }
}'

Sample response

{
    "id": "TRN_udnMIdFzIcLC0kt6GatzZLsmyhvBXj",
    "time_created": "2021-03-20T23:31:33.878Z",
    "type": "SALE",
    "status": "CAPTURED",
    ....
}

The following table describes the API resources and gives an example ID for each.