api_v2.json

{
	"info": {
		"name": "API v2 WIP",
		"_postman_id": "d92d637f-bd3a-1b2b-f577-338db8fbb981",
		"description": "Postman pack for basic testing of API v2 ",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Accounts",
			"item": [
				{
					"name": "Retrieve an Account",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/accounts/bb653011-a7a7-0131-ec3a-0022194273f7",
							"host": [
								"{{url}}"
							],
							"path": [
								"accounts",
								"bb653011-a7a7-0131-ec3a-0022194273f7"
							]
						},
						"description": "**GET /v2/accounts/{id}** - Returns a json structure containing the details of the requested account.\n\n**Required Fields**\n\t\nid: ID of the account\n\n**Optional Fields**\n\non\\_behalf\\_of: ID of contact\n\n**Response**\n\t\nid: ID of the account\n\naccount\\_name: Name of the account\n\nbrand: The brand that is associated with this account\n\nyour\\_reference: Your unique customer ID\n\nstatus: Status of the account\n\nstreet: First line of the address\n\ncity: City\n\nstate\\_or\\_province: Name of State or Province\n\ncountry: Country\n\npostal\\_code: Post Code or Zip code\n\nspread\\_table: Name of spread table\n\ncreated\\_at: ISO 8601 Date when the Account was created\n\nupdated\\_at: ISO 8601 Date when the Account was last updated\n\nidentification\\_type: name of ID type\n\nidentification\\_value: ID value\n\nshort\\_reference: shortened reference\n\n"
					},
					"response": []
				},
				{
					"name": "Update an account",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/accounts/bb653011-a7a7-0131-ec3a-0022194273f7",
							"host": [
								"{{url}}"
							],
							"path": [
								"accounts",
								"bb653011-a7a7-0131-ec3a-0022194273f7"
							]
						},
						"description": "**POST /v2/accounts/{id}** - Updates an existing account and returns a json structure containing the details of the requested account.\n\n**Required Fields**\t\n\nid: ID of the account\n\n**Optional Fields**\n\naccount\\_name: Name of the account\n\nlegal\\_entity\\_type: Account type\n\nbrand: The brand to associate with this account\n\nyour\\_reference: Your unique customer ID\n\nstatus: Status of the account\n\nstreet: Street address\n\ncity: City\n\nstate\\_or\\_province: Name of state or province\n\npostal\\_code: Post Code or Zip Code\n\ncountry: A two-letter country codes as defined in ISO 3166-1\n\nspread\\_table: Name of spread table\n\nidentification\\_type: name of ID type\n\nidentification\\_value: ID value\n\n**Response**\n\t\nid: ID of the account\n\naccount\\_name: Name of the account\n\nbrand: The brand that is associated with this account\n\nyour\\_reference: Your unique customer ID\n\nlegal\\_entity\\_type\t\n\nstatus: Status of the account\n\nstreet: First line of the address\n\ncity: City\n\nstate\\_or\\_province: Name of state or province \n\ncountry: Country\n\npostal\\_code: Post Code or Zip code\n\nspread\\_table: Name of spread table\n\ncreated\\_at: ISO 8601 Date when the Account was created\n\nupdated\\_at: ISO 8601 Date when the Account was last updated\n\nidentification\\_type: name of ID type\n\nidentification\\_value: ID value\n\nshort\\_reference: Shortened reference"
					},
					"response": []
				},
				{
					"name": "Account (logged-in Contact)",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/accounts/current",
							"host": [
								"{{url}}"
							],
							"path": [
								"accounts",
								"current"
							]
						},
						"description": "**GET /v2/accounts/current** - Returns a json structure containing the details of the active account.\n\n**Response**\n\t\nid: ID of the account\n\naccount\\_name: Name of the account\n\nbrand: The brand that is associated with this account\n\nyour\\_reference: Your unique customer ID\n\nlegal\\_entity\\_type\t\n\nstatus: Status of the account\n\nstreet: First line of the address\n\ncity: City\n\nstate\\_or\\_province: Name of state or province\n\ncountry: Country\n\npostal\\_code: Post Code or Zip code\n\nspread\\_table: Name of spread table\n\ncreated\\_at: ISO 8601 Date when the Account was created\n\nupdated\\_at: ISO 8601 Date when the Account was last updated\n\nidentification\\_type: name of ID type\n\nidentification\\_value: ID value\n\nshort\\_reference: shortened reference\n\n"
					},
					"response": []
				},
				{
					"name": "Create Account",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/accounts/create?account_name=Fitz Account&legal_entity_type=company",
							"host": [
								"{{url}}"
							],
							"path": [
								"accounts",
								"create"
							],
							"query": [
								{
									"key": "account_name",
									"value": "Fitz Account"
								},
								{
									"key": "legal_entity_type",
									"value": "company"
								}
							]
						},
						"description": "**POST /v2/accounts/create** - Creates a new account and returns a json structure containing the details of the requested account.\n\n**Required Fields**\n\naccount\\_name: Name of the account\n\n**Optional Fields**\n\nbrand: The brand to associate with this account\n\nyour\\_reference: Your unique customer ID\n\nstatus: Status of the account. If nothing is supplied, the default setting is enabled\n\nstreet: Street address\n\nstate\\_or\\_province: name of state or province\n\ncity: City\n\npostal\\_code: Post Code or Zip Code\n\ncountry: A two-letter country codes as defined in ISO 3166-1\n\nspread\\_table: Name of spread table\n\nidentification\\_type: name of ID type\n\nidentification\\_value: ID value\n\n**Response**\n\t\nid: ID of the account\n\naccount\\_name: Name of the account\n\nbrand: The brand that is associated with this account\n\nyour\\_reference: Your unique customer ID\n\nlegal\\_entity\\_type\t\n\nstatus: Status of the account\n\nstreet: First line of the address\n\ncity: City\n\nstate\\_or\\_province: name of state or province\n\ncountry: Country\n\npostal\\_code: Post Code or Zip code\n\nspread\\_table: Name of spread table\n\ncreated\\_at: ISO 8601 Date when the Account was created\n\nupdated\\_at: ISO 8601 Date when the Account was last updated\n\nidentification\\_type: name of ID type\n\nidentification\\_value: ID value\n\nshort\\_reference: shortened reference\n\n"
					},
					"response": []
				},
				{
					"name": "Find Account",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/accounts/find",
							"host": [
								"{{url}}"
							],
							"path": [
								"accounts",
								"find"
							]
						},
						"description": "**GET /v2/accounts/find** - Return an array containing json structures of details of the accounts matching the search criteria for the logged in user.\n\n\n**Optional Fields**\n\naccount\\_name: Name of the account\n\nbrand: The brand to associate with this account\n\nyour\\_reference: Your unique customer ID\n\nstatus: Status of the account\n\nstreet: Street address\n\ncity: City\n\nstate\\_or\\_province: Name of state or province\n\npostal\\_code: Post Code or Zip Code\n\ncountry: A two-letter country codes as defined in ISO 3166-1\n\nspread\\_table: Name of spread table\n\npage: Which page to show\n\nper\\_page: Maximum number of entries to return\n\norder: The field to order entries by\n\norder\\_asc\\_desc: Whether the order is ascending or descending\n\n\n**Response**\n\naccounts: An array of Account objects\n\n  - id: ID of the account\n\n  - account\\_name: Name of account\n\n  - brand: The brand that is associated with this account\n\n  - your\\_reference: Your unique customer ID\n\n  - status: Status of the account\n\n  - street: First line of the address\n\n  - city: City\n\n  - state\\_or\\_province: Name of state or province\n\n  - country: Country\n\n  - postal\\_code: Post Code or Zip code\n\n  - spread\\_table: Name of spread table\n\n  - created\\_at: ISO 8601 Date when the Account was created\n\n  - updated\\_at: ISO 8601 Date when the Account was last updated\n\n  - identification\\_type: Name of ID type\n\n  - identification\\_value: ID value\n\n  - short\\_reference: shortened reference\n\npagination: Pagination details relevant to the search query\n\n  - total\\_entries: Total entries for this search query\n\n  - total\\_pages: Total pages for this search query\n\n  - current\\_page: Current page of the search query\n\n  - per\\_page: Amount of search results to return per page\n\n  - previous\\_page: Previous page for this search query\n\n  - next\\_page: Next page for this search query\n\n  - order: Order of the search returned for this search query\n\n  - order\\_asc\\_desc: Order of results returned e.g. 'asc' or 'desc'\n\n\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "Authentication",
			"item": [
				{
					"name": "API User Login",
					"request": {
						"method": "POST",
						"header": [],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "api_key",
									"value": "{{api_key}}",
									"type": "text"
								},
								{
									"key": "login_id",
									"value": "{{login_id}}",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/authenticate/api",
							"host": [
								"{{url}}"
							],
							"path": [
								"authenticate",
								"api"
							]
						},
						"description": "**POST /v2/authenticate/api** - Generates an auth token for the api user which needs to be used in all subsequent calls.\n\n**Required fields:**\n\nlogin\\_id - The login id of the user\n\napi\\_key - A unique value that is the user's api key\n\n**Response:**\n\nauth\\_token - The auth token to use on subsequent requests\n\n[View Documentation](https://beta.currencycloud.com/documentation/api-docs/post-authenticate-api)"
					},
					"response": []
				},
				{
					"name": "Contact Login",
					"request": {
						"method": "POST",
						"header": [],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "nonce",
									"value": "{{nonce}}",
									"type": "text"
								},
								{
									"key": "security_answer",
									"value": "{{security_answer}}",
									"type": "text"
								},
								{
									"key": "password",
									"value": "{{password}}",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/authenticate/login",
							"host": [
								"{{url}}"
							],
							"path": [
								"authenticate",
								"login"
							]
						},
						"description": "**POST /v2/authenticate/login** - Generates an auth token for the contact which needs to be used in all subsequent calls.\n\n**Required fields:**\n\nnonce - The nonce for the authentication request\n\nsecurity\\_answer - The answer for the question retrieved from /authentication/user\n\npassword - The password for the user\n\n**Response:**\n\nauth\\_token - The auth token to use on subsequent requests"
					},
					"response": []
				},
				{
					"name": "Login Security Question",
					"request": {
						"method": "GET",
						"header": [],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "nonce",
									"value": "{{nonce}}",
									"type": "text"
								},
								{
									"key": "security_answer",
									"value": "{{security_answer}}",
									"type": "text"
								},
								{
									"key": "password",
									"value": "{{password}}",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/authenticate/user?login_id={{login_id}}",
							"host": [
								"{{url}}"
							],
							"path": [
								"authenticate",
								"user"
							],
							"query": [
								{
									"key": "login_id",
									"value": "{{login_id}}"
								}
							]
						},
						"description": "**GET /v2/authenticate/user** - Retrieves a security question to be displayed to the user. The user must answer the question successfully to be able to log in.\n\n**Required fields:**\n\nlogin\\_id - The login id of the user\n\n\n**Response:**\n\nnonce - A short-lived token that is used for a subsequent login request.\n\nsecurity\\_code - An enumeration that identifies the security question\n\nsecurity\\_question - A security question in English that needs to be answered for a successful login"
					},
					"response": []
				},
				{
					"name": "End API Session",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "api_key",
									"value": "{{api_key}}",
									"type": "text"
								},
								{
									"key": "login_id",
									"value": "{{login_id}}",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/authenticate/close_session",
							"host": [
								"{{url}}"
							],
							"path": [
								"authenticate",
								"close_session"
							]
						},
						"description": "**POST /v2/authenticate/close\\_session** - All sessions must come to an end, either manually using the 'close session' call, or by timing out. If you know that the session is no longer required, for example because the end-user wants to logout, it is good practise to explicitly close the session rather than leaving it to time-out."
					},
					"response": []
				}
			]
		},
		{
			"name": "Balances",
			"item": [
				{
					"name": "Retrieve A Balance",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "api_key",
									"value": "{{api_key}}",
									"type": "text"
								},
								{
									"key": "login_id",
									"value": "{{login_id}}",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/balances/GBP",
							"host": [
								"{{url}}"
							],
							"path": [
								"balances",
								"GBP"
							]
						},
						"description": "**GET /v2/balances/{currency}** - Provides the balance for a currency and shows the date that the balance was last updated.\n\n**Required Fields**\n\ncurrency - 3 digit ISO 4217 currency code\n\n**Response**\n\nid - Unique ID\n\naccount\\_id - Unique ID of related account\n\ncurrency - 3 character ISO 4217 currency code\n\namount - Amount of balance to 2dp\n\ncreated\\_at - ISO8601 date when the balance was created\n\nupdated\\_at - ISO8601 date when the balance was last updated\n"
					},
					"response": []
				},
				{
					"name": "Find Balances",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "api_key",
									"value": "{{api_key}}",
									"type": "text"
								},
								{
									"key": "login_id",
									"value": "{{login_id}}",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/balances/find?amount_from=100.00&amount_to=5000.00",
							"host": [
								"{{url}}"
							],
							"path": [
								"balances",
								"find"
							],
							"query": [
								{
									"key": "amount_from",
									"value": "100.00"
								},
								{
									"key": "amount_to",
									"value": "5000.00"
								}
							]
						},
						"description": "**GET /v2/balances/find** - Search for a range of balances and receive a paged response. This is useful if you want to see historic balances.\n\n**Optional Fields**\n\namount\\_from - Amount of balances to 2dp\n\namount\\_to - Amount of balances to 2dp\n\nas\\_at\\_date - ISO8601 Date Time to view balances at a specific point in time.\n\npage - Which page to show\n\nper\\_page - Maximum number of entries to return\n\norder - The field to order entries by\n\norder\\_asc\\_desc - Whether the order is ascending or descending.\n\n**Response**\n\nbalances - An array of balance objects:\n\n- id - Unique ID\n- account\\_id - Unique ID of related account\n- currency - 3 character ISO4217 currency code\n- amount - Amount of balance to 2dp\n- created\\_at - ISO8601 Date when the balance was created\n- updated\\_at - ISO8601 Date when the balance was last updated\n\npagination - Pagination details relevant to the search query:\n\n- total\\_entries - Total entries for this search query\n- total\\_pages - Total pages for this search query\n- current\\_page - Current page of the search query\n- per\\_page - Amount of search results to return per page\n- previous\\_page - Previous page for this search query\n- next\\_page - Next page for this search query\n- order - Order of the search returned for this search query\n- order\\_asc\\_desc - Order of results returned\n\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "Beneficiaries",
			"item": [
				{
					"name": "Retrieve a Beneficiary",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/beneficiaries/242910e3-92a9-4d6c-af27-dbef1bb1412b",
							"host": [
								"{{url}}"
							],
							"path": [
								"beneficiaries",
								"242910e3-92a9-4d6c-af27-dbef1bb1412b"
							]
						},
						"description": "**GET /v2/beneficiaries/{id}** - Returns a json structure containing the details of the requested beneficiary.\n\n**Required Fields**\n\nid: ID of the beneficiary\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n**Response**\n\nid: ID of the Beneficiary\n\nbank\\_account\\_holder\\_name: Bank account holder's name\n\nemail: Email address of the Beneficiary\n\nbeneficiary\\_address: Address of the beneficiary\n\nbeneficiary\\_country: Country\n\ncurrency: 3 character ISO 4217 currency code\n\nbank\\_address: Bank address\n\nbank\\_country: Bank country\n\nrouting\\_code\\_type_1: The routing type code that identifies the bank account for the 'regular' payment type\n\nrouting\\_code\\_value\\_1: Routing code value 1\n\nrouting\\_code\\_type\\_2: The routing type code that identifies the bank account for the 'regular' payment type\n\nrouting\\_code\\_value\\_2: Routing code value 2\n\nbank\\_name: Bank name\n\nbank\\_account\\_type: Bank account type\n\npayment\\_types: priority, regular\n\ncreator\\_contact\\_id: Contact ID\n\nbic\\_swift: BIC/SWIFT code\n\niban: International bank account number\n\ndefault\\_beneficiary: Boolean. Default beneficiary\n\naccount\\_number: Account number\n\nname: Nickname\n\nbeneficiary\\_entity\\_type: Beneficiary type\n\nbeneficiary\\_company\\_name: Beneficiary company name\n\nbeneficiary\\_first\\_name: Beneficiary first name\n\nbeneficiary\\_last\\_name: Beneficiary last name\n\nbeneficiary\\_date\\_of\\_birth: DOB of beneficiary\n\nbeneficiary\\_identification\\_type: type of ID\n\nbeneficiary\\_identification\\_value: value for id type\n\nbeneficiary\\_city: Beneficiary city\n\nbeneficiary\\_state\\_or\\_province: Beneficiary state or province\n\nbeneficiary\\_postcode: Beneficiary postcode\n\ncreated\\_at: ISO 8601 Date of when record was created\n\nupdated\\_at: ISO 8601 Date of when record was last updated\n\n"
					},
					"response": []
				},
				{
					"name": "Update A Beneficiary",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/beneficiaries/242910e3-92a9-4d6c-af27-dbef1bb1412b?email=mister_fitz@example.com",
							"host": [
								"{{url}}"
							],
							"path": [
								"beneficiaries",
								"242910e3-92a9-4d6c-af27-dbef1bb1412b"
							],
							"query": [
								{
									"key": "email",
									"value": "mister_fitz@example.com"
								}
							]
						},
						"description": "**GET /v2/beneficiaries/{id}** - Returns a json structure containing the details of the requested beneficiary.\n\n**Required Fields**\n\nid: ID of the beneficiary\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\nbank\\_account\\_holder\\_name: Bank account holder's name\n\nemail: Email address of beneficiary\n\nbeneficiary\\_address: Address of beneficiary\n\nbeneficiary\\_country: A two-letter country code as defined in ISO 3166-1 that defines the beneficiary's country\n\nbank\\_country: A two-letter country code as defined in ISO 3166-1 of the bank account\n\ncurrency: 3 character ISO 4217 currency code\n\naccount\\_number: Account number\n\nrouting\\_code\\_type\\_1: Routing code type 1\n\nrouting\\_code\\_value\\_1: Routing code value 1\n\nrouting\\_code\\_type\\_2: Routing code type 2\n\nrouting\\_code\\_value\\_2: Routing code value 2\n\npayment\\_types: Priority or regular\n\nbic\\_swift: 8 or 11 char ISO 9362 BIC/SWIFT code\n\niban: up to 34 char international bank account number\n\ndefault\\_beneficiary: boolean\n\nbank\\_address: Address of the bank\n\nbank\\_name: Name of the bank\n\nbank\\_account\\_type: Type of bank account\n\nname: Nickname for beneficiary\n\nbeneficiary\\_entity\\_type: Type of beneficiary - can be individual or company\n\nbeneficiary\\_company\\_name: Beneficiary company name\n\nbeneficiary\\_first\\_name: Beneficiary first name\n\nbeneficiary\\_last\\_name: Beneficiary second name\n\nbeneficiary\\_city: Beneficiary city\n\nbeneficiary\\_postcode: Beneficiary postcode\n\nbeneficiary\\_state\\_or\\_province: Beneficiary state or province\n\nbeneficiary\\_date\\_of\\_birth: Beneficiary date of birth(company creation date when beneficiary\\_entity\\_type is company)\n\nidentification\\_type: name of ID type\n\nidentification\\_value: ID value\n\n**Response**\n\nid: ID of the Beneficiary\n\nbank\\_account\\_holder\\_name: Bank account holder's name\n\nemail: Email address of the Beneficiary\n\nbeneficiary\\_address: Address of the beneficiary\n\nbeneficiary\\_country: Country\n\ncurrency: 3 character ISO 4217 currency code\n\nbank\\_address: Bank address\n\nbank\\_country: Bank country\n\nrouting\\_code\\_type\\_1: The routing type code that identifies the bank account for the 'regular' payment type\n\nrouting\\_code\\_value\\_1: Routing code value 1\n\nrouting\\_code\\_type\\_2: The routing type code that identifies the bank account for the 'regular' payment type\n\nrouting\\_code\\_value\\_2: Routing code value 2\n\nbank\\_name: Bank name\n\nbank\\_account\\_type: Bank account type\n\npayment\\_types: priority, regular\n\ncreator\\_contact\\_id: Contact ID\n\nbic\\_swift: BIC/SWIFT code\n\niban: International bank account number\n\ndefault\\_beneficiary: Boolean. Default beneficiary\n\naccount\\_number: Account number\n\nname: Nickname\n\nbeneficiary\\_entity\\_type: Beneficiary type\n\nbeneficiary\\_company\\_name: Beneficiary company name\n\nbeneficiary\\_first\\_name: Beneficiary first name\n\nbeneficiary\\_last\\_name: Beneficiary last name\n\nbeneficiary\\_city: Beneficiary city\n\nbeneficiary\\_state\\_or\\_province: Beneficiary state or province\n\nbeneficiary\\_postcode: Beneficiary postcode\n\ncreated\\_at: ISO 8601 Date of when record was created\n\nupdated\\_at: ISO 8601 Date of when record was last updated\n"
					},
					"response": []
				},
				{
					"name": "Validate Beneficiary Bank Details",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/beneficiaries/validate?beneficiary_country=GB&bank_country=GB&currency=GBP&account_number=12344321&routing_code_type_1=sort_code&routing_code_value_1=112233&beneficiary_entity_type=individual&beneficiary_first_name=Jeff&beneficiary_last_name=Fitz&beneficiary_city=Jeff City&beneficiary_postcode=EC1 1XY&bank_account_type=checking",
							"host": [
								"{{url}}"
							],
							"path": [
								"beneficiaries",
								"validate"
							],
							"query": [
								{
									"key": "beneficiary_country",
									"value": "GB"
								},
								{
									"key": "bank_country",
									"value": "GB"
								},
								{
									"key": "currency",
									"value": "GBP"
								},
								{
									"key": "account_number",
									"value": "12344321"
								},
								{
									"key": "routing_code_type_1",
									"value": "sort_code"
								},
								{
									"key": "routing_code_value_1",
									"value": "112233"
								},
								{
									"key": "beneficiary_entity_type",
									"value": "individual"
								},
								{
									"key": "beneficiary_first_name",
									"value": "Jeff"
								},
								{
									"key": "beneficiary_last_name",
									"value": "Fitz"
								},
								{
									"key": "beneficiary_city",
									"value": "Jeff City"
								},
								{
									"key": "beneficiary_postcode",
									"value": "EC1 1XY"
								},
								{
									"key": "bank_account_type",
									"value": "checking"
								}
							]
						},
						"description": "**POST /v2/beneficiaries/validate** - Validates Beneficiary details without creating one\n\n**Required Fields**\n\nbank\\_country: A two-letter country code as defined in ISO 3166-1 of the bank account\n\ncurrency: 3 character ISO 4217 currency code\n\nbeneficiary\\_country: A two-letter country code as defined in ISO 3166-1 that defines the beneficiary's country\n\n\n**Optional Fields**\n\t\nKey: Description\n\non\\_behalf\\_of: Contact ID of the client\n\naccount\\_number: Account number\n\nrouting\\_code\\_type\\_1:Routing code type 1\n\nrouting\\_code\\_value\\_1: Routing code value 1\n\nrouting\\_code\\_type\\_2: Routing code type 2\n\nrouting\\_code\\_value\\_2: Routing code value 2\n\nbic\\_swift: 8 or 11 char ISO 9362 BIC/SWIFT code\n\niban: up to 34 char international bank account number\n\nbank\\_address: Address of the bank\n\nbank\\_name: Name of the bank\n\nbank\\_account\\_type: Type of bank account\n\nbeneficiary\\_entity\\_type: Type of beneficiary - can be individual or company\n\nbeneficiary\\_company\\_name: Beneficiary company name\n\nbeneficiary\\_first\\_name: Beneficiary first name\n\nbeneficiary\\_last\\_name: Beneficiary second name\n\nbeneficiary\\_city: Beneficiary city\n\nbeneficiary\\_postcode: Beneficiary postcode\n\nbeneficiary\\_state\\_or\\_province: Beneficiary state or province\n\nbeneficiary\\_date\\_of\\_birth: Beneficiary date of birth(company creation date when beneficiary\\_entity\\_type is company)\n\nbeneficiary\\_identification\\_type: name of ID type\n\nbeneficiary\\_identification\\_value: id type value\n\n**Response**\n\t\nKey: Description\n\ncurrency: 3 character ISO 4217 currency code\n\nbank\\_address: Bank address\n\nbank\\_country: Bank country\n\nrouting\\_code\\_type\\_1: The routing type code that identifies the bank account for the 'regular' payment type\n\nbeneficiary\\_address: Beneficiary address\n\nbeneficiary\\_country: Country\n\nrouting\\_code\\_value\\_1: Routing code value 1\n\nrouting\\_code\\_type\\_2: The routing type code that identifies the bank account for the 'regular' payment type\n\nrouting\\_code\\_value\\_2: Routing code value 2\n\nbank\\_name: Bank name\n\nbank\\_account\\_type: Bank account type\n\npayment\\_types: priority, regular\n\nbic\\_swift: BIC/SWIFT code\n\niban: International bank account number\n\naccount\\_number: Account number\n\nbeneficiary\\_entity\\_type: Beneficiary type\n\nbeneficiary\\_company\\_name: Beneficiary company name\n\nbeneficiary\\_first\\_name: Beneficiary first name\n\nbeneficiary\\_last\\_name: Beneficiary last name\n\nbeneficiary\\_city: Beneficiary city\n\nbeneficiary\\_state\\_or\\_province: Beneficiary state or province\n\nbeneficiary\\_postcode: Beneficiary postcode\n\nbeneficiary\\_date\\_of\\_birth: DOB of beneficiary\n\nbeneficiary\\_identification\\_type: name of ID type\n\nbeneficiary\\_identification\\_value: id type value"
					},
					"response": []
				},
				{
					"name": "Create Beneficiary",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/beneficiaries/create?bank_account_holder_name=Mister Fitz&beneficiary_country=GB&bank_country=GB&currency=GBP&account_number=12344321&routing_code_type_1=sort_code&routing_code_value_1=112233&beneficiary_entity_type=individual&beneficiary_first_name=Jeff&beneficiary_last_name=Fitz&beneficiary_city=Jeff City&beneficiary_postcode=EC1 1XY&bank_account_type=checking",
							"host": [
								"{{url}}"
							],
							"path": [
								"beneficiaries",
								"create"
							],
							"query": [
								{
									"key": "bank_account_holder_name",
									"value": "Mister Fitz"
								},
								{
									"key": "beneficiary_country",
									"value": "GB"
								},
								{
									"key": "bank_country",
									"value": "GB"
								},
								{
									"key": "currency",
									"value": "GBP"
								},
								{
									"key": "account_number",
									"value": "12344321"
								},
								{
									"key": "routing_code_type_1",
									"value": "sort_code"
								},
								{
									"key": "routing_code_value_1",
									"value": "112233"
								},
								{
									"key": "beneficiary_entity_type",
									"value": "individual"
								},
								{
									"key": "beneficiary_first_name",
									"value": "Jeff"
								},
								{
									"key": "beneficiary_last_name",
									"value": "Fitz"
								},
								{
									"key": "beneficiary_city",
									"value": "Jeff City"
								},
								{
									"key": "beneficiary_postcode",
									"value": "EC1 1XY"
								},
								{
									"key": "bank_account_type",
									"value": "checking"
								}
							]
						},
						"description": "**POST /v2/beneficiaries/create** - Creates a new beneficiary and returns a hash containing the details of the new beneficiary.\n\n**Required Fields**\n\nbank\\_account\\_holders\\_name: Bank account holder's name\n\nbeneficiary\\_country: A two-letter country code as defined in ISO 3166-1 that defines the beneficiary's country\n\nbank\\_country: A two-letter country code as defined in ISO 3166-1 of the bank account\n\ncurrency: 3 character ISO 4217 currency code\n\nName: name of beneficiary\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\nemail: Email address of beneficiary\n\nbeneficiary\\_address: Address of beneficiary\n\naccount\\_number: Account number\n\nrouting\\_code\\_type\\_1: Routing code type 1\n\nrouting\\_code\\_value\\_1: Routing code value 1\n\nrouting\\_code\\_type\\_2: Routing code type 2\n\nrouting\\_code\\_value\\_2: Routing code value 2\n\npayment\\_types: Priority or regular\n\nbic\\_swift: 8 or 11 char ISO 9362 BIC/SWIFT code\n\niban: up to 34 char international bank account number\n\ndefault\\_beneficiary: boolean\n\nbank\\_address: Address of the bank\n\nbank\\_name: Name of the bank\n\nbank\\_account\\_type: Type of bank account\n\nname: Nickname for beneficiary\n\nbeneficiary\\_entity\\_type: Type of beneficiary - can be individual or company\n\nbeneficiary\\_company\\_name: Beneficiary company name\n\nbeneficiary\\_first\\_name: Beneficiary first name\n\nbeneficiary\\_last\\_name: Beneficiary second name\n\nbeneficiary\\_city: Beneficiary city\n\nbeneficiary\\_postcode: Beneficiary postcode\n\nbeneficiary\\_state\\_or\\_province: Beneficiary state or province\n\nbeneficiary\\_date\\_of\\_birth: Beneficiary date of birth(company creation date when beneficiary\\_entity\\_type is company)\n\nbeneficiary\\_identification\\_type: Name of ID type\n\nbeneficiary\\_identification\\_value: Value of ID type\n\n**Response**\n\nid: ID of the Beneficiary\n\nbank\\_account\\_holder\\_name: Bank account holder's name\n\nemail: Email address of the Beneficiary\n\nbeneficiary\\_address: Address of the beneficiary\n\nbeneficiary\\_country: Country\n\ncurrency: 3 character ISO 4217 currency code\n\nbank\\_address: Bank address\n\nbank\\_country: Bank country\n\nrouting\\_code\\_type\\_1: The routing type code that identifies the bank account for the 'regular' payment type\n\nrouting\\_code\\_value\\_1: Routing code value 1\n\nrouting\\_code\\_type\\_2: The routing type code that identifies the bank account for the 'regular' payment type\n\nrouting\\_code\\_value\\_2: Routing code value 2\n\nbank\\_name: Bank name\n\nbank\\_account\\_type: Bank account type\n\npayment\\_types: priority, regular\n\ncreator\\_contact\\_id: Contact ID\n\nbic\\_swift: BIC/SWIFT code\n\niban: International bank account number\n\ndefault\\_beneficiary: Boolean. Default beneficiary\n\naccount\\_number: Account number\n\nname: Nickname\n\nbeneficiary\\_entity\\_type: Beneficiary type\n\nbeneficiary\\_company\\_name: Beneficiary company name\n\nbeneficiary\\_first\\_name: Beneficiary first name\n\nbeneficiary\\_last\\_name: Beneficiary last name\n\nbeneficiary\\_city: Beneficiary city\n\nbeneficiary\\_state\\_or\\_province: Beneficiary state or province\n\nbeneficiary\\_postcode: Beneficiary postcode\n\ncreated\\_at: ISO 8601 Date of when record was created\n\nupdated\\_at: ISO 8601 Date of when record was last updated\n"
					},
					"response": []
				},
				{
					"name": "Find Beneficiaries",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/beneficiaries/find",
							"host": [
								"{{url}}"
							],
							"path": [
								"beneficiaries",
								"find"
							]
						},
						"description": "**GET /v2/beneficiaries/find** - Return an array containing json structures of details of the accounts matching the search criteria for the logged in user.\n\n**Optional Fields**\n\nbank\\_account\\_holder\\_name: Bank account holder's name\n\nbeneficiary\\_country: A two-letter country code as defined in ISO 3166-1 that defines the beneficiary's country\n\ncurrency: 3 character ISO 4217 currency code\n\naccount\\_number: Account number\n\nrouting\\_code\\_type: Routing code type\n\nrouting\\_code\\_value: Routing code value\n\npayment\\_types: Priority or regular\n\nbic\\_swift: 8 or 11 char ISO 9362 BIC/SWIFT code\n\niban: up to 34 char international bank account number\n\ndefault\\_beneficiary: Check whether beneficiary is a default\n\nbank\\_name: Name of the bank\n\nbank\\_account\\_type: Type of bank account\n\nname: Nickname for beneficiary\n\nbeneficiary\\_entity\\_type: Type of beneficiary - can be individual or company\n\nbeneficiary\\_company\\_name: Beneficiary company name\n\nbeneficiary\\_first\\_name: Beneficiary first name\n\nbeneficiary\\_last\\_name: Beneficiary second name\n\nbeneficiary\\_city: Beneficiary city\n\nbeneficiary\\_postcode: Beneficiary postcode\n\nbeneficiary\\_state\\_or\\_province: Beneficiary state or province\n\nbeneficiary\\_date\\_of\\_birth: Beneficiary date of birth(company creation date when beneficiary\\_entity\\_type is company)\n\npage: Which page to show\n\nper\\_page: Maximum number of entries to return\n\norder: The field to order entries by\n\norder\\_asc\\_desc: Whether the order is ascending (asc) or descending (desc)\n\non\\_behalf\\_of: Contact ID of the client\n\n**Response**\n\nbeneficiaries: An array of Beneficiary objects\n\n  - id: ID of the Beneficiary\n\n  - bank\\_account\\_holder\\_name: Bank account holder's name\n\n  - email: Email address of the Beneficiary\n\n  - beneficiary\\_address: Address of the beneficiary\n\n  - beneficiary\\_country: Country\n\n  - currency: 3 character ISO 4217 currency code\n\n  - bank\\_address: Bank address\n\n  - bank\\_country: Bank country\n\n  - routing\\_code\\_type\\_1: The routing type code that identifies the bank account for the 'regular' payment type\n\n  - routing\\_code\\_value\\_1: Routing code value 1\n\n  - routing\\_code\\_type\\_2: The routing type code that identifies the bank account for the 'regular' payment type\n\n  - routing\\_code\\_value\\_2: Routing code value 2\n\n  - bank\\_name: Bank name\n\n  - bank\\_account\\_type: Bank account type\n\n  - payment\\_types: priority, regular\n\n  - creator\\_contact\\_id: Contact ID\n\n  - bic\\_swift: BIC/SWIFT code\n\n  - iban: International bank account number\n\n  - default\\_beneficiary: Boolean. Default beneficiary\n\n  - account\\_number: Account number\n\n  - name: Nickname\n\n  - beneficiary\\_entity\\_type: Beneficiary type\n\n  - beneficiary\\_company\\_name: Beneficiary company name\n\n  - beneficiary\\_first\\_name: Beneficiary first name\n\n  - beneficiary\\_last\\_name: Beneficiary last name\n\n  - beneficiary\\_date\\_of\\_birth: DOB of beneficiary\n\n  - beneficiary\\_identification\\_type: Type of id\n\n  - beneficiary\\_identification\\_value: value of id type\n\n  - beneficiary\\_city: Beneficiary city\n\n  - beneficiary\\_state\\_or\\_province: Beneficiary state or province\n\n  - beneficiary\\_postcode: Beneficiary postcode\n\n  - created\\_at: ISO 8601 Date of when record was created\n\n  - updated\\_at: ISO 8601 Date of when record was last updated\n\npagination: Pagination details relevant to the search query\n\n  - total\\_entries: Total entries for this search query\n\n  - total\\_pages: Total pages for this search query\n\n  - current\\_page: Current page of the search query\n\n  - per\\_page: Amount of search results to return per page\n\n  - previous\\_page: Previous page for this search query\n\n  - next\\_page: Next page for this search query\n\n  - order: Order of the search returned for this search query\n\n  - order\\_asc\\_desc: Order of results returned e.g. 'asc' or 'desc'\n\n"
					},
					"response": []
				},
				{
					"name": "Delete A Beneficiary",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/beneficiaries/b6a9c145-73fb-4f2f-8876-a61e727c6886/delete",
							"host": [
								"{{url}}"
							],
							"path": [
								"beneficiaries",
								"b6a9c145-73fb-4f2f-8876-a61e727c6886",
								"delete"
							]
						},
						"description": "**GET /v2/beneficiaries/{id}/delete** - Returns a json structure containing the details of the requested beneficiary.\n\n**Required Fields**\n\nid: ID of the beneficiary\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n**Response**\n\nid: ID of the Beneficiary\n\nbank\\_account\\_holder\\_name: Bank account holder's name\n\nemail: Email address of the Beneficiary\n\nbeneficiary\\_address: Address of the beneficiary\n\nbeneficiary\\_country: Country\n\ncurrency: 3 character ISO 4217 currency code\n\nbank\\_address: Bank address\n\nbank\\_country: Bank country\n\nrouting\\_code\\_type_1: The routing type code that identifies the bank account for the 'regular' payment type\n\nrouting\\_code\\_value\\_1: Routing code value 1\n\nrouting\\_code\\_type\\_2: The routing type code that identifies the bank account for the 'regular' payment type\n\nrouting\\_code\\_value\\_2: Routing code value 2\n\nbank\\_name: Bank name\n\nbank\\_account\\_type: Bank account type\n\npayment\\_types: priority, regular\n\ncreator\\_contact\\_id: Contact ID\n\nbic\\_swift: BIC/SWIFT code\n\niban: International bank account number\n\ndefault\\_beneficiary: Boolean. Default beneficiary\n\naccount\\_number: Account number\n\nname: Nickname\n\nbeneficiary\\_entity\\_type: Beneficiary type\n\nbeneficiary\\_company\\_name: Beneficiary company name\n\nbeneficiary\\_first\\_name: Beneficiary first name\n\nbeneficiary\\_last\\_name: Beneficiary last name\n\nbeneficiary\\_city: Beneficiary city\n\nbeneficiary\\_state\\_or\\_province: Beneficiary state or province\n\nbeneficiary\\_postcode: Beneficiary postcode\n\nbeneficiary\\_identification\\_type: name of ID type\n\nbeneficiary\\_identification\\_value: ID value\n\ncreated\\_at: ISO 8601 Date of when record was created\n\nupdated\\_at: ISO 8601 Date of when record was last updated\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "Contacts",
			"item": [
				{
					"name": "Retrieve a Contact",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/contacts/e7499b81-a7a7-0131-ec50-0022194273f7",
							"host": [
								"{{url}}"
							],
							"path": [
								"contacts",
								"e7499b81-a7a7-0131-ec50-0022194273f7"
							]
						},
						"description": "**GET /v2/contacts/{id}** - Returns a json structure containing the details of the requested contact.\n\n\n**Required Fields**\n\nid: ID of the contact\n\n**Response**\n\nid: ID of the contact\n\naccount\\_name: Account name\n\naccount\\_id: ID of the account\n\nyour\\_reference: Your unique ID\n\nemail\\_address: Email address\n\nfirst\\_name: First name\n\nlast\\_name: Last name\n\nphone\\_number: Phone number\n\nmobile\\_phone\\_number: Mobile phone number\n\nlocale: The locale of the user as combination of an ISO 639-1 language code and ISO\\_3166-1 regional code e.g. en, en-US, fr-FR\n\nlogin\\_id: Login ID\n\nstatus: Status\n\ntimezone: The timezone of the user as it exists in the IANA tz database e.g. Europe/London, America/New\\_York (reference http://en.wikipedia.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones#List)\n\ndate\\_of\\_birth: DOB of contact\n\ncreated\\_at: ISO 8601 Date when the Contact was created\n\nupdated\\_at: ISO 8601 Date when the Contact was last updated"
					},
					"response": []
				},
				{
					"name": "Update a Contact",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/contacts/e7499b81-a7a7-0131-ec50-0022194273f7",
							"host": [
								"{{url}}"
							],
							"path": [
								"contacts",
								"e7499b81-a7a7-0131-ec50-0022194273f7"
							]
						},
						"description": "**POST /v2/contacts/{id}** - Updates an existing contact and returns a hash containing the details of the requested contact.\n\n**Required Fields**\n\nid: ID of the contact\n\n**Optional Fields**\n\nfirst\\_name: First name\n\nlast\\_name: Last name\n\nemail\\_address: Email address\n\nyour\\_reference: Your unique ID\n\nphone\\_number: Phone number\n\nmobile\\_phone\\_number: Mobile phone number\n\nlogin\\_id: Login ID of the contact which must be unique. (only updateable by a broker)\n\nstatus: Status (only updateable by a broker)\n\nlocale: The locale of the user as combination of an ISO 639-1 language code and ISO\\_3166-1 regional code e.g. en, en-US, fr-FR\n\ntimezone: The timezone of the user as it exists in the IANA tz database e.g. Europe/London, America/New\\_York (reference http://en.wikipedia.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones#List)\n\n\n**Response**\n\nid: ID of the contact\n\naccount\\_name: Account name\n\naccount\\_id: ID of the account\n\nyour\\_reference: Your unique ID\n\nemail\\_address: Email address\n\nfirst\\_name: First name\n\nlast\\_name: Last name\n\nphone\\_number: Phone number\n\nmobile\\_phone\\_number: Mobile phone number\n\nlocale: The locale of the user as combination of an ISO 639-1 language code and ISO\\_3166-1 regional code e.g. en, en-US, fr-FR\n\nlogin\\_id: Login ID\n\nstatus: Status\n\ntimezone: The timezone of the user as it exists in the IANA tz database e.g. Europe/London, America/New\\_York (reference http://en.wikipedia.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones#List)\n\ndate\\_of\\_ birth: DOB of contact\n\ncreated\\_at: ISO 8601 Date when the Contact was created\n\nupdated\\_at: ISO 8601 Date when the Contact was last updated\n\n"
					},
					"response": []
				},
				{
					"name": "Contact (logged-in Contact)",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/contacts/current",
							"host": [
								"{{url}}"
							],
							"path": [
								"contacts",
								"current"
							]
						},
						"description": "**GET /v2/contacts/current** - Returns a json structure containing the details of the active contact.\n\n\n**Response**\n\nid: ID of the contact\n\naccount\\_name: Account name\n\naccount\\_id: ID of the account\n\nyour\\_reference: Your unique ID\n\nemail\\_address: Email address\n\nfirst\\_name: First name\n\nlast\\_name: Last name\n\nphone\\_number: Phone number\n\nmobile\\_phone\\_number: Mobile phone number\n\nlocale: The locale of the user as combination of an ISO 639-1 language code and ISO\\_3166-1 regional code e.g. en, en-US, fr-FR\n\nlogin\\_id: Login ID\n\nstatus: Status\n\ntimezone: The timezone of the user as it exists in the IANA tz database e.g. Europe/London, America/New\\_York (reference http://en.wikipedia.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones#List)\n\ndate\\_of\\_birth: DOB of contact\n\ncreated\\_at: ISO 8601 Date when the Contact was created\n\nupdated\\_at: ISO 8601 Date when the Contact was last updated\n"
					},
					"response": []
				},
				{
					"name": "Create Contact",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/contacts/create?account_id=91b76af6-0677-4f94-92ec-82a4fd09ede5&first_name=Mister&last_name=Fitz&email_address=misterfitz@example.com&phone_number=112233",
							"host": [
								"{{url}}"
							],
							"path": [
								"contacts",
								"create"
							],
							"query": [
								{
									"key": "account_id",
									"value": "91b76af6-0677-4f94-92ec-82a4fd09ede5"
								},
								{
									"key": "first_name",
									"value": "Mister"
								},
								{
									"key": "last_name",
									"value": "Fitz"
								},
								{
									"key": "email_address",
									"value": "misterfitz@example.com"
								},
								{
									"key": "phone_number",
									"value": "112233"
								}
							]
						},
						"description": "**POST /v2/contacts/create** - Creates a new contact and returns a hash containing the details of the requested contact.\n\n**Required Fields**\n\naccount\\_id: ID of the account\n\nfirst\\_name: First name\n\nlast\\_name: Last name\n\nemail\\_address: Email address\n\nphone\\_number: Phone number\n\n**Optional Fields**\n\nyour\\_reference: Your unique ID\n\nmobile\\_phone\\_number: Mobile phone number\n\nlogin\\_id: Login ID of the contact which must be unique. (If none is specified the contact's email address is used)\n\nstatus: Status (only updateable by a broker)\n\nlocale: The locale of the user as combination of an ISO 639-1 language code and ISO\\_3166-1 regional code e.g. en, en-US, fr-FR\n\ntimezone: The timezone of the user as it exists in the IANA tz database e.g. Europe/London, America/New\\_York (reference http://en.wikipedia.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones#List)\n\ndate\\_of\\_birth: DOB of contact\n\n**Response**\n\nid: ID of the contact\n\naccount\\_name: Account name\n\naccount\\_id: ID of the account\n\nyour\\_reference: Your unique ID\n\nemail\\_address: Email address\n\nfirst\\_name: First name\n\nlast\\_name: Last name\n\nphone\\_number: Phone number\n\nmobile\\_phone\\_number: Mobile phone number\n\nlocale: The locale of the user as combination of an ISO 639-1 language code and ISO\\_3166-1 regional code e.g. en, en-US, fr-FR\n\nlogin\\_id: Login ID\n\nstatus: Status\n\ntimezone: The timezone of the user as it exists in the IANA tz database e.g. Europe/London, America/New\\_York (reference http://en.wikipedia.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones#List)\n\ndate\\_of\\_birth: DOB of contact\n\ncreated\\_at: ISO 8601 Date when the Contact was created\n\nupdated\\_at: ISO 8601 Date when the Contact was last updated\n\n"
					},
					"response": []
				},
				{
					"name": "Find Contact",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/contacts/find",
							"host": [
								"{{url}}"
							],
							"path": [
								"contacts",
								"find"
							]
						},
						"description": "**GET /v2/contacts/find** - Return an array containing hashes of details of the contacts matching the search criteria for the active user.\n\n**Optional Fields**\n\naccount\\_name: Account name\n\naccount\\_id: ID of account\n\nfirst\\_name: First name\n\nlast\\_name: Last name\n\nemail\\_address: Email address\n\nyour\\_reference: Your unique ID\n\nphone\\_number: Phone number\n\nlogin\\_id: Login ID of the contact which must be unique. (only updateable by a broker)\n\nstatus: Status (only updateable by a broker)\n\nlocale: The locale of the user as combination of an ISO 639-1 language code and ISO\\_3166-1 regional code e.g. en, en-US, fr-FR\n\ntimezone: The timezone of the user as it exists in the IANA tz database e.g. Europe/London, America/New\\_York (reference http://en.wikipedia.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones#List)\n\npage: Which page to show\n\nper\\_page: Maximum number of entries to return\n\norder: The field to order entries by\n\norder\\_asc\\_desc: Whether the order is ascending (asc) or descending (desc)\n\n\n**Response**\n\ncontacts: An array of Contact objects\n\n  - id: ID of the contact\n\n  - account\\_name: Account name\n\n  - account\\_id: ID of the account\n\n  - your\\_reference: Your unique ID of the contact\n\n  - email\\_address: Email address\n\n  - first\\_name: First name\n\n  - last\\_name: Last name\n\n  - phone\\_number: Phone number\n\n  - mobile\\_phone\\_number: Mobile phone number\n\n  - locale: The locale of the user as combination of an ISO 639-1 language code and ISO_3166-1 regional code e.g. en, en-US, fr-FR\n\n  - login\\_id: Login ID\n\n  - status: Status\n\n  - timezone: The timezone of the user as it exists in the IANA tz database e.g. Europe/London, America/New\\_York (reference http://en.wikipedia.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones#List)\n\n  - date_of_birth: DOB of contact\n\n  - created\\_at: ISO 8601 Date when the Contact was created\n\n  - updated\\_at: ISO 8601 Date when the Contact was last updated\n\npagination: Pagination details relevant to the search query\n\n  - total\\_entries: Total entries for this search query\n\n  - total\\_pages: Total pages for this search query\n\n  - current\\_page: Current page of the search query\n\n  - per\\_page: Amount of search results to return per page\n\n  - previous\\_page: Previous page for this search query\n\n  - next\\_page: Next page for this search query\n\n  - order: Order of the search returned for this search query\n\n  - order\\_asc\\_desc: Order of results returned e.g. 'asc' or 'desc'\n\n\n"
					},
					"response": []
				},
				{
					"name": "Reset security details for a Contact",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/contacts/reset_security_details?token=e538276d519f037b2b4e6fcde4a4f541&password=test&security_question_one=sec_q_fav_city&security_question_two=sec_q_pet_name&security_question_three=sec_q_fav_animal&security_answer_one=test&security_answer_two=test&security_answer_three=test",
							"host": [
								"{{url}}"
							],
							"path": [
								"contacts",
								"reset_security_details"
							],
							"query": [
								{
									"key": "token",
									"value": "e538276d519f037b2b4e6fcde4a4f541"
								},
								{
									"key": "password",
									"value": "test"
								},
								{
									"key": "security_question_one",
									"value": "sec_q_fav_city"
								},
								{
									"key": "security_question_two",
									"value": "sec_q_pet_name"
								},
								{
									"key": "security_question_three",
									"value": "sec_q_fav_animal"
								},
								{
									"key": "security_answer_one",
									"value": "test"
								},
								{
									"key": "security_answer_two",
									"value": "test"
								},
								{
									"key": "security_answer_three",
									"value": "test"
								}
							]
						},
						"description": "**POST /v2/contacts/reset\\_security\\_details** - Resets the users details if the token is valid contact.\n\n**Required Fields**\n\ntoken - The unique and temporary token that identifies this reset security details request\n\npassword - The password to use for the user\n\nsecurity\\_question\\_one - One of the four allowed security questions (sec\\_q\\_fav\\_city, sec\\_q\\_pet\\_name, sec\\_q\\_fav\\_animal, sec\\_q\\_hol\\_dst)\n\nsecurity\\_question\\_two - One of the four allowed security questions (sec\\_q\\_fav\\_city, sec\\_q\\_pet\\_name, sec\\_q\\_fav\\_animal, sec\\_q\\_hol\\_dst)\n\nsecurity\\_question\\_three - One of the four allowed security questions (sec\\_q\\_fav\\_city, sec\\_q\\_pet\\_name, sec\\_q\\_fav\\_animal, sec\\_q\\_hol\\_dst)\n\nsecurity\\_answer\\_one - The answer for security\\_answer\\_one\n\nsecurity\\_answer\\_two - The answer for security\\_answer\\_two\n\nsecurity\\_answer\\_three - The answer for security\\_answer\\_three\n\n**Response**\n\n"
					},
					"response": []
				},
				{
					"name": "Retrieve Security Details",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/contacts/security_details",
							"host": [
								"{{url}}"
							],
							"path": [
								"contacts",
								"security_details"
							]
						},
						"description": "**GET /v2/contacts/security\\_details** - Returns a json structure with all the security questions for the active contact\n\n\n**Response**\n\nsecurity\\_questions - The list of security questions for the currently logged in user\n\n- security\\_code - An enumeration (sec\\_q\\_hol\\_dst, sec\\_q\\_fav\\_animal, sec\\_q\\_pet\\_name, sec\\_q\\_fav\\_city) that identifies the security question\n\n- security\\_question - A security question in English that needs to be answered for a successful login.\n\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "Conversions",
			"item": [
				{
					"name": "Retrieve a Conversion",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/conversions/{{conversion_id}}",
							"host": [
								"{{url}}"
							],
							"path": [
								"conversions",
								"{{conversion_id}}"
							]
						},
						"description": "**GET /v2/conversions/{id}  ** \n   Returns a json structure containing the details of the requested conversion.\n\n\n**Required Fields**\n\nid:ID of the conversion\n\n**Response**\n\nId:Conversion unique ID\n\nAccount\\_id:ID that the Conversion belongs to\n\nCreator\\_contact\\_id:ID of the Contact that created the Conversion\n\nShort\\_reference:Human readable unique ID\n\nSettlement\\_date:Datetime of when sell_currency will be debited\n\nConversion\\_date:Datetime of when the buy_currency will be credited\n\nstatus:Status of the Conversion\nbetween the Partner and Currency Cloud\n\npartner\\_status:Status of the Conversion between the Partner and Client\n\ncurrency\\_pair\t:A concatenation of the two currencies being converted\n\nbuy\\_currency\t:ISO-4217 three letter currency that was bought\n\nsell\\_currency\t:ISO-4217 three letter currency that was sold\n\nfixed\\_side:The side of the Conversion that was fixed when the Conversion was booked, either 'buy' or 'sell'\n\npartner\\_buy\\_amount:Amount of the buy_currency being bought by the partner\n\npartner\\_sell\\_amount:Amount of the sell_currency being sold by the partner\n\nclient\\_buy\\_amount:Amount of the buy_currency being bought by the client\n\nclient\\_sell\\_amount:Amount of the sell_currency being sold by the client\n\nmid\\_market\\_rate:The mid-point between the bid and offer rate when the Conversion was created - often used for historical rate comparisons\n\ncore\\_rate:Rate that Currency Cloud paid for the Conversion\n\npartner\\_rate:Rate that the partner paid for the Conversion\n\nclient\\_rate:Rate that the client paid for the Conversion\n\ndeposit\\_required:Whether or not a deposit is required for the Conversion\n\ndeposit\\_status:Status of the deposit, if required\n\ndeposit\\_currency:ISO-4217 three letter currency of the deposit, if required\n\ndeposit\\_amount:Amount of the deposit, if required\n\ndeposit\\_required\\_at:Datetime of when the deposit has to be received by, if required\n\npayment\\_ids:Array of Payment IDs that are related to the Conversion\n\ncreated\\_at:Datetime of when the Conversion was created\n\nupdated\\_at:Datetime of when the Conversion was last updated\n\n\n"
					},
					"response": []
				},
				{
					"name": "Create a Conversion",
					"event": [
						{
							"listen": "test",
							"script": {
								"type": "text/javascript",
								"exec": [
									"postman.setEnvironmentVariable(\"conversion_id\", JSON.parse(responseBody).id);"
								]
							}
						}
					],
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "buy_currency",
									"value": "USD",
									"type": "text"
								},
								{
									"key": "sell_currency",
									"value": "GBP",
									"type": "text"
								},
								{
									"key": "fixed_side",
									"value": "buy",
									"type": "text"
								},
								{
									"key": "amount",
									"value": "10000",
									"type": "text"
								},
								{
									"key": "reason",
									"value": "testing",
									"type": "text"
								},
								{
									"key": "term_agreement",
									"value": "true",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/conversions/create",
							"host": [
								"{{url}}"
							],
							"path": [
								"conversions",
								"create"
							]
						},
						"description": "**POST /v2/conversions/create  ** \n    Returns a json structure containing the details of the created conversion.\n\n\n**Required Fields**\n\nBuy\\_currency:\t\n\nSell\\_currency:\t\n\nFixed\\_side:\t\n\nAmount:\t\n\nreason:Reason for currency conversion\n\nterm\\_agreement:Terms and conditions\n\n**Optional Fields**\n\non\\_behalf_of\t:Contact ID of the client\n\nconversion\\_date:if nothing passed then default uses first_conversion_date\n\nbeneficiary\\_id:\n\nclient\\_rate:Set the client rate instead of using a spread table\n\ncurrency\\_pair:real market pair - required if supplying client_rate\n\nclient\\_buy\\_amount\n\nclient\\_sell\\_amount\n\npayment\\_reason:Reason for payment - required when supplying a beneficiary\\_id\n\npayment\\_type:Can be priority or regular\n\npayment\\_reference:Payment reference - required when supplying a beneficiary\\_id\n\n\n\n**Response**\n\nid:Conversion unique ID\n\naccount\\_id:ID that the Conversion belongs to\n\ncreator\\_contact\\_id\t:ID of the Contact that created the Conversion\n\nshort\\_reference:Human readable unique ID\n\nsettlement\\_date:Datetime of when sell_currency will be debited\n\nconversion\\_date:Datetime of when the buy_currency will be credited\n\nstatus:Status of the Conversion between the Partner and Currency Cloud\n\npartner\\_status:Status of the Conversion between the Partner and Client\n\ncurrency\\_pair:A concatenation of the two currencies being converted\n\nbuy\\_currency:ISO-4217 three letter currency that was bought\n\nsell\\_currency:ISO-4217 three letter currency that was sold\n\nfixed\\_side:The side of the Conversion that was fixed when the Conversion was booked, either 'buy' or 'sell'\n\npartner\\_buy\\_amount:Amount of the buy_currency being bought by the partner\n\npartner\\_sell\\_amount:Amount of the sell_currency being sold by the partner\n\nclient\\_buy\\_amount\t:Amount of the buy_currency being bought by the client\n\nclient\\_sell\\_amount\t:Amount of the sell_currency being sold by the client\n\nmid\\_market\\_rate:The mid-point between the bid and offer rate when the Conversion was created - often used for historical rate comparisons\n\ncore\\_rate:Rate that Currency Cloud paid for the Conversion\n\npartner\\_rate:Rate that the partner paid for the Conversion\n\nclient\\_rate:Rate that the client paid for the Conversion\n\ndeposit\\_required:Whether or not a deposit is required for the Conversion\n\ndeposit\\_status:Status of the deposit, if required\n\ndeposit\\_currency:ISO-4217 three letter currency of the deposit, if required\n\ndeposit\\_amount:Amount of the deposit, if required\n\ndeposit\\_required_at\t:Datetime of when the deposit has to be received by, if required\n\npayment\\_ids\t:Array of Payment IDs that are related to the Conversion\n\ncreated\\_at:Datetime of when the Conversion was created\n\nupdated\\_at:Datetime of when the Conversion was last updated\n\n"
					},
					"response": []
				},
				{
					"name": "Find a Conversion",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "buy_currency",
									"value": "USD",
									"type": "text"
								},
								{
									"key": "sell_currency",
									"value": "GBP",
									"type": "text"
								},
								{
									"key": "fixed_side",
									"value": "buy",
									"type": "text"
								},
								{
									"key": "amount",
									"value": "10000",
									"type": "text"
								},
								{
									"key": "reason",
									"value": "testing",
									"type": "text"
								},
								{
									"key": "term_agreement",
									"value": "true",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/conversions/find",
							"host": [
								"{{url}}"
							],
							"path": [
								"conversions",
								"find"
							]
						},
						"description": "**GET /v2/conversions/find  ** \n    Return an array containing json structures of details of the conversions matching the search criteria for the logged in user.\n\n\n**Required Fields**\n\n--\n\n\n**Optional Fields**\n\nshort\\_reference:Unique human readable identifier\n\nstatus:The current status of the Conversion\n\npartner\\_status:The partner status of the Conversion\n\nbuy\\_currency\t:3 character ISO 4217 currency code\n\nsell\\_currency:3 character ISO 4217 currency code\n\nconversion\\_ids:Array of conversion ids\n\ncreated\\_at\\_from:ISO 8601 Datetime when the payment was created\n\ncreated\\_at\\_to:ISO 8601 Datetime when the payment was created\n\nupdated\\_at\\_from:ISO 8601 Datetime when the payment was updated\n\nupdated\\_at\\_to: ISO 8601 Datetime when the payment was updated\n\ncurrency\\_pair:Currency pair\n\npartner\\_buy\\_amount\\_from:\t\n\npartner\\_buy\\_amount\\_to:\n\npartner\\_sell\\_amount\\_from:\n\npartner\\_sell\\_amount\\_to:\n\nbuy\\_amount\\_from:\t\n\nbuy\\_amount\\_to:\t\n\nsell\\_amount\\_from:\t\n\nsell\\_amount\\_to:\n\non_\\behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nConversions:An array of Conversion objects\n\nid:Conversion unique ID\n\naccount\\_id:ID that the Conversion belongs to\n\ncreator\\_contact\\_id\t:ID of the Contact that created the Conversion\n\nshort\\_reference:Human readable unique ID\n\nsettlement\\_date:Datetime of when sell_currency will be debited\n\nconversion\\_date:Datetime of when the buy_currency will be credited\n\nstatus:Status of the Conversion between the Partner and Currency Cloud\n\npartner\\_status:Status of the Conversion between the Partner and Client\n\ncurrency\\_pair:A concatenation of the two currencies being converted\n\nbuy\\_currency:ISO-4217 three letter currency that was bought\n\nsell\\_currency:ISO-4217 three letter currency that was sold\n\nfixed\\_side:The side of the Conversion that was fixed when the Conversion was booked, either 'buy' or 'sell'\n\npartner\\_buy\\_amount:Amount of the buy_currency being bought by the partner\n\npartner\\_sell\\_amount:Amount of the sell_currency being sold by the partner\n\nclient\\_buy\\_amount\t:Amount of the buy_currency being bought by the client\n\nclient\\_sell\\_amount\t:Amount of the sell_currency being sold by the client\n\nmid\\_market\\_rate:The mid-point between the bid and offer rate when the Conversion was created - often used for historical rate comparisons\n\ncore\\_rate:Rate that Currency Cloud paid for the Conversion\n\npartner\\_rate:Rate that the partner paid for the Conversion\n\nclient\\_rate:Rate that the client paid for the Conversion\n\ndeposit\\_required:Whether or not a deposit is required for the Conversion\n\ndeposit\\_status:Status of the deposit, if required\n\ndeposit\\_currency:ISO-4217 three letter currency of the deposit, if required\n\ndeposit\\_amount:Amount of the deposit, if required\n\ndeposit\\_required_at\t:Datetime of when the deposit has to be received by, if required\n\npayment\\_ids\t:Array of Payment IDs that are related to the Conversion\n\ncreated\\_at:Datetime of when the Conversion was created\n\nupdated\\_at:Datetime of when the Conversion was last updated\n\npagination:Pagination details relevant to the search query\n\n total\\_entries:Total entries for this search query\n \n  total\\_pages:Total pages for this search query\n  \n  current\\_page:Current page of the search query\n  \n  per\\_page:Amount of search results to return per page\n  \n previous\\_page:Previous page for this search query\n \n  next\\_page:Next page for this search query\n  \n  order\t:Order of the search returned for this search query\n  \n  order\\_asc\\_desc:Order of results returned e.g. 'asc' or 'desc'\n\n"
					},
					"response": []
				},
				{
					"name": "Cancel Conversion",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "notes",
									"value": "Cancel due to very important reason",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/conversions/{{conversion_id}}/cancel",
							"host": [
								"{{url}}"
							],
							"path": [
								"conversions",
								"{{conversion_id}}",
								"cancel"
							]
						},
						"description": "**POST /v2/conversions/:id/cancel** \n    Returns a json structure containing the details of the conversion cancellation.\n\n\n**Required Fields**\n\nid: conversion ID should be passed as a part of URL. It is needed to identify, which conversion we are going to cancel.\n\n**Optional Fields**\n\nnote: the reason why conversion is cancelled\n\n\n**Response**\n\naccount\\_id: account ID that the Conversion belongs to\n\ncontact\\_id: contact ID that the Conversion belongs to\n\nconversion\\_id: ID of the conversions which was cancelled\n\namount: profit or loss amount\n\ncurrency: ISO-4217 three letter profit or loss currency\n\nnotes: notes that were provided as a reason of cancellation\n\nevent\\_date\\_time: Datetime of conversion cancellation event"
					},
					"response": []
				},
				{
					"name": "Cancellation Quote",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "notes",
									"value": "Cancel due to very important reason",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/conversions/{{conversion_id}}/cancellation_quote",
							"host": [
								"{{url}}"
							],
							"path": [
								"conversions",
								"{{conversion_id}}",
								"cancellation_quote"
							]
						},
						"description": "**GERT /v2/conversions/:id/cancellation_quote** \n    Returns a json structure containing the details of the conversion cancellation rate.\n\n\n**Required Fields**\n\nid: conversion ID should be passed as a part of URL. It is needed to identify, which conversion we are going to cancel.\n\n**Optional Fields**\n\nNone\n\n\n**Response**\n\namount: profit or loss amount\n\ncurrency: ISO-4217 three letter profit or loss currency\n\nevent\\_date\\_time: Datetime of conversion cancellation event"
					},
					"response": []
				},
				{
					"name": "Find Conversion P&L",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "buy_currency",
									"value": "USD",
									"type": "text"
								},
								{
									"key": "sell_currency",
									"value": "GBP",
									"type": "text"
								},
								{
									"key": "fixed_side",
									"value": "buy",
									"type": "text"
								},
								{
									"key": "amount",
									"value": "10000",
									"type": "text"
								},
								{
									"key": "reason",
									"value": "testing",
									"type": "text"
								},
								{
									"key": "term_agreement",
									"value": "true",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/conversions/profit_and_loss?event_date_time_from=2017-11-20&event_date_time_to=2017-11-22&amount_from=-12&amount_to=-7&conversion_id=d5a6d00c-2c10-4844-bd45-406a5dee3ac0",
							"host": [
								"{{url}}"
							],
							"path": [
								"conversions",
								"profit_and_loss"
							],
							"query": [
								{
									"key": "event_date_time_from",
									"value": "2017-11-20",
									"equals": true
								},
								{
									"key": "event_date_time_to",
									"value": "2017-11-22",
									"equals": true
								},
								{
									"key": "amount_from",
									"value": "-12",
									"equals": true
								},
								{
									"key": "amount_to",
									"value": "-7",
									"equals": true
								},
								{
									"key": "conversion_id",
									"value": "d5a6d00c-2c10-4844-bd45-406a5dee3ac0",
									"equals": true
								}
							]
						},
						"description": "**GET /v2/conversions/profit_and_loss** \nReturn an array containing json structures of details of the conversion profit and losses matching the search criteria for the logged in user.\n\n**Required Fields**\n\nNone\n\n**Optional Fields**\n\naccount\\_id: ID of the Account that the Conversion belongs to\n\ncontact\\_id: ID of the Contact that did the cancellation\n\nconversion\\_id: ID of the cancelled conversion\n\nevent\\_type: Event type. Can be one from following list - self\\_service\\_cancellation, automated\\_date\\_change, back\\_office\\_cancellation\n\nevent\\_date\\_time\\_from: Allows you to return profit and losses will be done from on or after a defined date/time. ISO 8601 standard\n\nevent\\_date\\_time\\_to: Allows you to return profit and losses will be done from on or before a defined date/time. ISO 8601 standard\n\namount\\_from: Allows you to return profit and losses based on a minimum profit or loss amount\n\namount\\_to: Allows you to return profit and losses based on a maximum profit or loss amount\n\ncurrency: The currency being purchsed in a conversion.  ISO 4217 standard\n\nscope: Scope allows contacts to search all profit and losses at all account levels. Defaults to own. <br>\n        own: allows to search profit and losses on the main account <br>\n        clients: allows to search profit and losses of account sub accounts <br>\n        all: allows to search balances profit and losses account and sub-accounts\n\n\n**Response**\n\nconversion\\_profit\\_and\\_losses: An array of Conversion Profit and Losses entities.\n\n  account\\_id: account ID that the Conversion belongs to\n\n  contact\\_id: contact ID that the Conversion belongs to\n\n  conversion\\_id: ID of the conversions which was cancelled\n  \n  event\\_type: Type of cancellation\n\n  amount: profit or loss amount\n\n  currency: ISO-4217 three letter profit or loss currency\n\n  notes: notes that were provided as a reason of cancellation\n\n  event\\_date\\_time: Datetime of conversion cancellation event\n  \npagination:Pagination details relevant to the search query\n\n  total\\_entries:Total entries for this search query\n \n  total\\_pages:Total pages for this search query\n  \n  current\\_page:Current page of the search query\n  \n  per\\_page:Amount of search results to return per page\n  \n  previous\\_page:Previous page for this search query\n \n  next\\_page:Next page for this search query\n  \n  order\t:Order of the search returned for this search query\n  \n  order\\_asc\\_desc:Order of results returned e.g. 'asc' or 'desc'\n"
					},
					"response": []
				},
				{
					"name": "Retrieve a Conversion Split Preview",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {},
						"url": {
							"raw": "{{url}}/conversions/{{conversion_id}}/split_preview?amount=100",
							"host": [
								"{{url}}"
							],
							"path": [
								"conversions",
								"{{conversion_id}}",
								"split_preview"
							],
							"query": [
								{
									"key": "amount",
									"value": "100",
									"equals": true
								}
							]
						},
						"description": "**GET /v2/conversions/{id}/split_preview  ** \n   Returns a json structure containing the conversion split preview.\n\n\n**Required Fields**\n\nid: ID of the conversion\n\namount: Sell amount to be split from original conversion\n\n**Response**\n\nparent_conversion: Parent conversion details\n  - id: Parent conversion ID\n  - short_reference: Parent conversion short reference\n  - sell_amount: Parent conversion client sell amount\n  - sell_currency: Parent conversion client sell currency code\n  - buy_amount: Parent conversion client buy amount\n  - buy_currency: Parent conversion client buy currency code\n  - settlement_date: Parent conversion settlement date\n  - conversion_date: Parent conversion delivery date\n  - status: Order status, mapped according to APIv2 rules  \n\nchild_conversion: Child conversion details\n  - id: null, since it is a preview call\n  - short_reference: Child conversion short reference\n  - sell_amount: Child conversion client sell amount\n  - sell_currency: Child conversion client sell currency code\n  - buy_amount: Child conversion client buy amount\n  - buy_currency: Child conversion client buy currency code\n  - settlement_date: Child conversion settlement date\n  - conversion_date: Child conversion delivery date\n  - status: Order status, mapped according to APIv2 rules"
					},
					"response": []
				},
				{
					"name": "Split Conversion",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "amount",
									"value": "100",
									"description": "",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/conversions/{{conversion_id}}/split",
							"host": [
								"{{url}}"
							],
							"path": [
								"conversions",
								"{{conversion_id}}",
								"split"
							]
						},
						"description": "**POST /v2/conversions/{id}/split  ** \n   Execute conversion split and returns a json structure containing split results.\n\n\n**Required Fields**\n\nid: ID of the conversion\n\namount: Sell amount to be split from original conversion\n\n**Response**\n\nparent_conversion: Parent conversion details\n  - id: Parent conversion ID\n  - short_reference: Parent conversion short reference\n  - sell_amount: Parent conversion client sell amount\n  - sell_currency: Parent conversion client sell currency code\n  - buy_amount: Parent conversion client buy amount\n  - buy_currency: Parent conversion client buy currency code\n  - settlement_date: Parent conversion settlement date\n  - conversion_date: Parent conversion delivery date\n  - status: Order status, mapped according to APIv2 rules  \n\nchild_conversion: Child conversion details\n  - id: Child conversion ID\n  - short_reference: Child conversion short reference\n  - sell_amount: Child conversion client sell amount\n  - sell_currency: Child conversion client sell currency code\n  - buy_amount: Child conversion client buy amount\n  - buy_currency: Child conversion client buy currency code\n  - settlement_date: Child conversion settlement date\n  - conversion_date: Child conversion delivery date\n  - status: Order status, mapped according to APIv2 rules"
					},
					"response": []
				},
				{
					"name": "Retrieve a Conversion Split History",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {},
						"url": {
							"raw": "{{url}}/conversions/{{conversion_id}}/split_history",
							"host": [
								"{{url}}"
							],
							"path": [
								"conversions",
								"{{conversion_id}}",
								"split_history"
							]
						},
						"description": "**GET /v2/conversions/{id}/split_history  ** \n   Returns a json structure containing the conversion split history.\n\n\n**Required Fields**\n\nid: ID of the conversion\n\n**Response**\n\nparent_conversion: Parent conversion details\n  - id: Parent conversion ID\n  - short_reference: Parent conversion short reference\n  - sell_amount: Parent conversion client sell amount\n  - sell_currency: Parent conversion client sell currency code\n  - buy_amount: Parent conversion client buy amount\n  - buy_currency: Parent conversion client buy currency code\n  - settlement_date: Parent conversion settlement date\n  - conversion_date: Parent conversion delivery date\n  - status: Order status, mapped according to APIv2 rules \n  \norigin_conversion: Origin conversion details\n  - id: Origin conversion ID\n  - short_reference: Origin conversion short reference\n  - sell_amount: Origin conversion client sell amount\n  - sell_currency: Origin conversion client sell currency code\n  - buy_amount: Origin conversion client buy amount\n  - buy_currency: Origin conversion client buy currency code\n  - settlement_date: Origin conversion settlement date\n  - conversion_date: Origin conversion delivery date\n  - status: Order status, mapped according to APIv2 rules    \n  \nchild_conversions: Array of child conversions\n  - id: Child conversion ID\n  - short_reference: Child conversion short reference\n  - sell_amount: Child conversion client sell amount\n  - sell_currency: Child conversion client sell currency code\n  - buy_amount: Child conversion client buy amount\n  - buy_currency: Child conversion client buy currency code\n  - settlement_date: Child conversion settlement date\n  - conversion_date: Child conversion delivery date\n  - status: Order status, mapped according to APIv2 rules"
					},
					"response": []
				}
			]
		},
		{
			"name": "Payers",
			"item": [
				{
					"name": "Retrieve a Payer",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/payers/{id}",
							"host": [
								"{{url}}"
							],
							"path": [
								"payers",
								"{id}"
							]
						},
						"description": "**GET /v2/payers/{id}**\nReturns a hash containing the details of the requested payer.\n\n\n**Required Fields**\n\nid:Unique ID of payer\n\n**Optional Fields**\n\non\\_behalf\\_of: ID of contact\n\n**Response**\n\nid:Payer unique ID\n\nlegal\\_entity\\_type:Legal Entity type\n\ncompany\\_name:Company name - if\nlegal_entity_type is 'company'\n\nfirst\\_name:First name - if legal_entity_type is 'individual'\n\nlast\\_name:Last name - if legal_entity_type is 'individual'\n\naddress:Address\n\ncity:City\n\nstate\\_or\\_province:State or Province if applicable\n\ncountry:ISO 3166-1 two-letter country code\n\npostcode:Postcode\n\ndate\\_of\\_birth:Date of Birth. If the legal_entity_type is 'company', the field will represent the company's creation date\n\nidentification\\_type: name of ID type\n\nidentification\\_value: ID value\n\ncreated\\_at:Datetime of when the Payer was created\n\nupdated\\_at:Datetime of when the Payer was last updated\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "Payments",
			"item": [
				{
					"name": "Retrieve a Payment",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/payments/008e538a-aeaf-4bf1-90eb-17a79c290867",
							"host": [
								"{{url}}"
							],
							"path": [
								"payments",
								"008e538a-aeaf-4bf1-90eb-17a79c290867"
							]
						},
						"description": "**GET /v2/payments/{id}**\nReturns a hash containing the details of the requested payment.\n\n\n**Required Fields**\n\nid:Unique ID of payment\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact id\n\n**Response**\n\nId:Payment unique ID\n\nPayer\\_id:Unique payer ID\n\namount:Amount of Payment to 2dp\n\nbeneficiary\\_id:ID of the beneficiary\n\ncurrency:3 character ISO 4217 currency code\n\nconversion\\_id:Conversion unique ID\nreference:Reference\n\npayment\\_type:Can be standard or local\n\npayment\\_date:ISO 8601 Date when the payment should be paid\n\nreason\t:Reason for payment\n\nstatus:Status of the payment\n\ntransferred\\_at:ISO 8601 Date when the Payment was sent\n\nauthorisation\\_steps\\_required:Number of authorisation steps required\n\ncreator\\_contact\\_id\t:ID of the contact\n\nlast\\_updater\\_contact\\_id:ID of the contact\n\nshort\\_reference:transfer ID of the payment\n\nfailure\\_reason:Reason for the failure\n\ncreated\\_at:Datetime of when the Payment was created\n\nupdated\\_at:Datetime of when the Payment was last updated\n"
					},
					"response": []
				},
				{
					"name": "Update a Payment",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "id",
									"value": "073e6d71-b753-46f9-9cb0-250324a2e63a",
									"type": "text"
								},
								{
									"key": "currency",
									"value": "USD",
									"type": "text"
								},
								{
									"key": "beneficiary_id",
									"value": "3f45396b-c61c-44ed-bc36-658505e968f1",
									"type": "text"
								},
								{
									"key": "amount",
									"value": "78.13",
									"type": "text"
								},
								{
									"key": "reason",
									"value": "Testing",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/payments/073e6d71-b753-46f9-9cb0-250324a2e63a",
							"host": [
								"{{url}}"
							],
							"path": [
								"payments",
								"073e6d71-b753-46f9-9cb0-250324a2e63a"
							]
						},
						"description": "**POST /v2/payments/{id}**\nEdits a prevoiusly created payment and returns a hash containing the details of the edited payment.\n\n\n**Required Fields**\n\nId:Unique ID of payment\n\nCurrency:3 character ISO 4217 currency code\n\nBeneficiary\\_id\t:Unique ID of beneficiary\n\namount:Amount of Payment to 2dp\n\nreason\t:Reason for payment\n\n**Optional Fields**\n\nPayment\\_date:ISO 8601 Date when the payment should be paid\n\nPayment\\_type:Can be priority or regular\n\nReference:Reference\n\nconversion\\_id:Conversion unique ID\n\npayer\\_entity\\_type:Type of payer - can be individual or company\n\npayer\\_company\\_name:Payer company name\n\npayer\\_first\\_name:Payer first name\n\npayer\\_last\\_name:Payer second name\n\npayer\\_city:Payer city\n\npayer\\_postcode:Payer postcode\n\npayer\\_state\\_or\\_province:Payer state or province\n\npayer\\_date\\_of\\_birth:Payer date of birth(company creation date when payer\\_entity\\_type is company)\n\npayer\\_identification\\_type: name of ID type\n\npayer\\_identification\\_value: ID type value\n\non\\_behalf\\_of: contact ID\n\n**Response**\n\nid:Payment unique ID\n\npayer\\_id:Unique payer ID\n\namount:Amount of Payment to 2dp\n\nbeneficiary\\_id\t:ID of the beneficiary\n\ncurrency:3 character ISO 4217 currency code\n\nconversion\\_id:Conversion unique ID\n\nreference:Reference\n\npayment\\_type:Can be standard or local\n\npayment\\_date:ISO 8601 Date when the payment should be paid\n\nreason:Reason for payment\n\nstatus:Status of the payment\n\ntransferred\\_at:ISO 8601 Date when the Payment was sent\n\nauthorisation\\_steps\\_required:Number of authorisation steps required\n\ncreator\\_contact\\_id:ID of the contact\n\nlast\\_updater\\_contact\\_id:ID of the contact\n\nshort\\_reference:transfer ID of the payment\n\nfailure\\_reason:Reason for the failure\n\ncreated\\_at:Datetime of when the Payment was created\n\nupdated\\_at:Datetime of when the Payment was last updated\n\n\n"
					},
					"response": []
				},
				{
					"name": "Create a Payment",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "currency",
									"value": "USD",
									"type": "text"
								},
								{
									"key": "beneficiary_id",
									"value": "3f45396b-c61c-44ed-bc36-658505e968f1",
									"type": "text"
								},
								{
									"key": "amount",
									"value": "78.13",
									"type": "text"
								},
								{
									"key": "reason",
									"value": "Testing",
									"type": "text"
								},
								{
									"key": "reference",
									"value": "Testing reference",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/payments/create",
							"host": [
								"{{url}}"
							],
							"path": [
								"payments",
								"create"
							]
						},
						"description": "**POST /v2/payments/create**\nCreates a new payment and returns a hash containing the details of the created payment.\n\n\n**Required Fields**\n\ncurrency:3 character ISO 4217 currency code\n\nbeneficiary\\_id:Unique ID of beneficiary\n\namount:Amount of Payment to 2dp\n\nreason:Reason for payment\n\nreference:Reference\n\n**Optional Fields**\n\nPayment\\_date:ISO 8601 Date when the payment should be paid\n\nPayment\\_type:Can be priority or regular\n\nconversion\\_id:Conversion unique ID\n\npayer\\_entity\\_type:Type of payer - can be individual or company\n\npayer\\_company\\_name:Payer company name\n\npayer\\_first\\_name:Payer first name\n\npayer\\_last\\_name:Payer second name\n\npayer\\_city:Payer city\n\npayer\\_postcode:Payer postcode\n\npayer\\_state\\_or\\_province:Payer state or province\n\npayer\\_date\\_of\\_birth:Payer date of birth(company creation date when payer\\_entity\\_type is company)\n\nidentification\\_type: name of ID type\n\nidentification\\_value: ID value\n\non\\_behalf\\_of: contact ID\n\n**Response**\n\nid:Payment unique ID\n\npayer\\_id:Unique payer ID\n\namount:Amount of Payment to 2dp\n\nbeneficiary\\_id\t:ID of the beneficiary\n\ncurrency:3 character ISO 4217 currency code\n\nconversion\\_id:Conversion unique ID\n\nreference:Reference\n\npayment\\_type:Can be standard or local\n\npayment\\_date:ISO 8601 Date when the payment should be paid\n\nreason:Reason for payment\n\nstatus:Status of the payment\n\ntransferred\\_at:ISO 8601 Date when the Payment was sent\n\nauthorisation\\_steps\\_required:Number of authorisation steps required\n\ncreator\\_contact\\_id:ID of the contact\n\nlast\\_updater\\_contact\\_id:ID of the contact\n\nshort\\_reference:transfer ID of the payment\n\nfailure\\_reason:Reason for the failure\n\ncreated\\_at:Datetime of when the Payment was created\n\nupdated\\_at:Datetime of when the Payment was last updated\n\n"
					},
					"response": []
				},
				{
					"name": "Authorise a Payment",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/payments/{{id}}/authorise",
							"host": [
								"{{url}}"
							],
							"path": [
								"payments",
								"{{id}}",
								"authorise"
							]
						},
						"description": "**POST /v2/payments/{id}/authorise** \n  Authorise a payment and returns a json structure containing the details of the authorisation object.\n\n\n**Required Fields**\n\nid:Unique ID of payment\n\n**Response**\n\nauthorisation\\_id:Payment Authorisation unique ID\n\npayment\\_id:ID of the payment\n\nauthoriser\\_id:contact ID of the authoriser\n\nstatus:status of the authorisation - valid/invalid\n\ncreated\\_at:Datetime of when the Payment was created\n\nupdated\\_at:Datetime of when the Payment was last updated\n"
					},
					"response": []
				},
				{
					"name": "Find a Payment",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/payments/find",
							"host": [
								"{{url}}"
							],
							"path": [
								"payments",
								"find"
							]
						},
						"description": "**GET /v2/payments/find** \n  Returns an Array of Payment objects matching the search criteria.\n\n**Optional Fields**\n\nshort\\_reference: shortened reference\n\nCurrency:3 character ISO 4217 currency code\n\nAmount:Amount of Payment to 2dp\n\nAmount\\_from:Amount of Payment to 2dp\n\nAmount\\_to:\tAmount of Payment to 2dp\n\nStatus:Status of the payment\n\nReason:Reason for payment\n\nPayment\\_date\\_from:ISO 8601 Date when the payment should be paid\n\nPayment\\_date\\_to:ISO 8601 Date when the payment should be paid\n\nTransferred\\_at\\_from:ISO 8601 Datetime when the payment should be transfered\n\nTransferred\\_at\\_to:ISO 8601 Datetime when the payment should be transfered\n\nCreated\\_at\\_from:ISO 8601 Datetime when the payment was created\n\nCreated\\_at\\_to:ISO 8601 Datetime when the payment was created\n\nUpdated\\_at\\_from:ISO 8601 Datetime when the payment was updated\n\nUpdated\\_at\\_to:ISO 8601 Datetime when the payment was updated\n\nBeneficiary\\_id:ID of the beneficiary\n\nConversion\\_id:Conversion unique ID\n\npage\tWhich page to show\n\nper\\_page:Maximum number of entries to return\n\norder:The field to order entries by\n\norder\\_asc\\_desc\tWhether the order is ascending (asc) or descending (desc)\n\non\\_behalf\\_of: contact ID\n\n**Response**\n\n  Payments:An array of Payment objects\n  \n  Id:Payment unique ID\n  \n  Amount:Amount of Payment to 2dp\n  \n  Beneficiary\\_id:ID of the beneficiary\n  \n  currency:3 character ISO 4217 currency code\n  \n  conversion\\_id:Conversion unique ID\n  \n  reference:Reference\n  \n  payment\\_type:Can be standard or local\n  \n   payment\\_date:ISO 8601 Date when the payment should be paid\n   \n   reason:Reason for payment\n   \n   status:Status of the payment\n   \n   transferred\\_at:ISO 8601 Date when the Payment was sent\n   \n   authorisation\\_steps\\_required:Number of authorisation steps required\n   \n   creator\\_contact\\_id:ID of the contact\n   \n   last\\_updater\\_contact\\_id:ID of the contact\n   \n   short\\_reference:transfer ID of the payment\n   \n   failure\\_reason:Reason for the failure\n   \n   payer\\_id:Unique payer id\n   \n   created\\_at:Datetime of when the Payment was created\n   \n   updated\\_at:Datetime of when the Payment was last updated\n   \npagination:Pagination details relevant to the search query\n\n  total\\_entries:Total entries for this search query\n  \n  total\\_pages:Total pages for this search query\n  \n  current\\_page:The current page of the search query\n  \n  per\\_page:The amount of search results to return per page\n  \n  previous\\_page:The previous page for this search query\n  \n  next\\_page:The next page for this search query\n  \n  order:The order of the search returned for this search query\n  \n  order\\_asc\\_desc:The order of results returned e.g. 'asc' or 'desc'\n\n"
					},
					"response": []
				},
				{
					"name": "Retrieve Payment Authorisations",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/payments/1e99053f-50f7-4861-9c31-4014b2f37144/authorisations",
							"host": [
								"{{url}}"
							],
							"path": [
								"payments",
								"1e99053f-50f7-4861-9c31-4014b2f37144",
								"authorisations"
							]
						},
						"description": "**GET /v2/payments/{id}/authorisations** \n  Returns an Array of Payment Authorisation objects.\n\n\n**Required Fields**\n\nid:Unique ID of payment\n\n**Optional Fields**\n\nPage:Which page to show\n\nPer\\_pag:Maximum number of entries to return\n\norder:The field to order entries by\n\norder\\_asc\\_desc:Whether the order is ascending (asc) or descending (desc\n\n\n**Response**\n\nAuthorisations:An array of Payment Authorisation objects\n\n Authorisation\\_id: Payment Authorisation unique ID\n \n  Payment\\_id\t:ID of the payment\n  \n  Authoriser\\_id:contact ID of the authoriser\n  \n Status: status of the authorisation-valid\\/invalid\n \ncreated\\_at:ISO 8601 Date when the Payment Authorisation was created\n  \nupdated\\_at:ISO 8601 Date when the Payment Authorisation was updated\n  \ncreated\\_at:Datetime of when the Payment was created\n\nupdated\\_at:Datetime of when the Payment was last updated\n \npagination:Pagination details relevant to the search query\n\ntotal\\_entries:Total entries for this search query\n\ntotal\\_pages:Total pages for this search query\n\ncurrent\\_page:The current page of the search query\n\nper\\_page:The amount of search results to return per page\n\nprevious\\_page:The previous page for this search query\n\nnext\\_page:The next page for this search query\n\norder:The order of the search returned for this search query\n\norder\\_asc\\_desc:The order of results returned e.g. 'asc' or 'desc'\n\n"
					},
					"response": []
				},
				{
					"name": "Delete a Payment",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/payments/89786f57-1c16-4b6e-8874-ae853d0ad0c7/delete",
							"host": [
								"{{url}}"
							],
							"path": [
								"payments",
								"89786f57-1c16-4b6e-8874-ae853d0ad0c7",
								"delete"
							]
						},
						"description": "**POST /v2/payments/{id}/delete ** \n   Delete a prevoiusly created payment and returns a hash containing the details of the deleted payment.\n\n\n**Required Fields**\n\nid:Unique ID of payment\n\n**Optional Fields**\n\non\\_behalf\\_of: contact ID\n\n**Response**\n\nId:Payment unique ID\n\nPayer\\_id:Unique payer ID\n\nAmount:Amount of Payment to 2dp\n\nBeneficiary\\_id:ID of the beneficiary\n\nCurrency:3 character ISO 4217 currency code\n\nConversion\\_id:Conversion unique ID\n\nReference:Reference\n\nPayment\\_type:Can be standard or local\n\nPayment\\_date:ISO 8601 Date when the payment should be paid\n\nreason\t:Reason for payment\n\nstatus:Status of the payment\n\ntransferred\\_at:ISO 8601 Date when the Payment was sent\n\nauthorisation\\_steps\\_required:Number of authorisation steps required\n\ncreator\\_contact\\_id:ID of the contact\n\nlast\\_updater\\_contact\\_id:ID of the contact\n\nshort\\_reference:transfer ID of the payment\n\nfailure\\_reason:Reason for the failure\n\ncreated\\_at:Datetime of when the Payment was created\n\nupdated\\_at:Datetime of when the Payment was last updated\n\n\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "Rates",
			"item": [
				{
					"name": "Retrieve Multiple Rates",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/rates/find?currency_pair=EURGBP",
							"host": [
								"{{url}}"
							],
							"path": [
								"rates",
								"find"
							],
							"query": [
								{
									"key": "currency_pair",
									"value": "EURGBP"
								}
							]
						},
						"description": "**GET /v2/rates/find** - Returns core rate for multiple currency pairs in a single API call\n\n**Required Fields**\n\ncurrency\\_pair - Currency pair eg. EURUSD,GBPZAR\n\n**Optional Fields**\n\non\\_behalf\\_of - Contact ID of the client\n\nignore\\_invalid\\_pairs - Ignore invalid pairings\n\n**Response**\n\nrates\n\nunavailable - All currencies that are currently unavailable"
					},
					"response": []
				},
				{
					"name": "Detailed Rates",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/rates/detailed?buy_currency=USD&sell_currency=NOK&fixed_side=buy&amount=10000",
							"host": [
								"{{url}}"
							],
							"path": [
								"rates",
								"detailed"
							],
							"query": [
								{
									"key": "buy_currency",
									"value": "USD"
								},
								{
									"key": "sell_currency",
									"value": "NOK"
								},
								{
									"key": "fixed_side",
									"value": "buy"
								},
								{
									"key": "amount",
									"value": "10000"
								}
							]
						},
						"description": "**GET /v2/rates/detailed - Returns rate for the client**\n\n**Required Fields**\n\nbuy\\_currency - Currency you are converting to\n\nsell\\_currency - Currency you are converting from\n\nfixed\\_side - The currency that the amount applies to, either buy or sell\n\namount - The amount to 2 decimal places\n\n**Optional Fields**\n\nconversion\\_date - The date you want the bought currency\n\non\\_behalf\\_of - Contact ID of the client\n\n**Response**\n\nsettlement\\_cut\\_off\\_time\n\ncurrency\\_pair\n\nclient\\_buy\\_currency\n\nclient\\_sell\\_currency\n\nclient\\_buy\\_amount\n\nclient\\_sell\\_amount\n\nfixed\\_side\n\nmid\\_market\\_rate\n\nclient\\_rate\n\npartner\\_rate\n\ncore\\_rate\n\ndeposit\\_required\n\ndeposit\\_amount\n\ndeposit\\_currency\n\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "Reference",
			"item": [
				{
					"name": "Conversion Dates",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/reference/conversion_dates?conversion_pair=EURGBP",
							"host": [
								"{{url}}"
							],
							"path": [
								"reference",
								"conversion_dates"
							],
							"query": [
								{
									"key": "conversion_pair",
									"value": "EURGBP"
								}
							]
						},
						"description": "**GET /v2/reference/conversion\\_dates** - Returns a dates for which dates this currency pair can not be traded\n\n**Required Fields**\n\nconversion\\_pair: The conversion pair to get delivery dates for e.g. USDGBP, EURMXN\n\n**Optional Fields**\n\nstart\\_date: An ISO 8601 date time from where to calculate conversion dates from\n\n**Response**\n\ninvalid\\_conversion\\_dates: A list of dates and reasons why a conversion can not occur\n\nfirst\\_conversion\\_date: The first delivery date that a conversion can be executed on\n\ndefault\\_conversion\\_date: The default delivery date that a conversion can be executed on."
					},
					"response": []
				},
				{
					"name": "Available Currencies",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/reference/currencies",
							"host": [
								"{{url}}"
							],
							"path": [
								"reference",
								"currencies"
							]
						},
						"description": "**GET /v2/reference/currencies** - Returns a list of all the currencies that are tradeable\n\n**Response**\n\ncurrencies\n\n- code: The ISO4217 code that identifies the currency\n\n- decimal\\_places: The number of decimal places for a subunit of the currency\n\n- name: The name of the currency"
					},
					"response": []
				},
				{
					"name": "Settlement Accounts",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/reference/settlement_accounts?currency=USD",
							"host": [
								"{{url}}"
							],
							"path": [
								"reference",
								"settlement_accounts"
							],
							"query": [
								{
									"key": "currency",
									"value": "USD"
								}
							]
						},
						"description": "**GET /v2/reference/settlement\\_accounts** - Returns settlement account information, detailing where funds need to be sent to\n\n**Optional Fields**\n\ncurrency - The 3 character ISO 4217 currency code of a specific settlement account\n\n**Response**\n\nsettlement\\_accounts: An array of Settlement Account objects\n\n  - bank\\_account\\_holder\\_name: Name of the bank account holder\n\n  - beneficiary\\_address: Address of the beneficiary\n\n  - beneficiary\\_country: Country\n\n  - bank\\_name: Bank name\n\n  - bank\\_address: Bank address\n\n  - bank\\_country: Bank country\n\n  - currency: 3 character ISO 4217 currency code\n\n  - bic\\_swift: BIC/SWIFT code\n\n  - iban: International bank account number\n\n  - account\\_number: Account number\n\n  - routing\\_code\\_type\\_1: A routing code that identifies the bank account, often used for local payments\n\n  - routing\\_code\\_value\\_1: Routing code value 1\n\n  - routing\\_code\\_type\\_2: A routing code that identifies the bank account, often used for local payments\n\n  - routing\\_code\\_value\\_2: Routing code value 2"
					},
					"response": []
				},
				{
					"name": "Beneficiary Required Details",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/reference/beneficiary_required_details?currency=USD&bank_account_country=US",
							"host": [
								"{{url}}"
							],
							"path": [
								"reference",
								"beneficiary_required_details"
							],
							"query": [
								{
									"key": "currency",
									"value": "USD"
								},
								{
									"key": "bank_account_country",
									"value": "US"
								}
							]
						},
						"description": "**GET /v2/reference/beneficiary\\_required\\_details** - Returns required beneficiary details and their basic validation formats\n\n**Optional Fields**\n\ncurrency - The 3 character ISO 4217 currency code of the beneficiary's bank account\n\nbank\\_account\\_country - A two-letter country code as defined in ISO 3166-1\n\nbeneficiary_country - The two letter contry code for the beneficiary\n\n**Response**\n\ndetails - An array of fields that are required\n\npayment\\_type - Payment type that is supported by current beneficiary. Can be priority or regular."
					},
					"response": []
				}
			]
		},
		{
			"name": "Settlements",
			"item": [
				{
					"name": "Create a Settlement",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/settlements/create",
							"host": [
								"{{url}}"
							],
							"path": [
								"settlements",
								"create"
							]
						},
						"description": "**POST /v2/settlements/create**\nCreates a new settlement and returns the settlement object\n\n**Required Fields**\n\n--\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n\n**Response**\n\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: conversion type\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released"
					},
					"response": []
				},
				{
					"name": "Release a settlement",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/settlements/c0696d4b-2e85-4fb9-b86f-5d3d405df191/release",
							"host": [
								"{{url}}"
							],
							"path": [
								"settlements",
								"c0696d4b-2e85-4fb9-b86f-5d3d405df191",
								"release"
							]
						},
						"description": "** POST /v2/settlements/{id}/release **\n  Move the Settlement to state 'released', meaning it is ready to be processed.\n\n**Required Fields**\n\nid - Settlement ID\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n**Response**\n\nid:Settlement unique ID\n\nshort_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: settlement type\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n"
					},
					"response": []
				},
				{
					"name": "Retrieve a Settlement",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/settlements/",
							"host": [
								"{{url}}"
							],
							"path": [
								"settlements",
								""
							]
						},
						"description": "**GET /v2/settlements/{id}**\nReturns a Settlement object for the requested ID.\n\n**Required Fields**\n\nid:Settlement ID\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n"
					},
					"response": []
				},
				{
					"name": "Unrelease a Settlement",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/settlements/c0696d4b-2e85-4fb9-b86f-5d3d405df191/unrelease",
							"host": [
								"{{url}}"
							],
							"path": [
								"settlements",
								"c0696d4b-2e85-4fb9-b86f-5d3d405df191",
								"unrelease"
							]
						},
						"description": "**POST /v2/settlements/{id}/unrelease**\nMove the Settlement back to state 'open', allowing Conversions to be added or removed\n\n\n**Required Fields**\n\nid:Settlement ID\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: settlement type\n\nonversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n\n"
					},
					"response": []
				},
				{
					"name": "Add a Conversion to Settlement",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/settlements/{id}/add_conversion",
							"host": [
								"{{url}}"
							],
							"path": [
								"settlements",
								"{id}",
								"add_conversion"
							]
						},
						"description": "**POST /v2/settlements/{id}/add_conversion**\nAdd a Conversion to an open Settlement. Returns the updated Settlement object.\n\n**Required Fields**\n\nid:Settlement ID\n\nconversion_id:ID of the conversion\n\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: type of settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n\n"
					},
					"response": []
				},
				{
					"name": "Remove a Conversion from a Settlement",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/settlements/c0696d4b-2e85-4fb9-b86f-5d3d405df191/remove_conversion",
							"host": [
								"{{url}}"
							],
							"path": [
								"settlements",
								"c0696d4b-2e85-4fb9-b86f-5d3d405df191",
								"remove_conversion"
							]
						},
						"description": "**POST /v2/settlements/{id}/remove_conversion**\nRemove a Conversion from an open Settlement. Returns the updated Settlement object.\n\n**Required Fields**\n\nid:Settlement ID\n\nconversion_id:ID of the conversion\n\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: type of settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n"
					},
					"response": []
				},
				{
					"name": "Delete a Settlement",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/settlements/{{id}}/delete",
							"host": [
								"{{url}}"
							],
							"path": [
								"settlements",
								"{{id}}",
								"delete"
							]
						},
						"description": "**POST /v2/settlements/{id}/delete**\nDeletes an open Settlement and returns the Settlement object in its final state.\n\n\n**Required Fields**\n\nid:Settlement ID\n\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: settlement type\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n"
					},
					"response": []
				},
				{
					"name": "Find Settlements",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/settlements/find",
							"host": [
								"{{url}}"
							],
							"path": [
								"settlements",
								"find"
							]
						},
						"description": "**GET /v2/settlements/find**\nReturns an array of Settlement objects for the given search criteria\n\n**Required Fields**\n\n--\n\n\n\n**Optional Fields**\n\nshort_reference:Unique human readable identifier\n\nstatus:The current status of the settlement\n\ncreated\\_at\\_from:ISO 8601 Datetime when the settlement was created\n\ncreated\\_at\\_to:ISO 8601 Datetime when the settlement was created\n\nupdated\\_at\\_from:ISO 8601 Datetime when the settlement was updated\n\nupdated\\_at\\_to:ISO 8601 Datetime when the settlement was updated\n\nreleased\\_at\\_from:ISO 8601 Datetime when the settlement was updated\n\nreleased\\_at\\_to:ISO 8601 Datetime when the settlement was updated\n\npage:Which page to show\n\nper\\_page:Maximum number of entries to return\n\norder:The field to order entries by\n\norder\\_asc\\_desc:Whether the order is ascending (asc) or descending (desc)\n\non_behalf\\_of:Contact ID of the client\n\n\n**Response**\n\nsettlements:An array of Settlement objects\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: settlement type\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n\npagination:Pagination details relevant to the search query\n\ntotal\\_entries:Total entries for this search query\n\ntotal\\_pages:Total pages for this search query\n\ncurrent\\_page:The current page of the search query\n\nper\\_page:The amount of search results to return per page\n\nprevious\\_page:\tThe previous page for this search query\n\nnext\\_page:The next page for this search query\n\norder:The order of the search returned for this search query\n\norder\\_asc\\_desc:The order of results returned e.g. 'asc' or 'desc'"
					},
					"response": []
				}
			]
		},
		{
			"name": "Signups",
			"item": [
				{
					"name": "Create Signup",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": ""
						},
						"url": {
							"raw": "{{url}}/signups/create?first_name=Fitz&last_name=Bloggs&company_name=Fitz Industries&reason=Need to pay clients&email_address=fitz2@example.com&type=api",
							"host": [
								"{{url}}"
							],
							"path": [
								"signups",
								"create"
							],
							"query": [
								{
									"key": "first_name",
									"value": "Fitz"
								},
								{
									"key": "last_name",
									"value": "Bloggs"
								},
								{
									"key": "company_name",
									"value": "Fitz Industries"
								},
								{
									"key": "reason",
									"value": "Need to pay clients"
								},
								{
									"key": "email_address",
									"value": "fitz2@example.com"
								},
								{
									"key": "type",
									"value": "api"
								}
							]
						},
						"description": "**POST /v2/signups/create** - Creates a new account & contact and returns a user signup request.\n\n**Required Fields**\n\nemail\\_address: Email address\n\n**Optional Fields**\n\nfirst\\_name: First name\n\nlast\\_name: Last name\n\ncompany\\_name: Company name\n\nreason: Reason for registering\n\ntype: Type of request\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "Transactions",
			"item": [
				{
					"name": "Retrieve a Transaction",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "api_key",
									"value": "{{api_key}}",
									"type": "text"
								},
								{
									"key": "login_id",
									"value": "{{login_id}}",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/transactions/123455",
							"host": [
								"{{url}}"
							],
							"path": [
								"transactions",
								"123455"
							]
						},
						"description": "**GET /v2/transactions/{id}** - Find the details of a specific transaction\n\n**Required Fields**\n\t\nid: Transaction ID\n\n**Optional Fields**\n\non\\_behalf\\_of: ID of contact\n\n**Response**\n\t\nid: Unique ID\n\nbalance\\_id: Unique ID of related Balance\n\naccount\\_id: Unique ID of related Account\n\ncurrency: 3 character ISO 4217 currency code\n\namount: Absolute Amount of the transaction to 2dp\n\nbalance\\_amount: Amount of the Balance at the time of the transaction - will be null for 'pending' transactions.\n\ntype: 'credit' or 'debit'\n\naction: The action that caused the transaction to be created - funding, conversion, payment, payment\\_failure, manual\\_intervention\n\nrelated\\_entity\\_type: Related Object type that created the transaction - conversion, payment or inbound\\_funds\n\nrelated\\_entity\\_id: Unique ID of the related Object that created the transaction\n\nrelated\\_entity\\_short\\_reference: shortened reference\n\nstatus: Current status of transactions - pending, processing, completed, deleted.\n\nreason: Description of transactions - free form text\n\nsettles\\_at: ISO 8601 Date when the transaction is expected to be processed\n\ncreated\\_at: ISO 8601 Date when the transaction was created\n\nupdated\\_at: ISO 8601 Date when the transaction was last updated\n\n"
					},
					"response": []
				},
				{
					"name": "Find Transactions",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "api_key",
									"value": "{{api_key}}",
									"type": "text"
								},
								{
									"key": "login_id",
									"value": "{{login_id}}",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/transactions/find",
							"host": [
								"{{url}}"
							],
							"path": [
								"transactions",
								"find"
							]
						},
						"description": "**GET /v2/transactions/find** - Search for transactions that meet a number of criteria and receive a paged response.\n\n**Optional Fields**\n\t\ncurrency: 3 digit ISO 4217 currency code\n\namount: Absolute Amount of the transactions to 2dp\n\namount\\_from: Absolute Amount of the transactions to 2dp\n\namount\\_to: Absolute Amount of the transactions to 2dp\n\naction: The action that caused the transaction to be created - funding, conversion, payment, payment\\_failure, manual\\_intervention\n\nrelated\\_entity\\_type: Related Object type that created the transaction - conversion, payment, inbound\\_funds\n\nrelated\\_entity\\_id: Unique ID of the related Object that created the transaction\n\nrelated\\_entity\\_short\\_reference: shortened reference\n\nstatus: Current status of transactions - pending, processing, completed, deleted. Default to show completed and processing transactions.\n\ntype: Credit or Debit\n\nreason: Description of transactions - free form text\n\nsettles\\_at\\_from: ISO 8601 Date when the transaction is expected to be processed\n\nsettles\\_at\\_to: ISO 8601 Date when the transaction is expected to be processed\n\ncreated\\_at\\_from: ISO 8601 Date when the transaction was created\n\ncreated\\_at\\_to: ISO 8601 Date when the transaction was created\n\nupdated\\_at\\_from: ISO 8601 Date when the transaction was last updated\n\nupdated\\_at\\_to: ISO 8601 Date when the transaction was last updated\n\npage: Which page to show\n\nper\\_page: Maximum number of entries to return\n\norder: The field to order entries by\n\norder\\_asc\\_desc: Whether the order is ascending (asc) or descending (desc)\n\non\\_behalf\\_of: ID of contact\n\n**Response**\n\t\ntransactions: An array of Transaction objects\n\n  - id: Unique ID\n  \n  - balance\\_id: Unique ID of related Balance\n  \n  - account\\_id: Unique ID of related Account\n  \n  - currency: 3 character ISO 4217 currency code\n  \n  - amount: Absolute Amount of the transaction to 2dp\n  \n  - balance\\_amount: Amount of the Balance at the time of the transaction - will be null for 'pending' transactions.\n  \n  - type: 'credit' or 'debit'\n  \n  - action: The action that caused the transaction to be created - funding, conversion, payment, payment\\_failure, manual\\_intervention\n  \n  - related\\_entity\\_type: Related Object type that created the transaction - conversion, payment or inbound\\_funds\n  \n  - related\\_entity\\_id: Unique ID of the related Object that created the transaction\n\n  - related\\_entity\\_short\\_reference: Shortened reference\n\n  - status: Current status of transactions - pending, processing, completed, deleted.\n  \n  - reason: Description of transactions - free form text\n  \n  - settles\\_at: ISO 8601 Date when the transaction is expected to be processed\n  \n  - created\\_at: ISO 8601 Date when the transaction was created\n  \n  - updated\\_at: ISO 8601 Date when the transaction was last updated\n\npagination: Pagination details relevant to the search query\n\n  - total\\_entries: Total entries for this search query\n  \n  - total\\_pages: Total pages for this search query\n  \n  - current\\_page: The current page of the search query\n  \n  - per_page: The amount of search results to return per page\n  \n  - previous\\_page: The previous page for this search query\n  \n  - next\\_page: The next page for this search query\n  \n  - order: The order of the search returned for this search query\n  \n  - order\\_asc\\_desc: The order of results returned e.g. 'asc' or 'desc'\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "Customer Reporting",
			"description": "**/v2/customer_reporting/**\nReporting functionality that allows to generate Payment and Conversion Reports according to provided search options.\nIn addition, it allows to retriewe previously generated reports by ID or by specified search options",
			"item": [
				{
					"name": "Create Conversions Report",
					"event": [
						{
							"listen": "test",
							"script": {
								"type": "text/javascript",
								"exec": [
									"postman.setEnvironmentVariable(\"report_id\", JSON.parse(responseBody).id)"
								]
							}
						}
					],
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "description",
									"value": "Test Conversions Report created in purpose of testing  :)",
									"type": "text"
								},
								{
									"key": "buy_currency",
									"value": "EUR",
									"type": "text",
									"disabled": true
								},
								{
									"key": "sell_currency",
									"value": "USD",
									"type": "text",
									"disabled": true
								},
								{
									"key": "client_buy_amount_from",
									"value": "1.0",
									"type": "text",
									"disabled": true
								},
								{
									"key": "client_buy_amount_to",
									"value": "50000.0",
									"type": "text",
									"disabled": true
								},
								{
									"key": "client_sell_amount_from",
									"value": "1.0",
									"type": "text",
									"disabled": true
								},
								{
									"key": "client_sell_amount_to",
									"value": "50000.0",
									"type": "text",
									"disabled": true
								},
								{
									"key": "scope",
									"value": "all",
									"type": "text",
									"disabled": true
								},
								{
									"key": "created_at_from",
									"value": "2017-11-26T23:59:59+00:00",
									"type": "text",
									"disabled": true
								},
								{
									"key": "created_at_to",
									"value": "2017-11-27T23:59:59+00:00",
									"type": "text",
									"disabled": true
								}
							]
						},
						"url": {
							"raw": "{{url}}/customer_reporting/conversions/create",
							"host": [
								"{{url}}"
							],
							"path": [
								"customer_reporting",
								"conversions",
								"create"
							]
						},
						"description": "**GET /v2/customer_reporting/conversions/create  ** \n   Creates new Conversions Report entity\n\n**Required Fields**\n\n\tNone\n\n**Optional Fields**\n\n\tdescription:Description that will be applied to report\n\t\n\tbuy\\_currency:Conversion buy currency. 3 character ISO 4217 currency code\n\t\n\tsell\\_currency:Conversion sell currency. 3 character ISO 4217 currency code\n\t\n\tclient\\_buy\\_amount\\_from:Client buy amount range start\n\t\n\tclient\\_buy\\_amount\\_to:Client buy amount range end\n\t\n\tclient\\_sell\\_amount\\_from:Client sell amount range start\n\t\n\tclient\\_sell\\_amount\\_to:Client sell amount range end\n\t\n\tpartner\\_buy\\_amount\\_from:Partner buy amount range start\n\t\n\tpartner\\_buy\\_amount\\_to:Partner buy amount range end\n\t\n\tpartner\\_sell\\_amount\\_from:Partner sell amount range start\n\t\n\tpartner\\_sell\\_amount\\_to:Partner sell amount range end\n\t\n\tclient\\_status:The current status of the Conversion\n\t\n\tpartner\\_status:The current status of the Conversion\n\t\n\tconversion\\_date\\_from:Conversion date range start. ISO 8601 Datetime when buy currency was delivered\n\t\n\tconversion\\_date\\_to:Conversion date range end. ISO 8601 Datetime when buy currency was delivered\n\t\n\tsettlement\\_date\\_from:Conversion settlement date range start. ISO 8601 Datetime when the sell_currency was debited\n\t\n\tsettlement\\_date\\_to:Conversion settlement date range end. ISO 8601 Datetime when the sell_currency was debited\n\t\n\tcreated\\_at\\_from:Payment creation date start\n\t\n\tcreated\\_at\\_to:Payment creation date end\n\t\n\tupdated\\_at\\_from:ISO 8601 Start Datetime when the payment was updated\n\t\n\tupdated\\_at\\_to:ISO 8601 End Datetime when the payment was updated\n\n\tunique\\_request\\_id:Payment unique request ID\n\t\n\tscope:Specifies which account level will be used; 'own' is a default value\n\n**Response**\n\tNew Payments Report entity:\n\n\tid:Report unique ID\n\n\tshort\\_reference:Human readable unique ID\n\t\n\tdescription:Text that was provided as a reason of Report generation\n\t\n\tsearch\\_params:The list of options that were provided for filtering of entities that user searching for (payments, conversions, beneficiaries, transactions)\n\t\n\treport\\_type:Type of the Report (payment, conversion, beneficiary or transaction)\n\t\n\tstatus:Status of the Report (processing, completed or expired)\n\t\n\texpiration\\_date:Date when the Report expires\n\t\n\treport\\_url:URL that allows you to download generated report\n\t\n\taccount\\_id:ID of the Account that the Report belongs to\n\t\n\tcontact\\_id:ID of the Contact that the Report belongs to\n\t\n\tcreated\\_at:Datetime of when the Report was created\n\t\n\tupdated\\_at:Datetime of when the Report was last updated"
					},
					"response": []
				},
				{
					"name": "Create Payments Report",
					"event": [
						{
							"listen": "test",
							"script": {
								"type": "text/javascript",
								"exec": [
									"postman.setEnvironmentVariable(\"report_id\", JSON.parse(responseBody).id)"
								]
							}
						}
					],
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "description",
									"value": "Test Conversions Report created in purpose of testing",
									"type": "text"
								},
								{
									"key": "currency",
									"value": "PLN",
									"type": "text",
									"disabled": true
								},
								{
									"key": "amount_from",
									"value": "500.0",
									"type": "text",
									"disabled": true
								},
								{
									"key": "amount_to",
									"value": "11000.0",
									"type": "text",
									"disabled": true
								},
								{
									"key": "scope",
									"value": "all",
									"type": "text"
								},
								{
									"key": "created_at_from",
									"value": "2013-01-01T23:59:59+00:00",
									"type": "text",
									"disabled": true
								},
								{
									"key": "created_at_to",
									"value": "2017-04-20T23:59:59+00:00",
									"type": "text",
									"disabled": true
								},
								{
									"key": "bulk_upload_reference",
									"value": "some_reference",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/customer_reporting/payments/create",
							"host": [
								"{{url}}"
							],
							"path": [
								"customer_reporting",
								"payments",
								"create"
							]
						},
						"description": "**GET /v2/customer_reporting/payments/create  ** \n   Creates new Payments Report entity\n\n**Required Fields**\n\n\tNone\n\n**Optional Fields**\n\n\tdescription:Description that will be applied to report\n\t\n\tcurrency:Payment 3 character ISO 4217 currency code\n\t\n\tamount\\_from:Amount of Payment to 2dp start\n\t\n\tamount\\_to:Amount of Payment to 2dp end\n\t\n\tstatus:Payment status\n\t\n\tpayment\\_date\\_from:Payment date from. ISO 8601 Date when the payment should be paid\n\t\n\tpayment\\_date\\_to:Payment date to. ISO 8601 Date when the payment should be paid\n\t\n\ttransferred\\_at\\_from:ISO 8601 Start Datetime when the payment should be transfered.\n\t\n\ttransferred\\_at\\_to:ISO 8601 End Datetime when the payment should be transfered\n\t\n\tcreated\\_at\\_from:Payment creation date start\n\t\n\tcreated\\_at\\_to:Payment creation date end\n\t\n\tupdated\\_at\\_from:ISO 8601 Start Datetime when the payment was updated\n\t\n\tupdated\\_at\\_to:ISO 8601 End Datetime when the payment was updated\n\t\n\tbeneficiary\\_id:ID of Beneficiary that belongs to Payment\n\t\n\tconversion\\_id:ID of Conversion linked to the Payment\n\t\n\twith\\_deleted:Allows to search deleted Payments\n\t\n\tpayment\\_group\\_id:ID of Payments Group in case Payment belongs to such group\n\t\n\tunique\\_request\\_id:Payment unique request ID\n\t\n\tscope:Specifies which account level will be used; 'own' is a default value\n\n**Response**\n\tNew Payments Report entity:\n\n\tid:Report unique ID\n\n\tshort\\_reference:Human readable unique ID\n\t\n\tdescription:Text that was provided as a reason of Report generation\n\t\n\tsearch\\_params:The list of options that were provided for filtering of entities that user searching for (payments, conversions, beneficiaries, transactions)\n\t\n\treport\\_type:Type of the Report (payment, conversion, beneficiary or transaction)\n\t\n\tstatus:Status of the Report (processing, completed or expired)\n\t\n\texpiration\\_date:Date when the Report expires\n\t\n\treport\\_url:URL that allows you to download generated report\n\t\n\taccount\\_id:ID of the Account that the Report belongs to\n\t\n\tcontact\\_id:ID of the Contact that the Report belongs to\n\t\n\tcreated\\_at:Datetime of when the Report was created\n\t\n\tupdated\\_at:Datetime of when the Report was last updated"
					},
					"response": []
				},
				{
					"name": "Retrive a Report",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "description",
									"value": "Test Conversions Report created in purpose of testing :)",
									"type": "text"
								},
								{
									"key": "buy_currency",
									"value": "GBP",
									"type": "text"
								},
								{
									"key": "sell_currency",
									"value": "EUR",
									"type": "text"
								},
								{
									"key": "client_buy_amount_from",
									"value": "10000.0",
									"type": "text"
								},
								{
									"key": "client_buy_amount_to",
									"value": "100000.0",
									"type": "text"
								},
								{
									"key": "client_sell_amount_from",
									"value": "100.0",
									"type": "text"
								},
								{
									"key": "client_sell_amount_to",
									"value": "10000.0",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/customer_reporting/report_requests/{{report_id}}",
							"host": [
								"{{url}}"
							],
							"path": [
								"customer_reporting",
								"report_requests",
								"{{report_id}}"
							]
						},
						"description": "**GET /v2/customer_reporting/report_requests/{report_id}  ** \n   Returns a json structure containing the details of the requested Report.\n\n**Required Fields**\n\nid:ID of the Report\n\n**Response**\n\nid:Report unique ID\n\nshort\\_reference:Human readable unique ID\n\ndescription:Text that was provided as a reason of Report generation\n\nsearch\\_params:The list of options that were provided for filtering of entities that user searching for (payments, conversions, beneficiaries, transactions)\n\nreport\\_type:Type of the Report (payment, conversion, beneficiary or transaction)\n\nstatus:Status of the Report (processing, completed or expired)\n\nexpiration\\_date:Date when the Report expires\n\nreport\\_url:URL that allows you to download generated report\n\naccount\\_id:ID of the Account that the Report belongs to\n\ncontact\\_id:ID of the Contact that the Report belongs to\n\ncreated\\_at:Datetime of when the Report was created\n\nupdated\\_at:Datetime of when the Report was last updated\n\n\n"
					},
					"response": []
				},
				{
					"name": "Find Report",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "X-AUTH-TOKEN",
								"value": "{{auth_token}}"
							}
						],
						"body": {
							"mode": "formdata",
							"formdata": [
								{
									"key": "description",
									"value": "Test Conversions Report created in purpose of testing :)",
									"type": "text"
								},
								{
									"key": "buy_currency",
									"value": "GBP",
									"type": "text"
								},
								{
									"key": "sell_currency",
									"value": "EUR",
									"type": "text"
								},
								{
									"key": "client_buy_amount_from",
									"value": "10000.0",
									"type": "text"
								},
								{
									"key": "client_buy_amount_to",
									"value": "100000.0",
									"type": "text"
								},
								{
									"key": "client_sell_amount_from",
									"value": "100.0",
									"type": "text"
								},
								{
									"key": "client_sell_amount_to",
									"value": "10000.0",
									"type": "text"
								}
							]
						},
						"url": {
							"raw": "{{url}}/customer_reporting/report_requests/find?status=completed&created_at_from=2017-11-24&order_asc_desc=asc",
							"host": [
								"{{url}}"
							],
							"path": [
								"customer_reporting",
								"report_requests",
								"find"
							],
							"query": [
								{
									"key": "status",
									"value": "completed",
									"equals": true
								},
								{
									"key": "created_at_from",
									"value": "2017-11-24",
									"equals": true
								},
								{
									"key": "order_asc_desc",
									"value": "asc",
									"equals": true
								}
							]
						},
						"description": "**GET /v2/customer_reporting/report_requests/find  ** \n   Return an array, which contains json structures of matched Report Requests.\n\n**Required Fields**\n\n\tNone\n\n**Optional Fields**\n\n\tshort\\_reference:Unique short reference of Report\n\t\n\tdescription:Description of Report\n\t\n\taccount\\_id:ID of the Account that the Report belongs to\n\t\n\tcontact\\_id:ID of the Contact that the Report belongs to\n\t\n\tcreated\\_at\\_from:Report creation date start\n\t\n\tcreated\\_at\\_to:Report creation date end\n\t\n\texpiration\\_date\\_from:Report expiration date from\n\t\n\texpiration\\_date\\_to:Report expiration date to\n\t\n\tstatus:Report status\n\t\n\treport\\_type:Report type\n\n**Response**\n\nconversion\\_profit\\_and\\_losses: An array of Report Request entities.\n\n\tid:Report unique ID\n\n\tshort\\_reference:Human readable unique ID\n\t\n\tdescription:Text that was provided as a reason of Report generation\n\t\n\tsearch\\_params:The list of options that were provided for filtering of entities that user searching for (payments, conversions, beneficiaries, transactions)\n\t\n\treport\\_type:Type of the Report (payment, conversion, beneficiary or transaction)\n\t\n\tstatus:Status of the Report (processing, completed or expired)\n\t\n\texpiration\\_date:Date when the Report expires\n\t\n\treport\\_url:URL that allows you to download generated report\n\t\n\taccount\\_id:ID of the Account that the Report belongs to\n\t\n\tcontact\\_id:ID of the Contact that the Report belongs to\n\t\n\tcreated\\_at:Datetime of when the Report was created\n\t\n\tupdated\\_at:Datetime of when the Report was last updated\n  \npagination:Pagination details relevant to the search query\n\n  total\\_entries:Total entries for this search query\n \n  total\\_pages:Total pages for this search query\n  \n  current\\_page:Current page of the search query\n  \n  per\\_page:Amount of search results to return per page\n  \n  previous\\_page:Previous page for this search query\n \n  next\\_page:Next page for this search query\n  \n  order\t:Order of the search returned for this search query\n  \n  order\\_asc\\_desc:Order of results returned e.g. 'asc' or 'desc'\n"
					},
					"response": []
				}
			]
		}
	]
}