Settlement API: Interchange and scheme fees

Add fees.interchange and fees.scheme to settlement resource.

This feature will gradually roll out from March 1st.

NB: The fees are only relevant for Interchange+ merchants.

See https://developer.clearhaus.com/rels/settlement#properties.

Transaction API: RRN

Add Retrieval Reference Number to transaction resource.

This property is also supported by the transaction query language.

See https://developer.clearhaus.com/rels/transaction#properties and https://developer.clearhaus.com/merchant-api/tql/#identifiers.

Rate Limiting

Starting with the OAuth token endpoint on Wednesday January 15th 2020 the Merchant API will start enforcing rate limits.

The issued tokens are valid for 24 hours and it is best practice to make use of the expires_in property to take advantage of the lifetime of the token and avoid unnecessary calls to the OAuth2 token endpoint.

Given the growing interest in the Merchant API we will gradually extend rate limiting to other resources as the need arises.

See example access token response with expires_in at https://developer.clearhaus.com/merchant-api/start/#supported-grants.

Transaction API: Settlement information on authorizations

Add support for settlement information on authorizations.

The properties amount_gross and amount_net will not be utilized as they are only relevant for captures, refunds and credits.

This feature will gradually roll out from December 10th.

See https://developer.clearhaus.com/rels/transaction#properties.

OAuth Client registration

Add support for creating OAuth Clients in the Developer portal.

Previously client registration was made by request via support@clearhaus.com.

With this new functionality the Resource Owner Password Credentials Grant becomes deprecated and existing clients can be transitioned to the Client Credentials Grant.

See https://developer.clearhaus.com/merchant-api/start/#client-registration and https://developer.clearhaus.com/merchant-api/clients.

Record API

Application API: New modifiers in APQL

Add support for additional modifiers in AQPL.

See https://developer.clearhaus.com/merchant-api/apql.

Application API: Application Query Language

  • Add support for querying applications.

  • Deprecation: Remove state parameter from the application resource. Use query with metadata.state:{state} instead. The state parameter will be removed in 2 months.

See https://developer.clearhaus.com/rels/applications#request-parameters and https://developer.clearhaus.com/merchant-api/apql.

Transaction API: Payment method in TQL

Add support for payment_method in TQL.

See https://developer.clearhaus.com/merchant-api/tql/#payment-method.

Application API: Goodbye to Director and Owners

Deprecation: Remove director and owners resources.

After 5 months of deprecation and no current usage, the two resources are removed.

See https://changelog.clearhaus.com/application-api-people-70783