Get Payment by Id sale.payment.get

Scope: sale

Who can execute the method: administrator

This method retrieves the values of all payment fields by Id.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
sale_order_payment.id

Payment identifier

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":6}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.payment.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":6,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.payment.get
        
try
        {
        	const response = await $b24.callMethod(
        		"sale.payment.get",
        		{
        			"id": 6
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.payment.get',
                    [
                        'id' => 6,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Payment data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting payment information: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "sale.payment.get",
            {
                "id": 6
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.payment.get',
            [
                'id' => 6
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "payment": {
                    "accountNumber": "161\/1",
                    "comments": "",
                    "companyId": null,
                    "currency": "USD",
                    "dateBill": "2022-10-14T16:46:27+02:00",
                    "dateMarked": null,
                    "datePaid": null,
                    "datePayBefore": null,
                    "dateResponsibleId": "2022-10-14T16:46:27+02:00",
                    "empMarkedId": null,
                    "empPaidId": null,
                    "empResponsibleId": 1,
                    "empReturnId": null,
                    "externalPayment": "N",
                    "id": 6,
                    "id1c": "",
                    "isReturn": "N",
                    "marked": "N",
                    "orderId": 5,
                    "paid": "N",
                    "payReturnComment": "",
                    "payReturnDate": null,
                    "payReturnNum": "",
                    "paySystemId": 6,
                    "paySystemIsCash": "Y",
                    "paySystemName": "Cash",
                    "paySystemXmlId": "bx_64134ba550ffa",
                    "payVoucherDate": null,
                    "payVoucherNum": "",
                    "priceCod": "0",
                    "psCurrency": "",
                    "psInvoiceId": null,
                    "psResponseDate": null,
                    "psStatus": "",
                    "psStatusCode": "",
                    "psStatusDescription": "",
                    "psStatusMessage": "",
                    "psSum": null,
                    "reasonMarked": "",
                    "responsibleId": 1,
                    "sum": 2352,
                    "updated1c": "N",
                    "version1c": "",
                    "xmlId": "bx_6349845343355"
                }
            },
            "time": {
                "start": 1713446368.239796,
                "finish": 1713446369.113212,
                "duration": 0.8734161853790283,
                "processing": 0.4978961944580078,
                "date_start": "2024-04-18T16:19:28+02:00",
                "date_finish": "2024-04-18T16:19:29+02:00"
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response

payment
sale_order_payment

Payment information

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error":200640400001,
            "error_description":"payment does not exist"
        }

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

200640400001

Payment not found

200040300010

Insufficient permissions to read payment

100

Parameter id not specified

0

Other errors (e.g., fatal errors)

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Update Payment
Next
Get List of Payments