{"info":{"_postman_id":"c2bc56d2-67a7-48d7-84df-3b2294bfe145","name":"Digital Goods Wallet - Xfers Web SDK APIs","description":"

This documentation is for merchants who pipe the KYC information to Xfers

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5775523","collectionId":"c2bc56d2-67a7-48d7-84df-3b2294bfe145","publishedId":"SVSRHRth","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-07-25T03:25:12.000Z"},"item":[{"name":"Connect","item":[{"name":"Create/Login Account","id":"6d71a7b3-4915-48e6-a528-86c662ab433c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-XFERS-APP-API-KEY","value":"{{merchant-app-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"phone_no","value":"+6594463205","description":"

REQUIRED | User's mobile number

\n","type":"text"},{"key":"signature","value":"9c883e51601531f0fce7c75ce95b14cd241a41ff","description":"

REQUIRED | SHA1-hex of (phone_no + APP_SECRET_KEY)

\n","type":"text"},{"key":"full_name","value":"John Wong","description":"

REQUIRED | User's full name

\n","type":"text"},{"key":"identity_no","value":"G1073215M","description":"

REQUIRED | User's national identity number

\n","type":"text"},{"key":"date_of_birth","value":"1990-01-01","description":"

REQUIRED | User's date of birth in \"yyyy-mm-dd\"

\n","type":"text"}]},"url":"{{base-api-url}}api/v3/authorize/signup_login","description":"

This API call will attempt to login(existing user) or signup a new user.

\n

An SMS with a OTP will be send to that number which must be used for get_token api call.

\n

Note: If merchant is sharing KYC information with Xfers, merchant must send in full name, id number, and date of birth to the this API.\nThis will allow Xfers to verify the requested Xfers account belongs to the right user.

\n","urlObject":{"path":["v3","authorize","signup_login"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"01c05baa-0d5d-45d6-8219-084205fd8574","name":"Create/Login Account","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-APP-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"phone_no","value":"+6594463205","description":"`REQUIRED` | User's mobile number ","type":"text"},{"key":"signature","value":"9c883e51601531f0fce7c75ce95b14cd241a41ff","description":"`REQUIRED` | SHA1-hex of (phone_no + APP_SECRET_KEY)","type":"text"},{"key":"full_name","value":"John Wong","description":"`REQUIRED` | User's full name","type":"text"},{"key":"identity_no","value":"G1073215M","description":"`REQUIRED` | User's national identity number","type":"text"},{"key":"date_of_birth","value":"1990-01-01","description":"`REQUIRED` | User's date of birth in \"yyyy-mm-dd\"","type":"text"}]},"url":"{{base-api-url}}api/v3/authorize/signup_login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2019 06:48:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"b7c3068aa235d4828da18f5517f840f9\""},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"9881aa1e-9d72-4f40-815b-5bde62456212"},{"key":"X-Runtime","value":"0.077394"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"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":"50a2e6f04c4bc39a-SIN"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"success\"\n}"},{"id":"82288c23-20b8-4737-a76c-c69e316fcaeb","name":"200 OK Response","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-APP-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"phone_no","value":"+6594463208","description":"`REQUIRED` | User's mobile number ","type":"text"},{"key":"signature","value":"5b404cac7a43323dbd047d2d25b0efada3a1b39d","description":"`REQUIRED` | SHA1-hex of (phone_no + APP_SECRET_KEY)","type":"text"},{"key":"full_name","value":"John Wong","description":"`REQUIRED` | User's full name","type":"text"},{"key":"identity_no","value":"G1073215M","description":"`REQUIRED` | User's national identity number","type":"text"},{"key":"date_of_birth","value":"1990-01-01","description":"`REQUIRED` | User's date of birth in \"yyyy-mm-dd\"","type":"text"}]},"url":"{{base-api-url}}api/v3/authorize/signup_login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2019 06:26:56 GMT"},{"key":"ETag","value":"W/\"20357b4f2b277b646c19d7c94c783864\""},{"key":"Server","value":"nginx/1.13.12"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"e4a0328a-20a3-4932-828d-93e811909b1e"},{"key":"X-Runtime","value":"0.088371"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"success\"\n}"},{"id":"e35828be-4c2c-420c-b993-4c6a3db1a65f","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-APP-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"phone_no","value":"+6594463208","description":"`REQUIRED` | User's mobile number ","type":"text"},{"key":"signature","value":"5b404cac7a43323dbd047d2d25b0efada3a1b39d","description":"`REQUIRED` | SHA1-hex of (phone_no + APP_SECRET_KEY)","type":"text"},{"key":"full_name","value":"John Wong","description":"`REQUIRED` | User's full name","type":"text"},{"key":"identity_no","value":"G1073215M","description":"`REQUIRED` | User's national identity number","type":"text"},{"key":"date_of_birth","value":"1990-01-01","description":"`REQUIRED` | User's date of birth in \"yyyy-mm-dd\"","type":"text"}]},"url":"{{base-api-url}}api/v3/authorize/signup_login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"error\": \"User identity does not match the phone number in Xfers.\"\n}"}],"_postman_id":"6d71a7b3-4915-48e6-a528-86c662ab433c"},{"name":"Get User API Token","id":"41282485-02b0-450e-ab7b-4c939ad6f228","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-XFERS-APP-API-KEY","value":"{{merchant-app-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{base-api-url}}api/v3/authorize/get_token?otp=594901&phone_no=94463208&signature=17da2f8d0f4f82c689ccb5bcbc42e4f15edbed6d","description":"

This API call will return the user’s user_api_token. You should save this token in database for reuse. There is no need to go through the connect flow again for this user.

\n

It will also return a is_fully_verified if and ONLY IF they already have an Xfers account and have completed our KYC process.

\n","urlObject":{"path":["v3","authorize","get_token"],"host":["{{base-api-url}}api"],"query":[{"description":{"content":"

REQUIRED | 6 digits one-time-password sent over SMS

\n","type":"text/plain"},"key":"otp","value":"594901"},{"description":{"content":"

REQUIRED | User's mobile number

\n","type":"text/plain"},"key":"phone_no","value":"94463208"},{"description":{"content":"

REQUIRED | SHA1-hex of (phone_no + OTP + APP_SECRET_KEY)

\n","type":"text/plain"},"key":"signature","value":"17da2f8d0f4f82c689ccb5bcbc42e4f15edbed6d"}],"variable":[]}},"response":[{"id":"74e9db96-8c2d-4c13-8630-ec1157f67484","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"X-XFERS-APP-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base-api-url}}api/v3/authorize/get_token?otp=594901&phone_no=94463208&signature=17da2f8d0f4f82c689ccb5bcbc42e4f15edbed6d","host":["{{base-api-url}}api"],"path":["v3","authorize","get_token"],"query":[{"key":"otp","value":"594901","description":"`REQUIRED` | 6 digits one-time-password sent over SMS"},{"key":"phone_no","value":"94463208","description":"`REQUIRED` | User's mobile number"},{"key":"signature","value":"17da2f8d0f4f82c689ccb5bcbc42e4f15edbed6d","description":"`REQUIRED` | SHA1-hex of (phone_no + OTP + APP_SECRET_KEY)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2019 09:55:49 GMT"},{"key":"Server","value":"nginx/1.12.0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"f98b5103-ae8b-48c0-9a34-e278add15e67"},{"key":"X-Runtime","value":"0.087260"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"272"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid OTP provided\",\n \"info\": \"Received Request: {\\\"otp\\\"=>\\\"594901\\\", \\\"phone_no\\\"=>\\\"94463208\\\", \\\"signature\\\"=>\\\"17da2f8d0f4f82c689ccb5bcbc42e4f15edbed6d\\\", \\\"controller\\\"=>\\\"api/v3/authorize\\\", \\\"action\\\"=>\\\"get_token\\\", \\\"authorize\\\"=>{}}\",\n \"error_code\": \"XFE12\",\n \"error_handling\": \"Make sure you entered the correct parameters.\"\n}"},{"id":"7bade974-79a2-4df6-8335-be5fbccf3973","name":"200 OK Response","originalRequest":{"method":"GET","header":[{"key":"X-XFERS-APP-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base-api-url}}api/v3/authorize/get_token?otp=594901&phone_no=94463208&signature=17da2f8d0f4f82c689ccb5bcbc42e4f15edbed6d","host":["{{base-api-url}}api"],"path":["v3","authorize","get_token"],"query":[{"key":"otp","value":"594901","description":"`REQUIRED` | 6 digits one-time-password sent over SMS"},{"key":"phone_no","value":"94463208","description":"`REQUIRED` | User's mobile number"},{"key":"signature","value":"17da2f8d0f4f82c689ccb5bcbc42e4f15edbed6d","description":"`REQUIRED` | SHA1-hex of (phone_no + OTP + APP_SECRET_KEY)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2019 06:35:49 GMT"},{"key":"ETag","value":"W/\"ee6ca5180ed410c64976229e10f0a215\""},{"key":"Server","value":"nginx/1.13.12"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"7b0761ca-c340-4f4a-9f17-0fad5f369003"},{"key":"X-Runtime","value":"0.307009"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"249"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"success\",\n \"id\": \"user_grk7g6ltqda9\",\n \"user_api_token\": \"9-AGqLu_ZDrmjqeoLV8GifeJf6kWjh3-C3JSAy--HsU\",\n \"currency\": \"sgd\",\n \"sign_up_url\": \"/api/v3/account_registration?phone_no=94463208&token=183ce054651b2034a321e967460f03bce94d77b9\",\n \"wallet_name\": \"Digital Goods\"\n}"}],"_postman_id":"41282485-02b0-450e-ab7b-4c939ad6f228"}],"id":"baa0a909-a518-420a-b0a5-2afaa3cb6c67","_postman_id":"baa0a909-a518-420a-b0a5-2afaa3cb6c67","description":""},{"name":"User","item":[{"name":"Get User Details","id":"b4430aa6-67b7-40e5-8c81-deb309687ede","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{user-api-key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{base-api-url}}api/v3/user","urlObject":{"path":["v3","user"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"8b7e82b1-8aa2-4a03-8c38-cb521b42a269","name":"200 OK Response","originalRequest":{"method":"GET","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{user-api-key}}","type":"text"}],"url":"{{base-api-url}}api/v3/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Apr 2019 06:32:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"939"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"d705f438ca9f9128f7dc7ba9d8c181e0\""},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"aaaa4ff2-b4e1-41a3-bfdb-79862fc8c1e5"},{"key":"X-Runtime","value":"0.079727"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"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":"4c10c3626bcda9f6-SIN"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"user_nj677zo10mg1\",\n \"available_balance\": \"0.0\",\n \"ledger_balance\": \"0.0\",\n \"bank_transfer_rates\": \"0.0\",\n \"bank_transfer_fees\": \"0.45\",\n \"full_name\": \"\",\n \"first_name\": \"Gerry\",\n \"last_name\": \"Yap\",\n \"date_of_birth\": \"1990-06-08\",\n \"gender\": \"\",\n \"email\": \"docs+user@xfers.com\",\n \"country\": \"SG\",\n \"state\": \"Singapore\",\n \"city\": \"Singapore\",\n \"nationality\": \"Singaporean\",\n \"address_line_1\": \"Blk 71 Ayer Rajah Cresent\",\n \"address_line_2\": \"#02-52\",\n \"postal_code\": \"541121\",\n \"identity_no\": \"S8117102G\",\n \"phone_no\": \"\",\n \"bank_accounts\": [\n {\n \"id\": 473,\n \"account_no\": \"0393123432\",\n \"account_holder_name\": \"Tian Wei\",\n \"bank_abbrev\": \"DBS\",\n \"verification_status\": \"pending\",\n \"verified\": false,\n \"usage\": \"all\"\n }\n ],\n \"annual_income\": \"\",\n \"id_front_url\": \"https://d1bk42oitlm1au.cloudfront.net/assets/nricFrontPlaceholder-12d9dc211bc2b5400a5acbae81a0a3b9591a5de96bf8323ec29e8a246df078d6.png\",\n \"id_back_url\": \"https://d1bk42oitlm1au.cloudfront.net/assets/nricBackPlaceholder-7245295ffff921f163075a934c3710f41af0d68d82a14c5cb98345847be17667.png\",\n \"selfie_2id_url\": \"https://d1bk42oitlm1au.cloudfront.net/assets/nricSelfiePlaceholder-9110699ca25040cd577236df2132d84a23c829c9cb3b376dfa8f6c44551a1b19.png\",\n \"proof_of_address_url\": \"https://d1bk42oitlm1au.cloudfront.net/assets/nricDocumentPlaceholder-d109b49285f9430de16c8042b83d22067c10e6729c77fa0107220383e5087dda.png\",\n \"verification_documents\": [],\n \"multi_bank_account_detected\": false,\n \"account_locked\": false,\n \"kyc_limit_remaining\": 50,\n \"meta_data\": \"\",\n \"wallet_name\": \"Your Digital Goods Account\",\n \"wallet_id\": 2,\n \"gauth_enabled\": false,\n \"kyc_verified\": true,\n \"kyc_rejected_reason\": null,\n \"kyc_information_edit_allowed\": false,\n \"kyc_information_verifying\": false,\n \"storage_limit_exceeded\": false,\n \"country_of_birth\": \"SG\",\n \"nric_issue_date\": \"\",\n \"nric_expiry_date\": \"\",\n \"nric_type\": \"\",\n \"account_fully_verified\": true,\n \"is_myinfo_flow\": false,\n \"accepted_tnc\": false,\n \"vip_beta_user\": false,\n \"top_up_limit\": 500,\n \"id_front_uploaded\": false,\n \"id_back_uploaded\": false,\n \"selfie_uploaded\": false,\n \"proof_of_address_uploaded\": false\n}"},{"id":"d545a226-1d8c-4417-af9f-a0dd2b8b7ab0","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{user-api-key}}","type":"text"}],"url":"{{base-api-url}}api/v3/user"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2019 09:53:22 GMT"},{"key":"Server","value":"nginx/1.12.0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"d1188c2f-a12b-439f-85db-1fc0caa83163"},{"key":"X-Runtime","value":"0.015237"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid API KEY\"\n}"}],"_postman_id":"b4430aa6-67b7-40e5-8c81-deb309687ede"},{"name":"Update User Details","id":"f953485b-47a1-4727-bc73-cbb7fa8422bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{user-api-key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"full_name","value":"John Doe","description":"

OPTIONAL | User's full name

\n","type":"text"},{"key":"date_of_birth","value":"1990-01-01","description":"

OPTIONAL | User's date of birth in \"yyyy-mm-dd\"

\n","type":"text"},{"key":"address_line_1","value":"Lorem Ipsum Road","description":"

OPTIONAL | User's address line 1

\n","type":"text"},{"key":"address_line_2","value":"#01-10","description":"

OPTIONAL | User's address line 2

\n","type":"text"},{"key":"country","value":"SG","description":"

OPTIONAL | User's country of residence in abbreviation

\n","type":"text"},{"key":"postal_code","value":"123456","description":"

OPTIONAL | User's address postal code

\n","type":"text"},{"key":"identity_no","value":"S1234578G","description":"

OPTIONAL | User's national identity number

\n","type":"text"},{"key":"nationality","value":"Singaporean","description":"

OPTIONAL | User's nationality

\n","type":"text"},{"key":"id_front_url","value":"","description":"

OPTIONAL | URL storing the front image of user identity card

\n","type":"text","disabled":true},{"key":"id_back_url","value":"","description":"

OPTIONAL | URL storing the back image of user identity card

\n","type":"text","disabled":true},{"key":"proof_of_address_url","value":"","description":"

OPTIONAL | URL storing the image/pdf of proof of address document of user. Eg: Bank statemen

\n","type":"text","disabled":true},{"key":"selfie_2id_url","value":"","description":"

OPTIONAL | URL storing the selfie image of user holding their ID card

\n","type":"text","disabled":true}]},"url":"{{base-api-url}}api/v3/user","urlObject":{"path":["v3","user"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"0f6f3882-a3c8-4470-ba6c-2dab458908d8","name":"200 OK Response","originalRequest":{"method":"PUT","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{user-api-key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"full_name","value":"John Doe","description":"`OPTIONAL` | User's full name","type":"text"},{"key":"date_of_birth","value":"1990-01-01","description":"`OPTIONAL` | User's date of birth in \"yyyy-mm-dd\"","type":"text"},{"key":"address_line_1","value":"Lorem Ipsum Road","description":"`OPTIONAL` | User's address line 1","type":"text"},{"key":"address_line_2","value":"#01-10","description":"`OPTIONAL` | User's address line 2","type":"text"},{"key":"country","value":"SG","description":"`OPTIONAL` | User's country of residence in abbreviation","type":"text"},{"key":"postal_code","value":"123456","description":"`OPTIONAL` | User's address postal code","type":"text"},{"key":"identity_no","value":"S1234578G","description":"`OPTIONAL` | User's national identity number","type":"text"},{"key":"nationality","value":"Singaporean","description":"`OPTIONAL` | User's nationality","type":"text"},{"key":"id_front_url","value":"","description":"`OPTIONAL` | URL storing the front image of user identity card","type":"text","disabled":true},{"key":"id_back_url","value":"","description":"`OPTIONAL` | URL storing the back image of user identity card","type":"text","disabled":true},{"key":"proof_of_address_url","value":"","description":"`OPTIONAL` | URL storing the image/pdf of proof of address document of user. Eg: Bank statemen","type":"text","disabled":true},{"key":"selfie_2id_url","value":"","description":"`OPTIONAL` | URL storing the selfie image of user holding their ID card","type":"text","disabled":true}]},"url":"{{base-api-url}}api/v3/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2019 09:21:28 GMT"},{"key":"ETag","value":"W/\"798e83c188e386d1b0acc449e130abed\""},{"key":"Server","value":"nginx/1.12.0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"17ee6704-d3c4-44cf-a7e0-10949e1ce49a"},{"key":"X-Runtime","value":"0.824661"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"712"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"user_nj677zo10mg1\",\n \"available_balance\": \"0.0\",\n \"ledger_balance\": \"0.0\",\n \"bank_transfer_rates\": \"0.0\",\n \"bank_transfer_fees\": \"0.45\",\n \"full_name\": \"John Doe\",\n \"first_name\": \"Gerry\",\n \"last_name\": \"Yap\",\n \"date_of_birth\": \"1990-01-01\",\n \"gender\": \"\",\n \"email\": \"docs+user@xfers.com\",\n \"unconfirmed_email\": \"\",\n \"is_trial\": true,\n \"country\": \"SG\",\n \"state\": \"Singapore\",\n \"city\": \"Singapore\",\n \"nationality\": \"Singaporean\",\n \"address_line_1\": \"Blk 71 Ayer Rajah Cresent\",\n \"address_line_2\": \"#02-52\",\n \"postal_code\": \"541121\",\n \"identity_no\": \"S8117102G\",\n \"phone_no\": \"\",\n \"bank_accounts\": [\n {\n \"id\": 473,\n \"account_no\": \"0393123432\",\n \"account_holder_name\": \"Tian Wei\",\n \"bank_abbrev\": \"DBS\",\n \"verification_status\": \"pending\",\n \"bank_account_proof\": null,\n \"bank_account_proof_tiny\": null,\n \"usage\": \"all\",\n \"reject_reason\": null\n }\n ],\n \"annual_income\": \"\",\n \"id_front_url\": \"\",\n \"id_back_url\": \"\",\n \"selfie_2id_url\": \"\",\n \"proof_of_address_url\": \"\",\n \"multi_bank_account_detected\": false,\n \"account_locked\": false,\n \"kyc_limit_remaining\": 50,\n \"meta_data\": \"\",\n \"wallet_name\": \"Your Digital Goods Account\",\n \"wallet_id\": 2,\n \"gauth_enabled\": false,\n \"kyc_verified\": true,\n \"kyc_rejected_reason\": null,\n \"kyc_information_edit_allowed\": false,\n \"kyc_information_verifying\": false,\n \"storage_limit_exceeded\": false,\n \"country_of_birth\": \"SG\",\n \"nric_issue_date\": \"\",\n \"nric_expiry_date\": \"\",\n \"nric_type\": \"nric\",\n \"account_fully_verified\": true,\n \"is_myinfo_flow\": false,\n \"accepted_tnc\": false,\n \"vip_beta_user\": false,\n \"top_up_limit\": 500,\n \"id_front_uploaded\": false,\n \"id_back_uploaded\": false,\n \"selfie_uploaded\": false,\n \"proof_of_address_uploaded\": false\n}"},{"id":"e533bc63-3bea-4a0e-8850-d81794d90b48","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{user-api-key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"full_name","value":"John Doe","description":"`OPTIONAL` | User's full name","type":"text"},{"key":"date_of_birth","value":"1990-01-01","description":"`OPTIONAL` | User's date of birth in \"yyyy-mm-dd\"","type":"text"},{"key":"address_line_1","value":"Lorem Ipsum Road","description":"`OPTIONAL` | User's address line 1","type":"text"},{"key":"address_line_2","value":"#01-10","description":"`OPTIONAL` | User's address line 2","type":"text"},{"key":"country","value":"SG","description":"`OPTIONAL` | User's country of residence in abbreviation","type":"text"},{"key":"postal_code","value":"123456","description":"`OPTIONAL` | User's address postal code","type":"text"},{"key":"identity_no","value":"S1234578G","description":"`OPTIONAL` | User's national identity number","type":"text"},{"key":"nationality","value":"Singaporean","description":"`OPTIONAL` | User's nationality","type":"text"},{"key":"id_front_url","value":"","description":"`OPTIONAL` | URL storing the front image of user identity card","type":"text","disabled":true},{"key":"id_back_url","value":"","description":"`OPTIONAL` | URL storing the back image of user identity card","type":"text","disabled":true},{"key":"proof_of_address_url","value":"","description":"`OPTIONAL` | URL storing the image/pdf of proof of address document of user. Eg: Bank statemen","type":"text","disabled":true},{"key":"selfie_2id_url","value":"","description":"`OPTIONAL` | URL storing the selfie image of user holding their ID card","type":"text","disabled":true}]},"url":"{{base-api-url}}api/v3/user"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2019 09:54:30 GMT"},{"key":"Server","value":"nginx/1.13.12"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"f22c9a56-5bcb-4e13-a87d-6fc4effda6af"},{"key":"X-Runtime","value":"0.023896"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid API KEY\"\n}"}],"_postman_id":"f953485b-47a1-4727-bc73-cbb7fa8422bb"}],"id":"47de8e33-2b3e-4f76-b563-20f9af724890","_postman_id":"47de8e33-2b3e-4f76-b563-20f9af724890","description":""},{"name":"Payout","item":[{"name":"Create Payout","id":"ad7223a0-f8a2-443b-9afe-91ef0229b56c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"user_api_token","value":"{{user-api-key}}","description":"

REQUIRED | Buyer’s api token obtain via get_user_token API.

\n","type":"text"},{"key":"amount","value":"20000","description":"

REQUIRED | Transaction Amount

\n","type":"text"},{"key":"invoice_id","value":"Order_127","description":"

REQUIRED | Unique ref no provided by you to prevent double charging, this cannot be repeated

\n","type":"text"},{"key":"descriptions","value":"Payment for Rent for July","description":"

OPTIONAL | Description of transaction for display purposes

\n","type":"text"}]},"url":"{{base-api-url}}api/v3/payouts","description":"

The following API will allow you to move money from merchant's account to user's account.

\n

In header X-XFERS-USER-API-KEY, You need to put merchant's api key. (As found in Dashboard > Settings > API Tokens).\nIn the user_api_token in the body, You need to put user's api key. (As received from get_user_token API).

\n

Alternatively, You can also make a peer to peer transfer using this API by putting the sender's token in X-XFERS-USER-API-KEY in the header and putting the receiver's token in user_api_token in the body

\n

Payout Response Status

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
pendingPayout is waiting to be verified by Transaction Report.
\n
","urlObject":{"path":["v3","payouts"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"810f9118-56f5-4bdc-8ceb-537f611b1679","name":"Create Payout","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"user_api_token","value":"{{user-api-key}}","description":"`REQUIRED` | Buyer’s api token obtain via get_user_token API.","type":"text"},{"key":"amount","value":"300","description":"`REQUIRED` | Transaction Amount","type":"text"},{"key":"invoice_id","value":"Order_122","description":"`REQUIRED` | Unique ref no provided by you to prevent double charging, this cannot be repeated ","type":"text"},{"key":"descriptions","value":"Payment for Rent for July","description":"`OPTIONAL` | Description of transaction for display purposes ","type":"text"}]},"url":"{{base-api-url}}api/v3/payouts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 16 Aug 2019 02:01:29 GMT"},{"key":"ETag","value":"W/\"194f65ac677974ae9d9157b248b38b9b\""},{"key":"Server","value":"nginx/1.12.0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"6c1ee74f-e2fc-41f9-b883-f8a9608a60a7"},{"key":"X-Runtime","value":"0.217036"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"313"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"contract_cb823b9ba12e407195a2ee0d167bf27e\",\n \"recipient\": \"wowoo+user@xfers.com\",\n \"metadata\": {\n \"merchant_metadata\": \"\"\n },\n \"invoice_id\": \"Order_122\",\n \"descriptions\": \"Payment for Rent for July\",\n \"process_type\": \"normal\",\n \"amount\": \"300.0\",\n \"currency\": \"sgd\",\n \"bank\": null,\n \"bank_account_no\": null,\n \"created_date\": \"2019-08-16T02:01:29Z\",\n \"completed_date\": null,\n \"status\": \"completed\",\n \"wallet_id\": 2,\n \"wallet_name\": \"Digital Goods\",\n \"balance\": \"389.0\",\n \"fee_amount\": \"3.0\"\n}"},{"id":"be3b0ef4-2058-4efa-b19f-f74fc09d5d28","name":"400 Bad Request - Source account does not have enough money!","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"user_api_token","value":"{{user-api-key}}","description":"`REQUIRED` | Buyer’s api token obtain via get_user_token API.","type":"text"},{"key":"amount","value":"20000","description":"`REQUIRED` | Transaction Amount","type":"text"},{"key":"invoice_id","value":"Order_127","description":"`REQUIRED` | Unique ref no provided by you to prevent double charging, this cannot be repeated ","type":"text"},{"key":"descriptions","value":"Payment for Rent for July","description":"`OPTIONAL` | Description of transaction for display purposes ","type":"text"}]},"url":"{{base-api-url}}api/v3/payouts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 16 Aug 2019 02:02:21 GMT"},{"key":"Server","value":"nginx/1.12.0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"43ceaecd-c976-4d65-b3b1-d3a882d5e676"},{"key":"X-Runtime","value":"0.120731"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"314"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Source account does not have enough money!\",\n \"info\": \"Received Request: {\\\"user_api_token\\\"=>\\\"vpy5Jz-zYYCrem5F6W2KUY_sMez1EAPnphyjHh1pewo\\\", \\\"amount\\\"=>\\\"20000\\\", \\\"invoice_id\\\"=>\\\"Order_127\\\", \\\"descriptions\\\"=>\\\"Payment for Rent for July\\\", \\\"controller\\\"=>\\\"api/v3/payouts\\\", \\\"action\\\"=>\\\"create\\\"}\",\n \"error_code\": \"XFE310\",\n \"error_handling\": \"Please ensure your account has sufficient balance.\"\n}"}],"_postman_id":"ad7223a0-f8a2-443b-9afe-91ef0229b56c"},{"name":"Get Payout","id":"2da75c55-dd68-48c2-9ee3-e9b91f1a8591","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{base-api-url}}api/v3/payouts/{{payout_id}}","description":"

Retrieves the details of a payout that has previously been created.
Supply the unique payout ID that was returned from your previous request, and Xfers will return the corresponding payout information.

\n

Payout Response Status

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
pendingPayout is waiting to be verified by Transaction Report.
completedPayout has been completed. Fund has been credited into user's Xfers Wallet.
rejectedPayout has been rejected.
\n
","urlObject":{"path":["v3","payouts","{{payout_id}}"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"491a9485-47d0-4fec-8ac6-47121ac55eaf","name":"Get Payout","originalRequest":{"method":"GET","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}"}],"url":"{{base-api-url}}api/v3/payouts/{{payout_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 16 Aug 2019 02:04:11 GMT"},{"key":"ETag","value":"W/\"94d817a75de6ed1747069d38799eed84\""},{"key":"Server","value":"nginx/1.12.0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"70f59147-3fdc-4f8f-9c02-817cfc6bc610"},{"key":"X-Runtime","value":"0.062383"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"316"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"contract_cb823b9ba12e407195a2ee0d167bf27e\",\n \"recipient\": \"wowoo+user@xfers.com\",\n \"metadata\": {\n \"merchant_metadata\": \"\"\n },\n \"invoice_id\": \"Order_122\",\n \"descriptions\": \"Payment for Rent for July\",\n \"process_type\": \"normal\",\n \"amount\": \"300.0\",\n \"currency\": \"sgd\",\n \"bank\": null,\n \"bank_account_no\": null,\n \"created_date\": \"2019-08-16T02:01:29Z\",\n \"completed_date\": \"2019-08-16T02:01:38Z\",\n \"status\": \"completed\",\n \"wallet_id\": 2,\n \"wallet_name\": \"Digital Goods\",\n \"balance\": \"389.0\",\n \"fee_amount\": \"3.0\"\n}"},{"id":"c6420be7-63c5-4d63-99a3-c5c804826363","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}"}],"url":"{{base-api-url}}api/v3/payouts/{{payout_id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 16 Aug 2019 02:05:00 GMT"},{"key":"Server","value":"nginx/1.13.12"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"cb9cac7d-8d71-427e-9fb2-12c99c2839e7"},{"key":"X-Runtime","value":"0.056987"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Couldn't find Contract\"\n}"}],"_postman_id":"2da75c55-dd68-48c2-9ee3-e9b91f1a8591"}],"id":"018568e5-e98e-45f2-90c1-974b6d46ac62","description":"

This API enables merchant to provide the ability for its users to perform withdrawal from merchant wallet to Xfers Digital Goods Wallet.

\n","event":[{"listen":"prerequest","script":{"id":"d6f5e584-fdae-44ca-9b37-5abb8b68e3a9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab6c52bf-7c29-4ab2-af1c-7447d5dac892","type":"text/javascript","exec":[""]}}],"_postman_id":"018568e5-e98e-45f2-90c1-974b6d46ac62"},{"name":"Charge","item":[{"name":"Create Charge","id":"ce43f085-cf4b-4f86-a6e7-bcd1d034c812","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"order_id","value":"Order_1233","description":"

REQUIRED | Unique ref no provided by you to prevent double charging, this cannot be repeated

\n","type":"text"},{"key":"amount","value":"10000.00","description":"

REQUIRED | Charge Amount

\n","type":"text"},{"key":"currency","value":"SGD","description":"

REQUIRED | 3-letter ISO code for currency

\n","type":"text"},{"key":"user_api_token","value":"{{user-api-key}}","description":"

REQUIRED | Buyer's api token obtain via Connect's get user token APIs.

\n","type":"text"},{"key":"debit_only","value":"true","description":"

OPTIONAL | When this is true, this charge will attempt to debit from users existing balance/card on file. Status returned will be “completed” on successful debit or “cancelled” when there insufficient funds / valid card on file in user wallet.

\n","type":"text"}]},"url":"{{base-api-url}}api/v3/charges","description":"

The following API will allow you to create a charge on your user and collect money from them.

\n

In header X-XFERS-USER-API-KEY, You need to put merchant's api key. (As found in Dashboard > Settings > API Tokens). In the user_api_token in the body, You need to put user's api key. (As received from get_user_token API).

\n","urlObject":{"path":["v3","charges"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"a5a99971-f20f-4518-97a7-99ff2de3c1b0","name":"Create Charge","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"order_id","value":"Order_1234","description":"`REQUIRED` | Unique ref no provided by you to prevent double charging, this cannot be repeated","type":"text"},{"key":"amount","value":"150.00","description":"`REQUIRED` | Charge Amount","type":"text"},{"key":"currency","value":"SGD","description":"`REQUIRED` | 3-letter ISO code for currency","type":"text"},{"key":"user_api_token","value":"{{user-api-key}}","description":"`REQUIRED` | Buyer's api token obtain via Connect's get user token APIs.","type":"text"},{"key":"debit_only","value":"true","description":"`OPTIONAL` | When this is true, this charge will attempt to debit from users existing balance/card on file. Status returned will be “completed” on successful debit or “cancelled” when there insufficient funds / valid card on file in user wallet.","type":"text"}]},"url":"{{base-api-url}}api/v3/charges"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 15 Aug 2019 10:09:58 GMT"},{"key":"ETag","value":"W/\"cec817b1c05af59ba48663ae0116f89c\""},{"key":"Server","value":"nginx/1.12.0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"80144fee-3138-408f-b4b1-00614e27e276"},{"key":"X-Runtime","value":"0.273740"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"255"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"contract_d9a879675d2242319bf55b0891f2850e\",\n \"object\": \"TransferContract\",\n \"status\": \"completed\",\n \"amount\": \"150.0\",\n \"total_amount\": \"150.0\",\n \"currency\": \"sgd\",\n \"fee_amount\": \"1.5\",\n \"notify_url\": null,\n \"wallet_name\": \"Digital Goods\",\n \"order_id\": \"Order_1234\",\n \"description\": null,\n \"receipt_email\": \"wowoo+user@xfers.com\",\n \"expiration_date\": null,\n \"metadata\": {}\n}"},{"id":"b8048af8-6411-44ef-b400-a3deba731d87","name":"400 Bad Request - Source account does not have enough money!","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"order_id","value":"Order_1233","description":"`REQUIRED` | Unique ref no provided by you to prevent double charging, this cannot be repeated","type":"text"},{"key":"amount","value":"10000.00","description":"`REQUIRED` | Charge Amount","type":"text"},{"key":"currency","value":"SGD","description":"`REQUIRED` | 3-letter ISO code for currency","type":"text"},{"key":"user_api_token","value":"{{user-api-key}}","description":"`REQUIRED` | Buyer's api token obtain via Connect's get user token APIs.","type":"text"},{"key":"debit_only","value":"true","description":"`OPTIONAL` | When this is true, this charge will attempt to debit from users existing balance/card on file. Status returned will be “completed” on successful debit or “cancelled” when there insufficient funds / valid card on file in user wallet.","type":"text"}]},"url":"{{base-api-url}}api/v3/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 15 Aug 2019 10:23:25 GMT"},{"key":"Server","value":"nginx/1.12.0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"c594ef73-39b4-482f-8169-c663657b35be"},{"key":"X-Runtime","value":"0.142859"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"314"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Source account does not have enough money!\",\n \"info\": \"Received Request: {\\\"order_id\\\"=>\\\"Order_1233\\\", \\\"amount\\\"=>\\\"10000.00\\\", \\\"currency\\\"=>\\\"SGD\\\", \\\"user_api_token\\\"=>\\\"vpy5Jz-zYYCrem5F6W2KUY_sMez1EAPnphyjHh1pewo\\\", \\\"debit_only\\\"=>\\\"true\\\", \\\"controller\\\"=>\\\"api/v3/charges\\\", \\\"action\\\"=>\\\"create\\\"}\",\n \"error_code\": \"XFE310\",\n \"error_handling\": \"Please ensure your account has sufficient balance.\"\n}"},{"id":"ba7b6ed2-7de6-4611-a1f9-53b82e2f74c6","name":"400 Bad Request - External key (order_id or invoice_id) has already been taken","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"order_id","value":"Order_1235","description":"`REQUIRED` | Unique ref no provided by you to prevent double charging, this cannot be repeated","type":"text"},{"key":"amount","value":"1000.00","description":"`REQUIRED` | Charge Amount","type":"text"},{"key":"currency","value":"SGD","description":"`REQUIRED` | 3-letter ISO code for currency","type":"text"},{"key":"user_api_token","value":"{{user-api-key}}","description":"`REQUIRED` | Buyer's api token obtain via Connect's get user token APIs.","type":"text"},{"key":"debit_only","value":"true","description":"`OPTIONAL` | When this is true, this charge will attempt to debit from users existing balance/card on file. Status returned will be “completed” on successful debit or “cancelled” when there insufficient funds / valid card on file in user wallet.","type":"text"}]},"url":"{{base-api-url}}api/v3/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 15 Aug 2019 10:20:43 GMT"},{"key":"Server","value":"nginx/1.13.12"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"ee583fa4-4acc-4684-9bd0-470c64fcbc01"},{"key":"X-Runtime","value":"0.174475"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"285"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Validation failed: External key (order_id or invoice_id) has already been taken\",\n \"info\": \"Received Request: {\\\"order_id\\\"=>\\\"Order_1234\\\", \\\"amount\\\"=>\\\"1000.00\\\", \\\"currency\\\"=>\\\"SGD\\\", \\\"user_api_token\\\"=>\\\"vpy5Jz-zYYCrem5F6W2KUY_sMez1EAPnphyjHh1pewo\\\", \\\"debit_only\\\"=>\\\"true\\\", \\\"controller\\\"=>\\\"api/v3/charges\\\", \\\"action\\\"=>\\\"create\\\"}\"\n}"}],"_postman_id":"ce43f085-cf4b-4f86-a6e7-bcd1d034c812"},{"name":"Refund Charge","id":"3e828518-9f7b-4e66-871e-2397640cb25d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base-api-url}}api/v3/charges/{{charge_id}}/refunds","description":"

The following API will refund a charge to users

\n","urlObject":{"path":["v3","charges","{{charge_id}}","refunds"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"9b64b731-d5cf-42c2-9108-96bc0e98e78d","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base-api-url}}api/v3/charges/{{charge_id}}/refunds"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 15 Aug 2019 10:23:00 GMT"},{"key":"Server","value":"nginx/1.13.12"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"20d44338-b4f3-485a-a8fe-35c581fb5b1b"},{"key":"X-Runtime","value":"0.154896"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"247"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Source account does not have enough money!\",\n \"info\": \"Received Request: {\\\"controller\\\"=>\\\"api/v3/charges\\\", \\\"action\\\"=>\\\"refunds\\\", \\\"id\\\"=>\\\"contract_3ee7c0de0ee74e0793fa54dbb2edb987\\\", \\\"charge\\\"=>{}}\",\n \"error_code\": \"XFE310\",\n \"error_handling\": \"Please ensure your account has sufficient balance.\"\n}"},{"id":"b1b50130-51b0-4c2d-aa8e-c95da08b89fc","name":"Refund Charge","originalRequest":{"method":"POST","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base-api-url}}api/v3/charges/{{charge_id}}/refunds"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 15 Aug 2019 10:21:34 GMT"},{"key":"ETag","value":"W/\"9f30cb6b4fd119358e639aa3ce7fa977\""},{"key":"Server","value":"nginx/1.13.12"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"0916f4e8-cda9-4191-afc0-0f33a647be1b"},{"key":"X-Runtime","value":"0.309175"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"255"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"contract_d9a879675d2242319bf55b0891f2850e\",\n \"object\": \"TransferContract\",\n \"status\": \"refunded\",\n \"amount\": \"150.0\",\n \"total_amount\": \"150.0\",\n \"currency\": \"sgd\",\n \"fee_amount\": \"1.5\",\n \"notify_url\": null,\n \"wallet_name\": \"Digital Goods\",\n \"order_id\": \"Order_1234\",\n \"description\": null,\n \"receipt_email\": \"wowoo+user@xfers.com\",\n \"expiration_date\": null,\n \"metadata\": {}\n}"}],"_postman_id":"3e828518-9f7b-4e66-871e-2397640cb25d"}],"id":"92b55057-9d64-4df5-b7ea-3c2cf0dd5df9","description":"

This API enables merchant to charge users directly from Xfers Digital Goods Wallet for buying an item.

\n","event":[{"listen":"prerequest","script":{"id":"348728d4-3e16-47e0-81a7-50c0c6ae8470","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"09f26e35-7af2-4f37-a6ea-897d85b32aa9","type":"text/javascript","exec":[""]}}],"_postman_id":"92b55057-9d64-4df5-b7ea-3c2cf0dd5df9"},{"name":"Activity","item":[{"name":"Get Activities","id":"fdb9d6d8-32dd-4774-888e-154735df01f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"limit","value":"50","description":"

OPTIONAL | Maximum no. of activities in one query. Default to 50.

\n","type":"text"},{"key":"offset","value":"0","description":"

OPTIONAL | Offset no. for the list of activity. Default to 0.

\n","type":"text"},{"key":"start_date","value":"2019-08-12T15:02:28+08:00","description":"

OPTIONAL | Only activities happened after this date. Default to one month ago.

\n","type":"text"},{"key":"end_date","value":"2019-09-12T15:02:28+08:00","description":"

OPTIONAL | Only activities happened before this date. Default to today.

\n","type":"text"}]},"url":"{{base-api-url}}api/v3/user/activities","description":"

The following API allow merchant to get the list of relevant transaction activities.

\n","urlObject":{"path":["v3","user","activities"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"9ffa1559-f204-4fb4-b2a4-62cee0577358","name":"Get Activities","originalRequest":{"method":"GET","header":[{"key":"X-XFERS-USER-API-KEY","value":"{{merchant-app-key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"limit","value":"50","type":"text"},{"key":"offset","value":"0","type":"text"},{"key":"start_date","value":"2019-08-12T15:02:28+08:00","type":"text"},{"key":"end_date","value":"2019-09-12T15:02:28+08:00","type":"text"}]},"url":"{{base-api-url}}api/v3/user/activities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 Sep 2019 07:14:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"724"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"8c7601be21ae9d602d054eb79c513ca4\""},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Request-Id","value":"94d3ae1d-8024-4ecf-b781-37e5f997e20b"},{"key":"X-Runtime","value":"0.228052"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"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":"515015a2f8fdde01-SIN"}],"cookie":[],"responseTime":null,"body":"{\n \"activities\": [\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-16T10:01:29+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"contract_cb823b9ba12e407195a2ee0d167bf27e\",\n \"amount\": -300,\n \"status\": \"completed\",\n \"type\": \"Transfer\",\n \"metadata\": {\n \"origin_name\": \"wowoo_merchant\",\n \"destination_name\": \"Gerry Yap\",\n \"description\": \"Payment for Rent for July\"\n },\n \"order_id\": null,\n \"invoice_id\": \"Order_122\"\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:28:33+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"contract_a3e4c5e669a64bcfa4343554d6bc244a\",\n \"amount\": -300,\n \"status\": \"completed\",\n \"type\": \"Transfer\",\n \"metadata\": {\n \"origin_name\": \"wowoo_merchant\",\n \"destination_name\": \"Gerry Yap\",\n \"description\": \"Payment for Rent for July\"\n },\n \"order_id\": null,\n \"invoice_id\": \"Order_123\"\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:21:25+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"contract_3ee7c0de0ee74e0793fa54dbb2edb987\",\n \"amount\": 1000,\n \"status\": \"completed\",\n \"type\": \"Transfer\",\n \"metadata\": {\n \"origin_name\": \"Gerry Yap\",\n \"destination_name\": \"wowoo_merchant\",\n \"description\": \"\"\n },\n \"order_id\": \"Order_1235\",\n \"invoice_id\": null\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:19:04+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"f02a26a16fa94d08afa932b6f9221a62\",\n \"invoice_id\": \"5259_2019-08-15T10:19:04+00:00_system_upgrade\",\n \"amount\": -1000,\n \"status\": \"completed\",\n \"type\": \"Payout\",\n \"metadata\": {\n \"origin_name\": \"wowoo_merchant\",\n \"destination_name\": \"\",\n \"description\": \"\"\n }\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:19:02+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"11111\",\n \"amount\": 1000,\n \"status\": \"completed\",\n \"type\": \"Deposit\",\n \"metadata\": {\n \"description\": \"Xfers - Oversea-Chinese Banking Corporation Limited\"\n }\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:18:51+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"ff0c926cdbde456da597d2c85c944a3d\",\n \"invoice_id\": \"5259_2019-08-15T10:18:51+00:00_system_upgrade\",\n \"amount\": -2000,\n \"status\": \"completed\",\n \"type\": \"Payout\",\n \"metadata\": {\n \"origin_name\": \"wowoo_merchant\",\n \"destination_name\": \"\",\n \"description\": \"\"\n }\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:18:48+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"11110\",\n \"amount\": 2000,\n \"status\": \"completed\",\n \"type\": \"Deposit\",\n \"metadata\": {\n \"description\": \"Xfers - Oversea-Chinese Banking Corporation Limited\"\n }\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:18:25+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"49b1b7556f48497cb8aaa40d5a68ed70\",\n \"invoice_id\": \"5259_2019-08-15T10:18:25+00:00_system_upgrade\",\n \"amount\": -2000,\n \"status\": \"completed\",\n \"type\": \"Payout\",\n \"metadata\": {\n \"origin_name\": \"wowoo_merchant\",\n \"destination_name\": \"\",\n \"description\": \"\"\n }\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:18:24+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"11109\",\n \"amount\": 2000,\n \"status\": \"completed\",\n \"type\": \"Deposit\",\n \"metadata\": {\n \"description\": \"Xfers - Oversea-Chinese Banking Corporation Limited\"\n }\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:09:58+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"contract_d9a879675d2242319bf55b0891f2850e\",\n \"amount\": -150,\n \"status\": \"refunded\",\n \"type\": \"Transfer\",\n \"metadata\": {\n \"origin_name\": \"Gerry Yap\",\n \"destination_name\": \"wowoo_merchant\",\n \"description\": \"Reversal\"\n },\n \"order_id\": \"Order_1234\",\n \"invoice_id\": null\n },\n {\n \"fee\": 0,\n \"created_at\": \"2019-08-15T18:09:58+08:00\",\n \"wallet_name\": \"Digital Goods\",\n \"id\": \"contract_d9a879675d2242319bf55b0891f2850e\",\n \"amount\": 150,\n \"status\": \"refunded\",\n \"type\": \"Transfer\",\n \"metadata\": {\n \"origin_name\": \"Gerry Yap\",\n \"destination_name\": \"wowoo_merchant\",\n \"description\": \"\"\n },\n \"order_id\": \"Order_1234\",\n \"invoice_id\": null\n }\n ],\n \"activities_returned\": 10,\n \"limit\": 50,\n \"offset\": 0,\n \"start_date\": \"2019-08-12T15:02:28+08:00\",\n \"end_date\": \"2019-09-12T15:02:28+08:00\"\n}"}],"_postman_id":"fdb9d6d8-32dd-4774-888e-154735df01f8"}],"id":"3d37dba8-ab25-451f-b0a8-4aa6720c5346","_postman_id":"3d37dba8-ab25-451f-b0a8-4aa6720c5346","description":""}],"event":[{"listen":"prerequest","script":{"id":"ee7e2a18-e9ac-4db3-9d44-83c5d2afcb0b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"45bce3c0-ac4d-44f5-a35b-ae5ba6328784","type":"text/javascript","exec":[""]}}]}