{"info":{"_postman_id":"c938c6c4-df62-44a5-94b9-b7ae680e8326","name":"Payment","description":"

Authentication

To use the payments API you should do the following:

Sign up at Cryptogram for a free account.
\n
Obtain your access token in the Developer section under your account.
\n
Add the token to the Authorization header of your HTTP requests using the format: Authorization: Bearer YOUR_ACCESS_TOKEN
\n

Payment Workflow

Frontend: Determine the total sum of purchase and currency for a customer.
\n
API: Send a request to create payment of the total sum and currency.
\n
Frontend: Redirect the customer to the generated payment url.
\n
Cryptogram: The customer completes the payment and is redirected back.
\n
API: Listen for payment notification and/or send a request to retrieve the details.
\n

Instant Payments Notifications

IPN (Instant payment notifications, or webhooks) is used to notify you when the status of a payment changes, follow these steps to get started:

Create webhook in the Developer section under your account.
\n
Specify the target url, when the notification will be sent to.
\n
Please make sure that firewall software on your server (such as: Cloudflare) allows our requests to come through. It may be required to whitelist our IP addresses.
\n
When the status of a payment changes, you will receive a POST request at the provided url. The body of the request will only contain the \"id\" of the payment resource, and you should send a request to retrieve the payment details.
\n

{\n    \"resource\": \"CommercePayment\",\n    \"id\": \"6d8eefdb-7e06-47e9-bcc9-7aa320c3aa82\"\n}\n\n

In the event of a failure, we will re-attempt the request for 19 more times over the period of several hours.

Available Wallets

When creating a payment, you must specify the accepted cryptocurrency. Below are the available wallets and their identifiers:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Wallet
btc	Bitcoin
eth	Ethereum
bnb	Binance Coin

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"42478447","collectionId":"c938c6c4-df62-44a5-94b9-b7ae680e8326","publishedId":"2sAYdbQDza","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-03T10:48:38.000Z"},"item":[{"name":"Create Payment","id":"c7b0609e-80da-4634-8f3d-c7231bfa7aea","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{your_access_token}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"currency\": \"USD\",\n \"wallets\": [\"bnb\"],\n \"title\": \"Vulputate ipsum penatibus.\",\n \"description\": \"Ullamcorper quia lorem penatibus? Mi hendrerit sequi fuga. Magni, nobis cum ultrices dapibus provident.\",\n \"redirect\": \"https://cryptogram.vip\",\n \"expires_at\": \"2025-05-19T09:13:28\",\n \"message\": \"Magnam hic esse mollitia! Similique ligula, minus montes pellentesque dis, consequuntur imperdiet.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptogram.vip/api/v1/commerce-payments","description":"

This endpoint should be used to create payment on our servers.

Request Fields:

amount (required): The amount that users have to pay in fiat currency.
\n
currency (required): The fiat currency in which the amount is denominated.
\n
wallets (required): The accepted cryptocurrencies for this payment.
\n
title (required): The title to be displayed on the payment page.
\n
description (required): The description of the payment for the customer.
\n
redirect (required): Where the customer should be redirected to after payment.
\n
message (required): The message that should be displayed to the customer after payment.
\n
expires_at (required): This is when the payment link should expire.
\n

Response Fields:

It is the same as the Get Payment request.

\n","urlObject":{"path":["api","v1","commerce-payments"],"host":["https://cryptogram.vip"],"query":[],"variable":[]}},"response":[{"id":"744e9e5d-2c46-4d6d-a831-4aa282c7c480","name":"Newly Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"currency\": \"USD\",\n \"wallets\": [\"bnb\"],\n \"title\": \"Vulputate ipsum penatibus.\",\n \"description\": \"Ullamcorper quia lorem penatibus? Mi hendrerit sequi fuga. Magni, nobis cum ultrices dapibus provident.\",\n \"redirect\": \"https://cryptogram.vip\",\n \"expires_at\": \"2025-05-19T09:13:28\",\n \"message\": \"Magnam hic esse mollitia! Similique ligula, minus montes pellentesque dis, consequuntur imperdiet.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptogram.vip/api/v1/commerce-payments"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 21 Feb 2025 13:01:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"999"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2a36905c-aadc-4cf5-98e6-0f2b8cdfe57a\",\n \"amount\": 10,\n \"currency\": \"USD\",\n \"title\": \"Vulputate ipsum penatibus.\",\n \"description\": \"Ullamcorper quia lorem penatibus? Mi hendrerit sequi fuga. Magni, nobis cum ultrices dapibus provident.\",\n \"redirect\": \"https://cryptogram.vip\",\n \"message\": \"Magnam hic esse mollitia! Similique ligula, minus montes pellentesque dis, consequuntur imperdiet.\",\n \"expires_at\": \"2025-05-19T09:13:28.000000Z\",\n \"created_at\": \"2025-02-21T13:01:12.000000Z\",\n \"updated_at\": \"2025-02-21T13:01:12.000000Z\",\n \"wallets\": [\n \"bnb\"\n ],\n \"url\": \"https://cryptogram.vip/payments/2a36905c-aadc-4cf5-98e6-0f2b8cdfe57a\",\n \"transaction\": null\n}"}],"_postman_id":"c7b0609e-80da-4634-8f3d-c7231bfa7aea"},{"name":"Get Payment","id":"e4c12f20-2cf3-4f06-8014-8e69d8832450","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{your_access_token}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://cryptogram.vip/api/v1/commerce-payments/{payment_id}","description":"

This endpoint should be used to retrieve payment details

Response Fields:

The payment properties submitted at the time of creation will be included, along with the following additional properties:

id: This is the payment id. Save it with the associated record for the customer at your backend, so that you can use it to verify payment at a later date.
\n
created_at: The date when the payment was created.
\n
updated_at: The last time the payment was updated.
\n
url: The payment link to which the customer should be redirected.
\n
transaction: This is available when the customer has initiated transaction with one of the accepted cryptocurrencies of the payment, otherwise it will be null.
\n
transaction.wallet: This is the wallet the customer has chosen for the payment.
\n
transaction.status: This is the current state. It is one of completed, pending, canceled
\n
transaction.value: This is the expected amount the customer should pay in crypto.
\n
transaction.price: This is the expected amount, converted to fiat currency.
\n
transaction.received: This is the amount that has been received by the customer in crypto.
\n
transaction.received_price: This is the received amount, converted to fiat currency.
\n
transaction.address: This is where the customer should send the crypto.
\n
transaction.completed_at: When the transaction was marked as completed.
\n
transaction.created_at: When the transaction was created.
\n
transaction.updated_at: When the transaction was last updated.
\n

\n","urlObject":{"path":["api","v1","commerce-payments","{payment_id}"],"host":["https://cryptogram.vip"],"query":[],"variable":[]}},"response":[{"id":"7e539a54-bcd4-4e98-b9af-5c2b5f117950","name":"Payment Details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://cryptogram.vip/api/v1/commerce-payments/{payment_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 21 Feb 2025 14:16:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"999"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7344515a-926b-411b-bf95-8064a2341dec\",\n \"amount\": 10,\n \"currency\": \"USD\",\n \"title\": \"Vulputate ipsum penatibus.\",\n \"description\": \"Ullamcorper quia lorem penatibus? Mi hendrerit sequi fuga. Magni, nobis cum ultrices dapibus provident.\",\n \"redirect\": \"https://cryptogram.vip\",\n \"message\": \"Magnam hic esse mollitia! Similique ligula, minus montes pellentesque dis, consequuntur imperdiet.\",\n \"expires_at\": \"2025-05-19T09:13:28.000000Z\",\n \"created_at\": \"2025-02-21T13:38:45.000000Z\",\n \"updated_at\": \"2025-02-21T13:38:45.000000Z\",\n \"wallets\": [\n \"bnb\"\n ],\n \"url\": \"https://cryptogram.vip/payments/7344515a-926b-411b-bf95-8064a2341dec\",\n \"transaction\": {\n \"wallet\": \"bnb\",\n \"currency\": \"USD\",\n \"status\": \"completed\",\n \"value\": 0.01499948,\n \"price\": 10,\n \"received\": 0.0149995,\n \"received_price\": 10,\n \"address\": \"0x91e1fD3da33423Daf871126f9ef831B7f8FF3d4E\",\n \"completed_at\": \"2025-02-21T13:43:04.000000Z\",\n \"canceled_at\": null,\n \"created_at\": \"2025-02-21T13:38:57.000000Z\",\n \"updated_at\": \"2025-02-21T13:43:04.000000Z\"\n }\n}"}],"_postman_id":"e4c12f20-2cf3-4f06-8014-8e69d8832450"},{"name":"Update Payment","id":"f40afab5-d63c-4a6d-802a-2eb8bff9cab1","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{your_access_token}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Facere rhoncus sapien laoreet.\",\n \"description\": \"Exercitation voluptatum etiam rem sem laudantium! Viverra eros, commodi arcu quasi risus facilisi doloribus.\",\n \"redirect\": \"https://cryptogram.vip/auth/login\",\n \"message\": \"Diamlorem molestiae odio cillum, dictumst primis sequi et nobis iusto, penatibus nam placerat augue doloremque.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cryptogram.vip/api/v1/commerce-payments/{payment_id}","description":"

This endpoint should be used to update an existing payment on our servers.

Request Fields:

title: The title to be displayed on the payment page.
\n
description: The description of the payment for the customer.
\n
redirect: Where the customer should be redirected to after payment.
\n
message: The message that should be displayed to the customer after payment.
\n

Response Fields:

It is the same as the Get Payment request.

\n","urlObject":{"path":["api","v1","commerce-payments","{payment_id}"],"host":["https://cryptogram.vip"],"query":[],"variable":[]}},"response":[],"_postman_id":"f40afab5-d63c-4a6d-802a-2eb8bff9cab1"}],"event":[{"listen":"prerequest","script":{"id":"1a97e4de-31b4-430a-9480-f5bda71f0210","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"fec3015e-e511-4663-9c94-2818fe4f49b0","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"app_url","value":"https://cryptogram.vip","type":"string"},{"key":"token","value":"{your_access_token}","type":"string"},{"key":"payment_id","value":"{payment_id}"}]}