{"info":{"_postman_id":"8e63aa5e-0996-47f9-b589-997c3e9c81bd","name":"Palla Platform Partner Docs","description":"

The Platform API is for use by trusted Partners.

\n

By using Palla's APIs you are agreeing to Palla's terms and conditions.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"306637","collectionId":"8e63aa5e-0996-47f9-b589-997c3e9c81bd","publishedId":"TzkyP11Z","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"383fab"},"publishDate":"2022-09-13T02:55:01.000Z"},"item":[{"name":"Auth","item":[{"name":"Partner Credential Exchange","id":"4b19f79a-d589-4487-b6e9-f1df88f8ea09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"{{partner-client-id}}\",\n \"client_secret\": \"{{partner-client-secret}}\",\n \"audience\": [\n \"https://api.platform.palla.app/\"\n ],\n \"grant_type\": \"client_credentials\",\n \"user_id\": \"abc12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/auth/token","description":"

Perform a credentials exchange for a Bearer token. The token authorizes the partner for a specific User with the provided user_id.

\n

This endpoint can only be called from from the partner's backend. The returned token is safe to provide to a web or native application for subsequent API calls.

\n
\n
Request
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldRequiredDescription
client_id✓The client id issued to the partner.
client_secret✓The client secret issued to the partner.
audience✓The name of the application for which a token is being requested. For the platform, this is always [\"https://api.platform.palla.app/\"]
grant_type✓The type of grant being requested. Here this is always client_credentials
user_id✓The id that the partner uses to reference their customer. This can be any string value.
countryThe country of the customer. This is optional and requires a configuration in that country. This value defaults to country of the primary configuration.
providerThe provider, or business unit, that the customer belongs to. This is optional and requires a separate configuration for the business unit.
\n
","urlObject":{"path":["v1","auth","token"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"d4154ce5-e156-45cc-a24a-1d35cfc65918","name":"Credential Exchange for User","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"banco-client-id\",\n \"client_secret\": \"banco-secret\",\n \"audience\": [\"https://api.platform.palla.app/\"],\n \"grant_type\":\"client_credentials\", \n \"user_id\":\"12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/auth/token"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Sep 2021 14:54:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"954"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"25"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 201,\n \"path\": \"/v1/auth/token\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\"\n },\n \"data\": {\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaHR0cHM6Ly9hcGkucGFydG5lcnMucGFsbGEuYXBwLyJdLCJhenAiOiJiYW5jby1jbGllbnQiLCJleHAiOjE2MzA1OTgwODIsImh0dHBzOi8vcGFsbGEuYXBwL2NvdW50cnkvIjoiTVgiLCJodHRwczovL3BhbGxhLmFwcC9wcm92aWRlci8iOiJiYW5jbyIsImh0dHBzOi8vcGFsbGEuYXBwL3Njb3BlLyI6WyJhY2Nlc3MiLCJwcm90ZWN0ZWQiLCJhY2NvdW50cyJdLCJpYXQiOjE2MzA1OTQ0ODIsImlzcyI6Imh0dHBzOi8vcGFydG5lcnMucGFsbGEuYXBwL2Rldi8iLCJzdWIiOiIxMjM0NSJ9.glpc-njlJaNMWndNOlIQOCBgExV-bspTj_Fc1XY_rBRTfTLonBTlk1o1TqzZEMotfNrkntxU0cv0agDjItdyuB7uQQ6d8Q_4HVNOG0UBJwFFJQQucG5RNds9dMj2BeBHjQiTTORHe7Wxa0mwbxVHYWWeKTJrrBI_HKn5bXHhdLD9AIvq3wS0fR7gNi-2-5pEE8OAfJcO9agUxzYQMmQQjxT0_gNQxIDBhM7wtMnU2-lzBT-oGNakXEc1faiKy7I4AkiZClMWNo73gXf7R9mDhnC8vnf0fbYM5yaccJvYjtduxBIjKsqwYfvw-dk2Et_02xV9igp04PEurIR-_kfH_w\",\n \"scope\": [\n \"access\",\n \"protected\",\n \"accounts\"\n ],\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n }\n}"},{"id":"044d09f2-fb02-47ea-ae79-926c5c0985a6","name":"Credential Exchange User Country","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"banco-client-id\",\n \"client_secret\": \"banco-secret\",\n \"audience\": [\"https://api.platform.palla.app/\"],\n \"grant_type\":\"client_credentials\", \n \"user_id\":\"12345\",\n \"country\": \"US\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/auth/token"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Sep 2021 14:54:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"954"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"25"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 201,\n \"path\": \"/v1/auth/token\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\"\n },\n \"data\": {\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaHR0cHM6Ly9hcGkucGFydG5lcnMucGFsbGEuYXBwLyJdLCJhenAiOiJiYW5jby1jbGllbnQiLCJleHAiOjE2MzA1OTgwODIsImh0dHBzOi8vcGFsbGEuYXBwL2NvdW50cnkvIjoiTVgiLCJodHRwczovL3BhbGxhLmFwcC9wcm92aWRlci8iOiJiYW5jbyIsImh0dHBzOi8vcGFsbGEuYXBwL3Njb3BlLyI6WyJhY2Nlc3MiLCJwcm90ZWN0ZWQiLCJhY2NvdW50cyJdLCJpYXQiOjE2MzA1OTQ0ODIsImlzcyI6Imh0dHBzOi8vcGFydG5lcnMucGFsbGEuYXBwL2Rldi8iLCJzdWIiOiIxMjM0NSJ9.glpc-njlJaNMWndNOlIQOCBgExV-bspTj_Fc1XY_rBRTfTLonBTlk1o1TqzZEMotfNrkntxU0cv0agDjItdyuB7uQQ6d8Q_4HVNOG0UBJwFFJQQucG5RNds9dMj2BeBHjQiTTORHe7Wxa0mwbxVHYWWeKTJrrBI_HKn5bXHhdLD9AIvq3wS0fR7gNi-2-5pEE8OAfJcO9agUxzYQMmQQjxT0_gNQxIDBhM7wtMnU2-lzBT-oGNakXEc1faiKy7I4AkiZClMWNo73gXf7R9mDhnC8vnf0fbYM5yaccJvYjtduxBIjKsqwYfvw-dk2Et_02xV9igp04PEurIR-_kfH_w\",\n \"scope\": [\n \"access\",\n \"protected\",\n \"accounts\"\n ],\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n }\n}"},{"id":"bf57a73d-c1b9-4b3d-bb31-7dc33b8b5168","name":"Bad Credentials","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"bad-id\",\n \"client_secret\": \"bad-secret\",\n \"audience\": [\"https://api.platform.palla.app/\"],\n \"grant_type\":\"client_credentials\",\n \"user_id\":\"12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/auth/token"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Mar 2022 18:18:21 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"177"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"5"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":""},{"id":"c9675764-c4f2-42a1-8475-1f3829156e6d","name":"Unauthorized Audience","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"{{partner-client-id}}\",\n \"client_secret\": \"{{partner-client-secret}}\",\n \"audience\": [\"https://api.wrong.palla.app/\"],\n \"grant_type\":\"client_credentials\",\n \"user_id\":\"12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/auth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Mar 2022 18:19:10 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"138"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"4"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 401,\n \"path\": \"/v1/auth/token\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\"\n },\n \"error\": {\n \"message\": \"audience access\",\n \"rc\": 41\n }\n}"},{"id":"4b3bee1e-5959-41ee-a594-aacff4087c8a","name":"User ID Required","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"{{partner-client-id}}\",\n \"client_secret\": \"{{partner-client-secret}}\",\n \"audience\": [\"https://api.platform.palla.app/\"],\n \"grant_type\":\"client_credentials\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/auth/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Mar 2022 18:21:08 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"129"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"5"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 400,\n \"path\": \"/v1/auth/token\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\"\n },\n \"error\": {\n \"message\": \"user_id\",\n \"rc\": 1\n }\n}"},{"id":"2accee5f-d4cc-4d4d-a987-a64065213a8b","name":"MFA Required","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"{{partner-client-id}}\",\n \"client_secret\": \"{{partner-client-secret}}\",\n \"audience\": [\"https://api.platform.palla.app/\"],\n \"grant_type\":\"client_credentials\",\n \"user_id\":\"12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/auth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Mar 2022 18:46:40 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"136"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"6"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 401,\n \"path\": \"/v1/auth/token\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\"\n },\n \"error\": {\n \"message\": \"mfa required\",\n \"rc\": 123\n }\n}"},{"id":"3a3440df-a96d-4eb5-a8f6-69a4825d1e4e","name":"Incorrect MFA Code","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"{{partner-client-id}}\",\n \"client_secret\": \"{{partner-client-secret}}\",\n \"audience\": [\"https://api.platform.palla.app/\"],\n \"grant_type\":\"client_credentials\", \n \"user_id\":\"12345\",\n \"mfa_type\": \"totp\",\n \"mfa_code\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/auth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Mar 2022 18:47:56 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"131"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"4"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 401,\n \"path\": \"/v1/auth/token\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\"\n },\n \"error\": {\n \"message\": \"mfa code\",\n \"rc\": 42\n }\n}"}],"_postman_id":"4b19f79a-d589-4487-b6e9-f1df88f8ea09"}],"id":"a2da3ad1-748e-42d8-9e4c-4ca399d430aa","description":"

Authentication endpoints return tokens for user access.

\n","event":[{"listen":"prerequest","script":{"id":"caf7d0d8-0cb2-4e83-a3d3-210eadefca9a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e5f67ac5-8caa-4b37-b531-d6e9e059ffe4","type":"text/javascript","exec":[""]}}],"_postman_id":"a2da3ad1-748e-42d8-9e4c-4ca399d430aa"},{"name":"Accounts","item":[{"name":"Create Account","id":"8edbd5e6-1ba0-494e-bfa6-f8f307681836","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"legalName\": {\n \"first\": \"Juan\",\n \"middle\": \"Luis\",\n \"last\": \"Perez\"\n },\n \"dob\": {\n \"day\": 30,\n \"month\": 5,\n \"year\": 1979\n },\n \"displayName\": \"Juan Perez\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/accounts","description":"

Create an Account for the authorized User.

\n

This endpoint is idempotent. If the account exists, the provided values will be used to update the account.

\n
\n
Request
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldRequiredDescription
legalName✓(parent)
legalName.first✓The legal first name of the user.
legalName.middleThe legal middle name of the user.
legalName.last✓The legal last name of the user.
displayNameThe name that will be displayed to other users. If this is left empty, it will be set to {legalName.first} {legalName.last}
dob(parent)
dob.year✓The year of the user's birth.
dob.month✓The month of the user's birth.
dob.day✓The day of the user's birth.
address(parent)
address.street✓The street number and name of the user's address.
address.city✓The city of the user's address.
address.state✓The state / administrative area of the user's address.
address.postalCode✓The postal code of the user's address.
address.country✓The country of the user's address.
configurationA configuration to apply to the user's account. This can be any object of type {\"string\":\"string\"} -Please discuss with Palla for more details.
\n
","urlObject":{"path":["v1","accounts"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"7b6e1df8-f78e-4f50-a069-96e65a8818b1","name":"Create Account","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"legalName\": {\n\t\t\"first\": \"Juan\",\n\t\t\"middle\": \"Luis\",\n\t\t\"last\": \"Perez\"\n\t},\n \"dob\": {\n \"day\": 30,\n \"month\": 5,\n \"year\": 1979\n },\n \"displayName\": \"Juan Perez\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/accounts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Nov 2022 20:52:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"325"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"97"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 201,\n \"path\": \"/v1/accounts\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\"\n },\n \"data\": {\n \"created\": 1667854320,\n \"type\": \"personal\",\n \"status\": \"active\",\n \"userDetails\": {\n \"name\": \"Juan Perez\",\n \"country\": \"MX\"\n },\n \"legalName\": {\n \"first\": \"Juan\",\n \"middle\": \"Luis\",\n \"last\": \"Perez\"\n },\n \"dob\": {\n \"month\": 5,\n \"day\": 30,\n \"year\": 1979\n }\n }\n}"},{"id":"85d5fcb3-a169-4dac-a261-e54f2f46aa29","name":"Create Account Address","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"legalName\": {\n \"first\": \"Juan\",\n \"middle\": \"Luis\",\n \"last\": \"Perez\"\n },\n \"dob\": {\n \"day\": 30,\n \"month\": 5,\n \"year\": 1979\n },\n \"address\": {\n \"street\": \"429 Lenox Ave\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postalCode\": \"33139\",\n \"country\": \"US\"\n },\n \"displayName\": \"Juan Perez\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/accounts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2024 19:50:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"450"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"50"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 201,\n \"path\": \"/v1/accounts\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\",\n \"requestCountry\": \"US\"\n },\n \"data\": {\n \"created\": 1718999354,\n \"type\": \"personal\",\n \"status\": \"active\",\n \"userDetails\": {\n \"name\": \"Juan Perez\",\n \"country\": \"US\"\n },\n \"configuration\": null,\n \"legalName\": {\n \"first\": \"Juan\",\n \"middle\": \"Luis\",\n \"last\": \"Perez\"\n },\n \"dob\": {\n \"month\": 5,\n \"day\": 30,\n \"year\": 1979\n },\n \"address\": {\n \"street\": \"429 Lenox Ave\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postalCode\": \"33139\",\n \"country\": \"US\"\n }\n }\n}"},{"id":"35f32c3e-30ab-4c5d-8136-6922be42ea44","name":"Create Business","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"business\",\n \"business\": {\n \"name\": \"Natural Products Ltd.\",\n \"taxId\": \"111222\"\n },\n \"displayName\": \"Natural Products\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/accounts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Jul 2023 19:04:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"317"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"197"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 201,\n \"path\": \"/v1/accounts\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\",\n \"requestCountry\": \"US\"\n },\n \"data\": {\n \"created\": 1651687181,\n \"type\": \"business\",\n \"status\": \"active\",\n \"userDetails\": {\n \"name\": \"Natural Products\",\n \"country\": \"MX\"\n },\n \"business\": {\n \"name\": \"Natural Products Ltd.\",\n \"taxId\": \"111222\"\n }\n }\n}"},{"id":"db356b08-fd1a-48af-beb2-dc1f94cafe5d","name":"Create Account Encrypted Data","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"encrypted\": {\n \"keyId\": \"abc123\",\n \"dataFormat\": \"base64\",\n \"data\": \"i2lK21y9bDUwOyP3vteyjUAVUo1PH0KpJh7EHeJK6MzG2PjGmI2sXX42Jn5tm1OBsnfIJ4c7ByY5yaCV7gW3bwFHnspYaH2mqTgIzcMi1GDG1ivlKCGXMJdGPH+jssMnj5BARgUX0Xq/CRCWBIjb8bt6giedsvKGC0VdIUxQalhmvB+1zcqUARhojSFTmXfpWMYzfcizTCPXVWmGJHa6F1SAn6h2nNXLtxviIU90TyTubvUcM31GGz3W/Os+0O7Ugs0Jt7/v6oueXp4elvZAhX0Zf5gDWVfWhj79q+OOm0D+JEFjRtUIIf4rXuik0sglKcB9FzCgdlecDl7189oQ+8/QadGz1WWH5XtP+kAebBBaWBG6j3CdY7yUsfdA5Z+bc6h29oFJQsbJaTq/oqurNj2g/gC+q0EmiU1VVjeUc/7WdRpLSmNKkYPiljU+9JPC1SKdGkyXHWbsx1OpO6xyrHuw+aPt6sfXBqmeIZL1xDO7N+Tz67UId2gF7Csc81U7qSwUShyLHLSTil7oTMfSpN3Z6oCll2uNPr/f8MdcZMngu7JAcBzoDG+GKMOoZcCHYhV6sXLccaDAdvWGDmKkgYb3OGwnSuj1xMn4Tpqsl20lNlc5chAAiHa2RdgK+e2lnr4LfDJuTAGUHnaYS/Ep+YJXuHeTExiDwwZHI8WF+fU=\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/accounts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 05 Feb 2024 19:05:14 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"349"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"XX"},{"key":"x-envoy-upstream-service-time","value":"54"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 201,\n \"path\": \"/v1/accounts\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\",\n \"requestCountry\": \"XX\"\n },\n \"data\": {\n \"created\": 1707159535,\n \"type\": \"personal\",\n \"status\": \"active\",\n \"userDetails\": {\n \"name\": \"Juan Perez\",\n \"country\": \"MX\"\n },\n \"configuration\": null,\n \"legalName\": {\n \"first\": \"John\",\n \"middle\": \"Luis\",\n \"last\": \"Perez\"\n },\n \"dob\": {\n \"month\": 5,\n \"day\": 30,\n \"year\": 1979\n }\n }\n}"}],"_postman_id":"8edbd5e6-1ba0-494e-bfa6-f8f307681836"},{"name":"Fetch Account Details","id":"bc5dcc41-9890-49d3-8cc0-2af4294dc3d1","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"url":"{{palla-platform-url}}/v1/accounts","description":"

Get the profile data of an Account. If the Account has an associated Identity, that is also returned.

\n","urlObject":{"path":["v1","accounts"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"dce0cb61-ab30-4161-ae07-f6853d257f12","name":"Fetch Account Details","originalRequest":{"method":"GET","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"},{"key":"x-palla-mock-response","value":"1","type":"text","disabled":true}],"url":"{{palla-platform-url}}/v1/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Nov 2022 20:52:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"381"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"33"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"path\": \"/v1/accounts\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\"\n },\n \"data\": {\n \"created\": 1667854320,\n \"type\": \"personal\",\n \"status\": \"active\",\n \"userDetails\": {\n \"name\": \"Juan Perez\",\n \"country\": \"MX\"\n },\n \"identity\": {\n \"legalName\": {\n \"first\": \"Juan\",\n \"middle\": \"Luis\",\n \"last\": \"Perez\"\n },\n \"dob\": {\n \"month\": 5,\n \"day\": 30,\n \"year\": 1979\n }\n }\n }\n}"}],"_postman_id":"bc5dcc41-9890-49d3-8cc0-2af4294dc3d1"}],"id":"39c6c098-6ab5-49a8-86f6-82c5ec6cf647","description":"

An Account belongs to a User that is authorized to use Palla. All resources, such as Relationships, Transfers, etc. are associated with the Account.

\n","event":[{"listen":"prerequest","script":{"id":"aba6911d-75c8-4638-989e-8c53cfdb1d63","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"552e13d6-41c7-481d-b19b-dbaa04111c75","type":"text/javascript","exec":[""]}}],"_postman_id":"39c6c098-6ab5-49a8-86f6-82c5ec6cf647"},{"name":"Payment Methods","item":[{"name":"Create Payment Method","id":"1cf2c129-664b-4890-aa84-2c6b80e38f37","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-palla-request-id","type":"text","value":"my-request-id"}],"body":{"mode":"raw","raw":"{\n \"type\": \"card\",\n \"primary\": true,\n \"card\": {\n \"keyId\": \"{{public_key_id}}\",\n \"data\": \"rsa-encrypted-card-data\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods","description":"

Create a Payment Method belonging to the Account.

\n

We offer sample code and pre-compiled binaries to easily encrypt card data correctly. See here: https://github.com/palla-financial/card-encrypt

\n
\n
Request
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldRequiredDescription
type✓The type of payment method being created. Currently the only possible value is card
primary✓A flag setting this payment method as the user's primary payment method. The user's primary payment method will be used to receive funds.
card✓(parent)
card.keyId✓The id of the public key used to encrypt the card.
card.data✓A pipe-delineated string containing the Card Account Number, Expiration in YYYYMM format and Security Code, encrypted with the key provided in keyId.
configurationA configuration to apply to the user's account. This can be any object of type {\"string\":\"string\"} - Please discuss with Palla for more details.
\n
","urlObject":{"path":["v1","payment-methods"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"9dafa38a-5d72-4cb7-8c9f-ce88803ab3d2","name":"Create Payment Method","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"card\",\n \"primary\": true,\n \"card\": {\n \"keyId\": \"{{public-key-id}}\",\n \"data\":\"encrypted data\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2024 19:52:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"608"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"2811"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 201,\n \"path\": \"/v1/payment-methods\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\"\n },\n \"data\": {\n \"paymentMethodId\": \"pmt_01J0Y5P8TQ950YKY7HZXRAH81A\",\n \"type\": \"card\",\n \"primary\": true,\n \"country\": \"US\",\n \"pull\": {\n \"enabled\": true,\n \"method\": \"debit\",\n \"currency\": \"USD\",\n \"network\": \"visa\"\n },\n \"push\": {\n \"enabled\": true,\n \"method\": \"debit\",\n \"currency\": \"USD\",\n \"network\": \"visa\"\n },\n \"created\": 1718999525,\n \"address\": {\n \"street\": \"429 Lenox Ave\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postalCode\": \"33139\",\n \"country\": \"US\"\n },\n \"card\": {\n \"brand\": \"visa\",\n \"last4\": \"0004\",\n \"expMonth\": \"09\",\n \"expYear\": \"2029\"\n },\n \"bank_account\": null,\n \"configuration\": null\n }\n}"},{"id":"4f1fa035-d530-4a23-b76b-f8af4b6114a4","name":"Card Exists For User","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"card\",\n \"primary\": true,\n \"card\": {\n \"keyId\": \"{{public-key-id}}\",\n \"data\":\"J3GV7YelxdqL-xKJjN882YJ1AAdQ7w5cO9yW7x2kYLPppDG1gEE9acTBIgPWNemSqkcX8QxEKYEMC6ybHX3uPdIdDOeut3DoGZLOF60BKNe1hzC8oNkwh5gClBDsB21LIvo1jokCEDBwxRGiRJCF6JOahhj9SJ-PuSCkzNIt_DcXWxq4WutD9OhxmkpiC17todRKqKstmRkVKje9rnHYKyy51d0GO-Wzs3ylKD8E3Y1Ce97b0TQSUnmPgEQE74FIOsb5A1ou7v40vrSs-l3M_2TNu1zpNOK5XkancCwi1zRAsyZsMwk6B5K3IATX3XZSsipk20PtD2TOceyMIAi7qg==\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2024 19:55:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"195"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"2303"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 409,\n \"path\": \"/v1/payment-methods\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\"\n },\n \"error\": {\n \"message\": \"card exists\",\n \"rc\": 23,\n \"description\": \"resource/conflict\"\n }\n}"},{"id":"ad8a9dab-d725-42f4-8b90-6ed3ec32150c","name":"Missing Identity Name","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","type":"text","value":"my-request-id"}],"body":{"mode":"raw","raw":"{\n \"type\": \"card\",\n \"primary\": true,\n \"card\": {\n \"keyId\": \"wpA2TTOSsMpGmUHN-x70KQ\",\n \"data\": \"rsa-encrypted-card-data\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Mar 2022 17:16:55 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"154"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"4"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 409,\n \"path\": \"/v1/payment-methods\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\"\n },\n \"error\": {\n \"message\": \"name\",\n \"rc\": 22,\n \"resource\": \"identity\"\n }\n}"},{"id":"e4c82b13-8d74-407d-8f27-cbd186f45652","name":"OFAC Hit","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","type":"text","value":"my-request-id"}],"body":{"mode":"raw","raw":"{\n \"type\": \"card\",\n \"primary\": true,\n \"card\": {\n \"keyId\": \"wpA2TTOSsMpGmUHN-x70KQ\",\n \"data\": \"rsa-encrypted-card-data\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods"},"status":"Unknown","code":451,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Mar 2022 17:22:24 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"132"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"14"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 451,\n \"path\": \"/v1/payment-methods\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\"\n },\n \"error\": {\n \"message\": \"ofac\",\n \"rc\": 43\n }\n}"},{"id":"ab58fc37-6c38-49cf-9c32-7df3d65ed9f7","name":"BIN Restriction","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"card\",\n \"primary\": true,\n \"card\": {\n \"keyId\": \"{{public-key-id}}\",\n \"data\":\"J3GV7YelxdqL-xKJjN882YJ1AAdQ7w5cO9yW7x2kYLPppDG1gEE9acTBIgPWNemSqkcX8QxEKYEMC6ybHX3uPdIdDOeut3DoGZLOF60BKNe1hzC8oNkwh5gClBDsB21LIvo1jokCEDBwxRGiRJCF6JOahhj9SJ-PuSCkzNIt_DcXWxq4WutD9OhxmkpiC17todRKqKstmRkVKje9rnHYKyy51d0GO-Wzs3ylKD8E3Y1Ce97b0TQSUnmPgEQE74FIOsb5A1ou7v40vrSs-l3M_2TNu1zpNOK5XkancCwi1zRAsyZsMwk6B5K3IATX3XZSsipk20PtD2TOceyMIAi7qg==\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jun 2024 13:49:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"190"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"2207"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 412,\n \"path\": \"/v1/payment-methods\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\",\n \"requestCountry\": \"US\"\n },\n \"error\": {\n \"message\": \"card bin\",\n \"rc\": 65,\n \"description\": \"mismatch/issuer\"\n }\n}"}],"_postman_id":"1cf2c129-664b-4890-aa84-2c6b80e38f37"},{"name":"List Payment Methods","id":"4c8ee7a1-10a2-45be-8b9f-1c9677b2dd11","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"url":"{{palla-platform-url}}/v1/payment-methods","description":"

List all of the Payment Methods belonging to the Account.

\n","urlObject":{"path":["v1","payment-methods"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"460d8a4d-e31f-405c-91ae-8b3cc278944e","name":"List Payment Methods","originalRequest":{"method":"GET","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"url":"{{palla-platform-url}}/v1/payment-methods"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2024 19:53:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"593"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"117"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"path\": \"/v1/payment-methods\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\",\n \"itemCount\": 1,\n \"requestCountry\": \"US\"\n },\n \"data\": {\n \"items\": [\n {\n \"paymentMethodId\": \"pmt_01J0Y5P8TQ950YKY7HZXRAH81A\",\n \"type\": \"card\",\n \"primary\": true,\n \"country\": \"US\",\n \"pull\": {\n \"enabled\": true,\n \"method\": \"debit\",\n \"currency\": \"USD\",\n \"network\": \"visa\"\n },\n \"push\": {\n \"enabled\": true,\n \"method\": \"debit\",\n \"currency\": \"USD\",\n \"network\": \"visa\"\n },\n \"created\": 1718999525,\n \"address\": {\n \"street\": \"429 Lenox Ave\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postalCode\": \"33139\",\n \"country\": \"US\"\n },\n \"card\": {\n \"brand\": \"visa\",\n \"last4\": \"0004\",\n \"expMonth\": \"09\",\n \"expYear\": \"2029\"\n }\n }\n ]\n }\n}"}],"_postman_id":"4c8ee7a1-10a2-45be-8b9f-1c9677b2dd11"},{"name":"Update Payment Method","id":"5e701b1e-c955-4997-9230-b7ec6288c53a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"x-palla-request-id","type":"text","value":"my-request-id"}],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": \"pmt_01FW482PM57E4HT2JK2HGDBR4B\",\n \"primary\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods","description":"

Update a Payment Method belonging to the Account.

\n
\n
Request
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldRequiredDescription
paymentMethodId✓The id of the payment method intended for update.
primaryA flag setting this payment method as the user's primary payment method. The user's primary payment method will be used to receive funds.
configurationA configuration to apply to the user's account. This can be any object of type {\"string\":\"string\"} - Please discuss with Palla for more details.
\n
","urlObject":{"path":["v1","payment-methods"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"d4c01f0f-8630-4801-8bac-732a39831de2","name":"Update Payment Method","originalRequest":{"method":"PUT","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": \"pmt_01J0Y5P8TQ950YKY7HZXRAH81A\",\n \"primary\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2024 19:54:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"608"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"128"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"path\": \"/v1/payment-methods\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\",\n \"requestCountry\": \"US\"\n },\n \"data\": {\n \"paymentMethodId\": \"pmt_01J0Y5P8TQ950YKY7HZXRAH81A\",\n \"type\": \"card\",\n \"primary\": true,\n \"country\": \"US\",\n \"pull\": {\n \"enabled\": true,\n \"method\": \"debit\",\n \"currency\": \"USD\",\n \"network\": \"visa\"\n },\n \"push\": {\n \"enabled\": true,\n \"method\": \"debit\",\n \"currency\": \"USD\",\n \"network\": \"visa\"\n },\n \"created\": 1718999525,\n \"address\": {\n \"street\": \"429 Lenox Ave\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postalCode\": \"33139\",\n \"country\": \"US\"\n },\n \"card\": {\n \"brand\": \"visa\",\n \"last4\": \"0004\",\n \"expMonth\": \"09\",\n \"expYear\": \"2029\"\n },\n \"bank_account\": null,\n \"configuration\": null\n }\n}"},{"id":"7072c4bc-94a6-4997-b310-6a8ab62f3728","name":"Missing Payment Method","originalRequest":{"method":"PUT","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": \"pmt_01J0Y5P8TQ950YKY7HZXRAHN00\",\n \"primary\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2024 19:56:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"198"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"6"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 404,\n \"path\": \"/v1/payment-methods\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\",\n \"requestCountry\": \"US\"\n },\n \"error\": {\n \"message\": \"payment_methods\",\n \"rc\": 22,\n \"description\": \"resource/missing\"\n }\n}"}],"_postman_id":"5e701b1e-c955-4997-9230-b7ec6288c53a"},{"name":"Delete Payment Method","id":"76f1133f-a5fd-4843-9025-d3455ed40e98","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": \"pmt_01FEVEE4BJ9NT7QS08ZJ9RAVZC\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods","description":"

Delete a Payment Method by ID belonging to the Account.

\n
\n
Request
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldRequiredDescription
paymentMethodId✓The id of the payment method intended for deletion.
\n
","urlObject":{"path":["v1","payment-methods"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"c2cd43d4-1b9e-4adf-a585-3f71ff36350f","name":"Delete Payment Method","originalRequest":{"method":"DELETE","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": \"pmt_01F7CD7ARNWDHBVC95ZDEVWJEA\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/payment-methods"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 04 Jun 2021 21:01:09 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"157"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"0"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"path\": \"/v1/payment-methods\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\"\n },\n \"data\": {\n \"paymentMethodId\": \"pmt_01F7CD7ARNWDHBVC95ZDEVWJEA\"\n }\n}"}],"_postman_id":"76f1133f-a5fd-4843-9025-d3455ed40e98"}],"id":"b4a06deb-82e1-4b3b-869f-778012131037","description":"

Payment Methods are used to send and/or receive Transfers.

\n","event":[{"listen":"prerequest","script":{"id":"ee9a3a2e-eb74-4349-a137-cc458d6d2001","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7123ab59-f0c4-43e9-a560-4a850cf26cd9","type":"text/javascript","exec":[""]}}],"_postman_id":"b4a06deb-82e1-4b3b-869f-778012131037"},{"name":"Links","item":[{"name":"Generate Relationship Link","id":"d9c12183-a697-41a4-b664-71586e240c22","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"url":"{{palla-platform-url}}/v1/links","description":"

Create a unique Link on behalf of the Account.

\n","urlObject":{"path":["v1","links"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"654757e0-4a93-49d9-aa79-1f43df2ae658","name":"Generate Relationship Link","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"},{"key":"x-palla-mock-response","value":"1","type":"text","disabled":true}],"url":"{{palla-platform-url}}/v1/links"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2024 19:57:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"376"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"683"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 201,\n \"path\": \"/v1/links\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\",\n \"requestCountry\": \"US\"\n },\n \"data\": {\n \"linkId\": \"lnk_Cf23ueZQ\",\n \"slug\": \"Cf23ueZQ\",\n \"status\": \"active\",\n \"created\": 1718999822,\n \"targets\": [\n {\n \"type\": \"checkout\",\n \"url\": \"https://banco.us/checkout/Cf23ueZQ\"\n },\n {\n \"type\": \"invite\",\n \"url\": \"https://banco.us/invite/Cf23ueZQ\"\n }\n ]\n }\n}"},{"id":"b84f05bc-51f9-4090-9533-1bae7a76b16a","name":"Too Many Links","originalRequest":{"method":"POST","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"},{"key":"x-palla-mock-response","value":"1","type":"text","disabled":true}],"url":"{{palla-platform-url}}/v1/links"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Mar 2022 16:15:02 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"132"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"10"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 409,\n \"path\": \"/v1/links\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\"\n },\n \"error\": {\n \"message\": \"too many links\",\n \"rc\": 23\n }\n}"}],"_postman_id":"d9c12183-a697-41a4-b664-71586e240c22"},{"name":"List Links","id":"a30f3a43-f392-404d-a583-d835aa2ec758","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"url":"{{palla-platform-url}}/v1/links","description":"

List the Links that have been created for the Account.

\n","urlObject":{"path":["v1","links"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"26390f06-ca91-4ecf-b844-1cb11b3f811f","name":"List Links","originalRequest":{"method":"GET","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"},{"key":"x-palla-mock-response","value":"1","type":"text","disabled":true}],"url":"{{palla-platform-url}}/v1/links"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2024 19:58:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"402"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"120"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"path\": \"/v1/links\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\",\n \"itemCount\": 1,\n \"requestCountry\": \"US\"\n },\n \"data\": {\n \"items\": [\n {\n \"linkId\": \"lnk_Cf23ueZQ\",\n \"slug\": \"Cf23ueZQ\",\n \"status\": \"active\",\n \"created\": 1718999822,\n \"targets\": [\n {\n \"type\": \"checkout\",\n \"url\": \"https://banco.us/checkout/Cf23ueZQ\"\n },\n {\n \"type\": \"invite\",\n \"url\": \"https://banco.us/invite/Cf23ueZQ\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"a30f3a43-f392-404d-a583-d835aa2ec758"},{"name":"Delete Links","id":"11a3ed69-cf56-44bf-8de1-96974474cb42","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"linkId\": \"lnk_CQ2N3GzF\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/links","description":"

Delete a Link by it's ID.

\n
\n
Request
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldRequiredDescription
linkId✓The id of the link intended for deletion.
\n
","urlObject":{"path":["v1","links"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"c5fb0d2a-09af-4032-9b67-eb48df4f7431","name":"Delete Links","originalRequest":{"method":"DELETE","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"},{"key":"x-palla-mock-response","value":"1","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"linkId\": \"lnk_Pj2Q7W2k\"\n}","options":{"raw":{"language":"json"}}},"url":"{{palla-platform-url}}/v1/links"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Thu, 18 Mar 2021 15:37:18 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"120"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"83"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"path\": \"/v1/links\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\"\n },\n \"data\": {\n \"linkId\": \"lnk_Pj2Q7W2k\"\n }\n}"}],"_postman_id":"11a3ed69-cf56-44bf-8de1-96974474cb42"}],"id":"315e262c-ec30-48ec-9d5c-d47685c51348","description":"

A Link is a unique URL belonging to an Account. When provided to another User, the link id can be used to create a Relationship.

\n","event":[{"listen":"prerequest","script":{"id":"6b69b68e-1595-479f-ad0c-4dceb3c2da79","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"294c016f-0304-4494-b0bc-734dbb5b63b3","type":"text/javascript","exec":[""]}}],"_postman_id":"315e262c-ec30-48ec-9d5c-d47685c51348"},{"name":"Relationships","item":[{"name":"Get Link Relationship","id":"6058bf27-cc6e-4e3b-be31-8102acf7a826","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-palla-request-id","type":"text","value":"my-request-id"}],"url":"{{palla-platform-url}}/v1/relationships?link-id=lnk_Cx3xqci5","description":"

Get the Relationship from another Account's Link. If the two Accounts do not have an existing Relationship, a new Relationship is created.

\n","urlObject":{"path":["v1","relationships"],"host":["{{palla-platform-url}}"],"query":[{"key":"link-id","value":"lnk_Cx3xqci5"}],"variable":[]}},"response":[{"id":"0d9c9400-59fd-4c04-be7c-012c15e20728","name":"Get Link Relationship","originalRequest":{"method":"GET","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"},{"key":"x-palla-mock-response","value":"1","type":"text","disabled":true}],"url":{"raw":"{{palla-platform-url}}/v1/relationships?link-id=lnk_Cx3xqci5","host":["{{palla-platform-url}}"],"path":["v1","relationships"],"query":[{"key":"link-id","value":"lnk_Cx3xqci5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Thu, 19 Aug 2021 03:25:37 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"2071"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"18"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"path\": \"/v1/relationships\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\"\n },\n \"data\": {\n \"relationshipId\": \"rls_01FDATERVMBMPE2G9693ABKZMF\",\n \"status\": \"discovered\",\n \"created\": 1629229638,\n \"user\": {\n \"name\": \"John Smith\",\n \"country\": \"US\"\n }\n }\n}"},{"id":"c3e8b737-f356-4fa7-9be9-3cbb60fd86c9","name":"Same Account","originalRequest":{"method":"GET","header":[{"key":"x-palla-request-id","type":"text","value":"my-request-id"},{"key":"x-palla-mock-response","value":"1","type":"text","disabled":true}],"url":{"raw":"{{palla-platform-url}}/v1/relationships?link-id=lnk_Cs1yb7FD","host":["{{palla-platform-url}}"],"path":["v1","relationships"],"query":[{"key":"link-id","value":"lnk_Cs1yb7FD"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Mar 2022 18:15:55 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"164"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-envoy-upstream-service-time","value":"5"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 422,\n \"path\": \"/v1/relationships\",\n \"requestId\": \"my-request-id\",\n \"result\": \"failure\"\n },\n \"error\": {\n \"message\": \"same account\",\n \"rc\": 1,\n \"resource\": \"relationships\"\n }\n}"}],"_postman_id":"6058bf27-cc6e-4e3b-be31-8102acf7a826"},{"name":"List Relationships","id":"d6531dff-9f3c-48c6-92f6-439d555780d3","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{palla-platform-url}}/v1/relationships","description":"

List all the Relationships belonging to the Account.

\n","urlObject":{"path":["v1","relationships"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[{"id":"8fa284f2-e906-43f1-8278-1bcb8595995a","name":"List Relationships","originalRequest":{"method":"GET","header":[{"key":"x-palla-mock-response","value":"1","type":"text","disabled":true}],"url":"{{palla-platform-url}}/v1/relationships"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Aug 2023 14:30:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2054"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"01H70FAGKGTFM6JT5TWZ5EDYDT"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"44"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"path\": \"/v1/relationships\",\n \"requestId\": \"01H70FAGKGTFM6JT5TWZ5EDYDT\",\n \"result\": \"success\",\n \"itemCount\": 1,\n \"itemLimit\": 10,\n \"itemOffset\": 0,\n \"itemTotal\": 0\n },\n \"data\": {\n \"items\": [\n {\n \"relationshipId\": \"rls_01H2R5VWCY16EHDNHDV4FA3YZJ\",\n \"status\": \"discovered\",\n \"created\": 1686586126,\n \"user\": {\n \"name\": \"John Smith\",\n \"country\": \"US\"\n }\n }\n ]\n }\n}"}],"_postman_id":"d6531dff-9f3c-48c6-92f6-439d555780d3"}],"id":"d8f1758e-b155-44a2-940f-6569a2580423","description":"

A Relationship is the connection between two Accounts. Relationships are created by sharing a Link. Accounts must have a Relationship in order to create Requests or Transfers.

\n","event":[{"listen":"prerequest","script":{"id":"0e773c82-5998-4e44-b484-652698b455c7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cb3b4743-ed6d-490e-abe1-28f8ae865cee","type":"text/javascript","exec":[""]}}],"_postman_id":"d8f1758e-b155-44a2-940f-6569a2580423"},{"name":"Transfers","item":[{"name":"List Transfers","id":"7bb54893-9a4f-4066-9222-8ae212ea12c5","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{palla-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"}],"url":"{{palla-platform-url}}/v1/transfers?limit=10","description":"

Retrieve a list of all Transfers sent or received by the Account.

\n","urlObject":{"path":["v1","transfers"],"host":["{{palla-platform-url}}"],"query":[{"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"cc73371e-06d7-4ecb-840f-54cfc0fad80d","name":"List Transfers","originalRequest":{"method":"GET","header":[{"key":"x-palla-request-id","value":"my-request-id","type":"text"},{"key":"x-palla-mock-response","value":"1","type":"text","disabled":true}],"url":{"raw":"{{palla-platform-url}}/v1/transfers?limit=10","host":["{{palla-platform-url}}"],"path":["v1","transfers"],"query":[{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Aug 2023 14:33:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4748"},{"key":"Connection","value":"keep-alive"},{"key":"x-palla-request-id","value":"my-request-id"},{"key":"x-amzn-waf-request-country","value":"US"},{"key":"x-envoy-upstream-service-time","value":"15"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"code\": 200,\n \"path\": \"/v1/transfers\",\n \"requestId\": \"my-request-id\",\n \"result\": \"success\",\n \"itemCount\": 1,\n \"itemLimit\": 10,\n \"itemOffset\": 0,\n \"itemTotal\": 0,\n \"requestCountry\": \"US\"\n },\n \"data\": {\n \"items\": [\n {\n \"transferId\": \"txr_01GR2DZ7PRTZDAN5X3GFR2936F\",\n \"role\": \"receiver\",\n \"total\": 28842,\n \"amount\": 28842,\n \"currency\": \"HNL\",\n \"status\": \"completed\",\n \"created\": 1675119009,\n \"rate\": {\n \"pair\": \"USDHNL\",\n \"rate\": 24.03516,\n \"time\": 1675036800,\n \"fee\": 199\n },\n \"displayRate\": {\n \"pair\": \"USDHNL\",\n \"rate\": 24.03516,\n \"time\": 1675036800,\n \"fee\": 199\n },\n \"relationship\": {\n \"relationshipId\": \"rls_01GR2DZ7JDX8BTQCCZF8NPBK43\",\n \"name\": {\n \"first\": \"Greg\",\n \"last\": \"Piccolo\"\n },\n \"country\": \"US\"\n },\n \"paymentMethod\": {\n \"paymentMethodId\": \"pmt_01GDNTB3GSB319X2288BNJ4DE8\",\n \"type\": \"card\",\n \"primary\": true,\n \"country\": \"HN\",\n \"created\": 1663958356,\n \"card\": {\n \"brand\": \"visa\",\n \"last4\": \"9998\",\n \"expMonth\": \"01\",\n \"expYear\": \"2027\"\n }\n },\n \"events\": [\n {\n \"eventId\": \"01GR2DZ7PRTZDAN5X3GFR2936F\",\n \"resource\": \"transfers\",\n \"action\": \"create\",\n \"role\": \"receiver\",\n \"status\": \"success\",\n \"itemId\": \"txr_01GR2DZ7PRTZDAN5X3GFR2936F\",\n \"score\": 1,\n \"timestamp\": 1675119009,\n \"value\": {\n \"total\": 28842,\n \"amount\": 28842,\n \"currency\": \"HNL\"\n }\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"7bb54893-9a4f-4066-9222-8ae212ea12c5"}],"id":"ad512e14-f19f-4d9d-92aa-c8779b403199","description":"

A Transfer is a record of funds sent to a Relationship.

\n","event":[{"listen":"prerequest","script":{"id":"8d9c6bb0-ab21-4348-9fe5-36d5fefb2ac3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7eb23811-47d7-4589-a883-21ce3db4e430","type":"text/javascript","exec":[""]}}],"_postman_id":"ad512e14-f19f-4d9d-92aa-c8779b403199"},{"name":"Callback API","item":[{"name":"Transfers Create Callback","id":"7bb648bf-8e7e-4c13-a5de-d6993cc6a846","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"abc123\",\n \"country\": \"MX\",\n \"provider\": \"banco.mx\",\n \"resource\": \"transfers\",\n \"role\": \"receiver\",\n \"action\": \"create\",\n \"time\": 1670609000,\n \"data\": {\n \"transferId\": \"txr_01GKW0WSB84W886VA3QQHVZM3K\",\n \"role\": \"receiver\",\n \"total\": 2900,\n \"amount\": 2900,\n \"currency\": \"USD\",\n \"status\": \"completed\",\n \"created\": 1670609003,\n \"rate\": {\n \"pair\": \"USDUSD\",\n \"rate\": 1,\n \"time\": 1670544000,\n \"fee\": 299\n },\n \"displayRate\": {\n \"pair\": \"USDMXN\",\n \"rate\": 19.5,\n \"time\": 1670544000,\n \"fee\": 299\n },\n \"displayValue\": {\n \"total\": 56550,\n \"amount\": 56550,\n \"currency\": \"MXN\"\n },\n \"relationship\": {\n \"relationshipId\": \"rls_01GKHVQAQZG8Y51ASVECZQP6EG\",\n \"name\": {\n \"first\": \"Greg\",\n \"last\": \"Piccolo\"\n },\n \"country\": \"US\"\n },\n \"paymentMethod\": {\n \"paymentMethodId\": \"pmt_01GCYPDFM6C7QXZZF574HQAPV9\",\n \"type\": \"card\",\n \"primary\": true,\n \"country\": \"US\",\n \"created\": 1663182487,\n \"card\": {\n \"brand\": \"visa\",\n \"last4\": \"5556\",\n \"expMonth\": \"01\",\n \"expYear\": \"2029\"\n }\n }\n },\n \"signature\": \"Xu7eP3UiEpHjR3z7xVif0qhvAbuYd672EljosuyyrN0cyuBbV_Th0XhHg7j3Z7J5-D3nN9pCw4qlsFrgeVG8COQWC2pgSUBmUO1DGuGXvjr444KpuQanGOM7oO3mTRxvNK4kfwPoVds-UYc3s8Mx9qQJTPf8FjZoaKdTktyBTLhutqrGsIzICDuQNVzPfnHgf2P9o0OxNIWvFCSLNmvVXbzNwYXUgzyS0PQM_8YHgSzLCTu1iO02eq66ct68kREZTyz-adYb74CjVfk3LcxEDdLXekkHomZynPndwFb2RTy86Zg2bg3wGI3M2LOqLaCaYfstHVPO1pHdDjEbYsXaeQ==\"\n}","options":{"raw":{"language":"json"}}},"url":"PARTNER_CALLBACK_URL","urlObject":{"host":["PARTNER_CALLBACK_URL"],"query":[],"variable":[]}},"response":[{"id":"10281051-a770-4266-8961-562733ea6a92","name":"Transfer Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"abc123\",\n \"country\": \"MX\",\n \"provider\": \"banco.mx\",\n \"resource\": \"transfers\",\n \"role\": \"receiver\",\n \"action\": \"create\",\n \"time\": 1670609000,\n \"data\": {\n \"transferId\": \"txr_01GKW0WSB84W886VA3QQHVZM3K\",\n \"role\": \"receiver\",\n \"total\": 2900,\n \"amount\": 2900,\n \"currency\": \"USD\",\n \"status\": \"completed\",\n \"created\": 1670609003,\n \"rate\": {\n \"pair\": \"USDUSD\",\n \"rate\": 1,\n \"time\": 1670544000,\n \"fee\": 299\n },\n \"displayRate\": {\n \"pair\": \"USDMXN\",\n \"rate\": 19.5,\n \"time\": 1670544000,\n \"fee\": 299\n },\n \"displayValue\": {\n \"total\": 56550,\n \"amount\": 56550,\n \"currency\": \"MXN\"\n },\n \"relationship\": {\n \"relationshipId\": \"rls_01GKHVQAQZG8Y51ASVECZQP6EG\",\n \"name\": {\n \"first\": \"Greg\",\n \"last\": \"Piccolo\"\n },\n \"country\": \"US\"\n },\n \"paymentMethod\": {\n \"paymentMethodId\": \"pmt_01GCYPDFM6C7QXZZF574HQAPV9\",\n \"type\": \"card\",\n \"primary\": true,\n \"country\": \"US\",\n \"created\": 1663182487,\n \"card\": {\n \"brand\": \"visa\",\n \"last4\": \"5556\",\n \"expMonth\": \"01\",\n \"expYear\": \"2029\"\n }\n }\n },\n \"signature\": \"Xu7eP3UiEpHjR3z7xVif0qhvAbuYd672EljosuyyrN0cyuBbV_Th0XhHg7j3Z7J5-D3nN9pCw4qlsFrgeVG8COQWC2pgSUBmUO1DGuGXvjr444KpuQanGOM7oO3mTRxvNK4kfwPoVds-UYc3s8Mx9qQJTPf8FjZoaKdTktyBTLhutqrGsIzICDuQNVzPfnHgf2P9o0OxNIWvFCSLNmvVXbzNwYXUgzyS0PQM_8YHgSzLCTu1iO02eq66ct68kREZTyz-adYb74CjVfk3LcxEDdLXekkHomZynPndwFb2RTy86Zg2bg3wGI3M2LOqLaCaYfstHVPO1pHdDjEbYsXaeQ==\"\n}","options":{"raw":{"language":"json"}}},"url":"PARTNER_CALLBACK_URL"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"7bb648bf-8e7e-4c13-a5de-d6993cc6a846"}],"id":"bb566979-9659-45a3-87f0-85b3e9c62be2","description":"

For certain events, a callback to a partner's server can be configured. Please ask Palla to enable the callback for you and provide a URL. The only event available today is Transfers Create though more will be available soon.

\n

Calls to your service must immediately return an empty 200 response. Any returned status code that is >=400 will be treated as an error and retried.

\n

Retries are potentially dangerous so it is critical to return a success response immediately.

\n

To ensure that the callback URL can only be used to receive messages sent by the Palla Platform, partners must enable any or all of 3 options:

\n
    \n
  1. Restrict endpoint access to the Palla Platform's static IP
    2. \n
  2. Provide an Authorization token to be sent as part of the request
    3. \n
  3. Verify the signature field with a public key provided by Palla
    4. \n
\n

The value to hash in order to check the signature is a pipe delimited string in the following format:

\n

country|provider|user_id|resource|action|role|time

\n

The values are case sensitive and should match exactly what was received in the payload envelope.

\n","_postman_id":"bb566979-9659-45a3-87f0-85b3e9c62be2"},{"name":"Health Check","item":[{"name":"Health Check","id":"a7333563-b991-4f56-a63f-5a6074d267b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{palla-platform-url}}/healthz","description":"

The healthcheck endpoint for the API proxy.

\n","urlObject":{"path":["healthz"],"host":["{{palla-platform-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7333563-b991-4f56-a63f-5a6074d267b9"}],"id":"02eefe42-5d60-4eca-af24-41a4fa53035c","_postman_id":"02eefe42-5d60-4eca-af24-41a4fa53035c","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0c532429-81dd-4780-80dc-bc35b32855c5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a6ce7196-33e2-45f1-bdd0-125ada9e982a"}}]}