List of payment requests

Parameters

HTTP method

Access rights

URL

Parameters

Note

GET payments https://api.admitad.com/payments/
  • limit**
  • offset**
  • has_statement***

Returns the list of payment requests.*

GET payments https://api.admitad.com/payments/{id}  

Returns payment request, where id is the payment request ID.*

  • * Returns the result in the JSON format.

  • ** Sets skipping and the number of records returned. For example limit=5&offset=2.

  • *** Filter by the availability of an extract from the payment request. Available values: 1/0. For example: has_statement=1.

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/payments/?limit=2&has_statement=0

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/payments/64/

Example of the response from the API server in the JSON format:

{
    "results": [
        {
            "status": "pending",
            "comment": "",
            "billing_info": {
                "id": 9,
                "name": "RUB #9"
            },
            "finally_currency": "RUB",
            "datetime": "2012-05-27 19:45:07",
            "currency": "EUR",
            "conversion_rate": "82.72",
            "payment_sum": "35742.00",
            "cancel_bill_id": null,
            "converted_payment_sum": "2956488.88",
            "has_statement": false,
            "id": 335,
            "withdrawal_type": "webmoney"
        },
        {
            "status": "processed",
            "comment": "",
            "billing_info": null,
            "finally_currency": "EUR",
            "datetime": "2012-05-27 13:45:07",
            "currency": "EUR",
            "conversion_rate": "1.0",
            "payment_sum": "1212.00",
            "cancel_bill_id": "P-RU-W.3-1",
            "converted_payment_sum": "1212.00",
            "has_statement": false,
            "id": 333,
            "withdrawal_type": "webmoney"
        },
    ],
    "_meta": {
        "count": 6,
        "limit": 2,
        "offset": 0
    }
}

Description of API server response fields

Name

Description

id

Payment ID

status

Payment status

comment

Comments to the payment

billing_info

Payment information

datetime

Time of payment

currency

Balance currency

finally_currency

Payment currency

converted_payment_sum

Currency exchange rate

payment_sum

Payment amount in balance currency

converted_payment_sum

Payment amount in payment currency

withdrawal_type

Withdrawal method

has_statement

Availability of a statement on the payment request

cancel_bill_id