{"info":{"_postman_id":"5357a59c-fff5-475f-be29-c75eb979f96c","name":"PayPlus - Endeavour API","description":"

Authentication

Every Service API call is secured by API Key. They are set via http headers:

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

Key	Value
Authorization	Bearer {{API KEY}}

Status

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

Status	Description
Created	Deposit initial staus when create
Processing	Deposit had been sent to service provider and waiting the service provider response
Success	Deposit success, callback will be sent
Cancelled	Deposit Canceled
Expired	Deposit Expired
Rejected	Deposit rejected, callback will be sent

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"21247586","collectionId":"5357a59c-fff5-475f-be29-c75eb979f96c","publishedId":"2s93sdaCiu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-06-13T08:36:26.000Z"},"item":[{"name":"Create Payment Request - Generic","id":"58767053-6e5e-4d39-affc-1760c01cb99c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"da8b440e-5e95-4d37-9763-169b409df483"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"04da610f-7ec0-427f-bdd8-8ee32fd607f8\",\n \"currency\": \"NZD\",\n \"amount\": \"10\"\n }\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments","description":"

Generic Payment Request

Method: POST

Content-Type : application/json

Endpoint :

[Generic]: https://endeavour.dev.pa-g.com/1.0/gateway/payments

Parameter

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

Key	Key	Format	Required	Description
order		Object	Y	Order identifier
	reference	string(128)	Y	Unique reference, must be unique across payment request
	currency	string(3)	Y	Currency ISO Code 4217, e.g. HKD, USD, CNY, MYR
	amount	decimal(20,18)	Y	Order amount e.g 10000.00, 100.00, 1.00
type		Array	Y	[\"wechatpay\"]
customer		Object	Y	Customer information
	first_name	string(255)	Y
	last_name	string(255)	Y
	email	string(128)	Y	Customer email address
	ip	string(15)	Y	Format of IPv4
	mobile	string(128)	Y	Customer phone number
return_url		string(512)	Y
notify_url		string(512)	Y	Callback URL
expires_in		int(20)	N	Customize the payment add page expire time,, e.g if set 600 the payment page will expire after 10 min

","urlObject":{"path":["1.0","gateway","payments"],"host":["https://endeavour.payplus.co.nz"],"query":[],"variable":[]}},"response":[{"id":"815628af-958c-406f-84ac-e02a8ade8b89","name":"Create Payment Request - Generic Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"0aaeefc0-7345-481b-9a94-bff3025fc0a4\",\n \"currency\": \"NZD\",\n \"amount\": \"100\"\n },\n \"notify_url\": \"https://www.payplus.co.nz/\"\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1648"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:41:54 GMT"},{"key":"x-amzn-RequestId","value":"158f99f6-50c5-41fa-8601-62753b7f0e09"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdAt8FQRSQ0Fpew="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-648847f2-48064a2f6ce4ec4623dc5425;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"xKIFZPvaqb8b6PrWjNlzQZpy7EpdnwpTcRubTAt6G9QoDN3SPqjPew=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"f4afb41e-250c-4689-bfa8-bc5cfa511750\",\n \"time\": 1686652914,\n \"code\": 200,\n \"message\": \"OK\",\n \"_elapsed_ms\": 69.6669,\n \"payload\": {\n \"payment\": {\n \"code\": \"v0IDUOPJkorBtrFHjsLbLyQO\",\n \"uuid\": \"690344ad-02a7-4b99-873d-e52e49ae89c0\",\n \"order_reference\": \"54974537-22a7-468e-8529-fdc6601bcf13\",\n \"order_currency\": \"NZD\",\n \"order_amount\": \"100\",\n \"order_surcharge_amount\": null,\n \"currency\": \"NZD\",\n \"amount\": \"100\",\n \"types\": [\n \"*\"\n ],\n \"status\": \"Created\",\n \"page_url\": \"https://endeavour-sandbox.payplus.co.nz/hpp/690344ad-02a7-4b99-873d-e52e49ae89c0\",\n \"return_url\": null,\n \"notify_url\": \"https://www.payplus.co.nz/\",\n \"receipt_url\": null,\n \"duration\": null,\n \"expired_at\": 1686656514,\n \"customer_first_name\": null,\n \"customer_last_name\": null,\n \"customer_mobile\": null,\n \"customer_email\": null,\n \"customer_state\": null,\n \"customer_postal_code\": null,\n \"customer_ip\": null,\n \"customer_country\": null,\n \"subtotal_currency\": null,\n \"subtotal_amount\": null,\n \"fee_currency\": null,\n \"fee_amount\": null,\n \"completed_at\": null,\n \"completed_iso\": null,\n \"created_iso\": \"2023-06-13T10:41:54+00:00\",\n \"updated_iso\": \"2023-06-13T10:41:54+00:00\",\n \"created_at\": 1686652914,\n \"updated_at\": 1686652914\n }\n }\n}"},{"id":"e58e6aff-7349-4761-975d-a5d528a5b3a1","name":"Create Payment Request - Generic Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"2c7ea5c8-3a67-4fb2-92fc-4dd1dd956745\",\n \"currency\": \"NZD\",\n \"amount\": \"100\"\n },\n \"notify_url\": \"https://www.payplus.co.nz/\"\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"237"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:42:29 GMT"},{"key":"x-amzn-RequestId","value":"b131011b-ce58-4c7f-984f-86d429fd6e60"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdAzUHD8yQ0FVtQ="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64884814-576b3af248e1b81443cf4ea5;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"6J4tcLW0PtDcD12v5ZZqSzhzIR4-jk2qTEHwk6ykrXrB23H1rzCdjw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7aea25a5-ec74-4dd6-b3bd-0cd5fb135c3c\",\n \"time\": 1686652948,\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"_elapsed_ms\": 66.5991,\n \"payload\": {\n \"order.currency\": \"The property currency is required\"\n }\n}"}],"_postman_id":"58767053-6e5e-4d39-affc-1760c01cb99c"},{"name":"Create Payment Request - Alipay","id":"25e079e4-ff1a-44e3-a02b-78310d746702","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"da8b440e-5e95-4d37-9763-169b409df483"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"b136a1e1-dc8e-4d03-97f6-5380d050c22d\",\n \"currency\": \"NZD\",\n \"amount\": \"100\"\n },\n \"types\": [\n \"alipay\"\n ]\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments","description":"

Alipay Payment Request

Method: POST

Content-Type : application/json

Endpoint :

[Alipay]: https://endeavour.dev.pa-g.com/1.0/gateway/payments

Parameter

Key	Key	Format	Required	Description
order		Object	Y	Order identifier
	reference	string(128)	Y	Unique reference, must be unique across payment request
	currency	string(3)	Y	Currency ISO Code 4217, e.g. HKD, USD, CNY, MYR
	amount	decimal(20,18)	Y	Order amount e.g 10000.00, 100.00, 1.00
type		Array	Y	[\"alipay\"]
customer		Object	Y	Customer information
	first_name	string(255)	Y
	last_name	string(255)	Y
	email	string(128)	Y	Customer email address
	ip	string(15)	Y	Format of IPv4
	mobile	string(128)	Y	Customer phone number
return_url		string(512)	Y
notify_url		string(512)	Y	Callback URL
expires_in		int(20)	N	Customize the payment add page expire time,, e.g if set 600 the payment page will expire after 10 min

","urlObject":{"path":["1.0","gateway","payments"],"host":["https://endeavour.payplus.co.nz"],"query":[],"variable":[]}},"response":[{"id":"a67e16be-b46c-4a23-8ce5-89e07476be2f","name":"Create Payment Request - Alipay Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"7097cbef-1bc6-49ae-8aa1-caddcb25b561\",\n \"currency\": \"NZD\",\n \"amount\": \"100\"\n },\n \"types\": [\n \"alipay\"\n ]\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2657"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:40:12 GMT"},{"key":"x-amzn-RequestId","value":"1a5299bf-7274-4c20-a1d9-4d43272241ae"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdAd5HOiyQ0Fc5Q="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6488478b-7a71c8880f0e644c60ece43c;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"Vh9lVx5uf9YRLXnFklp1I1l6_w2Ru11ODM5W0XED5B3Q_0DXD6CIgA=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"f7fb95cf-df8e-44ae-b5c9-f23839445efb\",\n \"time\": 1686652812,\n \"code\": 200,\n \"message\": \"OK\",\n \"_elapsed_ms\": 102.35,\n \"payload\": {\n \"payment\": {\n \"code\": \"F3OHaqZBSItQJockExFoNnfU\",\n \"uuid\": \"bb952883-00b4-49c8-9a29-22e24285d851\",\n \"order_reference\": \"f06b9b94-7e0a-4322-b7e9-04fbab7a583c\",\n \"order_currency\": \"NZD\",\n \"order_amount\": \"100\",\n \"order_surcharge_amount\": \"4.10\",\n \"currency\": \"NZD\",\n \"amount\": \"100\",\n \"types\": [\n \"alipay\"\n ],\n \"status\": \"Created\",\n \"page_url\": \"https://endeavour-sandbox.payplus.co.nz/hpp/bb952883-00b4-49c8-9a29-22e24285d851/0762436e-0d61-4c7b-8328-663bc8aafe5e\",\n \"return_url\": null,\n \"notify_url\": null,\n \"receipt_url\": null,\n \"duration\": null,\n \"expired_at\": 1686656411,\n \"customer_first_name\": null,\n \"customer_last_name\": null,\n \"customer_mobile\": null,\n \"customer_email\": null,\n \"customer_state\": null,\n \"customer_postal_code\": null,\n \"customer_ip\": null,\n \"customer_country\": null,\n \"subtotal_currency\": null,\n \"subtotal_amount\": null,\n \"fee_currency\": null,\n \"fee_amount\": null,\n \"completed_at\": null,\n \"completed_iso\": null,\n \"created_iso\": \"2023-06-13T10:40:11+00:00\",\n \"updated_iso\": \"2023-06-13T10:40:11+00:00\",\n \"created_at\": 1686652811,\n \"updated_at\": 1686652811\n },\n \"transaction\": {\n \"out_trade_no\": \"5849203f-da5b-48a2-ac52-653db61df431\",\n \"currency\": \"NZD\",\n \"total_fee\": \"104.10\",\n \"service\": \"create_forex_trade\",\n \"uri\": \"https://intlmapi.alipay.com/gateway.do?service=create_forex_trade&partner=2088141040426020&input_charset=UTF-8&sign_type=MD5¬ify_url=https%3A%2F%2Fendeavour-sandbox.payplus.co.nz%2Fnotification%2Falipayglobal&return_url=https%3A%2F%2Fendeavour-sandbox.payplus.co.nz%2Fhpp%2Fbb952883-00b4-49c8-9a29-22e24285d851%2Fresult&subject=Online+Payment&out_trade_no=5849203f-da5b-48a2-ac52-653db61df431¤cy=NZD&total_fee=104.10&secondary_merchant_id=PPOL-10006&secondary_merchant_name=The+Evlve+Limitedc&secondary_merchant_industry=4814&refer_url=&product_code=NEW_OVERSEAS_SELLER&sign=1734355fdb920fa426ad8ce69ada98f0\",\n \"uuid\": \"faa68a27-8837-4661-99f0-aef6fde48989\",\n \"created_at\": 1686652811,\n \"updated_at\": 1686652811\n }\n }\n}"},{"id":"83a3f8a5-4e1d-4cfb-a29b-4fa068870bb0","name":"Create Payment Request - Alipay Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"71c35774-6e95-40e2-8335-0f8bb8219827\",\n \"currency\": \"NZD\",\n \"amount\": \"100\"\n },\n \"types\": [\n \"alipay\"\n ]\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"237"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:41:13 GMT"},{"key":"x-amzn-RequestId","value":"4d7b7f42-f081-4a3a-81ea-2a9f45fbb4b1"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdAnkEbsyQ0Fcow="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-648847c9-3244c8a20cb31a2b24499009;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"ZuXEt0sRwH99vK6RhTrDow3FQtTwsmDUCbxzuCQtNlzMni-p20bGnQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"cab8a461-c9ec-4a09-9872-b253cae783d9\",\n \"time\": 1686652873,\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"_elapsed_ms\": 33.1891,\n \"payload\": {\n \"order.currency\": \"The property currency is required\"\n }\n}"}],"_postman_id":"25e079e4-ff1a-44e3-a02b-78310d746702"},{"name":"Create Payment Request - WeChat Pay","id":"d00be4cf-eb75-46ec-b128-6df44d8a6f89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"da8b440e-5e95-4d37-9763-169b409df483"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"3aee55fe-3f4b-4dc1-8387-e45ca2a12425\",\n \"currency\": \"NZD\",\n \"amount\": \"100\"\n },\n \"types\": [\n \"wechatpay\"\n ],\n \"wechatpay\": {\n \"trade_type\": \"JSAPI\"\n }\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments","description":"

WeChat Pay Payment Request

Method: POST

Content-Type : application/json

Endpoint :

[WeChat Pay]: https://endeavour.dev.pa-g.com/1.0/gateway/payments

Parameter

Key	Key	Format	Required	Description
order		Object	Y	Order identifier
	reference	string(128)	Y	Unique reference, must be unique across payment request
	currency	string(3)	Y	Currency ISO Code 4217, e.g. HKD, USD, CNY, MYR
	amount	decimal(20,18)	Y	Order amount e.g 10000.00, 100.00, 1.00
types		Array	Y	[\"wechapay\"]
customer		Object	Y	Customer information
	first_name	string(255)	Y
	last_name	string(255)	Y
	email	string(128)	Y	Customer email address
	ip	string(15)	Y	Format of IPv4
	mobile	string(128)	Y	Customer phone number
return_url		string(512)	Y
notify_url		string(512)	Y	Callback URL
wechatpay		object	N	Wechat Pay related value
	type	string(512)	N	\"NATIVE\",\"JSAPI\" (please confirm client using WeChat Browser when using \"JSAPI\")
	openid	string(512)	N	Require if type is JSAPI
expires_in		int(20)	N	Customize the payment add page expire time,, e.g if set 600 the payment page will expire after 10 min

","urlObject":{"path":["1.0","gateway","payments"],"host":["https://endeavour.payplus.co.nz"],"query":[],"variable":[]}},"response":[{"id":"8b76dfbd-c49b-4920-a49f-2d13888194f4","name":"Create Payment Request - WeChat Pay Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"af496ce3-a7a8-4016-90b6-d04d8ea8ed64\",\n \"currency\": \"NZD\",\n \"amount\": \"100\"\n },\n \"types\": [\n \"wechatpay\"\n ],\n \"wechatpay\": {\n \"trade_type\": \"JSAPI\"\n }\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2126"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:43:25 GMT"},{"key":"x-amzn-RequestId","value":"52a45ff5-66f8-47d1-89e9-75224507627c"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdA8IFO2yQ0FUqg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6488484d-3e6ad7f9135c73074e7c4dac;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"BYURf7hPJKEgafKGyflpjsY9cXZDPChgrccOezmlCiJ2eY8Z5D_AIg=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2b6dc67d-04e0-4a9c-b316-aa7966c4bfcb\",\n \"time\": 1686653005,\n \"code\": 200,\n \"message\": \"OK\",\n \"_elapsed_ms\": 112.025,\n \"payload\": {\n \"payment\": {\n \"code\": \"W1684gth5uxpg5YSTNxLcw6u\",\n \"uuid\": \"53ffc03f-85f9-492f-a82c-13f5df99f1a0\",\n \"order_reference\": \"1721cad6-99e5-40c2-a431-c7d59b0fc933\",\n \"order_currency\": \"NZD\",\n \"order_amount\": \"100\",\n \"order_surcharge_amount\": \"2.10\",\n \"currency\": \"NZD\",\n \"amount\": \"100\",\n \"types\": [\n \"wechatpay\"\n ],\n \"status\": \"Created\",\n \"page_url\": \"https://endeavour-sandbox.payplus.co.nz/hpp/53ffc03f-85f9-492f-a82c-13f5df99f1a0/9bd15678-3c06-48e4-ac8d-3aeff751e7bb\",\n \"return_url\": null,\n \"notify_url\": null,\n \"receipt_url\": null,\n \"duration\": null,\n \"expired_at\": 1686656605,\n \"customer_first_name\": null,\n \"customer_last_name\": null,\n \"customer_mobile\": null,\n \"customer_email\": null,\n \"customer_state\": null,\n \"customer_postal_code\": null,\n \"customer_ip\": null,\n \"customer_country\": null,\n \"subtotal_currency\": null,\n \"subtotal_amount\": null,\n \"fee_currency\": null,\n \"fee_amount\": null,\n \"completed_at\": null,\n \"completed_iso\": null,\n \"created_iso\": \"2023-06-13T10:43:25+00:00\",\n \"updated_iso\": \"2023-06-13T10:43:25+00:00\",\n \"created_at\": 1686653005,\n \"updated_at\": 1686653005\n },\n \"transaction\": {\n \"code_url\": null,\n \"openid_url\": \"https://biz.payplus.co.nz/Ppt?redirect_url=https://endeavour-sandbox.payplus.co.nz/hpp/53ffc03f-85f9-492f-a82c-13f5df99f1a0/9bd15678-3c06-48e4-ac8d-3aeff751e7bb/openid/return?1=1\",\n \"jsapi_parameters\": null,\n \"uuid\": \"bad169e5-a5c8-46cf-bfa7-f01e03c0e304\",\n \"created_at\": 1686653005,\n \"updated_at\": 1686653005\n }\n }\n}"},{"id":"a8217d1c-c9b5-4ebc-a89e-71a63e41e040","name":"Create Payment Request - WeChat Pay Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"f80a4504-4e47-418c-bc14-c5d8d7aacfc3\",\n \"currency\": \"NZD\",\n \"amount\": \"100\"\n },\n \"types\": [\n \"wechatpay\"\n ],\n \"wechatpay\": {\n \"trade_type\": \"JSAPI\"\n }\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"238"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:43:50 GMT"},{"key":"x-amzn-RequestId","value":"4be0ac69-4d40-4039-82fb-8e385429c3a0"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdA__E5MyQ0FcRg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64884866-7944c0d05a06444d213e1b74;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"WdU9VwtFDucxwlCMN8k7gvS0f-BGzoCN3179eeI5QUM4Q-fkLl8SpQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"649b3dfa-a289-41d4-8104-46c84ddb85dc\",\n \"time\": 1686653030,\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"_elapsed_ms\": 55.325,\n \"payload\": {\n \"order.reference\": \"The property reference is required\"\n }\n}"}],"_postman_id":"d00be4cf-eb75-46ec-b128-6df44d8a6f89"},{"name":"Payment Notification","id":"42b88137-e4f8-45ee-916c-180e235348f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"uuid\": \"79b127fd-ec47-48c3-abd7-133791722a17\",\n \"order_reference\": \"f036d704-0f25-4c1e-bf1f-762c93f2dc49\",\n \"order_currency\": \"NZD\",\n \"order_amount\": \"1.000000000000000000\",\n \"order_surcharge_amount\": \"0.050000000000000000\",\n \"order_subtotal\": \"1.05\",\n \"status\": \"Completed\",\n \"created_at\": 1686739449,\n \"completed_at\": 1686739477,\n \"fee_currency\": \"NZD\",\n \"fee_amount\": \"0.050000000000000000\",\n \"signature\": \"3d1813ff3da8c38d5e6221309391018eb464f3a65814db52fa9f0915b829d295feda8dde64a89a830bd0ac7d3465c4a2fd179f9dc05ff30d277c608ffd9e84a4\"\n}","options":{"raw":{"language":"json"}}},"url":"{{YOUR_CALLBACK_URL}}","description":"

Payment Notification

Method: POST

Content-Type : application/json

Endpoint :

The endpoint had been set in your payment request

Parameter

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

Key	Format	Description
uuid	Object	Order identifier
order_reference	string(128)	Unique reference, must be unique across payment request
order_currency	string(3)	Currency ISO Code 4217, e.g. HKD, USD, CNY, MYR
order_amount	decimal(20,18)	Order amount e.g 10000.00, 100.00, 1.00
order_surcharge_amount	decimal(20,18)	e.g 10000.00, 100.00, 1.00
order_subtotal	decimal(20,18)	e.g 10000.00, 100.00, 1.00
status	string(255)	[\"Completde\",\"Rejected\"]
created_at	string(128)	UTC+0
completed_at	string(15)	UTC+0
fee_currency	string(128)	Currency ISO Code 4217, e.g. HKD, USD, CNY, MYR
fee_amount	decimal(20,18)	e.g 10000.00, 100.00, 1.00
signature	string(512)	Callback URL

How to calculate the signature

Signature are used to protect your payment request, in order to prevent data forgery.
You can acquire the Signature Secret from Merchant Platform.

signature calculation

1. all POST data (exclude \"signature\" field) need add to the signature calculation include empty value, and Key.

2. sort all POST data (exclude \"signature\" field) in alphabetical ascending order.

3. for pre signature string, then json encode all sorted POST data (exclude \"signature\" field) append {merchant secret} at the end.

>>>>> Pre signature string = json_encode(all sorted POST data (exclude \"signature\" field) ) + {Merchant Secret}

3. finally, use sha512 to hash the pre signature string

>>>>> Sign = Sha512(Pre signature string)

If the calculated signature do not same with the POST signature, please ignore the data and contact our technical support.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"5357a59c-fff5-475f-be29-c75eb979f96c","id":"5357a59c-fff5-475f-be29-c75eb979f96c","name":"PayPlus - Endeavour API","type":"collection"}},"urlObject":{"host":["{{YOUR_CALLBACK_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"42b88137-e4f8-45ee-916c-180e235348f9"},{"name":"Create Payment Query","id":"a86902e5-ccce-4248-983d-6e96847fcdaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"da8b440e-5e95-4d37-9763-169b409df483"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"url":"https://endeavour.payplus.co.nz/1.0/gateway/payments?order_reference=3bd1c1a1-0e73-4848-9e37-7c7d96996c16","description":"

Payment Enquiry

Method: GET

Content-Type : application/json

Endpoint :

https://endeavour.dev.pa-g.com/1.0/gateway/payments?order_reference=7cb8683f-6a75-4566-b748-af5eca5cdc6e

Parameter

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

Key	Key	Format	Required	Description
order_reference		string(128)	Y	Unique reference, must be unique across payment request

","urlObject":{"path":["1.0","gateway","payments"],"host":["https://endeavour.payplus.co.nz"],"query":[{"key":"order_reference","value":"3bd1c1a1-0e73-4848-9e37-7c7d96996c16"}],"variable":[]}},"response":[{"id":"b4d2da2e-03af-4910-9e89-233d692da84e","name":"Create Payment Query Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"url":{"raw":"https://endeavour.payplus.co.nz/1.0/gateway/payments?order_reference=582104d1-e899-4f81-b678-db0b25366507","host":["https://endeavour.payplus.co.nz"],"path":["1.0","gateway","payments"],"query":[{"key":"order_reference","value":"582104d1-e899-4f81-b678-db0b25366507"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1480"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:44:56 GMT"},{"key":"x-amzn-RequestId","value":"4d6c2ac0-94a4-4120-9ed4-aa7eb95ecc6f"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdBKTEvSyQ0FkQw="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-648848a8-359f879240b9e4ac7e4291e2;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"kGlxadXDs72DlRi3y1edQ3DQXqNLXKEFTcQpEj5WHwq1x7Y2uOIVTA=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4431d426-2ae7-4f50-94da-bb3e42735eb7\",\n \"time\": 1686653096,\n \"code\": 200,\n \"message\": \"OK\",\n \"_elapsed_ms\": 75.073,\n \"payload\": {\n \"code\": \"czFAPwKSYXhnKk1t1XvIQraX\",\n \"uuid\": \"e043e4cb-cdde-42d1-9d9e-792910d2ec25\",\n \"order_reference\": \"3bd1c1a1-0e73-4848-9e37-7c7d96996c16\",\n \"order_currency\": \"NZD\",\n \"order_amount\": \"100.000000000000000000\",\n \"order_surcharge_amount\": null,\n \"currency\": \"NZD\",\n \"amount\": \"100.000000000000000000\",\n \"types\": [\n \"*\"\n ],\n \"status\": \"Created\",\n \"page_url\": \"https://endeavour-sandbox.payplus.co.nz/p:czFAPwKSYXhnKk1t1XvIQraX\",\n \"return_url\": null,\n \"notify_url\": null,\n \"receipt_url\": null,\n \"duration\": null,\n \"expired_at\": 1686592197,\n \"customer_first_name\": null,\n \"customer_last_name\": null,\n \"customer_mobile\": null,\n \"customer_email\": null,\n \"customer_state\": null,\n \"customer_postal_code\": null,\n \"customer_ip\": \"113.28.254.124\",\n \"customer_country\": \"HK\",\n \"subtotal_currency\": null,\n \"subtotal_amount\": null,\n \"fee_currency\": null,\n \"fee_amount\": null,\n \"completed_at\": null,\n \"completed_iso\": null,\n \"created_iso\": \"2023-06-12T16:49:57+00:00\",\n \"updated_iso\": \"2023-06-12T16:50:12+00:00\",\n \"created_at\": 1686588597,\n \"updated_at\": 1686588612\n }\n}"},{"id":"96110da0-ab96-4c53-bbf3-e952a671b033","name":"Create Payment Query Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"url":{"raw":"https://endeavour.payplus.co.nz/1.0/gateway/payments?order_reference=3bd1c1a1-0e73-4848-9e37-7c7d96996c16","host":["https://endeavour.payplus.co.nz"],"path":["1.0","gateway","payments"],"query":[{"key":"order_reference","value":"3bd1c1a1-0e73-4848-9e37-7c7d96996c16"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"195"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:47:32 GMT"},{"key":"x-amzn-RequestId","value":"75b1a337-2768-4ada-a8fa-7e78b8c9774d"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdBirHY6yQ0FijA="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64884944-44fba8f17d12d24002c7e39c;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"pFDrGqOMWAM2LxbMgFDTJwgbUJiQ7UUBwHPX1K1CU-amtJarFOck_w=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6b4be08e-7f96-4dc1-bd1a-2cd84b8475ef\",\n \"time\": 1686653252,\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"_elapsed_ms\": 115.979,\n \"payload\": [\n \"not found\"\n ]\n}"}],"_postman_id":"a86902e5-ccce-4248-983d-6e96847fcdaa"},{"name":"Create Refund Request","id":"af572593-44a6-4b9a-bb6f-9834e6444d23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"da8b440e-5e95-4d37-9763-169b409df483"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"3bd1c1a1-0e73-4848-9e37-7c7d96996c16\"\n },\n \"amount\": \"100\",\n \"refund_reference\":910d0fe3-97a6-4dab-89c8-ff524e8b314a\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/refunds","description":"

Refund Request

Method: POST

Content-Type : application/json

Endpoint :

https://endeavour.dev.pa-g.com/1.0/gateway/refunds

Parameter

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

Key	Key	Format	Required	Description
order		object
	reference	string(128)	Y	Unique reference, must be unique across payment request
amount	reference	double (11,2)	Y	e.g. 10000.00, 100.00, 1.00
refund_reference		string(128)	N	Unique reference, must be unique across payment request. It can be null, after request system will generate a new one for you

","urlObject":{"path":["1.0","gateway","refunds"],"host":["https://endeavour.payplus.co.nz"],"query":[],"variable":[]}},"response":[{"id":"2d4f6748-db6e-43c5-8d8d-510ad1e04416","name":"Create Refund Request Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"582104d1-e899-4f81-b678-db0b25366507\"\n },\n \"amount\": \"0.6\"\n}","options":{"raw":{"language":"json"}}},"url":"https://endeavour.payplus.co.nz/1.0/gateway/refunds"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2517"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:52:59 GMT"},{"key":"x-amzn-RequestId","value":"66e4d553-d619-47ff-976e-57975e834018"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdCVfG76SQ0Fj6A="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64884a89-6b167d0d5ae5c89128201d89;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"d8hoaX-43HkRqsWhaga7p7jXd8c9p_yJWpZ-bKeilc52tjgbSd4BJw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"39d41018-fda8-4de7-9c2b-f5e108cfe4d4\",\n \"time\": 1686653579,\n \"code\": 200,\n \"message\": \"OK\",\n \"_elapsed_ms\": 2321.8091,\n \"payload\": {\n \"payment\": {\n \"code\": \"ZUdUyRJUBBC18xTFxSkbHWfY\",\n \"uuid\": \"50d000f5-d07e-4bd0-a4f0-b063b46c2abd\",\n \"order_reference\": \"582104d1-e899-4f81-b678-db0b25366507\",\n \"order_currency\": \"NZD\",\n \"order_amount\": \"1.000000000000000000\",\n \"order_surcharge_amount\": \"0.040000000000000000\",\n \"currency\": \"NZD\",\n \"amount\": \"1.000000000000000000\",\n \"types\": [\n \"*\"\n ],\n \"status\": \"Completed\",\n \"page_url\": \"https://endeavour-sandbox.payplus.co.nz/hpp/50d000f5-d07e-4bd0-a4f0-b063b46c2abd\",\n \"return_url\": null,\n \"notify_url\": \"https://www.payplus.co.nz/\",\n \"receipt_url\": null,\n \"duration\": 56,\n \"expired_at\": 1686657066,\n \"customer_first_name\": null,\n \"customer_last_name\": null,\n \"customer_mobile\": null,\n \"customer_email\": null,\n \"customer_state\": null,\n \"customer_postal_code\": null,\n \"customer_ip\": \"113.28.254.124\",\n \"customer_country\": \"HK\",\n \"subtotal_currency\": \"NZD\",\n \"subtotal_amount\": \"1.040000000000000000\",\n \"fee_currency\": \"NZD\",\n \"fee_amount\": \"0.040000000000000000\",\n \"completed_at\": 1686653522,\n \"completed_iso\": \"2023-06-13T10:52:02+00:00\",\n \"created_iso\": \"2023-06-13T10:51:06+00:00\",\n \"updated_iso\": \"2023-06-13T10:52:02+00:00\",\n \"created_at\": 1686653466,\n \"updated_at\": 1686653522\n },\n \"transaction\": {\n \"uuid\": \"024c1c58-798e-44f4-af18-5a12126aab50\",\n \"type\": \"Refund\",\n \"order_reference\": \"582104d1-e899-4f81-b678-db0b25366507\",\n \"order_currency\": \"NZD\",\n \"order_amount\": \"0.500000000000000000\",\n \"currency\": null,\n \"amount\": null,\n \"status\": \"Completed\",\n \"customer_ip\": null,\n \"customer_country\": null,\n \"subtotal_currency\": null,\n \"subtotal_amount\": null,\n \"fee_currency\": null,\n \"fee_amount\": null,\n \"completed_at\": null,\n \"completed_iso\": null,\n \"created_at\": 1686653577,\n \"updated_at\": 1686653579\n }\n }\n}"},{"id":"f643fed4-92ff-4320-98fc-35d0d1154119","name":"Create Refund Request Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"reference\": \"582104d1-e899-4f81-b678-db0b25366507\"\n },\n \"amount\": \"0.5\"\n}"},"url":"https://endeavour.payplus.co.nz/1.0/gateway/refunds"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"278"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 10:55:01 GMT"},{"key":"x-amzn-RequestId","value":"07ad1a80-4708-44b7-b3e8-c72037a7366f"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdCo6HKIyQ0Fnpg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64884b05-03e055954e22a4645ce3b267;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"DY8crfjaE9Kd_PyzJ_huX-Ahotd4ir4_2nsJ0jPCs_Uctpe4r_m2Ww=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"71d8f654-ff9f-48a2-9318-c9f77e5e2a05\",\n \"time\": 1686653701,\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"_elapsed_ms\": 113.8072,\n \"payload\": {\n \"error\": {\n \"code\": 100004,\n \"message\": \"Cannot find payment\"\n }\n }\n}"}],"_postman_id":"af572593-44a6-4b9a-bb6f-9834e6444d23"},{"name":"Create Refund Query","id":"d7af6d30-d5cc-45a8-9d27-302a67c2896e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"da8b440e-5e95-4d37-9763-169b409df483"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"url":"https://endeavour.payplus.co.nz/1.0/gateway/refunds?order_reference=582104d1-e899-4f81-b678-db0b25366507&refund_reference=abc-123","description":"

Refund Enquiry

Method: GET

Content-Type : application/json

Endpoint :

https://endeavour-sandbox.payplus.co.nz/1.0/gateway/refunds?order_reference=54f09dc6-e79f-44e7-b304-4b278e2dbc40

Parameter

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

Key	Key	Format	Required	Description
order_reference		string(128)	Y	Unique reference, must be unique across payment request
refund_reference		string(128)

","urlObject":{"path":["1.0","gateway","refunds"],"host":["https://endeavour.payplus.co.nz"],"query":[{"key":"order_reference","value":"582104d1-e899-4f81-b678-db0b25366507"},{"key":"refund_reference","value":"abc-123"}],"variable":[]}},"response":[{"id":"8afe7e24-2a4f-43a8-9c9f-43f51c64104a","name":"Create Refund Query Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"f8bef24a-536e-4414-8e79-f79f14ef8055","type":"text"}],"url":{"raw":"https://endeavour-sandbox.payplus.co.nz/1.0/gateway/refunds?order_reference=582104d1-e899-4f81-b678-db0b25366507","protocol":"https","host":["endeavour-sandbox","payplus","co","nz"],"path":["1.0","gateway","refunds"],"query":[{"key":"order_reference","value":"582104d1-e899-4f81-b678-db0b25366507"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2516"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 11:00:35 GMT"},{"key":"x-amzn-RequestId","value":"4fdfcc82-afab-4aa7-8a79-b1175a394156"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdDdJFF-yQ0FmCQ="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64884c53-1d95ad844c59775a1df57399;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"aO7OJrDP8aWVCDncgi4AVDyz2GXtD13YWA41SS9_Tz9y1Q9bwYFbDA=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"21b06daf-f204-44e6-85f7-ce653db87fc4\",\n \"time\": 1686654035,\n \"code\": 200,\n \"message\": \"OK\",\n \"_elapsed_ms\": 55.0792,\n \"payload\": {\n \"payment\": {\n \"code\": \"ZUdUyRJUBBC18xTFxSkbHWfY\",\n \"uuid\": \"50d000f5-d07e-4bd0-a4f0-b063b46c2abd\",\n \"order_reference\": \"582104d1-e899-4f81-b678-db0b25366507\",\n \"order_currency\": \"NZD\",\n \"order_amount\": \"1.000000000000000000\",\n \"order_surcharge_amount\": \"0.040000000000000000\",\n \"currency\": \"NZD\",\n \"amount\": \"1.000000000000000000\",\n \"types\": [\n \"*\"\n ],\n \"status\": \"Completed\",\n \"page_url\": \"https://endeavour-sandbox.payplus.co.nz/hpp/50d000f5-d07e-4bd0-a4f0-b063b46c2abd\",\n \"return_url\": null,\n \"notify_url\": \"https://www.payplus.co.nz/\",\n \"receipt_url\": null,\n \"duration\": 264,\n \"expired_at\": 1686657066,\n \"customer_first_name\": null,\n \"customer_last_name\": null,\n \"customer_mobile\": null,\n \"customer_email\": null,\n \"customer_state\": null,\n \"customer_postal_code\": null,\n \"customer_ip\": \"113.28.254.124\",\n \"customer_country\": \"HK\",\n \"subtotal_currency\": \"NZD\",\n \"subtotal_amount\": \"1.040000000000000000\",\n \"fee_currency\": \"NZD\",\n \"fee_amount\": \"0.040000000000000000\",\n \"completed_at\": 1686653730,\n \"completed_iso\": \"2023-06-13T10:55:30+00:00\",\n \"created_iso\": \"2023-06-13T10:51:06+00:00\",\n \"updated_iso\": \"2023-06-13T10:55:30+00:00\",\n \"created_at\": 1686653466,\n \"updated_at\": 1686653730\n },\n \"transaction\": [\n {\n \"uuid\": \"024c1c58-798e-44f4-af18-5a12126aab50\",\n \"type\": \"Refund\",\n \"order_reference\": \"582104d1-e899-4f81-b678-db0b25366507\",\n \"order_currency\": \"NZD\",\n \"order_amount\": \"0.500000000000000000\",\n \"currency\": null,\n \"amount\": null,\n \"status\": \"Completed\",\n \"customer_ip\": null,\n \"customer_country\": null,\n \"subtotal_currency\": null,\n \"subtotal_amount\": null,\n \"fee_currency\": null,\n \"fee_amount\": null,\n \"completed_at\": null,\n \"completed_iso\": null,\n \"created_at\": 1686653577,\n \"updated_at\": 1686653579\n }\n ]\n }\n}"},{"id":"f5f3148a-cb16-455b-a040-cca05e0f57fa","name":"Create Refund Query Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"text"}],"url":{"raw":"https://endeavour.payplus.co.nz/1.0/gateway/refunds?order_reference=582104d1-e899-4f81-b678-db0b25366507","host":["https://endeavour.payplus.co.nz"],"path":["1.0","gateway","refunds"],"query":[{"key":"order_reference","value":"582104d1-e899-4f81-b678-db0b25366507"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"277"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 13 Jun 2023 11:01:33 GMT"},{"key":"x-amzn-RequestId","value":"b4d98ad7-b866-43ec-82dd-7a73b4f48265"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"x-amz-apigw-id","value":"GdDmKHatyQ0FuxA="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Methods","value":"GET,POST"},{"key":"X-Amzn-Trace-Id","value":"Root=1-64884c8d-6f54ea783033c5f57495b0d5;Sampled=0;lineage=5d525180:0"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 7019d108ed76e032af7a0273104a07a2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HKG62-C1"},{"key":"X-Amz-Cf-Id","value":"V_C9ebBxCnbttF715nTCd90PnpR_eyV4X1FO231xP7rcCQ3_uDce8g=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2d2ce009-af04-4750-a976-14c8b9d31de6\",\n \"time\": 1686654093,\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"_elapsed_ms\": 49.8731,\n \"payload\": {\n \"error\": {\n \"code\": 100004,\n \"message\": \"Cannot find payment\"\n }\n }\n}"}],"_postman_id":"d7af6d30-d5cc-45a8-9d27-302a67c2896e"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"8adbae3a-ca0a-49d5-ace6-503d3ae51e8b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5e20d526-2abe-489b-b335-5895d1345da4","type":"text/javascript","exec":[""]}}],"variable":[{"key":"endpoint","value":"https://endeavour.payplus.co.nz"},{"key":"API_KEY","value":"da8b440e-5e95-4d37-9763-169b409df483","type":"string"}]}