{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"02fb884d-a121-4940-acc4-df6082aa43bc","name":"Consumer App","description":"This collection is secured using OAuth 2.0 tokens with a password grant type.\n\nThe app must acquire a token by posting a request to [https://auth.[domain]/uaa/oauth/token](https://auth.[domain]/uaa/oauth/token) with Basic Authorization and the username and password in the body. The username is the customer's phone number, and the password is their selected PIN. The grant type, client ID, and secret can be supplied upon integration with a specific environment.\n\nThe token can be refreshed upon expiry, or a new one acquired if the user is inactive for too long.\n\nSubsequent requests to restricted endpoints must contain the supplied token (a JWT), and whether the user is allowed to access the endpoint is determined based on claims inserted into the token upon its creation. For example, a user's token will claim to belong to them using their account ID. Every request to resources that belong to specific accounts will be checked against the account ID claim in the auth token, and if it doesn't match the request is rejected. Although not all JWTs require a signature and can be tampered with, our ones are verified using a non-default algorithm that only accepts it if it is signed with our own signing key.\n\nAdditionally, the token is how the front-end knows what the customer ID is so that it can be used in requests such as Get User Info. The app can decode the token and extract the customer ID claim. This allows us to keep personally identifiable information such as the MSISDN out of the request paths, thereby keeping customer information private.\n\n## Glossary of Statuses\n\n| **Id** | **Code** | **Status** | **Description** |\n| --- | --- | --- | --- |\n| \\-2 | DEL | Deleted | Deleted, this account/device/etc. has been removed from use indefinitely |\n| 3 | CLD | Bulk Operation | Bulk operation finished (closed) |\n| 5 | ACT | Active | Active, ready, usable. This is the most commonly used status because it applies to customers, devices, etc. |\n| 8 | CLDE | Bulk Operation | As CLD, but with an error |\n| 16 | LOCK | Locked | Locked. Similar to deleted, but can be unlocked more easily |\n| 88 | DEAC | Deactivated | Deactivated, the contact/address/identifier is not in use anymore |\n| 89 | FRAUD | Security Issue | Locked due to marked as lost, stolen, or used for fraud |\n\n## Glossary of Address Types\n\n| **Id** | **Code** | **Description** |\n| --- | --- | --- |\n| 1 | Business |  |\n| 2 | Home |  |\n| 3 | Invoice |  |\n| 4 | Other |  |\n| 5 | Permanent | Used in some countries which require a permenant address listed for foreign nationals |\n| 6 | Present | Used in conjunction with permanent |\n| 7 | Rental |  |\n| 8 | Employer |  |\n| 9 | Delivery | Used for delivery of goods like debit cards |\n\n## Glossary of Contact Types\n\n| **Id** | **Code** | **Description** |\n| --- | --- | --- |\n| 0 | Unknown | If no others apply |\n| 1 | Company | Contact for business |\n| 2 | Individual | Contact for individual user |\n| 3 | Outlet | Contact for business subsidiary |\n\n## Glossary of Account Types (defaults)\n\n| **Id** | **Code** | **Description** |\n| --- | --- | --- |\n| 3000 | WMOB | Wallet Mob Account |\n| 3003 | MRCHT | Merchant Account |\n\n## Glossary of Customer Types (defaults)\n\n| **Id** | **Code** | **Description** |\n| --- | --- | --- |\n| 8 | MCHNT | Merchant |\n| 9 | BUSI | Business |\n| 1000 | MWLT | MWallet |\n\n## Glossary of Identifiers\n\n| **Id** | **Description** | **Code** | **Type** |\n| --- | --- | --- | --- |\n| 1 | Passport | PASS | TEXT |\n| 2 | Drivers Licence | DRIV | TEXT |\n| 4 | National ID | NATI | TEXT |\n| 5 | Organization | ORG | TEXT |\n| 6 | Selfie | IMAGEO | IMAGE |\n| 7 | Employment ID | EMID | TEXT |\n| 8 | Social ID | WELF | TEXT |\n| 9 | Social Card Image | SOCRD | IMAGE |\n| 10 | Signature | SIGNT | IMAGE |\n| 11 | Other | OTHER | IMAGE |\n| 12 | Mothers Maiden Name | MMN | TEXT |\n| 13 | Birth Place | BTHPL | TEXT |\n| 14 | Other ID | OTHID | TEXT |\n| 16 | Passport Image | PSSPT | IMAGE |\n| 17 | Drivers License Image | DRLIC | IMAGE |\n| 18 | National ID Image | NATIM | IMAGE |\n| 19 | Voter ID | VOTID | TEXT |\n| 20 | GSIS/SSS | GSIS | TEXT |\n| 21 | Tax ID No | TIN | TEXT |\n| 22 | Business Registration ID | BREGO | TEXT |\n| 23 | Secretary Cert | SCERT | TEXT |\n| 24 | Voter ID Image | VOTIM | IMAGE |\n| 25 | GSIS/SSS Image | GSISS | IMAGE |\n| 26 | Tax ID Image | TAXIM | IMAGE |\n| 27 | Province | PROV | TEXT |\n| 28 | Barangay | BARA | TEXT |\n| 29 | Postcode | POST | TEXT |\n| 30 | First School | SCHO | TEXT |\n| 31 | Referral Phone Number | REFN | TEXT |\n| 32 | On Behalf of | OBHO | TEXT |\n| 33 | Bank Name | BANK | TEXT |\n| 35 | Bank Short Code | BCODE | TEXT |\n| 41 | Security IMAGEo | SECPH | IMAGE |\n| 42 | Proof of Address | PROFA | IMAGE |\n| 43 | Proof of Income | PROFI | IMAGE |\n| 44 | Source of Funds | SRCFU | TEXT |\n| 48 | Business Picture | BSPIC | IMAGE |\n| 52 | Social Card Image Back | SOCBK | IMAGE |\n| 53 | Other Id Image Back | OTHBK | IMAGE |\n| 55 | Drivers Image Back | DRLBK | IMAGE |\n| 56 | National Id Image Back | NATBK | IMAGE |\n| 57 | Voter Id Image Back | VOTBK | IMAGE |\n| 58 | GSIS/SSS Image Back | GSIBK | IMAGE |\n| 59 | Tax ID Image Back | TAXBK | IMAGE |\n| 60 | Visa Image | VISA | IMAGE |\n| 61 | Visa ID | VSAID | TEXT |\n| 62 | Business Registration Image | BREIM | IMAGE |\n| 64 | Drivers Licence Version | DRIVV | TEXT |\n| 65 | Trading Name | TRDNM | TEXT |\n| 66 | Bank Verification No | BVNO | TEXT |\n| 67 | Business Registration Image 2 | BREI2 | IMAGE |\n| 68 | Employer Name | EMPRN | TEXT |\n| 80 | Marital Status | MARST | TEXT |\n| 81 | Number of Children | NCHLD | TEXT |\n| 83 | Account Manager | ACCMG | TEXT |\n| 85 | Profile Pic | PRFLP | IMAGE |\n\n## Glossary of Billable Events\n\n| **Id** | **Description** | **Code** |\n| --- | --- | --- |\n| 314 | Commission | COMM |\n| 315 | Merchant to Customer Transfer on-net | M2CT |\n| 316 | Customer to Merchant Withdrawal | C2MW |\n| 317 | Customer Purchase | C2MP |\n| 318 | Customer to Merchant Deposit | C2MD |\n| 319 | Consumer to Bank Deposit | C2BD |\n| 320 | Bank to Consumer Withdrawal | B2CW |\n| 321 | Bulk Payment | MMBP |\n| 322 | Customer to Customer Airtime Topup | C2CA |\n| 323 | Consumer to Consumer Transfer on-net | C2CT |\n| 324 | Customer to Merchant Transaction | C2MT |\n| 325 | Merchant to Customer Transfer off-net | M2CTO |\n| 326 | Customer to Merchant Redeem off-net | C2MRO |\n| 327 | Single-Customer Transfer | SCT |\n| 331 | Remittance Refund | RREF |\n| 337 | Cash Back | CBCK |\n| 338 | ATM Cash Out | ATMO |\n| 339 | Customer Initiated Merchant Payment | CIMP |\n| 340 | Merchant to Bank Deposit | M2BD |\n| 341 | Bank to Merchant Withdrawal | B2MW |\n| 342 | Emoney Reversal | REV |\n| 343 | Emoney Bill Payment | BILL |\n| 344 | Transaction Fee | TFEE |\n| 345 | Refund Customer | M2CRF |\n| 350 | Account Close | ACCLS |\n| 373 | Money Customer Purchase | MC2MP |\n| 374 | Tax Charge | TAX |\n| 375 | Third Party Commission | TPCOM |\n| 376 | Balance Conversion - Outbound | BXCHO |\n| 391 | Direct Deposit | DDEP |\n| 393 | Operator Adjustment | OADJ |\n| 394 | Emoney Change | M2CS |\n| 395 | Request Money Payment | SEEK |\n| 397 | Redeem Coupon | RDMCP |\n| 398 | Gift | GIFT |\n| 399 | Gift Offnet | GIFOF |\n| 400 | Consumer to Consumer Transfer off-net | C2CTO |\n| 402 | Balance Conversion - Inbound | BXCHI |\n| 403 | Bank to Merchant Withdrawal Agency | B2MWA |\n| 404 | Merchant to Bank Deposit Agency | M2BDA |\n| 405 | External Provider to Consumer Deposit | EP2CD |\n| 406 | External Provider to Merchant Deposit | EP2MD |\n| 407 | Bonus | BONUS |\n| 408 | Payment Card to Merchant | PC2M |\n| 409 | Merchant to External Provider Withdrawal | M2EPW |\n| 410 | Consumer to External Provider Withdrawal | C2EPW |\n| 412 | ATM Initiated Withdrawal | ATMW |\n| 413 | Merchant to Third Party Wallet | M2THW |\n| 414 | Consumer to Third Party Wallet | C2TPW |\n| 415 | Card Issuing | CISSU |\n| 420 | Bulk Payment Consumer off-net | MMCCO |\n| 421 | Bulk Payment Merchant off-net | MMMCO |\n| 422 | Topup Bundle | BNDLE |\n\n## Glossary of Error Codes\n\n| **errorCode** | **errorKey** | **errorDescription** |\n| --- | --- | --- |\n| 1000 | transaction.resultcode.1 | Invalid From Account |\n| 1001 | transaction.resultcode.2 | Invalid To Account |\n| 1002 | transaction.resultcode.3 | Insufficient funds |\n| 1003 | transaction.resultcode.4 | From Account is Suspended |\n| 1004 | transaction.resultcode.5 | To Account is Suspended |\n| 1005 | transaction.resultcode.6 | From Balance is Suspended |\n| 1006 | transaction.resultcode.7 | To Balance is Suspended |\n| 1007 | transaction.resultcode.8 | From Balance is Invalid |\n| 1008 | transaction.resultcode.9 | To Balance is Invalid |\n| 1009 | transaction.resultcode.10 | Payment Type is Invalid |\n| 1010 | transaction.resultcode.11 | From Customer - not Found |\n| 1011 | transaction.resultcode.12 | To Customer - not Found |\n| 1012 | transaction.resultcode.13 | Amount is invalid |\n| 1013 | transaction.resultcode.14 | From and To account are Identical |\n| 1014 | transaction.resultcode.15 | Merchant Account is Invalid |\n| 1015 | transaction.resultcode.16 | Merchant Account is Suspended |\n| 1016 | transaction.resultcode.17 | Merchant Balance is Invalid |\n| 1017 | transaction.resultcode.18 | Customer not Found |\n| 1018 | transaction.resultcode.19 | No Parent for Fees and Charges |\n| 1019 | transaction.resultcode.20 | Transaction is below minimum allowed value |\n| 1020 | transaction.resultcode.21 | Transaction limit reached |\n| 1021 | transaction.resultcode.22 | Daily limit reached |\n| 1022 | transaction.resultcode.23 | Monthly limit reached |\n| 1023 | transaction.resultcode.24 | System Account not Found |\n| 1024 | transaction.resultcode.25 | No Commission Configured |\n| 1025 | transaction.resultcode.26 | Balance limit reached |\n| 1026 | transaction.resultcode.27 | Transaction type not allowed |\n| 1027 | transaction.resultcode.28 | Transaction type not allowed for this account |\n| 1028 | transaction.resultcode.29 | Total Daily limit reached |\n| 1029 | transaction.resultcode.30 | Total Monthly limit reached |\n| 1030 | transaction.resultcode.31 | Transaction type not allowed for the Balance |\n| 1068 | transaction.resultcode.32 | Balance Locked for From Account |\n| 1069 | transaction.resultcode.33 | Balance Locked for To Account |\n| 1070 | transaction.resultcode.34 | Balance Locked for Commission |\n| 1071 | transaction.resultcode.35 | Balance Locked for Distribution |\n| 1103 | transaction.resultcode.36 | Source wallet type minimum transaction limit |\n| 1104 | transaction.resultcode.37 | Destination wallet type minimum transaction limit |\n| 1105 | transaction.resultcode.38 | Wallet type balance hard max limit |\n| 1106 | transaction.resultcode.39 | Customer balance hard max limit |\n| 201 | transaction.resultcode.40 | From Customer is Suspended |\n| 202 | transaction.resultcode.41 | To Customer is Suspended |\n\n# Idempotency Keys\n\nSome endpoints require an idempotency key to be applied to the header to prevent duplicate requests.\n\nThe header name is `Idempotency-Key`and the value can be any locally generated string. Often a customer identifier + time is used. This value is cached over a short timeframe (1 min by default) and if the same value is sent in that timeframe a 429 Too many requests is returned with a problem+json body. For those endpoints with this filter applied a 400 Bad Request is returned with a problem+json if the header is not included.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"15470766","team":2919620,"collectionId":"02fb884d-a121-4940-acc4-df6082aa43bc","publishedId":"2sA2r9WiTZ","public":true,"publicUrl":"https://wallet.api.youtap.com","privateUrl":"https://go.postman.co/documentation/15470766-02fb884d-a121-4940-acc4-df6082aa43bc","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-03-06T02:27:53.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/5e33f9ad2642aac9a985e25d3345dea0ea57b2e16c23c03ceb44e312bd55bb72","favicon":"https://youtap.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://wallet.api.youtap.com/view/metadata/2sA2r9WiTZ"}