CocoaPods trunk is moving to be read-only. Read more on the blog, there are 18 months to go.
| TestsTested | ✗ |
| LangLanguage | Obj-CObjective C |
| License | Apache 2 |
| ReleasedLast Release | Nov 2018 |
Maintained by Ryan Ackley.
| Depends on: | |
| AFNetworking | ~> 3 |
| JSONModel | ~> 1.2 |
| ISO8601 | ~> 0.5 |
No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This ObjC package is automatically generated by the Swagger Codegen project:
The SDK requires ARC (Automatic Reference Counting) to be enabled in the Xcode project.
Add the following to the Podfile:
pod 'ACHeck21Checks', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'To specify a particular branch, append , :branch => 'branch-name-here'
To specify a particular commit, append , :commit => '11aa22'
Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/ACHeck21Checks) and then add the following to the Podfile:
pod 'ACHeck21Checks', :path => 'Vendor/ACHeck21Checks'Import the following:
#import <ACHeck21Checks/ACHApiClient.h>
#import <ACHeck21Checks/ACHConfiguration.h>
// load models
#import <ACHeck21Checks/ACHAttachment.h>
#import <ACHeck21Checks/ACHCheck.h>
#import <ACHeck21Checks/ACHCheckQueryResult.h>
#import <ACHeck21Checks/ACHCreateAttachmentParams.h>
#import <ACHeck21Checks/ACHCreateCheckParams.h>
#import <ACHeck21Checks/ACHCredentials.h>
#import <ACHeck21Checks/ACHResourceLink.h>
#import <ACHeck21Checks/ACHReturn.h>
#import <ACHeck21Checks/ACHServerException.h>
#import <ACHeck21Checks/ACHSettlement.h>
#import <ACHeck21Checks/ACHValidateCheckParams.h>
#import <ACHeck21Checks/ACHValidationResult.h>
// load API classes for accessing endpoints
#import <ACHeck21Checks/ACHChecksApi.h>
#import <ACHeck21Checks/ACHLoginApi.h>
It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issue.
Please follow the installation procedure and then run the following:
ACHConfiguration *apiConfig = [ACHConfiguration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
NSString* *clientId = @"clientId_example"; //
ACHCreateCheckParams* *values = [[ACHCreateCheckParams alloc] init]; // (optional)
ACHChecksApi *apiInstance = [[ACHChecksApi alloc] init];
// Create a new Check transaction.
[apiInstance createCheckWithClientId:clientId
values:values
completionHandler: ^(ACHCheck* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
All URIs are relative to https://gateway.acheck21.com/GlobalGateway
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ACHChecksApi | createCheck | PUT /api/v1/checks/{clientId} | Create a new Check transaction. |
| ACHChecksApi | getAttachments | GET /api/v1/checks/{clientId}/{documentId}/attachments | Retrieve Attachments for a specific Check. Usually there is at most one settlement per check. |
| ACHChecksApi | getCheck | GET /api/v1/checks/{clientId}/{documentId} | Retrieve a specific Check |
| ACHChecksApi | getChecks | GET /api/v1/checks/{clientId} | Search for all Checks that belong to a merchant account. |
| ACHChecksApi | getReturns | GET /api/v1/checks/{clientId}/{documentId}/returns | Retrieve returns for a specific Check. |
| ACHChecksApi | getSettlements | GET /api/v1/checks/{clientId}/{documentId}/settlements | Retrieve Settlements for a specific Check. Usually there is at most one settlement per check. |
| ACHChecksApi | validateCheck | POST /api/v1/checks/{clientId}/validate | Validates a check. This usually involves verifying the account exists and that there are no unpaid items (a.k.a. bounced checks) associated with the account. This is configured in the Global Gateway's client manager. |
| ACHChecksApi | voidCheck | DELETE /api/v1/checks/{clientId}/{documentId} | Delete a specific Check transaction. |
| ACHLoginApi | getCurrentUser | GET /api/v1/login | Returns currently logged in valid UserName |
| ACHLoginApi | login | POST /api/v1/login | Login and generate cookie for future authorization. |