--- title: Retrieve payment accounts slug: docs/demo/retrieve-payment-accounts description: Learn how to use the curl command to make a GET request to a specific endpoint and retrieve payment details for a particular account using a REST API. This step-by-step code example includes the headers needed to accept and send JSON data efficiently. Boo docTags: createdAt: 2022-03-21T20:12:45.000Z --- { "id": "RqDJE1kMZs-fgHwYnyUTN", "data": { "url": "https://api.fictive.com/REST/api/accounts/{accountReference}/payment-details", "name": "Retrieve payment accounts", "method": "GET", "request": { "pathParameters": [ { "kind": "required", "name": "accountReference", "type": "string" } ], "queryParameters": [], "headerParameters": [ { "kind": "optional", "name": "X-TokenId", "type": "string", "description": "The eSuite Token Id" }, { "kind": "optional", "name": "X-SessionId", "type": "string", "description": "The eSuite Session Id" }, { "kind": "required", "name": "X-Version", "type": "string", "description": "The eSuite Version" }, { "kind": "optional", "name": "Origin", "type": "string", "description": "The eSuite Origin" } ], "bodyDataParameters": [], "formDataParameters": [] }, "responses": [ { "schema": [ { "kind": "optional", "type": "object", "schema": [ { "kind": "optional", "name": "cards", "type": "array", "schema": [ { "kind": "optional", "name": "associatedName", "type": "string", "example": "", "description": "Associated name" }, { "kind": "optional", "name": "billingHouseName", "type": "string", "example": "", "description": "Billing house name" }, { "kind": "optional", "name": "billingHouseFlatNumber", "type": "string", "example": "", "description": "Billing house flat number" }, { "kind": "optional", "name": "billingStreet", "type": "string", "example": "", "description": "Billing street" }, { "kind": "optional", "name": "billingDistrict", "type": "string", "example": "", "description": "Billing district" }, { "kind": "optional", "name": "billingTownCity", "type": "string", "example": "", "description": "Billing town city" }, { "kind": "optional", "name": "billingCounty", "type": "string", "example": "", "description": "Billing county" }, { "kind": "optional", "name": "billingPostcode", "type": "string", "example": "", "description": "Billing postcode" }, { "kind": "optional", "name": "billingCountry", "type": "string", "example": "", "description": "Billing country" }, { "kind": "optional", "name": "cardNumber", "type": "string", "example": "", "description": "Card number" }, { "kind": "optional", "name": "cardType", "type": "string", "example": "", "description": "Card type" }, { "kind": "optional", "name": "expiryDate", "type": "string", "example": "", "description": "Expiry date" }, { "kind": "optional", "name": "isDefault", "type": "boolean", "example": "", "description": "Is default" }, { "kind": "optional", "name": "issueCode", "type": "string", "example": "", "description": "Issue code" }, { "kind": "optional", "name": "paymentDetailId", "type": "string", "example": "", "description": "Payment account id" }, { "kind": "optional", "name": "authorised", "type": "boolean", "example": "", "description": "Value that determins if the card has been validated" }, { "kind": "optional", "name": "paymentAccountParameters", "type": "object", "schema": [], "example": {}, "description": "PaymentAccountParameter dictionary for wallet" }, { "kind": "optional", "name": "bin", "type": "string", "example": "", "description": "BIN" }, { "kind": "optional", "name": "pan", "type": "string", "example": "", "description": "PAN (CardReference)" }, { "kind": "optional", "name": "creationDate", "type": "string", "example": "", "description": "CreationDate" }, { "kind": "optional", "name": "cardCategory", "type": "string", "example": "", "description": "CardCategory (Debit/Credit)" }, { "kind": "optional", "name": "issuer", "type": "string", "example": "", "description": "Issuer" }, { "kind": "optional", "name": "cardPurpose", "type": "string", "example": "", "description": "CardPurpose (Business/...)" }, { "kind": "optional", "name": "issuingCountry", "type": "string", "example": "", "description": "IssuingCountry" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.PaymentDetailsCardSummary", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.PaymentDetailsCardSummary[]", "description": "Gets or sets the payment details cards." }, { "kind": "optional", "name": "payPal", "type": "object", "schema": [ { "kind": "optional", "name": "paymentDetailId", "type": "string", "example": "", "description": "Payment details id" }, { "kind": "optional", "name": "billingAgreementId", "type": "string", "example": "", "description": "BillingAgreementId" }, { "kind": "optional", "name": "payPalPayerId", "type": "string", "example": "", "description": "PayPalPayerId" }, { "kind": "optional", "name": "accountCountry", "type": "string", "example": "", "description": "AccountCountry" }, { "kind": "optional", "name": "accountEmail", "type": "string", "example": "", "description": "AccountEmail" }, { "kind": "optional", "name": "accountStatus", "type": "string", "example": "", "description": "AccountStatus" }, { "kind": "optional", "name": "billingAgreementDate", "type": "string", "example": "", "description": "BillingAgreementDate" }, { "kind": "optional", "name": "accountFirstName", "type": "string", "example": "", "description": "AccountFirstName" }, { "kind": "optional", "name": "accountLastName", "type": "string", "example": "", "description": "AccountLastName" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v4.PaymentDetailsPayPal", "customType": "FictiveGlobal.Api.Rest.Dtos.v4.PaymentDetailsPayPal", "description": "Gets or sets the PayPal account info." }, { "kind": "optional", "name": "bacs", "type": "object", "schema": [ { "kind": "optional", "name": "accountHolderName", "type": "string", "example": "", "description": "The account holder name." }, { "kind": "optional", "name": "accountNumber", "type": "string", "example": "", "description": "The account number." }, { "kind": "optional", "name": "sortCode", "type": "string", "example": "", "description": "The account sort code." }, { "kind": "optional", "name": "bacsReference", "type": "string", "example": "", "description": "The bacs mandate reference." }, { "kind": "optional", "name": "serviceReference", "type": "string", "example": "", "description": "The service id." } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.PaymentDetails.BacsDirectDebitPaymentDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.PaymentDetails.BacsDirectDebitPaymentDetails", "description": "Gets or sets the bacs direct debit payment details." }, { "kind": "optional", "name": "sepa", "type": "object", "schema": [ { "kind": "optional", "name": "accountHolderName", "type": "string", "example": "", "description": "Account holder name." }, { "kind": "optional", "name": "iban", "type": "string", "example": "", "description": "The IBAN." }, { "kind": "optional", "name": "bic", "type": "string", "example": "", "description": "The BIC." }, { "kind": "optional", "name": "serviceReference", "type": "string", "example": "", "description": "The service id." }, { "kind": "optional", "name": "mandateReference", "type": "string", "example": "", "description": "The mandate reference." }, { "kind": "optional", "name": "bankCountry", "type": "string", "example": "", "description": "BankCountry" }, { "kind": "optional", "name": "sepaMandateCreationDate", "type": "string", "example": "", "description": "SEPAMandateCreationDate" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.PaymentDetails.SepaDirectDebitPaymentDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.PaymentDetails.SepaDirectDebitPaymentDetails", "description": "Gets or sets the sepa direct debit payment details." } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v4.PaymentAccountDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v4.PaymentAccountDetails", "isExpanded": true, "description": "Payment account details" } ], "isExpanded": true, "statusCode": "200", "description": "OK", "jsonExample": "{\n \"cards\": [\n {\n \"associatedName\": \"Joe Bloggs\",\n \"billingHouseName\": \"\",\n \"billingHouseFlatNumber\": \"100\",\n \"billingStreet\": \"Picadilly Plaza\",\n \"billingTownCity\": \"Manchester\",\n \"billingPostcode\": \"M1 4BT\",\n \"billingCountry\": \"United Kingdom\",\n \"cardNumber\": \"****-****-****-1111\",\n \"cardType\": \"Visa\",\n \"expiryDate\": \"02/23\",\n \"isDefault\": true,\n \"issueCode\": \"123\",\n \"authorised\": false,\n \"paymentAccountParameters\": {\n \"ParameterName\": \"ParameterValue\",\n \"ParameterName2\": \"ParameterValue2\"\n }\n }\n ],\n \"payPal\": {\n \"paymentDetailId\": \"003421\",\n \"accountFirstName\": \"Joe\",\n \"accountLastName\": \"Bloggs\"\n },\n \"bacs\": {\n \"accountHolderName\": \"Joe Bloggs\",\n \"accountNumber\": \"*****111\",\n \"sortCode\": \"00-00-00\",\n \"bacsReference\": \"ADR18203\",\n \"contractReference\": \"0010CW9EZCZDHON6U2\"\n },\n \"sepa\": {\n \"accountHolderName\": \"Joe Bloggs\",\n \"iban\": \"****************678\",\n \"bic\": \"OKOYFIHH\",\n \"contractReference\": \"0010C5FGWLQBI93RL0\",\n \"mandateReference\": \"12345FVDDCF\",\n \"bankCountry\": \"GB\",\n \"sepaMandateCreationDate\": \"2021-09-21T00:00:00+00:00\"\n }\n}" }, { "schema": [ { "kind": "optional", "type": "object", "schema": [ { "kind": "optional", "name": "cards", "type": "array", "schema": [ { "kind": "optional", "name": "associatedName", "type": "string", "example": "", "description": "Associated name" }, { "kind": "optional", "name": "billingHouseName", "type": "string", "example": "", "description": "Billing house name" }, { "kind": "optional", "name": "billingHouseFlatNumber", "type": "string", "example": "", "description": "Billing house flat number" }, { "kind": "optional", "name": "billingStreet", "type": "string", "example": "", "description": "Billing street" }, { "kind": "optional", "name": "billingDistrict", "type": "string", "example": "", "description": "Billing district" }, { "kind": "optional", "name": "billingTownCity", "type": "string", "example": "", "description": "Billing town city" }, { "kind": "optional", "name": "billingCounty", "type": "string", "example": "", "description": "Billing county" }, { "kind": "optional", "name": "billingPostcode", "type": "string", "example": "", "description": "Billing postcode" }, { "kind": "optional", "name": "billingCountry", "type": "string", "example": "", "description": "Billing country" }, { "kind": "optional", "name": "cardNumber", "type": "string", "example": "", "description": "Card number" }, { "kind": "optional", "name": "cardType", "type": "string", "example": "", "description": "Card type" }, { "kind": "optional", "name": "expiryDate", "type": "string", "example": "", "description": "Expiry date" }, { "kind": "optional", "name": "isDefault", "type": "boolean", "example": "", "description": "Is default" }, { "kind": "optional", "name": "issueCode", "type": "string", "example": "", "description": "Issue code" }, { "kind": "optional", "name": "paymentDetailId", "type": "string", "example": "", "description": "Payment account id" }, { "kind": "optional", "name": "authorised", "type": "boolean", "example": "", "description": "Value that determins if the card has been validated" }, { "kind": "optional", "name": "paymentAccountParameters", "type": "object", "schema": [], "example": {}, "description": "PaymentAccountParameter dictionary for wallet" }, { "kind": "optional", "name": "bin", "type": "string", "example": "", "description": "BIN" }, { "kind": "optional", "name": "pan", "type": "string", "example": "", "description": "PAN (CardReference)" }, { "kind": "optional", "name": "creationDate", "type": "string", "example": "", "description": "CreationDate" }, { "kind": "optional", "name": "cardCategory", "type": "string", "example": "", "description": "CardCategory (Debit/Credit)" }, { "kind": "optional", "name": "issuer", "type": "string", "example": "", "description": "Issuer" }, { "kind": "optional", "name": "cardPurpose", "type": "string", "example": "", "description": "CardPurpose (Business/...)" }, { "kind": "optional", "name": "issuingCountry", "type": "string", "example": "", "description": "IssuingCountry" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.PaymentDetailsCardSummary", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.PaymentDetailsCardSummary[]", "description": "Gets or sets the payment details cards." }, { "kind": "optional", "name": "payPal", "type": "object", "schema": [ { "kind": "optional", "name": "paymentDetailId", "type": "string", "example": "", "description": "Payment details id" }, { "kind": "optional", "name": "billingAgreementId", "type": "string", "example": "", "description": "BillingAgreementId" }, { "kind": "optional", "name": "payPalPayerId", "type": "string", "example": "", "description": "PayPalPayerId" }, { "kind": "optional", "name": "accountCountry", "type": "string", "example": "", "description": "AccountCountry" }, { "kind": "optional", "name": "accountEmail", "type": "string", "example": "", "description": "AccountEmail" }, { "kind": "optional", "name": "accountStatus", "type": "string", "example": "", "description": "AccountStatus" }, { "kind": "optional", "name": "billingAgreementDate", "type": "string", "example": "", "description": "BillingAgreementDate" }, { "kind": "optional", "name": "accountFirstName", "type": "string", "example": "", "description": "AccountFirstName" }, { "kind": "optional", "name": "accountLastName", "type": "string", "example": "", "description": "AccountLastName" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v4.PaymentDetailsPayPal", "customType": "FictiveGlobal.Api.Rest.Dtos.v4.PaymentDetailsPayPal", "description": "Gets or sets the PayPal account info." }, { "kind": "optional", "name": "bacs", "type": "object", "schema": [ { "kind": "optional", "name": "accountHolderName", "type": "string", "example": "", "description": "The account holder name." }, { "kind": "optional", "name": "accountNumber", "type": "string", "example": "", "description": "The account number." }, { "kind": "optional", "name": "sortCode", "type": "string", "example": "", "description": "The account sort code." }, { "kind": "optional", "name": "bacsReference", "type": "string", "example": "", "description": "The bacs mandate reference." }, { "kind": "optional", "name": "serviceReference", "type": "string", "example": "", "description": "The service id." } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.PaymentDetails.BacsDirectDebitPaymentDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.PaymentDetails.BacsDirectDebitPaymentDetails", "description": "Gets or sets the bacs direct debit payment details." }, { "kind": "optional", "name": "sepa", "type": "object", "schema": [ { "kind": "optional", "name": "accountHolderName", "type": "string", "example": "", "description": "Account holder name." }, { "kind": "optional", "name": "iban", "type": "string", "example": "", "description": "The IBAN." }, { "kind": "optional", "name": "bic", "type": "string", "example": "", "description": "The BIC." }, { "kind": "optional", "name": "serviceReference", "type": "string", "example": "", "description": "The service id." }, { "kind": "optional", "name": "mandateReference", "type": "string", "example": "", "description": "The mandate reference." }, { "kind": "optional", "name": "bankCountry", "type": "string", "example": "", "description": "BankCountry" }, { "kind": "optional", "name": "sepaMandateCreationDate", "type": "string", "example": "", "description": "SEPAMandateCreationDate" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.PaymentDetails.SepaDirectDebitPaymentDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.PaymentDetails.SepaDirectDebitPaymentDetails", "description": "Gets or sets the sepa direct debit payment details." } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v4.PaymentAccountDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v4.PaymentAccountDetails", "isExpanded": true, "description": "Payment account details" } ], "isExpanded": true, "statusCode": "204", "description": "No Content", "jsonExample": "" }, { "isExpanded": true, "statusCode": "400", "description": "Unable to authenticate using the provided session", "jsonExample": "" }, { "isExpanded": true, "statusCode": "401", "description": "Not Authorized", "jsonExample": "" }, { "isExpanded": true, "statusCode": "404", "description": "Account Does Not Exist.", "jsonExample": "" }, { "isExpanded": true, "statusCode": "500", "description": "Internal Server Error", "jsonExample": "" } ], "contentType": "application/json", "description": "This endpoint will provide the ability to retrieve saved payment details that are stored within the eSuite platform.\r\n Only PayPal, Credit/Debit cards and DirectDebit supported", "examples": { "languages": [ { "id": "zK_xf5TmhwKWmbGzljd8L", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.fictive.com/REST/api/accounts/{accountReference}/payment-details \\\n --header 'accept: application/json' \\\n --header 'x-version: string'" }, { "id": "3wZKrohRlSWVkogGPOIgP", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-version\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.fictive.com/REST/api/accounts/{accountReference}/payment-details\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "d15GcOtpRhvmCKgeM4DbR", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fictive.com/REST/api/accounts/{accountReference}/payment-details\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-version\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "efbNBR4FKE0zr0-3sz2ag", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.fictive.com/REST/api/accounts/{accountReference}/payment-details\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-version': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "zK_xf5TmhwKWmbGzljd8L" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "{\n \"cards\": [\n {\n \"associatedName\": \"Joe Bloggs\",\n \"billingHouseName\": \"\",\n \"billingHouseFlatNumber\": \"100\",\n \"billingStreet\": \"Picadilly Plaza\",\n \"billingTownCity\": \"Manchester\",\n \"billingPostcode\": \"M1 4BT\",\n \"billingCountry\": \"United Kingdom\",\n \"cardNumber\": \"****-****-****-1111\",\n \"cardType\": \"Visa\",\n \"expiryDate\": \"02/23\",\n \"isDefault\": true,\n \"issueCode\": \"123\",\n \"authorised\": false,\n \"paymentAccountParameters\": {\n \"ParameterName\": \"ParameterValue\",\n \"ParameterName2\": \"ParameterValue2\"\n }\n }\n ],\n \"payPal\": {\n \"paymentDetailId\": \"003421\",\n \"accountFirstName\": \"Joe\",\n \"accountLastName\": \"Bloggs\"\n },\n \"bacs\": {\n \"accountHolderName\": \"Joe Bloggs\",\n \"accountNumber\": \"*****111\",\n \"sortCode\": \"00-00-00\",\n \"bacsReference\": \"ADR18203\",\n \"contractReference\": \"0010CW9EZCZDHON6U2\"\n },\n \"sepa\": {\n \"accountHolderName\": \"Joe Bloggs\",\n \"iban\": \"****************678\",\n \"bic\": \"OKOYFIHH\",\n \"contractReference\": \"0010C5FGWLQBI93RL0\",\n \"mandateReference\": \"12345FVDDCF\",\n \"bankCountry\": \"GB\",\n \"sepaMandateCreationDate\": \"2021-09-21T00:00:00+00:00\"\n }\n}" }, { "id": "response-1-204", "language": "204", "code": "// No Content\n{\n \"cards\": [\n {\n \"associatedName\": \"\",\n \"billingHouseName\": \"\",\n \"billingHouseFlatNumber\": \"\",\n \"billingStreet\": \"\",\n \"billingDistrict\": \"\",\n \"billingTownCity\": \"\",\n \"billingCounty\": \"\",\n \"billingPostcode\": \"\",\n \"billingCountry\": \"\",\n \"cardNumber\": \"\",\n \"cardType\": \"\",\n \"expiryDate\": \"\",\n \"isDefault\": false,\n \"issueCode\": \"\",\n \"paymentDetailId\": \"\",\n \"authorised\": false,\n \"paymentAccountParameters\": {},\n \"bin\": \"\",\n \"pan\": \"\",\n \"creationDate\": \"\",\n \"cardCategory\": \"\",\n \"issuer\": \"\",\n \"cardPurpose\": \"\",\n \"issuingCountry\": \"\"\n }\n ],\n \"payPal\": {\n \"paymentDetailId\": \"\",\n \"billingAgreementId\": \"\",\n \"payPalPayerId\": \"\",\n \"accountCountry\": \"\",\n \"accountEmail\": \"\",\n \"accountStatus\": \"\",\n \"billingAgreementDate\": \"\",\n \"accountFirstName\": \"\",\n \"accountLastName\": \"\"\n },\n \"bacs\": {\n \"accountHolderName\": \"\",\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"bacsReference\": \"\",\n \"serviceReference\": \"\"\n },\n \"sepa\": {\n \"accountHolderName\": \"\",\n \"iban\": \"\",\n \"bic\": \"\",\n \"serviceReference\": \"\",\n \"mandateReference\": \"\",\n \"bankCountry\": \"\",\n \"sepaMandateCreationDate\": \"\"\n }\n}" }, { "id": "response-2-400", "language": "400", "code": "// Unable to authenticate using the provided session\n" }, { "id": "response-3-401", "language": "401", "code": "// Not Authorized\n" }, { "id": "response-4-404", "language": "404", "code": "// Account Does Not Exist.\n" }, { "id": "response-5-500", "language": "500", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "response-0-200" } }, "type": "api-oas-v2", "children": [ { "text": "" } ] }