Transaction · Standard API · eKYC Core

Finish a transaction

POST/v1/transactions/{transaction_id}/finish

Finishes a transaction and returns the transaction id.

Request

MethodPOST
Path/v1/transactions/{transaction_id}/finish
Content-Typeapplication/json
Auth requiredYes — HMAC signing
NameTypeRequiredDescriptionSupported countries
vilcaf_numberstringOptionalCAF Numberindia
status_codeintOptionalstatus codeindia
JSON
{
    "vilcaf_number", string,
}

Sample request

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/transactions/3b4bf7b6-088b-4931-9279-9259f5c34fe3/finish \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "vilcaf_number": "CAF_123456789"
}
'

Response

On success the HTTP status code is 200, and data.id is returned. The errors array uses the shared response envelope.

JSON
{
    "data": {
        "id": uuid,
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

A finished transaction comes back like this:

JSON
{
    "data": {
        "id": "416ab0e7-13a2-4b4b-9304-03bb8612d817"
    }
}

Failure codes

If the data.status is "failure", the "errors" field will tell you why it failed.

In case of any other errors, the data field will be empty, and the server sends one of following HTTP status code with error code:

HTTP codeError codeDescription
401access_denied_exceptionYou are not authorized to perform the action.
400invalid_parameter_exceptionInput parameter violates a constraint.
400request_time_too_skewedThe X-TV-Timestamp header is expired, need a newer one.
408request_timeout_exceptionRequest takes too long to process
429rate_limit_exceptionThe number of requests exceeded your throughput limit.
500internal_server_errorSome unexpected error occurs while processing the request

The codes above are the ones documented for this endpoint. Response errors on the Overview lists the codes for the eKYC Core surface as a whole — the two lists do not match on every endpoint.