Payment Status API Documentation

Endpoint: Fetch Payment Status

Stage Host: https://stage-api.futurapay.com/
Live Host: https://api.futurapay.com/

Endpoint URL:

/api/v1/futurapay/payment/status

Method: POST

Request Body:

The request must be sent in JSON format with the following parameters:

Parameter	Type	Required	Description
`api_key`	String	Yes	API key for authentication.
`customer_transaction_id`	String	Yes	Unique ID associated with the customer transaction.

Sample Request Body:

{
    "api_key": "apiKey66a33e22470a2",
    "customer_transaction_id": "7192692104996"
}

Response:

The response will be returned in JSON format.

Field	Type	Description
`message`	String	Status message of the response.
`success`	Boolean	Indicates whether the request was successful.
`data`	Object	Contains the transaction details if successful.
`data.id`	Integer	Unique ID of the transaction.
`data.uuid`	String	UUID for the transaction.
`data.merchant_user_id`	Integer	ID of the merchant user.
`data.currency_id`	Integer	Currency ID used in the transaction.
`data.get_way_id`	Integer	ID of the gateway used for the payment.
`data.hash_token`	String	Hash token for the transaction.
`data.type`	String	Type of transaction (e.g., collection).
`data.customer_transaction_id`	String	Customer transaction ID.
`data.transaction_id`	String	System-generated transaction ID.
`data.ref_transaction_id`	String	Reference transaction ID (if any).
`data.x_reference_id`	String	External reference ID (if any).
`data.order_id`	String	Order ID related to the transaction.
`data.currency_code`	String	Currency code (e.g., EUR).
`data.country_id`	Integer	Country ID.
`data.amount`	Float	Amount of the transaction.
`data.initiate_amount`	Float	Initial amount (if any).
`data.usd_equivalence`	Float	USD equivalent of the transaction amount.
`data.local_currency_equivalent`	Float	Equivalent amount in local currency.
`data.freemium_amount`	Float	Amount from freemium services.
`data.fee_amount`	Float	Fee applied for the transaction.
`data.transaction_date`	String	Date of the transaction (YYYY-MM-DD).
`data.phone_number`	String	Phone number involved (if any).
`data.local_currency`	String	Local currency used (e.g., EUR).
`data.from_address`	String	Address of the sender (if applicable).
`data.to_address`	String	Address of the recipient.
`data.transaction_datetime_utc`	String	UTC datetime of the transaction.
`data.payment_method`	String	Payment method used (e.g., Card, MoonPay).
`data.pay_token`	String	Payment token (if applicable).
`data.transaction_year`	String	Year of the transaction.
`data.status`	String	Status of the transaction (e.g., pending).
`data.crypt_network_code`	String	Cryptocurrency network code (if any).
`data.cryto_hash_id`	String	Crypto hash ID (if applicable).
`data.hash_id_crypto_value`	String	Value of the crypto hash ID.
`data.block_chain_asset_api_balance`	String	Blockchain API balance.
`data.block_chain_usd_equivalent`	Float	USD equivalent of the blockchain asset.
`data.net_amount`	Float	Net amount after fees.

Sample Success Response:

{
    "message": "Transaction details fetch successfully.",
    "success": true,
    "data": {
        "id": 10,
        "uuid": "34e0ca01-cb63-44b8-830b-fbceb41173e4",
        "merchant_user_id": 5,
        "currency_id": 83,
        "get_way_id": 6,
        "hash_token": "444b845ba6d58c179756ccc3b4ecd39b6734cbf6ba0d52dbd78e3418d6512f15",
        "type": "collection",
        "customer_transaction_id": "7192692104996",
        "transaction_id": "txn9865549474849",
        "ref_transaction_id": null,
        "x_reference_id": null,
        "order_id": null,
        "currency_code": "EUR",
        "country_id": 82,
        "amount": 59.58,
        "initiate_amount": 0,
        "usd_equivalence": 54.6,
        "local_currency_equivalent": 50,
        "freemium_amount": 37,
        "fee_amount": 9.58,
        "transaction_date": "2024-08-09",
        "phone_number": null,
        "local_currency": "EUR",
        "from_address": "null",
        "to_address": "bchtest:qrn45hfjpqd0w5p7dur5a2aasgp3nj8d8qh4exym5k",
        "transaction_datetime_utc": "2024-08-09 14:08:49",
        "payment_method": "Card(MoonPay)",
        "pay_token": null,
        "transaction_year": "2024",
        "status": "pending",
        "crypt_network_code": null,
        "cryto_hash_id": null,
        "hash_id_crypto_value": null,
        "block_chain_asset_api_balance": null,
        "block_chain_usd_equivalent": null,
        "net_amount": 0
    }
}

Error Handling:

If the request body or required fields are not provided or are invalid, the following responses may be returned:

If api_key is missing or invalid:

{
    "message": "The selected api key is invalid. field is required.",
    "success": false,
    "data": []
}

If customer_transaction_id is missing or invalid:

{
    "message": "The selected customer transaction id is invalid. field is required.",
    "success": false,
    "data": []
}

Notes:

Ensure that the api_key is valid and authorized for access.
The customer_transaction_id should be unique and already associated with an existing transaction.

Error Responses:

400 Bad Request: If required parameters are missing or invalid.
401 Unauthorized: If the API key is invalid or not provided.
500 Internal Server Error: If there is an issue with the server processing the request.