{"info":{"_postman_id":"4454f69b-d985-46c6-b058-cdbf96a98b32","name":"CoinZoom Merchant Payment API","description":"

The merchant API is only available to selected CoinZoom customers. Please contact CoinZoom to get a merchant account set up.

To get started please register an account in our stage environment. https://stage.coinzoom.com Once you have registered your account let us know and we will enable the payment API's.

Each API call must include the 'Coinzoom-Api-Key' and 'Coinzoom-Api-Secret' HTTP headers to authenticate the account. These keys can be created within the the CoinZoom exchange from the 'API Trading' menu.

In order to test the mobile payments in our stage environment you will need to downlaod a copy of our mobile app, CoinZoom Prime using an Apple Test Flight version that can be found here: https://testflight.apple.com/join/0xtc0IQc

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8443211","collectionId":"4454f69b-d985-46c6-b058-cdbf96a98b32","publishedId":"Tz5s5xP1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"60bb46"},"publishDate":"2021-03-16T20:43:59.000Z"},"item":[{"name":"Create Payment","id":"21b1083d-e366-4ebe-bb71-8eeff9c9c957","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"invoiceNumber\": \"INV131\",\n \"description\": \"payment\",\n \"returnUrl\": null,\n \"customData\": {\"id1\": 1, \"id2\": 2},\n \"expiryMinutes\": 5,\n \"startDate\": null,\n \"prices\": [\n {\"currency\": \"ZOOM\", \"price\": 100}\n ],\n \"recurrence\": {\n \"unit\": \"WEEKLY\",\n \"frequency\": 1,\n \"cancellationText\": null,\n \"limits\": [\n {\"currency\": \"ZOOM\", \"maxPrice\": 70}\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/create","description":"

Creates a payment for use on a merchant's checkout process. The following fields are mandatory.

description: This is a string of up to 255 characters describing the goods being purchased
prices: This is an array of the currencies the merchant is willing to accept and, for each currency, the price of the goods. This specifies the amount the merchant will receive (minus fees).

The following optional fields can be provided.

invoiceNumber: This is a string of up to 50 characters
returnUrl: This is an optional URL to display to the customer at the end of the payment if they use the CoinZoom IFrame. If not provided the default returnUrl for the merchant account will be used, or if this is not set, the CoinZoom default payment confirmation screen will be used.
expiryMinutes: The length of time in minutes that the prices are valid. If not specified the default is 30 minutes.
startDate: If the goods will not be shipped, and payment processed, until a future date this should be populated with that date in YYYY-MM-DD format.
customData: An arbitrary JSON data structure that will be quoted back to the merchant when the status of the payment changes. The JSON can be up to 255 characters in length.
referralToken: The external identifier returned by a customer onboarding request. In this case the payment is for a customer who does not yet have a CoinZoom account. When the customer uses the IFrame URL provided they will be able to complete their CoinZoom account before continuing with the payment. CoinZoom mobile application payment is not currently supported for customers without a CoinZoom account.

Finally, if the payment is recurring, the recurrence section must be provided:

unit: DAILY, WEEKLY or MONTHLY
frequency: A positive whole number
cancellationText: This is optional text that will be displayed to the customer if they later choose to cancel a recurring payment.
limits: An array specifying the maximum price that will be taken on each subsequent instalment of the payment. The currencies must match the prices array.

CoinZoom will not trigger each instalment of a recurring payment. The merchant must call the trigger recurring payment endpoint when the next instalment is due.

The response from this endpoint provides a unique identifier for the payment. For each currency it provides a URL to launch the CoinZoom IFrame URL and a Base64 encoded PNG QR Code to launch the CoinZoom mobile application

\n","urlObject":{"path":["api","v1","public","payment","create"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[{"id":"467be403-962e-43e7-808f-84a887dcd9d8","name":"Create Payment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"invoiceNumber\": \"INV130\",\n \"description\": \"payment\",\n \"returnUrl\": null,\n \"customData\": null,\n \"expiryMinutes\": 5,\n \"prices\": [\n {\"currency\": \"ZOOM\", \"price\": 100},\n {\"currency\": \"BTC\", \"price\": 0.01}\n ],\n \"recurrence\": {\n \"unit\": \"WEEKLY\",\n \"frequency\": 1,\n \"cancellationText\": null,\n \"limits\": [\n {\"currency\": \"ZOOM\", \"maxPrice\": 70},\n {\"currency\": \"BTC\", \"maxPrice\": 0.007}\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2492"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"56b44821-1659-4d6b-a7f1-43e5fc446edc\",\n \"prices\": [\n {\n \"currency\": \"ZOOM\",\n \"url\": \"http://localhost:4202/payment?id=56b44821-1659-4d6b-a7f1-43e5fc446edc¤cy=ZOOM\",\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAMgAAADIAQAAAACFI5MzAAAC6ElEQVR4Xu2XPY7cMAyFOVDhzr6AAF1Dna7kuYB/LmBfSZ2uIUAX8HQqDDOPG6w9CZJiaSBIscIWC38DU0M+PnKI/3bo9wfn+SbfRM6/JJEeiTeyrXdLyGMiam6QxK+0jxH/mK2x1Dg8uUHoGXPrLVGZGj4a+7hJGDd1Ly6vmodwn+xdLBOZw5eVbxLJQZfKC9EQhH/LzheJ1Mc+r79fK/dVIpCXhiQC2+7nEz0hvLuLtie3pjxG1PwO2QdvWzILxNjwEswS7hCoJlNjXlIit/lyZlRDKvojd+zQKNSUJUg0PeH8TOYgyessmShTuEEir9HNKfee2mZv/ZUDDaluCzRKBJ48arX35/dRkJhHNogDX2kDRE0j3yH2GVETM/nci7vwFm6QWta4Q86v5OAua7V0i5gXu4UcXIpoJyT1zI6CiK5RFjtWM9cyJxo+46hI2Tw9Kk8NfBRxzJkDDYnu8AQBznEfGiTDrfJxLeEdPdfSR8MR/J5O7agIVAMZIq+2q8jrfuVAQRJ6jvEYjjU0+cNK7xCLwTijj5nGJGkYJbiW1I9RVh3mz0TQOF2qUpCU8e4ezpfMHN0KmZ83UJCI9qWW7KMWrrmnqz4aUsU7H8ktHv5XlubNqxQkIgH7I5pVNIi72/GzPhrCeHeZPPSIBOSu8qVrBYk7BTdHLBSocx7es6MgqcBX8PoDM82jVlh8bpCKUkPRUA0mNmp1bSgqglxiPKJKvKYi5TqrrSAMa8fY4cPbPiAf0oJ6AoOvZQtuCnbkfaxOPq0mVcZ1x2YKqLksd8P5fTQEcs4dGjfg7rLJHncIdC0bsShxCWi+N1UpCI5sdtiL5b7Hm1dpCHbYmh+MOWY2n7HPnl6lIbBkWDvt8NGhMRhoZwerCBJJrcfPJuoqfu7g+jeJ7T2mokTAJntWW0ni3soiDCu1z2rOLlERlg0lYG/CTwozM3Vv2fkyQX2wVpDBrJhCRq0uVSnIn883+SZy/mfyA2G331Drx5uaAAAAAElFTkSuQmCC\"\n },\n {\n \"currency\": \"BTC\",\n \"url\": \"http://localhost:4202/payment?id=56b44821-1659-4d6b-a7f1-43e5fc446edc¤cy=BTC\",\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAMgAAADIAQAAAACFI5MzAAAC4ElEQVR4Xu2Xsa3jMAyGaahwZy8gQGuo80r2Ao6zgL2SOq0hQAvYnQohvF95eI7f4a4IBRyuiJBKnwEK5M+fDPHfDv1+cZ4P+ZBy/iVx1HjeSXeWbhxunqitIJ4Pn28On+Rx0NQa3FQQmlzoLO7U0vKj1U0lYbzUHKw4hXmoJ7l3cSe127hxJSk56H28IxqC8G/ZeZOU+ujp9ftZuXdJgby2VCIw9V83ckKTV6vVI5nNh5tT+xlHQvJsdZ9opty1vA5qHSqIL+pbW3V4tZAebXzlWkAS+gNFNrimNq6D7r5fLSE+TD70rjTK3SETcTlfLSG8udA4s1vq2tzZSw4E5HkH+YzEi0Wt8niqSkB8ZDZoXPhKhwgeHlNBGFpWh1OLDSNliHofagjcLk/JHN7AXbakqYYkdWezUnk4lThFj3LC/ICirUZ/3FO8e5rPF0hIaBI1iSGZZUAcdcnB+8Tp2RIEiCDov57NVj6XEs5EoYOc0XAEv6dTOyKC+uBOHYz2RV7z7YwjICg1jPmpIHz1tNIaQqV3ccfotjxf4whIKl51JLiLggyRg4vvvE9Kz6FrUWT0itlSPOsjIXgyepd04+KR0Hav+khI4s1juiKCWinCnk+vkhDHR8qNUxsgw+lhMxUEZWnjYjNZhMo9wpZLKXGZBvQcxiNKHeZrdgTEx0eLOmN0w+nDXBafClJKjWssKZjY6u7NORslxH0FITTcBh0llKiCMPTCq8Xw0SO8aghnz4kIaqIehEUM3ZZvyZQ7MUnQNRJJZDGCynI3v3QtIOq5BWP4w/ZgMyhXBXEwA+yGcFOzDmi+i6oEBKcsKdiL9Uz8w2EFBDtsCg1jjmG/DlguTq+SEFhyMhiP8FEIfEGc72qLCHYc6iz+NlGfsJHh+ZUEkwdTEYOIV3pVW0hc7soijC1ATzCGKgK9oM7PueGxrVB/yc7bBPXh8ocJttcN2C/CS1UC8ufzIR9Szv9MfgGuJfQgiXd8sgAAAABJRU5ErkJggg==\"\n }\n ]\n}"},{"id":"c95c1b76-f23f-41be-97ba-36aeba6688cd","name":"Create Payment for New Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"invoiceNumber\": \"INV130\",\n \"description\": \"payment\",\n \"returnUrl\": null,\n \"customData\": null,\n \"expiryMinutes\": 5,\n \"prices\": [\n {\"currency\": \"ZOOM\", \"price\": 100},\n {\"currency\": \"BTC\", \"price\": 0.01}\n ],\n \"referralToken\": \"f9980a7d-3ace-42df-ac19-5fc6a79f22fe\"\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2492"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"56b44821-1659-4d6b-a7f1-43e5fc446edc\",\n \"prices\": [\n {\n \"currency\": \"ZOOM\",\n \"url\": \"http://payment.coinzoom.com/sign-up?referralToken=f9980a7d-3ace-42df-ac19-5fc6a79f22fe&id=56b44821-1659-4d6b-a7f1-43e5fc446edc¤cy=ZOOM\"\n },\n {\n \"currency\": \"BTC\",\n \"url\": \"http://payment.coinzoom.com/sign-up?referralToken=f9980a7d-3ace-42df-ac19-5fc6a79f22fe&id=56b44821-1659-4d6b-a7f1-43e5fc446edc¤cy=BTC\"\n }\n ]\n}"}],"_postman_id":"21b1083d-e366-4ebe-bb71-8eeff9c9c957"},{"name":"Update Payment","id":"bcdec200-14b3-42f7-aca3-34d799b86d46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"paymentId\": \"f2031b0c-b0af-4b9b-9e3b-ad60f21dc4a3\",\n \"prices\": [\n {\"currency\": \"ZOOM\", \"price\": 120}\n ],\n \"recurrencyLimits\": [\n {\"currency\": \"ZOOM\", \"maxPrice\": 80}\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/updateprice","description":"

Once a payment is created the prices are valid for a limited time. If the customer does not confirm the payment the merchant can use this endpoint to update the prices. The updated prices will then be valid from the current time to the specified number of minutes. The expiry will be 30 minutes if not explicitly specified.

\n","urlObject":{"path":["api","v1","public","payment","updateprice"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bcdec200-14b3-42f7-aca3-34d799b86d46"},{"name":"Request Recurring Max Price Change","id":"d1a3f732-1a36-4444-b4bf-383bd4add480","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"paymentId\": \"43091e6b-8981-486a-a84e-27500c3e367a\",\n \"maxPrice\": 630,\n \"currency\": \"ZOOM\"\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/increase/recurring/limit","description":"

Once a recurring payment is accepted CoinZoom will enforce the agreed maximum price on each instalment. Use this endpoint to increase the limit. CoinZoom will notify the customer and they will need to accept the change before it comes into effect.

The currency should match the one used when the initial payment was accepted.

\n","urlObject":{"path":["api","v1","public","payment","increase","recurring","limit"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1a3f732-1a36-4444-b4bf-383bd4add480"},{"name":"Get Payment","id":"0d19373b-5d3f-4bec-b4a1-4a97527c44e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"url":"{{coinzoomHost}}/api/v1/public/payment/get/c7b44082-adbc-4f70-a670-96589d43b24e","description":"

Use this endpoint to query the status of a payment, quoting the identifier for the payment in the URL.

\n","urlObject":{"path":["api","v1","public","payment","get","c7b44082-adbc-4f70-a670-96589d43b24e"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[{"id":"71945702-24ce-4fca-a894-4e8e1183b160","name":"Get Payment","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"url":"{{coinzoomHost}}/api/v1/public/payment/get/c7b44082-adbc-4f70-a670-96589d43b24e"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Jun 2021 22:39:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"0ac2e097290000a08c5dbf1000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"6618039eafd9a08c-SLC"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentId\": \"c7b44082-adbc-4f70-a670-96589d43b24e\",\n \"created\": \"2021-06-18T22:16:19.991991Z\",\n \"status\": \"COMPLETED\",\n \"invoiceNumber\": \"INV124\",\n \"timePaid\": \"2021-06-18T22:17:38.379584Z\",\n \"paidCurrency\": \"ZOOM\",\n \"paidPrice\": 0.995,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"WEEKLY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null,\n \"zoomMeHandle\": \"ZoomMe:paxton\"\n}"}],"_postman_id":"0d19373b-5d3f-4bec-b4a1-4a97527c44e1"},{"name":"Query Payments","id":"674c35ee-7b4c-4226-b2b3-d483bac72f3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"status\": [\"CREATED\"],\n \"recurringPaymentId\": null,\n \"recurringStatus\": null,\n \"size\": 500,\n \"start\": null,\n \"end\": null,\n \"bookmarkPaymentId\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/query","description":"

This request returns a list of payments. The values in the status array can be:

CREATED (a payment that hasn't been completed by the customer)
COMPLETED (a payment that has been paid by the customer)
INSUFFICIENT_FUNDS (a recurring instalment that failed because the customer had insufficient funds)

If recurringPaymentId is provided only the instalments of this payment will be returned.

The recurringStatus should only be used when querying for recurring payments. It can be one of:

ACTIVE
CUSTOMER_CANCELLED
PARTNER_CANCELLED

The data is returned in pages controlled by the size field. For the initial request pass null in the bookmarkPaymentId field. To get the next page of data pass the paymentId of the last entry in the previous call as the bookmarkPaymentId.

\n","urlObject":{"path":["api","v1","public","payment","query"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[{"id":"91e9c54d-205f-4f6c-993a-0cf9a9fd23d1","name":"Query Payments","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"status\": [\"CREATED\"],\n \"recurringPaymentId\": null,\n \"recurringStatus\": null,\n \"size\": 500,\n \"start\": null,\n \"end\": null,\n \"bookmarkPaymentId\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/query"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"5222"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"paymentId\": \"6af8f6ee-de8f-4a4c-a3b4-ced0a760f9dd\",\n \"created\": \"2021-03-10T23:55:46.623797Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"WEEKLY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"0c04d04b-bec8-4c93-b3b2-81674e883991\",\n \"created\": \"2021-03-09T18:57:31.329590Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"DAILY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"30a07a05-8485-4b94-b6ed-dce4ebcbf858\",\n \"created\": \"2021-03-09T00:02:27.033463Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"DAILY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"589eab3e-3997-44aa-ad90-dca7bcfceea2\",\n \"created\": \"2021-02-25T23:21:45.376051Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": null,\n \"recurringUnit\": null,\n \"recurringFrequency\": null,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"bdeb1cb3-febc-4d04-b13e-ace558b6135b\",\n \"created\": \"2021-02-25T23:21:29.695011Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"DAILY\",\n \"recurringFrequency\": 2,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"6647cf8b-83c2-4218-9782-65e10ecb126b\",\n \"created\": \"2021-02-25T22:18:16.467885Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": null,\n \"recurringUnit\": null,\n \"recurringFrequency\": null,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"43edf7ee-29d9-4663-9a8d-0e4c9818f38d\",\n \"created\": \"2021-02-25T02:07:29.845051Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"WEEKLY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"2b85c609-f891-42eb-8b5c-10c94449f29e\",\n \"created\": \"2021-02-25T01:44:54.495312Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"WEEKLY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"7759ea17-16e2-4690-a6bc-6ae03082a5f1\",\n \"created\": \"2021-02-21T20:07:51.130640Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"WEEKLY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"3719966d-8fd5-4634-95e4-5ff20b4e9a0c\",\n \"created\": \"2021-02-17T19:05:41.670093Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV-demo\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": null,\n \"recurringUnit\": null,\n \"recurringFrequency\": null,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"cc3f80eb-1e6c-4915-8e13-8939a6938c33\",\n \"created\": \"2021-02-17T02:30:56.807691Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"WEEKLY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"fd85253a-6256-494d-88d6-e7437af29885\",\n \"created\": \"2021-02-15T23:33:36.357864Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"WEEKLY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"6ce875d6-b950-49d8-afb1-74d9d36b16e2\",\n \"created\": \"2021-02-15T23:28:06.314899Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"WEEKLY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n },\n {\n \"paymentId\": \"44caccd0-0593-438a-a196-bcba45f4ae3e\",\n \"created\": \"2021-02-15T19:08:29.034222Z\",\n \"status\": \"CREATED\",\n \"invoiceNumber\": \"INV130\",\n \"timePaid\": null,\n \"paidCurrency\": null,\n \"paidPrice\": null,\n \"recurringStatus\": \"ACTIVE\",\n \"recurringUnit\": \"WEEKLY\",\n \"recurringFrequency\": 1,\n \"recurringPaymentId\": null,\n \"timeCancelled\": null\n }\n]"}],"_postman_id":"674c35ee-7b4c-4226-b2b3-d483bac72f3c"},{"name":"Cancel Recurring Payment","id":"1859498f-a72c-4c0b-8410-2e8dc7665aac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"paymentId\": \"503e36ca-c43d-439d-8401-868061369d13\"\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/cancel/recurring","description":"

This endpoint can be used by the merchant to cancel a recurring payment. Once the payment is cancelled CoinZoom will reject any future requests to pay instalments.

\n","urlObject":{"path":["api","v1","public","payment","cancel","recurring"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1859498f-a72c-4c0b-8410-2e8dc7665aac"},{"name":"Trigger Recurring","id":"d76a9c05-586b-4699-bc63-fc6394700481","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"paymentId\": \"f668094c-6baa-40e8-94c6-834e7b14bcdd\",\n \"price\": 60,\n \"invoiceNumber\": \"INV131-Jun\",\n \"customData\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/trigger/recurring","description":"

When a recurring payment is due its next instalment this endpoint should be called. The identifier for the original payment, creating the recurring process, should be quoted.

The invoiceNumber and customData are optional. If they are not provided the values from the original payment will be used.

CoinZoom will validate the price against the maximum in the original payment the customer agreed too. CoinZoom will also validate that the instalments are not being triggered more frequently that specified in the original payment.

The response from this endpoint provides a unique identifier to track the status of this instalment.

\n","urlObject":{"path":["api","v1","public","payment","trigger","recurring"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d76a9c05-586b-4699-bc63-fc6394700481"},{"name":"Trigger Delayed","id":"12f1d7d0-5314-4805-8b74-c16927ccffc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n \"paymentId\": \"4dc7a33f-7458-4171-9b72-c129f5cb8d4e\"\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/payment/trigger/delayed","description":"

When a payment was created with a start date the payment will not be sent to the merchant initially. Once the start date has elapsed the merchant should call this endpoint to initiate the payment.

\n","urlObject":{"path":["api","v1","public","payment","trigger","delayed"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"12f1d7d0-5314-4805-8b74-c16927ccffc9"}]}