SDKReconciliationV1

(reconciliation().v1())

Overview

Available Operations

createPolicy - Create a policy
deletePolicy - Delete a policy
getPolicy - Get a policy
getReconciliation - Get a reconciliation
listPolicies - List policies
listReconciliations - List reconciliations
reconcile - Reconcile using a policy
reconciliationgetServerInfo - Get server info

createPolicy

Create a policy

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.ReconciliationErrorResponse;
import com.formance.formance_sdk.models.operations.CreatePolicyResponse;
import com.formance.formance_sdk.models.shared.PolicyRequest;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws ReconciliationErrorResponse, Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID("<YOUR_CLIENT_ID_HERE>")
                    .clientSecret("<YOUR_CLIENT_SECRET_HERE>")
                    .build())
            .build();

        PolicyRequest req = PolicyRequest.builder()
                .ledgerName("default")
                .ledgerQuery(Map.ofEntries(
                    Map.entry("key", "<value>")))
                .name("XXX")
                .paymentsPoolID("XXX")
                .build();

        CreatePolicyResponse res = sdk.reconciliation().v1().createPolicy()
                .request(req)
                .call();

        if (res.policyResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	PolicyRequest	✔️	The request object to use for the request.

Response

CreatePolicyResponse

Errors

Error Type	Status Code	Content Type
models/errors/ReconciliationErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

deletePolicy

Delete a policy by its id.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.ReconciliationErrorResponse;
import com.formance.formance_sdk.models.operations.DeletePolicyRequest;
import com.formance.formance_sdk.models.operations.DeletePolicyResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ReconciliationErrorResponse, Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID("<YOUR_CLIENT_ID_HERE>")
                    .clientSecret("<YOUR_CLIENT_SECRET_HERE>")
                    .build())
            .build();

        DeletePolicyRequest req = DeletePolicyRequest.builder()
                .policyID("XXX")
                .build();

        DeletePolicyResponse res = sdk.reconciliation().v1().deletePolicy()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`request`	DeletePolicyRequest	✔️	The request object to use for the request.

Response

DeletePolicyResponse

Errors

Error Type	Status Code	Content Type
models/errors/ReconciliationErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getPolicy

Get a policy

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.ReconciliationErrorResponse;
import com.formance.formance_sdk.models.operations.GetPolicyRequest;
import com.formance.formance_sdk.models.operations.GetPolicyResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ReconciliationErrorResponse, Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID("<YOUR_CLIENT_ID_HERE>")
                    .clientSecret("<YOUR_CLIENT_SECRET_HERE>")
                    .build())
            .build();

        GetPolicyRequest req = GetPolicyRequest.builder()
                .policyID("XXX")
                .build();

        GetPolicyResponse res = sdk.reconciliation().v1().getPolicy()
                .request(req)
                .call();

        if (res.policyResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	GetPolicyRequest	✔️	The request object to use for the request.

Response

GetPolicyResponse

Errors

Error Type	Status Code	Content Type
models/errors/ReconciliationErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getReconciliation

Get a reconciliation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.ReconciliationErrorResponse;
import com.formance.formance_sdk.models.operations.GetReconciliationRequest;
import com.formance.formance_sdk.models.operations.GetReconciliationResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ReconciliationErrorResponse, Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID("<YOUR_CLIENT_ID_HERE>")
                    .clientSecret("<YOUR_CLIENT_SECRET_HERE>")
                    .build())
            .build();

        GetReconciliationRequest req = GetReconciliationRequest.builder()
                .reconciliationID("XXX")
                .build();

        GetReconciliationResponse res = sdk.reconciliation().v1().getReconciliation()
                .request(req)
                .call();

        if (res.reconciliationResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	GetReconciliationRequest	✔️	The request object to use for the request.

Response

GetReconciliationResponse

Errors

Error Type	Status Code	Content Type
models/errors/ReconciliationErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPolicies

List policies

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.ReconciliationErrorResponse;
import com.formance.formance_sdk.models.operations.ListPoliciesRequest;
import com.formance.formance_sdk.models.operations.ListPoliciesResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ReconciliationErrorResponse, Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID("<YOUR_CLIENT_ID_HERE>")
                    .clientSecret("<YOUR_CLIENT_SECRET_HERE>")
                    .build())
            .build();

        ListPoliciesRequest req = ListPoliciesRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        ListPoliciesResponse res = sdk.reconciliation().v1().listPolicies()
                .request(req)
                .call();

        if (res.policiesCursorResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	ListPoliciesRequest	✔️	The request object to use for the request.

Response

ListPoliciesResponse

Errors

Error Type	Status Code	Content Type
models/errors/ReconciliationErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listReconciliations

List reconciliations

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.ReconciliationErrorResponse;
import com.formance.formance_sdk.models.operations.ListReconciliationsRequest;
import com.formance.formance_sdk.models.operations.ListReconciliationsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ReconciliationErrorResponse, Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID("<YOUR_CLIENT_ID_HERE>")
                    .clientSecret("<YOUR_CLIENT_SECRET_HERE>")
                    .build())
            .build();

        ListReconciliationsRequest req = ListReconciliationsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        ListReconciliationsResponse res = sdk.reconciliation().v1().listReconciliations()
                .request(req)
                .call();

        if (res.reconciliationsCursorResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	ListReconciliationsRequest	✔️	The request object to use for the request.

Response

ListReconciliationsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ReconciliationErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

reconcile

Reconcile using a policy

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.ReconciliationErrorResponse;
import com.formance.formance_sdk.models.operations.ReconcileRequest;
import com.formance.formance_sdk.models.operations.ReconcileResponse;
import com.formance.formance_sdk.models.shared.ReconciliationRequest;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws ReconciliationErrorResponse, Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID("<YOUR_CLIENT_ID_HERE>")
                    .clientSecret("<YOUR_CLIENT_SECRET_HERE>")
                    .build())
            .build();

        ReconcileRequest req = ReconcileRequest.builder()
                .reconciliationRequest(ReconciliationRequest.builder()
                    .reconciledAtLedger(OffsetDateTime.parse("2021-01-01T00:00:00.000Z"))
                    .reconciledAtPayments(OffsetDateTime.parse("2021-01-01T00:00:00.000Z"))
                    .build())
                .policyID("XXX")
                .build();

        ReconcileResponse res = sdk.reconciliation().v1().reconcile()
                .request(req)
                .call();

        if (res.reconciliationResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	ReconcileRequest	✔️	The request object to use for the request.

Response

ReconcileResponse

Errors

Error Type	Status Code	Content Type
models/errors/ReconciliationErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

reconciliationgetServerInfo

Get server info

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.ReconciliationErrorResponse;
import com.formance.formance_sdk.models.operations.ReconciliationgetServerInfoResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ReconciliationErrorResponse, Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID("<YOUR_CLIENT_ID_HERE>")
                    .clientSecret("<YOUR_CLIENT_SECRET_HERE>")
                    .build())
            .build();

        ReconciliationgetServerInfoResponse res = sdk.reconciliation().v1().reconciliationgetServerInfo()
                .call();

        if (res.serverInfo().isPresent()) {
            // handle response
        }
    }
}

Response

ReconciliationgetServerInfoResponse

Errors

Error Type	Status Code	Content Type
models/errors/ReconciliationErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

SDKReconciliationV1

Overview

Available Operations

createPolicy

Example Usage

Parameters

Response

Errors

deletePolicy

Example Usage

Parameters

Response

Errors

getPolicy

Example Usage

Parameters

Response

Errors

getReconciliation

Example Usage

Parameters

Response

Errors

listPolicies

Example Usage

Parameters

Response

Errors

listReconciliations

Example Usage

Parameters

Response

Errors

reconcile

Example Usage

Parameters

Response

Errors

reconciliationgetServerInfo

Example Usage

Response

Errors