Getting started

Welcome to LaFinteca's API documentation.

LaFinteca provides a collection of json based APIs that enable you to process and manage payments.

Authentication

Every request should contain the Authorization header with the API key.

Replace {apiKey} with your API key.

Authorization: {apiKey}

Refer to: API Key for more details on acquiring an API key.

Request

Every API call should use the POST HTTP method.

POST /api/v3/order/get-status

POST /api/v3/order/get-status HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=utf-8
Authorization: {apiKey}

{
  "merchantOrderId": "1697633610"
}

Response

WARNING
You should consider any non-200 HTTP status response as unexpected behavior.
For example, if you are getting 5xx http status during withdrawal create request (/api/v3/order/withdrawal/create), you should treat this withdrawal as possibly created.
You must check the status of this withdrawal by calling /api/v3/order/get-status.

Every API response will contain the following structure:

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    # this array or object that will contain the response data or null in case of error, 
  },
  # in case of error, this object will contain the error details.
  # See the "Errors" section below for more details.
  "error": null
}

Errors

During the API call, you may encounter various error types.

The following structure shows how it will look like in the response body:

Sample of error response

Sample of validation violation

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": null,
  "error": {
    # Specific error code. Some of them are listed below
    "code": "ORDER_ALREADY_EXISTS",
    "validationErrors": null
  }
}

Code	Description
`INVALID_DATA`	Invalid request data. Check json syntax
`VALIDATION`	Validation error. See `error.validationErrors` for details
`METHOD_NOT_FOUND`	Endpoint not found
`INVALID_HTTP_METHOD`	Only POST method allowed
`AUTHENTICATION_FAILED`	Check your api token
`ORDER_ALREADY_EXISTS`	Order with same `merchantOrderId` already exists
`ORDER_NOT_FOUND`	Specified order was not found
`REJECTED_DUE_TO_TECHNICAL_ISSUE`	Rejected due to technical issue
`REQUEST_FROM_UNTRUSTED_SOURCE`	Request from untrusted source (ip not allowed)
`PAYIN_DISABLED`	Payment disabled. Contact us to enable
`PAYOUT_DISABLED`	Withdrawal disabled. Contact support to enable
`WALLET_NOT_FOUND`	Wallet not found. Contact support to enable wallet
`WALLET_INACTIVE`	Wallet inactive. Contact support to enable wallet
`ROUTING_NOT_CONFIGURED`	Routing not configured. Please contact us for details
`POINT_NOT_FOUND`	There is no way to process transaction. If issue is persistent please contact us for additional details
`AMOUNT_GREATER_THAN_ALLOWED`	Operation amount greater than allowed
`AMOUNT_LESS_THAN_ALLOWED`	Operation amount less than allowed
`NOT_ENOUGH_BALANCE`	Operation amount greater than available balance
`OPERATION_NOT_SUPPORTED`	Operation not supported
`REFERER_REQUEST_DOES_NOT_MATCH_ALLOWED_SOURCES`	Referer from request does not match user hosts. Please contact us if you have any questions.
`UNKNOWN`	Unknown error

Breaking changes

In the ever-evolving realm of software development, we recognize the critical importance of maintaining the functionality and security of our API. However, we also understand that changes to the API can potentially disrupt your existing applications.

Our unwavering commitment is to provide developers and users of our API with steadfast and reliable service. We acknowledge that significant changes, often referred to as 'breaking changes' may affect your applications, and we want to assure you that we are here to support you through these transitions.

Our promise to you includes:

Timely Communication: We will proactively inform you of any breaking changes that may impact your application or workflow, ensuring you have adequate time to prepare.
Transparency: We are committed to providing clear and comprehensive documentation about the nature of breaking changes, their implications, and the rationale behind them.
Assistance and Support: We are dedicated to helping you navigate these changes. If you have questions or need assistance during the transition, our support team is just a message away.

We deeply value your partnership and appreciate your trust in our API. If you have any questions or require further assistance, please don't hesitate to contact us.

Thank you for choosing our API, and we are eager to continue providing you with the best possible service.

Getting started

Authentication

Request

Response

Errors

Breaking changes

Are there any inquiries still outstanding?

Getting started