OpenPymts delivers Banking as a service solution to our customers for collecting payments, holding multi-currency accounts and wallets, and making domestic and international payments. The APIs listed here offer a breadth of services for your internal Cash Management, Treasury, or Liquidity purposes and/or for collecting and making end-customer payments.
\nA single API integration into the platform enables businesses to customize their payments and banking modules to offer simple and secure services for internal stakeholders and customers.
\nHere are the steps for a typical journey to get started on our system:
\nCreate your Business Profile as a signing officer and complete the business onboarding. For any help and guidance, our Operations team can help on this as well.
\nAdd Multi-Currency Accounts, if you need access to hold wallets in countries and currencies other than your business operations. You can also link your wallets to your bank accounts, if you wish to deposit money in your accounts.
\nAdd the end beneficiary to initiate any payments. Ensure the Bank account details for the Beneficiary are captured.
\nThis completes your setup and you are ready to make Payments and/or Book FX deals to manage liquidity between the multi-currency accounts offered by OpenPymts.
\nOpenPymts also offers the ability to self-serve any transactions incl. any history, and accounts.
\nSome of the common terms used:
\nPartner ID- A unique client identifier for a business account that initiates payouts or hold accounts with OpenPymts.
\nUser ID: A unique individual entity identifier that can be a business users (signing officer, Owner, Director) or the end beneficiary.
\nWallet ID - Links multiple currency accounts for a business entity help with OpenPymts.
\nTransaction ID- Any Incoming funds and Outgoing funds, including internal transfers used to manage cash flow. This is referred by Transation ID
\nBusiness Structure on OpenPymts Platform:
\nGet a Bearer token to perform subsequent API requests.
\n","urlObject":{"path":["authenticate"],"host":["{{PROD_OPP_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"abdffdaa-bbf9-4b96-ad66-f4b945e2d84b"}],"id":"6595d30d-b72d-47f8-a5da-153c1d58253c","description":"All requests to the OpenPymts API must be made over HTTPS and will be authenticated over standard HTTP Basic authentication.
\nOnce approved and signed, you will be provided with Client ID and Secret.These credentials should be used to generate a Bearer token which is required to authenticate all your API requests.
\nYou will have a different set of credentials for Sandbox and Production.
\nYour API credentials and bearer token must be kept secret. Do not put them in your client-side code or checked into your application's code.
\n","_postman_id":"6595d30d-b72d-47f8-a5da-153c1d58253c"},{"name":"Profile Management","item":[{"name":"Register Profile","id":"088a757e-a0a3-4894-9458-0d0cfa6f0fd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Prod_Bearer_Token_Opp}}"}],"body":{"mode":"raw","raw":"{\n \"profileType\" : \"Individual\",\n \"partnerName\": \"GC TestUser\",\n\t\"partnerEmail\": \"openpymts02@gmail.com\",\n \"partnerPhone\":\"5512643583\",\n\t\"address\": {\n\t\t\"street\": \"1 main street\",\n\t\t\"city\": \"New York\",\n\t\t\"region\": \"New York\",\n\t\t\"postalCode\": \"10011\",\n\t\t\"country\": \"US\"\n\t},\n\t\"countryOfOperation\": \"US\",\n \"firstName\": \"Joe\",\n \"lastName\" : \"Mac\",\n \"userEmail\": \"joemac@cptwo.com\",\n \"password\": \"TestUser$231\",\n\t\"countryResidence\": \"US\",\n\t\"dob\": \"1981-09-23\",\n \"terms\" :\"true\",\n\t\"hasParent\": \"\",\n\t\"partnerParentId\": \"\",\n\t\"hasChild\": \"\"\n}"},"url":"{{Prod_Opp_Url}}/users/registerProfile","description":"Register a new Individual or Business Entity.
\nFor underlying business entity, you can create a link to the Parent partner as well.
\n","urlObject":{"path":["users","registerProfile"],"host":["{{Prod_Opp_Url}}"],"query":[],"variable":[]}},"response":[{"id":"7c09297a-202c-44a0-b0be-dec7dc54559c","name":"Register Profile - Business","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"profileType\" : \"Business\",\n \"partnerName\": \"CP Demo Two\",\n\t\"partnerEmail\": \"admin@cptwo.com\",\n \"partnerPhone\":\"4168528200\",\n\t\"address\": {\n\t\t\"street\": \"1 main street\",\n\t\t\"city\": \"New York\",\n\t\t\"region\": \"New York\",\n\t\t\"postalCode\": \"50010\",\n\t\t\"country\": \"US\"\n\t},\n\t\"countryOfOperation\": \"US\",\n \"firstName\": \"Joe\",\n \"lastName\" : \"Mac\",\n \"userEmail\": \"joemac@cptwo.com\",\n \"password\": \"TestUser$231\",\n\t\"countryResidence\": \"US\",\n\t\"dob\": \"1981-09-23\",\n \"terms\" :\"true\",\n\t\"hasParent\": \"\",\n\t\"partnerParentId\": \"\",\n\t\"hasChild\": \"\"\n}"},"url":"{OPPURL}/users/registerProfile"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9845a4cf-fcb2-494a-9b18-93ee4ed3f214","name":"Register Profile - Individual","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"profileType\" : \"Individual\",\n\t\"firstName\": \"Ritesh\",\n \"lastName\" : \"Joseph\",\n \"userEmail\": \"rtjoe@gmail.com\",\n \"password\": \"TestUser$231\",\n \"address\": {\n\t\t\"street\": \"3009 main street\",\n\t\t\"city\": \"Toronto\",\n\t\t\"region\": \"Ontario\",\n\t\t\"postalCode\": \"M1M1M1\",\n\t\t\"country\": \"CA\"\n\t}\n\t\"countryResidence\": \"US\",\n\t\"dob\": \"1992-10-10\",\n \"terms\" :\"true\"\n}"},"url":"{OPPURL}/users/registerProfile"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"088a757e-a0a3-4894-9458-0d0cfa6f0fd6"},{"name":"Update Partner Profile","id":"00496ebf-2e98-4318-8b75-861ec2484cb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n\t\"partnerId\": \"tQn3b01Knbi4h2k\",\n\t\"kyb\":{\n \"tradingName\":\"CP Two Inc.\",\n \"dateOfInc\":\"2000-01-22\",\n \"registrationNum\":\"200300400\",\n \"taxIdNum\":\"112233445\",\n \"countryOfInc\":\"US\",\n \"stateOfInc\":{\n \"region\":\"New York\"\n },\n \"isPubliclyTraded\":\"false\",\n \"websiteUrl\":\"\",\n \"stockSymbol\":\"\",\n \"incType\":\"02\",\n \"typeOfBusiness\":\"10\",\n \"natureOfBusiness\":\"23\",\n \"sourceOfFunds\":\"04\",\n \"monthlyVol\":\"500\",\n \"monthlyPayments\":\"10000000\",\n \"purposeOfTxn\":\"02\",\n \"description\":\"\",\n \"docRefId\":\"D1A34300A\",\n \"otherFields\":\"\"\n }\n}"},"url":"{OPPURL}/users/updatePartnerProfile","description":"Update your Partner profile details at any time by referring the Partner ID. Also, update your Business information in the KYB space to complete onboarding.
\n","urlObject":{"path":["users","updatePartnerProfile"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[{"id":"18d31487-81fa-47fe-96f8-4a8368e7e9e5","name":"Update Partner Profile - KYB","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{bearer-token}"}],"body":{"mode":"raw","raw":"{\n\t\"partnerId\": \"tQn3b01Knbi4h2k\",\n\t\"kyb\":{\n \"tradingName\":\"CP Two Inc.\",\n \"dateOfInc\":\"2000-01-22\",\n \"registrationNum\":\"200300400\",\n \"taxIdNum\":\"112233445\",\n \"countryOfInc\":\"US\",\n \"stateOfInc\":{\n \"region\":\"New York\"\n },\n \"isPubliclyTraded\":\"false\",\n \"stockSymbol\":\"\",\n \"incType\":\"02\",\n \"typeOfBusiness\":\"10\",\n \"natureOfBusiness\":\"23\",\n \"sourceOfFunds\":\"04\",\n \"monthlyVol\":\"500\",\n \"monthlyPayments\":\"10000000\",\n \"purposeOfTxn\":\"02\",\n \"description\":\"\",\n \"docRefId\":\"D1A34300A\",\n \"otherFields\":\"\"\n }\n}"},"url":"{OPPURL}/users/updatePartnerProfile"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bd55268a-4842-4c76-9d95-10a18956f8ef","name":"Update Partner Profile - Simple","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{bearer-token}"}],"body":{"mode":"raw","raw":"{\n\t\"partnerId\": \"x2t24XbNhyZvYGn\",\n\t\"partnerName\": \"Amazon-CA\",\n\t\"partnerContact\": \"9358541234\",\n\t\"address\": {\n\t\t\"street\": \"200 main street\",\n\t\t\"city\": \"Toronto\",\n\t\t\"region\": \"Ontario\",\n\t\t\"postalCode\": \"M1M1M1\",\n\t\t\"country\": \"Canada\"\n\t},\n\t\"hasParent\": \"\",\n\t\"partnerParentId\": \"\",\n\t\"hasChild\": \n}"},"url":"{OPPURL}/users/updatePartnerProfile"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d05c6a05-744e-4e74-9dcc-f9df10cb87d4","name":"Update Partner Profile- Master Child Relation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Bearer-token}}"}],"body":{"mode":"raw","raw":"{\n\t\"partnerId\": \"VstUWVLsBJ2NPll\",\n\t\"hasparent\": \"True\",\n\t\"partnerparentid\": \"x2t24XbNhyZvYGn\",\n\t\"haschild\": \"\"\n}"},"url":"{{OPPURL}}/users/updatePartnerProfile"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"00496ebf-2e98-4318-8b75-861ec2484cb0"},{"name":"Add/Update UBO","id":"ed0ce796-b7b6-46a7-8c28-4842ecfa8a5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n\t\"userInfo\":{\n\t\t\"userEmail\": \"joemac@cptwo.com\",\n\t\t\"countryResidence\": \"CA\",\n\t\t\"firstName\": \"Joe\",\n \"lastName\": \"Mac\",\n\t\t\"userAddress\": {\n\t\t\t\"street\": \"10500 main street\",\n\t\t\t\"city\": \"Toronto\",\n\t\t\t\"region\": \"Ontario\",\n\t\t\t\"postalCode\": \"M1M2M3\",\n\t\t\t\"country\": \"CA\"\n\t\t},\n\t\t\"dob\": \"1980-09-23\",\n\t\t\"userPhone\": \"2012635170\"\n\t},\n \"kycInfo\":{\n\t\t\"citizen\":\"CA\",\n\t\t\"isThirdParty\":0,\n \"thirdPartyId\":{\n \"type\":\"\",\n \"number\":\"\",\n \"issuer\":\"\",\n \"issueDate\":\"\",\n \"expiryDate\":\"\"\n },\n\t\t\"isPepHio\":0,\n \"jobTitle\":\"21\",\n \"ownership\":30,\n \"primaryIdRef\":{\n \"type\":\"02\",\n \"number\":\"5252S2000\",\n \"issuer\":\"CA\",\n \"issueDate\":\"\",\n \"expiryDate\":\"2030-06-25\"\n },\n\t\t\"secondaryIdRef\":{\n \"type\":\"\",\n \"number\":\"\",\n \"issuer\":\"\",\n \"issueDate\":\"\",\n \"expiryDate\":\"\"\n },\n \"employmentStatus\":\"01\",\n \"occupation\":\"1112\",\n \"sourceOfWealth\":\"\",\n \"relationship\":\"04\",\n \"docRefId\":\"\",\n \"additionalInfo\":\"\"\n\t},\n\t\"partnerInfo\":{\n\t\t\"partnerId\": \"tQn3b01Knbi4h2k\"\n\t},\n \"orgRole\":\"02\",\n \"tncAckFlag\":\"True\",\n \"ppAckFlag\":\"True\"\n}"},"url":"{OPPURL}/users/addCompanyOfficer","description":"Add the UBO information for the Signing Officer, Beneficial owner and Directors for the organization.
\n","urlObject":{"path":["users","addCompanyOfficer"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed0ce796-b7b6-46a7-8c28-4842ecfa8a5b"},{"name":"Get Partner Profile","id":"7b20f6c9-ecb8-454c-be7d-7a90fcc32f68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Prod_Bearer_Token_Opp}}"}],"body":{"mode":"raw","raw":"{\n\t\"partnerId\": \"0xHIILU5jajr2i9\"\n}"},"url":"{{Prod_Opp_Url}}/users/getPartnerProfile","description":"Get the details of the Business currently shared with OpenPymts. Also used to fetch Onboarding status.
\n","urlObject":{"path":["users","getPartnerProfile"],"host":["{{Prod_Opp_Url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7b20f6c9-ecb8-454c-be7d-7a90fcc32f68"},{"name":"Get User Profile","id":"a9753f88-202c-4eb3-a05f-0dc3fc3ec71c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Prod_Bearer_Token_Opp}}"}],"body":{"mode":"raw","raw":"{\n\t\"userId\": \"Da7CtJt4EVeCTiS\"\n}"},"url":"{{Prod_Opp_Url}}/users/getUserProfile","description":"Get the details of the Business currently shared with OpenPymts. Also used to fetch Onboarding status.
\n","urlObject":{"path":["users","getUserProfile"],"host":["{{Prod_Opp_Url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9753f88-202c-4eb3-a05f-0dc3fc3ec71c"},{"name":"Upload Documents","id":"4b078b74-205b-426e-b718-701fe3d8f9fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Prod_Bearer_Token_Opp}}","type":"text"},{"key":"","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"uniqueDocumentNumber","value":"1245787","type":"text"},{"key":"file","type":"file","src":"/C:/Users/mayhe/OneDrive/Pictures/Krishna_1.jpg"},{"key":"partnerId","value":"default01abcxyz","type":"text"},{"key":"userId","value":"Da7CtJt4EVeCTiS","type":"text"},{"key":"description","value":"TestFile Only","type":"text"},{"key":"docType","value":"C","type":"text"}]},"url":"{{Prod_Opp_Url}}/document/uploadSingleFile","description":"This API helps upload supporting KYC, KYB and Transaction supporting documents.
\n","urlObject":{"path":["document","uploadSingleFile"],"host":["{{Prod_Opp_Url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b078b74-205b-426e-b718-701fe3d8f9fa"}],"id":"a3fbd8c5-c8e7-4cd1-8887-d64fcc58291f","description":"The Profile management APIs allow our integrated partners to expedite the onboarding process of their downstream clients, and underlying customers. Partners can submit the onboarding data and the required verification documents via the onboarding endpoints. Clients can have their own Bank Accounts and Beneficiaries that can transact on the platform.
\nOnce an entity is created and approved by our Compliance, it can:
\nReceive funds into an Account that it owns
\nSend funds to a Beneficiary from its Account
\nTransfer funds between Accounts of 2 different multi-currency accounts.
\nTransfer funds from the Accounts held with OpenPymts to the bank account of choice.
\nThe following fields are referenced in the Profile Management
\nPartnerID and UserID are unique references used to refer a business and individual respectively.
\nAdditionally, the following fields are required for Business Onboarding
\nHere is the list of documents required for Onboarding a business.
\nAdditionally, the following fields are required for Individual and Company Officers (i.e. Signing Officer, Beneficial Owner, Director) Onboarding for KYC.
\n","_postman_id":"a3fbd8c5-c8e7-4cd1-8887-d64fcc58291f"},{"name":"Manage Beneficiary","item":[{"name":"Add Beneficiary","id":"2c187f9e-f362-403f-8643-464997076105","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"source\": \"S\",\n \"senderUserId\": \"XyqAhK0lOOQDYJw\",\n \"profileType\": \"Business\",\n \"firstName\":\"James\",\n \"lastName\":\"Snow\",\n \"businessName\":\"JSB\",\n \"email\":\"jamessnow@jsb.com\",\n \"bankInfo\":{\n \"benePhone\":\"5611234567\",\n \"currencyISO\":\"EUR\",\n \"beneAddress\":{\n \"street\":\"40 main st\",\n \"city\":\"Frankfurt\",\n \"region\":\"\",\n \"postalCode\":\"20001\",\n \"country\":\"DE\"\n },\n \"accountData\":{\n \"bankName\":\"Duestche Bank\",\n \"accountNumber\":\"\",\n \"branchCode\":\"\",\n \"routing\":\"\",\n \"wireRouting\":\"\",\n \"iban\":\"DE89370400440532016000\",\n \"bic\":\"CMDADQWE\",\n \"sortCode\":\"\",\n \"ifscCode\":\"\"\n },\n \"bankAddress\":{\n \"street\":\"10 Main St\",\n \"city\":\"Frankfurt\",\n \"region\":\"\",\n \"postalCode\":\"20010\",\n \"country\":\"DE\"\n }\n }\n}"},"url":"{OPPURL}/users/addBeneficiary","description":"Add the Beneficiary related to your business to initiate fund transfers.
\n","urlObject":{"path":["users","addBeneficiary"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[{"id":"fca3d042-9bf9-426a-86e8-3037cd6731cc","name":"Add Bene - Business","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"source\": \"S\",\n \"senderUserId\": \"XyqAhK0lOOQDYJw\",\n \"profileType\": \"Business\",\n \"firstName\":\"James\",\n \"lastName\":\"Snow\",\n \"businessName\":\"JSB\",\n \"email\":\"jamessnow@jsb.com\",\n \"bankInfo\":{\n \"benePhone\":\"5611234567\",\n \"currencyISO\":\"EUR\",\n \"beneAddress\":{\n \"street\":\"40 main st\",\n \"city\":\"Frankfurt\",\n \"region\":\"\",\n \"postalCode\":\"20001\",\n \"country\":\"DE\"\n },\n \"accountData\":{\n \"bankName\":\"COMMERZBANK\",\n \"accountNumber\":\"\",\n \"branchCode\":\"\",\n \"routing\":\"\",\n \"wireRouting\":\"\",\n \"iban\":\"DE89370400440532013000\",\n \"bic\":\"CMDADASW\",\n \"sortCode\":\"\",\n \"ifscCode\":\"\"\n },\n \"bankAddress\":{\n \"street\":\"1 Main St\",\n \"city\":\"Frankfurt\",\n \"region\":\"\",\n \"postalCode\":\"20010\",\n \"country\":\"DE\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{OPPURL}/users/addBeneficiary"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6a46ec43-37c0-4869-bc75-caff7571619b","name":"Add Bene - Individual","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"source\": \"S\",\n \"senderUserId\": \"RLttiAtb3u26ilM\",\n \"profileType\": \"Individual\",\n \"firstName\": \"Joseph\",\n \"lastName\": \"Cooper\",\n \"email\": \"test42@gmail.com\",\n \"bankinfo\":{\n \"benePhone\":\"5611234567\",\n \"currencyISO\":\"EUR\",\n \"beneaddress\":{\n \"street\":\"1 main st\",\n \"city\":\"Toronto\",\n \"region\":\"ON\",\n \"postalCode\":\"L1L2L3\",\n \"country\":\"CA\"\n },\n \"accountData\":{\n \"bankName\":\"COMMERZBANK\",\n \"accountNumber\":\"\",\n \"branchCode\":\"\",\n \"routing\":\"\",\n \"wireRouting\":\"\",\n \"iban\":\"DE89370400440532013000\",\n \"bic\":\"CMDADASW\",\n \"sortCode\":\"\",\n \"ifscCode\":\"\"\n },\n \"bankaddress\":{\n \"street\":\"1 main st\",\n \"city\":\"Toronto\",\n \"region\":\"ON\",\n \"postalCode\":\"L1L2L3\",\n \"country\":\"CA\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{OPPURL}/users/addBeneficiary"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"2c187f9e-f362-403f-8643-464997076105"},{"name":"Get Beneficiary List","id":"569c696b-b4bd-405a-8990-7df7c8ae13d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"senderUserId\": \"RLttiAtb3u26ilM\"\n}","options":{"raw":{"language":"json"}}},"url":"{OPPURL}/users/getBeneficiaryList","description":"Fetch the list of Beneficiaries and their respective statuses.
\n","urlObject":{"path":["users","getBeneficiaryList"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"569c696b-b4bd-405a-8990-7df7c8ae13d9"}],"id":"f7d952ee-1926-41c8-afd9-bebc43e92f30","description":"Beneficiary as an entity in the OpenPymts ecosystem is the counterparty used to receive funds in a transaction. This will need to comply with all country-specific regulatory requirements.
\nA beneficiary can be a Business or an Individual and funds can be moved to its bank account or an OpenPymts wallet if they are already a user of the OpenPymts services.
\nHere is the list of fields required to create a Beneficiary:
\n","_postman_id":"f7d952ee-1926-41c8-afd9-bebc43e92f30"},{"name":"Bank Account Management","item":[{"name":"Create Currency Wallet","id":"9b9fbe06-f7f2-4e74-9b88-8e3064f0e691","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Bearer-token}}"}],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"wI08Gr8mvA0hB26\",\n \"userId\":\"1yhpJ2vMtZplNr4\",\n \"currencyISO\" :\"EUR\"\n}"},"url":"{OPPURL}/account/createWallet","description":"A signing officer of a business can add wallets in currencies not available thus far to your business.
\n","urlObject":{"path":["account","createWallet"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b9fbe06-f7f2-4e74-9b88-8e3064f0e691"},{"name":"Get Wallet List","id":"e960518f-42b7-4928-b546-873b7fea183c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"default01abcxyz\",\n \"userId\":\"aUPWMYXUgtsNtUN\",\n \"currencyISO\" :\"CAD\"\n}"},"url":"{OPPURL}/account/getWallets","description":"Fetch the list of multi-currency wallets and its details assigned to your profile.
\n","urlObject":{"path":["account","getWallets"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e960518f-42b7-4928-b546-873b7fea183c"},{"name":"Link Bank Account","id":"0c69cbbc-551b-46c5-917f-d4cb3bcf92d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"walletID\":\"xsZMkWfgO3jL\",\n \"userAccountName\":\"ABC Inc.\",\n \"registeredEmail\":\"test@testco.com\",\n \"currencyISO\":\"USD\",\n\t\"accountData\":{\n \"bankName\":\"TD Bank\",\n \"accountNumber\":\"1234567890\",\n \"branchCode\":\"\",\n \"routing\":\"021000021\",\n \"wireRouting\":\"\",\n \"iban\":\"\",\n \"bic\":\"\",\n \"sortCode\":\"\",\n \"ifscCode\":\"\"\n },\n \"bankAddress\":{\n \"street\":\"100 Main St\",\n \"city\":\"New York\",\n \"region\":\"NY\",\n \"postalCode\":\"50001\",\n \"country\":\"US\"\n },\n \"isPrimary\":\"true\"\n}"},"url":"{OPPURL}/account/addBankAccount","description":"Connect a bank account to your wallet. The bank details should match the Country and Payment Method.
\n","urlObject":{"path":["account","addBankAccount"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c69cbbc-551b-46c5-917f-d4cb3bcf92d5"}],"id":"34be3f16-5fd6-4c39-af2d-7d68dccbd549","description":"Accounts supported on OpenPymts are primarily of 2 types:
\nWallet: These are multi-currency accounts held at OpenPymts to hold balances and transact.
\nBank Accounts: All Bank Account associated with a wallet allow you to send funds from and make payments to bank accounts outside of the OpenPymts platform.
\nA currency wallet can be linked to multiple bank accounts and one can choose a primary bank account.
\nAdditionally to create a Currency wallet that is not assigned to your profile yet:
\n","_postman_id":"34be3f16-5fd6-4c39-af2d-7d68dccbd549"},{"name":"Transaction Management","item":[{"name":"Get Quote","id":"33bef26b-fe1f-41a0-a99d-f09709ab32a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\r\n \"partnerId\": \"x2t24XbNhyZvYGn\",\r\n \"sourceWalletId\": \"HvV2Gd5ODK9k\",\r\n \"destWalletId\":\"8DGDUjHXrePM\",\r\n \"pricingId\":\"oppid01\",\r\n \"srcCurrency\": \"USD\",\r\n \"srcAmount\": \"30\",\r\n \"destCurrency\": \"CAD\",\r\n \"destAmount\":\"\",\r\n \"note\": \"\",\r\n \"purposeOfPayment\": \"\",\r\n \"valueDate\": \"\"\r\n}"},"url":"{OPPURL}/trans/getQuote","description":"Request a rate quote for a specified currency pair and value date.
\nThe quote ID returned may then be supplied when calling either Creating a trade or submitting a payment. A quote is valid for 10 seconds.
\n","urlObject":{"path":["trans","getQuote"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[{"id":"760caaf5-9650-4935-ad4e-6f06b2ae1ba2","name":"Get Quote-Sender Amount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\r\n \"partnerId\": \"x2t24XbNhyZvYGn\",\r\n \"sourceWalletId\": \"HvV2Gd5ODK9k\",\r\n \"destWalletId\":\"8DGDUjHXrePM\",\r\n \"pricingId\":\"oppid01\",\r\n \"srcCurrency\": \"USD\",\r\n \"srcAmount\": \"65\",\r\n \"destCurrency\": \"CAD\",\r\n \"destAmount\":\"\",\r\n \"note\": \"\",\r\n \"purposeOfPayment\": \"\",\r\n \"valueDate\": \"\"\r\n}"},"url":"{OPPURL}/trans/getQuote"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"996f2977-8be3-42c8-881b-c4edd431c4d8","name":"Get Quote-Receiver Amount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\r\n \"partnerId\": \"x2t24XbNhyZvYGn\",\r\n \"sourceWalletId\": \"HvV2Gd5ODK9k\",\r\n \"destWalletId\":\"8DGDUjHXrePM\",\r\n \"pricingId\":\"oppid01\",\r\n \"srcCurrency\": \"USD\",\r\n \"srcAmount\": \"\",\r\n \"destCurrency\": \"CAD\",\r\n \"destAmount\":\"55\",\r\n \"note\": \"\",\r\n \"purposeOfPayment\": \"\",\r\n \"valueDate\": \"\"\r\n}"},"url":"{OPPURL}/trans/getQuote"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"33bef26b-fe1f-41a0-a99d-f09709ab32a1"},{"name":"Create Trade","id":"fe7cc72f-1dd7-4429-88ec-9f593ad4959a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"quoteId\": \"QT-1471439728963900\",\n \"pricingId\":\"oppid01\"\n}"},"url":"{OPPURL}/trans/createTrade","description":"Create a trade referring the quoteid, and book a Internal book transfer between your own accounts from one currency to the other following the Get Quote inquiry.
\nOnce the setup is complete OpenPymts will provide the pricingId specific to your account.
\n","urlObject":{"path":["trans","createTrade"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe7cc72f-1dd7-4429-88ec-9f593ad4959a"},{"name":"Refresh Quote","id":"b2db239d-d7dd-46b2-8dc8-1225d3979f6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"quoteId\": \"QT-1471439728963900\",\n \"pricingId\":\"oppid01\"\n}"},"url":"{OPPURL}/trans/refreshQuote","description":"Create a trade referring the quoteid, and book a Internal book transfer between your own accounts from one currency to the other following the Get Quote inquiry.
\n","urlObject":{"path":["trans","refreshQuote"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2db239d-d7dd-46b2-8dc8-1225d3979f6e"},{"name":"Initiate Transaction","id":"5cde0698-abdb-464a-bc04-793b0d286ca8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\r\n\t\"partnerId\": \"x2t24XbNhyZvYGn\",\r\n \"referenceId\": \"Invoice#1234G\",\r\n \"senderData\": {\r\n \"userId\":\"MMUXz5lI5TLPZOQ\"\r\n },\r\n \"senderFundingAccount\":\"\",\r\n \"receiverInfo\" :[{\r\n \"receiverId\":\"opp-testcorpuser\",\r\n \"receiverAccount\":\"kXgH3e5j5a\",\r\n \"receiverWallet\":\"\"\r\n }],\r\n \"receiverType\": \"\",\r\n \"quote\": {\r\n \"srcAmount\": 21.5,\r\n \"srcCurrency\": \"USD\",\r\n \"destAmount\":\"\",\r\n \"destCurrency\": \"CAD\",\r\n \"pricingId\":\"oppid01\"\r\n\t},\r\n\t\"transactionType\":\"Funds Out\",\r\n\t\"paymentMethod\":\"Money In Minutes\",\r\n\t\"purposeOfPayment\":\"01\",\r\n\t\"remittanceInfo\":\"/Payments/\",\r\n\t\"created\":\"\",\r\n\t\"status\": \"\"\r\n}"},"url":"{OPPURL}/trans/initiateTransaction","description":"Initiate a fund transfer to a external bank account or internally within the OpenPymts ecosystem, if you know the receive details.
\n","urlObject":{"path":["trans","initiateTransaction"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5cde0698-abdb-464a-bc04-793b0d286ca8"},{"name":"Approve Transaction","id":"980cd8ab-113d-4675-a682-39794208e681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\r\n \"partnerId\": \"lDljjfkATWnHfWD\",\r\n \"transactionId\": \"txn-vYfrQ3jJIpE8\",\r\n \"senderData\": {\r\n \"userId\":\"kmOg2Y6NvRSMo1U\"\r\n },\r\n \"quote\": {\r\n \"quoteId\": \"d42c38b2649a445ab21c02fe262c3816\"\r\n }\r\n}"},"url":"{OPPURL}/trans/approveTransaction","urlObject":{"path":["trans","approveTransaction"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"980cd8ab-113d-4675-a682-39794208e681"},{"name":"Submit Transaction","id":"8a0e8e8d-aeb1-4fa6-aaab-a1cef00670c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\r\n \"partnerId\": \"x2t24XbNhyZvYGn\",\r\n \"transactionId\": \"txn_9rPEb9K7iGek\",\r\n \"quote\": {\r\n \"quoteId\": \"QT-1300091703204800\"\r\n }\r\n}"},"url":"{OPPURL}/trans/submitTransaction","description":"This is the final confirmation to submit and confirm the transaction details and quotation for OpenPymts to initiate transaction processing.
\n","urlObject":{"path":["trans","submitTransaction"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a0e8e8d-aeb1-4fa6-aaab-a1cef00670c0"},{"name":"FundsIn - Manual","id":"81bbe5e4-1d03-478d-b855-bb256e2b3ee0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\r\n\t\"partnerId\": \"x2t24XbNhyZvYGn\",\r\n\t\"orderId\": \"\",\r\n\t\"orderStatus\": \"\",\r\n \"transactionType\":\"Funds In\",\r\n\t\"userData\": {\r\n\t\t\"userId\":\"MMUXz5lI5TLPZOQ\"\r\n\t},\r\n \"quote\":{\r\n \"srcAmount\": 60,\r\n \"srcCurrency\": \"USD\",\r\n \"destAmount\": \"\",\r\n \"destCurrency\" :\"\",\r\n \"transactionFX\": \"\",\r\n \"transactionFee\" :\"\"\r\n },\r\n \"receiverInfo\": [{\r\n \"receiverId\": \"MMUXz5lI5TLPZOQ \",\r\n \"receiverEmail\":\"\"\r\n }],\r\n \"paymentMethod\":\"Money In Minutes\",\r\n \"purposeOfPayment\": \"09\",\r\n\t\"paymentCreated\": \"\",\r\n\t\"paymentStatus\": \"\",\r\n\t\"userAckFlag\":\"Y\",\r\n\t\"returnUrl\": \"\",\r\n \"auth\":{\r\n \"opAccessToken\":\"\",\r\n \"paymentToken\":\"\",\r\n \"userOTP\":\"\"\r\n },\r\n \"sessionToken\":\"\"\r\n}"},"url":"{OPPURL}/orders/receivePayment","description":"For Sandbox purposes only, this can be used to upload wallet balance to succesfully test the funds out functionalities.
\n","urlObject":{"path":["orders","receivePayment"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"81bbe5e4-1d03-478d-b855-bb256e2b3ee0"}],"id":"d9cea402-29e1-47fb-b37e-7e09f69596f1","description":"A transaction is an entry on an activity and represents the various credits and debits on the accounts. The amount of details contained within a transaction will depend on the type of the transaction.
\nOnce the setup is complete OpenPymts will provide the pricingId specific to your account.
\nInternal transactions i.e. moving funds between your wallets is also possible using Create Trade API
\nInitiating Payouts and Payments using the OpenPymts ecosystem, you can initate a transaction
\n","_postman_id":"d9cea402-29e1-47fb-b37e-7e09f69596f1"},{"name":"Back office Management","item":[{"name":"Get Transaction by Partner","id":"a1d4c597-5b45-497f-9526-1fbe818efe05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"lDljjfkATWnHfWD\",\n \"transactionID\":\"txn-3vkNYdANQChx\"\n}"},"url":"{OPPURL}/trans/getTransaction","description":"Lookup transaction details including its status using Transaction ID.
\n","urlObject":{"path":["trans","getTransaction"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1d4c597-5b45-497f-9526-1fbe818efe05"},{"name":"Get Transaction by Reference ID","id":"6a2d3713-4809-4ddf-9b56-223a3c1f44c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"lDljjfkATWnHfWD\",\n \"userData\": {\n \t\"userId\":\"kmOg2Y6NvRSMo1U\"\n },\n \"currencyID\":\"CAD\",\n \"referenceID\": \"Invoice#1234\"\n}"},"url":"{OPPURL}/trans/getTransaction","description":"Lookup transaction details including its status using your Transaction Reference#
\n","urlObject":{"path":["trans","getTransaction"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6a2d3713-4809-4ddf-9b56-223a3c1f44c0"},{"name":"Get Transaction by Status","id":"4a2ecce5-e082-4700-9d2f-33b4e536cfd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"lDljjfkATWnHfWD\",\n \"userData\": {\n \t\"userId\":\"kmOg2Y6NvRSMo1U\"\n },\n \"currencyID\":\"CAD\",\n \"status\": \"Completed\"\n}"},"url":"{OPPURL}/trans/getTransaction","description":"Lookup transaction(s) details in a specific Status.
\n","urlObject":{"path":["trans","getTransaction"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a2ecce5-e082-4700-9d2f-33b4e536cfd9"},{"name":"Get Transaction by Date","id":"aadbaebd-b03c-470e-8172-d948baeaf3fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"lDljjfkATWnHfWD\",\n \"userData\": {\n \t\"userId\":\"xkEnefU3F0hWhPu\"\n },\n \"currencyID\":\"USD\",\n \"startDate\": \"07/20/2024\",\n \"endDate\": \"06/20/2024\"\n}"},"url":"{OPPURL}/trans/getTransaction","description":"Lookup transaction(s) details for a date range.
\n","urlObject":{"path":["trans","getTransaction"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aadbaebd-b03c-470e-8172-d948baeaf3fc"}],"id":"f29c2e8e-7e46-4cc0-867c-11e9ec2c2bec","description":"OpenPymts offers a range of APIs to help serve customers and track the status of their transactions. One can filter transactions based on Date, Status, Transaction ID, or even using an internal reference ID of their own.
\nWe help businesses keep you up to date on the status of the transaction. You can track the status: Created, Processing, Completed, Cancel
\nPlease note: Date Search Format - mm/dd/yyyy
\n","_postman_id":"f29c2e8e-7e46-4cc0-867c-11e9ec2c2bec"},{"name":"Data Dictionary","item":[{"name":"Get Reference Data","id":"24ef4afd-7224-4d3f-a394-66e24c22dc3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":""},"url":"{OPPURL}/data/getPickListData","urlObject":{"path":["data","getPickListData"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"24ef4afd-7224-4d3f-a394-66e24c22dc3a"},{"name":"Get Country Info","id":"fa1978ad-f097-4deb-a7af-18ad4546163d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{Bearer-token}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{OPPURL}/data/getCountryData?country=US","urlObject":{"path":["data","getCountryData"],"host":["{OPPURL}"],"query":[{"key":"country","value":"US"}],"variable":[]}},"response":[],"_postman_id":"fa1978ad-f097-4deb-a7af-18ad4546163d"},{"name":"Get Currencies by Country","id":"5331a122-77d5-47ee-bb61-4a6b8d021c84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{Bearer-token}"}],"body":{"mode":"raw","raw":""},"url":"{OPPURL}/data/getCountryCurrencyList","description":"This will help you get list Country and Currency supported.
\n","urlObject":{"path":["data","getCountryCurrencyList"],"host":["{OPPURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5331a122-77d5-47ee-bb61-4a6b8d021c84"}],"id":"edbd0b2a-0a6b-48ef-8065-d049588d9aab","description":"Data dictionary APIs are support APIs that help customers manage meta-data for relevant information required in the APIs.
\nGet Account Creation Data
\nIndividual Roles
\nbusinessIdentificationType
\nGet Transaction Data
\npurpose of transaction
\nNature of Business
\nOccupation Codes
\nGet Currencies by Country
\nGet KYC KYB Info
\nID Types for KYC
\nJob titles
\nSource of wealth
\nEmployment Status
\n