API Integration
Integrate our payment technology into your CTMS or EDC system
CT Payer provides an API integration option for life science companies that need a white label solution to make stipend and reimbursement payments to research particpants.
An application programming interface (API) is a particular set of rules and specifications that a company’s software programs can follow to communicate directly with our payment platform.
By integrating our APIs, companies can assign cards to study participants and make payments to payee’s cards through their own proprietary systems, allowing for a seamless, branded payment experience without the cost and time of building a payment platform from scratch.
Core API Calls
Echo
| CT Payer Request Parameter | Description | Data Type | Required |
| Resource | /echo.php | Alphanumeric | Yes |
| username | Client’s unique API username assigned by CT Payer | Alphanumeric | Yes |
| password | Client’s unique API password assigned by CT Payer | Alphanumeric | Yes |
Assign Card
| CT Payer Request Parameter | Description | Data Type | Required |
| Resource | /assigncard.php | Alphanumeric | Yes |
| username | Client’s unique API username assigned by CT Payer | Alphanumeric | Yes |
| password | Client’s unique API password assigned by CT Payer | Alphanumeric | Yes |
| cardId | Unique 10-digit card ID assigned by CT Payer | Numeric | Yes |
| participantId | A unique identifier client associates with the participant (40 characters max, including spaces) |
Alphanumeric | Yes |
| apiusername | The client user logged into client system performing transaction (i.e., “Brad Smith” or “bsmith”) |
Alphanumeric | Yes |
Load Card
| CT Payer Request Parameter | Description | Data Type | Required |
| Resource | /loadcard.php | Alphanumeric | Yes |
| username | Client’s unique API username assigned by CT Payer | Alphanumeric | Yes |
| password | Client’s unique API password assigned by CT Payer | Alphanumeric | Yes |
| cardId | Unique 10-digit card ID assigned by CT Payer | Numeric | Yes |
| internalPaymentId | Unique payment ID assigned by client | Alphanumeric | No |
| amount | Amount to load to card | Alphanumeric | Yes |
| description | Payment description (30 characters max, including spaces) | Alphanumeric | Yes |
| groupId | Group identifier for similar payments (15 characters max, including spaces) | Alphanumeric | No |
| paymentDate | Payment date (currently allow for immediate only) | Date (MM/DD/YYYY HH:MM:SS) |
No |
| apiusername | The client user logged into client system performing transaction (i.e., “Brad Smith” or “bsmith”) |
Alphanumeric | Yes |
Get Card Balance
| CT Payer Request Parameter | Description | Data Type | Required |
| Resource | /getcardbalance.php | Alphanumeric | Yes |
| username | Client’s unique API username assigned by CT Payer | Alphanumeric | Yes |
| password | Client’s unique API password assigned by CT Payer | Alphanumeric | Yes |
| cardId | Unique 10-digit card ID assigned by CT Payer | Numeric | Yes |
| apiusername | The client user logged into client system performing transaction (i.e., “Brad Smith” or “bsmith”) |
Alphanumeric | Yes |
Remove Funds
| CT Payer Request Parameter | Description | Data Type | Required |
| Resource | /chargecard.php | Alphanumeric | Yes |
| username | Client’s unique API username assigned by CT Payer | Alphanumeric | Yes |
| password | Client’s unique API password assigned by CT Payer | Alphanumeric | Yes |
| cardId | Unique 10-digit card ID assigned by CT Payer | Numeric | Yes |
| amount | Amount to remove from the card | Numeric | Yes |
| reason | Reason for removing funds (45 characters max, including spaces) | Alphanumeric | Yes |
| apiusername | The client user logged into client system performing transaction (i.e., “Brad Smith” or “bsmith”) |
Alphanumeric | Yes |
Cancel Card
| CT Payer Request Parameter | Description | Data Type | Required |
| Resource | /setcardstatus.php | Alphanumeric | Yes |
| username | Client’s unique API username assigned by CT Payer | Alphanumeric | Yes |
| password | Client’s unique API password assigned by CT Payer | Alphanumeric | Yes |
| cardId | Unique 10-digit card ID assigned by CT Payer | Numeric | Yes |
| reason | Client’s reason for canceling card (i.e. Lost Card) | Alphanumeric | Yes |
| apiusername | The client user logged into client system performing transaction (i.e., “Brad Smith” or “bsmith”) |
Alphanumeric | Yes |
Get Account Balance
| CT Payer Request Parameter | Description | Data Type | Required |
| Resource | /getaccountbalance.php | Alphanumeric | Yes |
| username | Client’s unique API username assigned by CT Payer | Alphanumeric | Yes |
| password | Client’s unique API password assigned by CT Payer | Alphanumeric | Yes |
| apiusername | The client user logged into client system performing transaction (i.e., “Brad Smith” or “bsmith”) |
Alphanumeric | Yes |
Get Card Details
| CT Payer Request Parameter | Description | Data Type | Required |
| Resource | /getcarddetails.php | Alphanumeric | Yes |
| username | Client’s unique API username assigned by CT Payer | Alphanumeric | Yes |
| password | Client’s unique API password assigned by CT Payer | Alphanumeric | Yes |
| cardId | Unique 10-digit card ID assigned by CT Payer | Numeric | Yes |
| apiusername | The client user logged into client system performing transaction (i.e., “Brad Smith” or “bsmith”) |
Alphanumeric | Yes |