Request for payment transaction creating / deposit / create

The request is sent by POST to the address: https://olympz.com/api/deposit/create

The request format is as follows:

Field	Type	Mandatory	Description	Example
amount	float (10,2)	Yes	Transaction amount	10.00
currency	string(3)	Yes	Transaction currency	USD
method_name	string	Yes	Method name	CardChannel1
transaction_id	string	Yes	Transaction number in the merchant system	1234567
system_fields	object	No (relevant for H2H integration only)	Container for additional fields of payment system. You can specify it with your manager.	"system_fields": { "card_number": "4111111111111111", "card_month": "12", "card_year": "2030", "cardholder_name": "Card Holder", "card_cvv": "123"
customer	object	Yes	Container for fields of end-customer / payer. You can specify it with your manager.	customer": { "id": "1", "ip": "127.0.0.1", "email": "[email protected]", "phone": "[phone]", "country": "GB", "last_name": "First", "first_name": "Last"

The example of the request:

{
    "amount": 10.00,
    "currency": "USD",
    "customer": {
        "id": "1234567890",
        "ip": "127.0.0.1",
        "email": "[email protected]",
        "phone": "[phone]",
        "country": "GB",
        "last_name": "First",
        "first_name": "Last"
    },
    "method_name": "CardGate",
    "system_fields": {
        "card_number": "4111111111111111",
        "card_month": "12",
        "card_year": "2030",
        "cardholder_name": "Card Holder",
        "card_cvv": "123"
    },
    "transaction_id": "117013802452690251779442581568"
}  

Response of Olympz:

Field	Type	Mandatory	Description	Example
status	string	Yes	Transaction status 'created' in the case of success, 'error' if an error arose.	created
id	integer	Yes (success)	Transaction number in Olympz system.	500
transaction_id	string	Yes (success)	Transaction number in the Merchant system, if it was transmitted in the request.	1234567
type	string	Yes (success)	Transaction type: 'deposit' – top-up.	deposit
original_amount	string	Yes (success)	The amount, required to be paid by a Client.	10.00
amount	string	Yes (success)	Transaction amount	10.00
currency	string(3)	Yes (success)	Transaction currency.	USD
method_name	string	Yes (success)	Method name.	CardGate
redirect	object	Yes (success)	Container with parameters of redirect.
redirect > url	url	Yes (success)	URL for the request sending.	https://olympz.com/
redirect > method	string	Yes (success)	The request method.	GET
redirect > params	object	Yes (success)	Container with the request parameters. All the parameters in the container need to be sent together with the request. [] will be presented in case of empty params.
code	string	Yes (fail)	Code an error	500
message	string	Yes (fail)	Text description of an error.	Internal server error
data	object	Yes (success)	Container with parameters for display

The example of successful Olympz response:

{
    "id": 4,
    "redirect": {
        "url": "https://olympz.com/payment/checkout",
        "method": "GET",
        "params": {
            "data": "12345678"
        }
    },
    "type": "deposit",
    "amount": "1000",
    "status": "pending",
    "created": 1701379215,
    "message": "",
    "currency": "USD",
    "method_name": "CardGate",
    "transaction_id": "117013802452690251779442581568",
    "original_amount": "1000"
}

The example of unsuccessful Olympz response:

{
    "status": "error",
    "code": "201",
    "message": "Mandatory field `amount` is not present"
}