Get invoice by external_id

POST 
/merchant-api/v1/invoices/get-by-external-id

This method shows the invoice by external_id

Request

application/json

Body

required

The description for the Post Body.

external_id stringrequired

External id that you specified when creating the invoice

gate_id string

Gate id you specified when creating the invoice

Responses

201

The invoice by external id was successfully geted.

application/json

Schema

Schema

transaction_uid stringrequired

Id of the invoice

amount stringrequired

Amount of money to pay for the invoice

merchant_invoice_fee stringrequired

Fee for the invoice

status stringrequired

Current status of the invoice

remark stringrequired

Description of invoice status

currency_id stringrequired

Currency of the invoice

external_id stringrequired

the information about the client

comment stringrequired

the description of the invoice

created_at stringrequired

Time stamp of the invoice creation

updated_at stringrequired

Time stamp of the invoice update

Example (from schema)

{
  "transaction_uid": "268b2841-ca68-4b55-bf09-25641f1f304a",
  "amount": "2500",
  "merchant_invoice_fee": "10",
  "status": "Created",
  "remark": "Gate error",
  "currency_id": "RUB",
  "external_id": "code123",
  "comment": "My first invoice",
  "created_at": "2022-09-15T07:26:13.893Z",
  "updated_at": "2022-09-15T07:26:13.893Z"
}

Loading...