{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5cd49055-4e53-4c85-b920-6528d9abd87b","name":"Payyd-Enterprise Api Documentation","description":"This API is intended for Payyd Enterprise Clients.\n\nTo ensure the collection runs properly, a script and specific environment variables are required. For assistance, please reach out to Payyd.\n\nThe Payyd API employs asynchronous messaging or a queue system to handle various actions, such as creation, updates, and deletions.  \nAs a result, enterprise partners must provide a callback URL to receive updates.\n\n---\n\n**Steps to run the collection without writing any code:**\n\n1. Open the collection in Postman or download it locally.\n    \n2. Set your public and private keys in the Postman Environment.\n    \n3. Review the _Pre-request Script_ to ensure the signature is correctly generated.\n    \n4. Execute the **GetToken** request to retrieve a bearer token.\n    \n5. Call the **Account Balance** endpoint to confirm it works without an _Invalid Signature_ error.\n    \n\n---\n\n**URLs**:  \nSandbox API: [https://sandbox-enterprisegateway.payyd.money/graphql](https://sandbox-enterprisegateway.payyd.money/graphql) (fake info is accepted)<br>PreProd API: [https://preprod-enterprisegateway.payyd.money/graphql](https://preprod-enterprisegateway.payyd.money/graphql) (fake info is NOT accepted)<br>PROD/LIVE API: [https://enterprisegateway.payyd.money/graphql](https://enterprisegateway.payyd.money/graphql) (fake info is NOT accepted)\n\n---\n\n**Enumerations**:\n\n```\npublic enum Language\n{\n    EN,    // English\n    ES,    // Spanish\n    FR,    // French\n    DE,    // German\n    IT,    // Italian\n    PT,    // Portuguese\n    RU,    // Russian\n    ZH,    // Chinese\n    JA,    // Japanese\n    KO,   // Korean\n    AR,   // Arabic\n    HI,   // Hindi\n    TR,   // Turkish\n    NL,   // Dutch\n    PL,   // Polish\n    TH,   // Thai\n    VI,   // Vietnamese\n    MS,   // Malay\n    ID    // Indonesian\n}\n\n ```\n\n```\npublic enum EntityType\n{\n    PERSONAL,\n    BUSINESS\n}\n\n ```\n\n```\npublic enum PayinTransactionStatus\n{\n    Cancelled,\n    Error,\n    LinkSent,\n    LinkViewed,\n    LinkDeclined,\n    AwaitingFunds,\n    LinkAbandoned,\n    FundsCollected,\n    FundsReceived\n}\n\n ```\n\n```\npublic enum PayoutTransactionStatus\n{\n    PayoutHold,\n    PayoutDraft,\n    PayoutInitiated,\n    PayoutProcessing,\n    PayoutCompleted,\n    PayoutRejected,\n    PayoutCancelled,\n    Error\n}\n\n ```\n\n```\npublic enum SingleOrAllOccurrences\n{\n    ThisEvent,\n    ThisAndFollowingEvents,\n    AllEvents\n}\n\n ```\n\n``` json\n{\n    \"UserNotFound\": \"User not found.\",\n    \"CountryNotFound\": \"Country not found.\",\n    \"InvalidPaymentSourceOrType\": \"Invalid payment method source or type.\",\n    \"ThirdPartyError\": \"any error message from third party\",\n    \"DuplicateEntry\": \"any message\",\n    \"InsufficientFunds\": \"Insufficient funds in {CurrencyCode}.\",\n    \"InvalidBankCodeOrName\": \"Bank code or bank name is invalid for Country {CountryIsoCode3}.\",\n    \"BankDetailsRequired\": \"Bank Details are required.\",\n    \"BusinessNameRequired\": \"Business name is required.\",\n    \"FirstNameRequired\": \"Firstname is required.\",\n    \"LastNameRequired\": \"Lastname is required.\",\n    \"StreetAddressRequired\": \"Street Address is required.\",\n    \"CityRequired\": \"City is required.\",\n    \"ZipCodeRequired\": \"Zip Code is required.\",\n    \"StateRequired\": \"States is required.\",\n    \"CountryRequired\": \"Country is required.\",\n    \"BusinessEntityNotFound\": \"Business Entity not found.\",\n    \"BusinessAddressRequired\": \"The registered or physical address of the business is required.\",\n    \"UserAddressRequired\": \"User address is required.\",\n    \"CompleteAddressRequired\": \"A complete address is required, including Street Address, City, State, Zip Code, and Country Name.\",\n    \"InvalidLaterOrNowDates\": \"Recurring start date must be equal or later than now.\",\n    \"EndDateMustBeLaterThanStartDateError\": \"Recurring end date must be later than start date.\",\n    \"NoPaymentServiceEnabled\": \"No service is enabled for Country {CountryIsoCode3}.\",\n    \"BankOffline\": \"Bank is Offline.\",\n    \"BankAccountNotFound\": \"Bank Account not found.\",\n    \"InvalidPaymentPurpose\": \"Invalid Payment Purpose.\",\n    \"PayorNotFound\": \"Invalid Payment Purpose.\",\n    \"CreditorNotFound\": \"Creditor not found.\",\n    \"BilledHoursMustBePositiveValue\": \"Billed hours must be a positive value.\",\n    \"PhoneNumberExistsAlready\": \"The phone numbers are already in use by another user.\",\n    \"EmailAddressExistsAlready\": \"The email address is already in use by another user.\",\n    \"TransactionNotFound\": \"The transaction code/number not found.\",\n    \"TransactionCannotBeCancelled\": \"Transaction cannot be cancelled.\",\n    \"TransactionAlreadyVerified\": \"Transaction has been verified already.\",\n    \"TransactionAlreadySent\": \"Transaction has been sent already.\",\n    \"TransactionAlreadyInProgress\": \"Transaction already in progress.\",\n    \"WithdrawalLimit\": \"{DailyLimit} maximum withdrawal per day and/or {MonthlyLimit} maximum withdrawal per month allowed.\",\n    \"MinimumDaysToWithdraw\": \"Recently deposited funds can only be withdrwan after {Days} days.\",\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30387140","team":6783028,"collectionId":"5cd49055-4e53-4c85-b920-6528d9abd87b","publishedId":"2sAYdZstVb","public":true,"publicUrl":"https://documenter-api.postman.tech/view/30387140/2sAYdZstVb","privateUrl":"https://go.postman.co/documentation/30387140-5cd49055-4e53-4c85-b920-6528d9abd87b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-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":"2025-02-18T23:50:31.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Enterprise-Sandbox","id":"9350eed1-65fa-4e70-a1f1-c6d8706e4336","owner":"30387140","values":[{"key":"graphql_url","value":"https://sandbox-enterprisegateway.payyd.money/graphql","enabled":true,"type":"default"},{"key":"x-api-key","value":"ask from payyd","enabled":true,"type":"secret"},{"key":"services_url","value":"https://sandbox-services.payyd.money/graphql","enabled":true,"type":"default"},{"key":"callback_url","value":"https://sample.domain/api/sample_callback","enabled":true,"type":"default"},{"key":"secret-key","value":"ask from payyd","enabled":true,"type":"secret"}],"published":true}],"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/3f24790de8edd4d910dd1cfffec345105346d403dc0dc6b0c8d4cc3ae5d22d5a","favicon":""},"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"},{"label":"Enterprise-Sandbox","value":"30387140-9350eed1-65fa-4e70-a1f1-c6d8706e4336"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAYdZstVb"}