CityPay
  • Merchant Payment Gateway
  • Introduction
    • API Overview
    • API Authentication
    • Error Codes
  • Endpoints and callbacks
    • Create Order
    • Get Order information
    • Deposit
    • Order Status
    • Payment Callback
    • Exchange rates
    • IP Addresses
    • Sandbox
  • Order API in your UI
    • Log in
    • Generate Order
    • Choose crypto
    • Get Order
    • Update order rates
    • Get Order History
Powered by GitBook
On this page

Was this helpful?

  1. Order API in your UI

Get Order

Use this method to get order information

Get URL

GET https://v2-order-api.citypay.io/orders/api/:token

This endpoint allows retrieving order information.

Headers

Name
Type
Description

bearer_token

string

Use log in to get bearer token

 “success”: true,
  “data”: {
    “companyName”: string,
    “id”: number,
    “customerId”: number,
    “token”: string,
    “coin”: null,
    “coinBaseName”: null,
    “exchangeRate”: null,
    “amountFiat”: string,
    “amount”: null,
    “dueDate”: null,
    “currency”: {
      “id”: number,
      “currency”: string,
      “abbreviation”: string
    },
    “createdAt”: date,
    “createdAtMiliseconds”: number,
    “type”: string,
    “expiresAt”: number,
    “expirationTime”: number,
    “email”: string,
    “qrCode”: string,
    “status”: {
      “code”: string,
      “label”: string
    },
    “coins”: [
      {
        “id”: number,
        “name”: string,
        “code”: string,
        “basename”: string
      }
    ],
    “urls”: {
      “callbackUrl”: string,
      “successUrl”: string,
      “cancelUrl”: string
    }
  },
  “message”: null
}

PreviousChoose cryptoNextUpdate order rates

Last updated 4 years ago

Was this helpful?