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
  • Description
  • Create Deposit

Was this helpful?

  1. Endpoints and callbacks

Deposit

Description

The deposit page URL is generated by sending a call to create s deposit method. The payment URL is generated after a successful call. You should redirect the buyer to that payment URL. On this page, the buyer can see address, select the desired payment currency, and make transactions.

Create Deposit

POST https://v2-listener.citypay.io/api/generateDeposit

This method allows you to create a deposit.

Path Parameters

Name
Type
Description

customer_id

string

Your account's ID

access_token

string

Token generated by CityPay for granting access

deposit_id

string

Deposit ID

deposit_token

integer

Unique identification for your customer

{
    "status": 1,
    "status_code ": 201,
    "message": {
        "id": 7,
        "payment_url": "https://v2-order.citypay.io/deposit?token=22332334232323232323",
        "token": "22332334232323232323"
    }
}
{
    "status": "error",
    "status_code ": 404,
    "message": {
         "message": "customer_id not found !"
    }
}

PreviousGet Order informationNextOrder Status

Last updated 4 years ago

Was this helpful?