Transaction status notification

Notification is sent if the Merchant specifies the corresponding URL in the deposit/create or payout/create request in case of transaction status changing. The request has headers Auth and Sign, signature and authorization should be checked, the merchant keys are used. The request is written as follows:

The response format:

Field
Type
Mandatory
Description
Example

status

string

Yes

Transaction status: 'ok' – successful, 'pending' – has non final status, 'cancel' – canceled, 'error' – an error has occurred, 'authorized' - has been authorized.

ok

id

integer

Yes

Transaction number in Olympz system.

500

transaction_id

string

Yes

Transaction number in the Merchant system, if it was transmitted in the request.

1234567

type

string

Yes

Transaction type: 'deposit', 'payout', 'refund'.

deposit

amount

string

Yes

In case of deposit — the amount paid by a Client. In case of payout – the amount paid to a Client.

10.00

currency

string(3)

Yes

Transaction currency.

USD

method_name

string

Yes

Method name.

CardChannel1

created

integer

Yes

Transaction creation time.

1500000000

updated

integer

Yes

Time of the last status change.

1510000000

original_amount

string

No

This field appear in case of currency conversion. It points amount that was received from Merchant.

1

message

string

No

Error description in case of failure.

operation_time_out

system_fields

object

No

Container for additional fields of payment system that you've sent.

Notification example:

{
    "id": "500",
    "status": "ok",
    "message": "",
    "type": "deposit",
    "transaction_id": "1234567",
    "original_amount": "10.00",
    "amount": "10.00",
    "currency": "USD",
    "method_name": "CardChannel1",
    "created": 1500000000,
    "updated": 1510000000,
    "system_fields": {
        "card_number": "411111******1111"
    }
}

The system will make efforts to send the notification no more than 20 times. The interval between efforts will grow each time.

The system concludes the successful notification delivering, if the response with code 200 and body:

{
    "answer": "ok"
}                

Last updated