Our RESTful API uses clear resource-based URLs, accepts form-encoded requests, returns JSON responses, supports standard HTTP methods and status codes, and requires authentication.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"46681645","collectionId":"eb90e750-9c42-4051-9eca-c9e60f2a7185","publishedId":"2sB34hHLmm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00ad69"},"publishDate":"2026-01-01T07:35:25.000Z"},"item":[{"name":"General Information","item":[{"name":"Authentication","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"0c2e6052-ae62-463d-8e6a-b6f6ae80da45","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b628b039-ee4d-43d6-94d8-26cfd76b9d04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"test-user@example.com","type":"text","uuid":"fd37ba18-dddf-4c68-bb16-770a1c73c3e1"},{"key":"password","value":"********","type":"text","uuid":"baf2bbbf-5a37-498c-8865-ca30bc03cabf"}]},"url":"https://www.gateway.coastalpay.com/api/login","description":"\n\nThis API is used to authenticate a user and obtain an access token. The client must send valid login credentials in the request body. On successful authentication, a token is returned that should be used for accessing protected endpoints.
\n
Security Notes:
\nAll credentials must be sent over HTTPS.
\nStore tokens securely on the client side.
\nTokens typically expire after a period of inactivity; re-authentication may be required.
\nThis API is used to authenticate a user and obtain an access token.
The client must send valid login credentials in the request body.
On successful authentication, an access token is returned which should be used to access protected endpoints.
No (this is the authentication endpoint)
\nThis endpoint authenticates the user and returns an access token.
If credentials are incorrect, it returns an error message.
{\n \"status\": false,\n \"message\": \"Invalid credentials.\"\n}\n\n\n\nThis endpoint logs out the currently authenticated user by invalidating their token. After a successful logout, the token can no longer be used to access protected routes.
\n
This error occurs when the request is made to a protected API endpoint without a valid Bearer token or the token has expired or is invalid.
\n{\n \"message\": \"Unauthenticated.\"\n}\nIndicates that the client expects the server to respond with a JSON formatted response. This is common for RESTful APIs to ensure consistent data exchange format.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"current_password","value":"OldPass@123","description":"The user's current password. Used to verify their identity before changing.
\n","type":"text","uuid":"d1238d4a-bfe4-46c7-a6cf-cfcab817b545"},{"key":"new_password","value":"NewPass@123","description":"The new password the user wants to set. Must meet the system's password policy.
\n","type":"text","uuid":"204f2738-9ae8-4987-8e3b-8fcd91d94147"},{"key":"confirm_password","value":"NewPass@123","description":"Re-enter the new password to confirm it matches new_password.
\n","type":"text","uuid":"88856521-03ec-41f8-baff-d78a77dde4b1"}]},"url":"https://www.gateway.coastalpay.com/api/change-password","description":"\n\nThis endpoint allows a logged-in user to change their password by providing their current password and a new password (with confirmation). All fields are required.
\n
{\n \"status\": true,\n \"message\": \"Password changed successfully.\"\n}\n\n\nThis response is returned when the user provides an invalid current_password \nthat does not match their existing password in the system. The password change process is aborted, and no updates are made.
\n
{\n \"status\": false,\n \"message\": \"Current password is incorrect.\"\n}\n\n\nThis response indicates that the provided new_password and confirm_password do not match. It is returned when the user attempts to change their password but the confirmation password does not exactly match the new password, as required for security.
\n
{\n \"status\": false,\n \"message\": \"New password and confirm password must match.\"\n}\n\n\nThis response is returned when the user attempts to change their password but provides the same value for both the current_password and new_password fields.
\n
{\n \"status\": false,\n \"message\": \"New password must be different from current password.\"\n}\n\n\nThis error occurs when the user attempts to set a new password that does not meet the minimum length requirement.By default, the password must be at least 6 characters long. This rule helps ensure a basic level of password strength and security.
\n
{\n \"status\": false,\n \"message\": \"New password must be at least 6 characters.\"\n}\nInforms the server that the client expects a JSON response.
\n","type":"text"},{"key":"Content-Type","value":"multipart/form-data","description":"The multipart/form-data content type is used when the request includes file uploads or binary data, along with regular form fields.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"business_name","value":"Coastal Demo Merchant","description":"Business name of the merchant
\n","type":"text","uuid":"699144bf-50fb-4f75-85d5-989ae4807545"},{"key":"owner_name","value":"John Doe","description":"Full name of the business owner
\n","type":"text","uuid":"70d34d9a-b16e-4ebc-9d69-0f32960ad24a"},{"key":"email","value":"john.doe+demo123@example.com","description":"Must be a valid and unique email
\n","type":"text","uuid":"c8bb7342-0073-4585-82b2-4c3fe959955e"},{"key":"password","value":"123456","description":"Password for the user account
\n","type":"text","uuid":"e9f62c2d-aa46-405c-9030-f5c048b80fe7"},{"key":"url","value":"coastal-demo-merchant","description":"Unique URL identifier for the merchant
\n","type":"text","uuid":"caf4e42c-9370-4d3f-b42b-b92d36308a6f"},{"key":"payment_method","value":"card","description":"Must be one of: card, ach, or all
\n","type":"text","uuid":"8380bf73-043a-4f4b-a832-73590774e811"},{"key":"surcharge_active","value":"yes","description":"\"yes\" to enable surcharge, \"no\" to disable, default is \"no\"
\n","type":"text"},{"key":"surcharge_type","value":"per","description":"Surcharge type : fixed, per & if surcharge_active is \"yes\"
\n","type":"text","uuid":"51975d3d-5206-48ad-b673-ad663456b08e"},{"key":"surcharge","value":"2.5","description":"Surcharge amount & & if surcharge_active is \"yes\"
\n","type":"text","uuid":"0cff6b87-e006-477d-92ce-383c1df5a3e8"},{"key":"compliant_surcharge_type","value":"fixed","description":"Must be one of : fixed , per
\n","type":"text","uuid":"53e06b50-52bb-4ca8-a75f-31784383f824"},{"key":"compliant_surcharge","value":"2.1","description":"Compliant surcharge amount
\n","type":"text","uuid":"9bc72942-6d50-4eab-a4b2-21a85a16e194"},{"key":"tax_type","value":"per","description":"Must be one of : fixed , per
\n","type":"text","uuid":"2a554406-24a7-4164-953e-c2adab63d3a8"},{"key":"tax","value":"5","description":"Tax amount
\n","type":"text","uuid":"4c010e58-f05c-44bf-8f9b-6434a9aefa4e"},{"key":"api_mode","value":"live","description":"Optional mode: live or sandbox
\n","type":"text","uuid":"057ae245-0963-4e03-8ef2-f00604858b9c"},{"key":"api_key","value":"live_key_123456789","description":"API key
\n","type":"text","uuid":"4efb0652-5cb6-4236-95e9-023a5b974a4b"},{"key":"terminal_id","value":"789456123","description":"Terminal ID
\n","type":"text","uuid":"4c83c330-c8b3-4342-9813-807bc8cbb3f5"},{"key":"dba_id_card","value":"CARD1234","description":"Required if payment_method = card or both & if api_mode = live
\n","type":"text","uuid":"52b8e767-0b68-41da-9685-bd309e61e789"},{"key":"dba_id_ach","value":"ACH5678","description":"Required if payment_method = ach or both & api_mode = live
\n","type":"text","uuid":"3273b6cb-8e2b-414c-ad3a-c2fd6b4dfb49"},{"key":"recurring","value":"on","description":"Must be : on, off
\n","type":"text","uuid":"a6dff626-2c1c-49e7-a84b-96ee8970aa26"},{"key":"sandbox_api_key","value":"sandbox_key_1133455","description":"Required if api_mode = sandbox
\n","type":"text"},{"key":"sandbox_terminal_id","value":"123445666","description":"Required if api_mode = sandbox
\n","type":"text"},{"key":"sandbox_dba_id_card","value":"CARD123123","description":"Required if payment_method = card or both & api_mode = sandbox
\n","type":"text"},{"key":"sandbox_dba_id_ach","value":"ACH123445","description":"Required if payment_method = ach or both & api_mode = sandbox
\n","type":"text"},{"key":"logo","description":"Optional image file
\n","type":"file","uuid":"e5b4f1aa-b33d-460f-8357-63e24b1d2e0a","value":null}]},"url":"https://www.gateway.coastalpay.com/api/merchant/create","description":"\n\nCreates a new merchant account and login credentials.
\n
surcharge_active = yes :api_mode = live :api_mode = sandbox :CoastalPay APIs use token-based authentication.
After successful login, an access token is issued and must be included in
the Authorization header for all protected API requests.
Requests without a valid token will be rejected with HTTP 401 Unauthorized.
\nRegister a merchant account (one-time).
\nLogin using registered credentials.
\nReceive an access token.
\nInclude the token in the Authorization header for all protected APIs.
\nLogout to invalidate the token.
\nBearer Authentication is used to secure API requests with a token. The token proves that the requester is authorized to access protected resources.
\nThe server validates the token included in the request header:
\nValid token → Access is granted
\nInvalid or missing token → Access is denied (usually returns 401 Unauthorized)
\n\n\n⚠️ Security Notice:
\n
Keep your Access Token confidential and never share it with others.
The CoastalPay API uses standard HTTP status codes to indicate whether a request
was successful or failed. When an error occurs, the API returns a structured
JSON response describing the issue so developers can easily identify and handle
the problem.
All error responses follow a consistent JSON structure:
\n{\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Validation failed\",\n \"errors\": {\n \"field_name\": [\"Description of the validation error\"]\n }\n}\n\nReturned when the access token is missing, invalid, or expired.
\n{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Access token is missing or invalid\"\n}\n\n\n\nRetrieves a list of all customer profiles associated with the authenticated merchant in the system. Each entry includes basic customer details such as name, email, and phone number. This endpoint is ideal for populating dashboards, enabling customer lookup features, or exporting customer contact lists.
\n
This endpoint supports pagination to efficiently manage large customer lists and improve response performance.
\n GET /api/customer/list?page=2&per_page=10
This response is returned when the merchant exists but no customer records are associated with the merchant.
\n{\n \"status\": false,\n \"message\": \"No customers found for this merchant.\",\n \"data\": []\n}\n\n\n\nFetch detailed profile information for a specific customer using their email address. This endpoint allows authenticated merchants to retrieve a customer’s contact details directly, enabling integrations such as lookups, validation workflows, or user-centric data retrieval.
\n
Informs the server that the client expects a JSON response.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"Indicates that the request body is in JSON format. Essential for PUT/POST APIs.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Alice\",\n \"last_name\": \"Smith\",\n \"email\": \"alice.smith@example.com\",\n \"phone\": \"5551234567\",\n \"phone_code\": \"+1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/api/customer/create","description":"\n\nUse this endpoint to create a new customer profile. This allows merchants to store basic customer details such as first name, last name, email, and contact number. These profiles are useful for managing customer relationships, tracking transactions, and setting up recurring billing.
\n
Informs the server that the client expects a JSON response.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"Indicates that the request body is in JSON format. Essential for PUT/POST APIs.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"johnsmith@example.com\",\n \"phone\": \"9876543210\",\n \"phone_code\": \"+1\",\n \"phone_full\": \"+19876543210\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/customer/update/{id}","description":"\n\n","urlObject":{"protocol":"https","path":["customer","update","{id}"],"host":["www","gateway","coastalpay","com"],"query":[],"variable":[]}},"response":[{"id":"af4c751b-900c-427d-bda8-456b899e5ee9","name":"Update Customer","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","description":"Informs the server that the client expects a JSON response.","type":"text"},{"key":"Content-Type","value":"application/json","description":"Indicates that the request body is in JSON format. Essential for PUT/POST APIs.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Sarah\",\n \"last_name\": \"Smith\",\n \"email\": \"Sarah.smith@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"+1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/customer/update/123"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"User updated successfully.\",\n \"data\": {\n \"id\": 123,\n \"name\": \"Smith\",\n \"email\": \"Sarah.smith@example.com\",\n \"phone\": \"+11234567890\"\n }\n}"}],"_postman_id":"14944f6c-5736-4147-9342-b294a50d6569"}],"id":"0eddcb4c-0b06-4168-943c-06f012a50112","description":"Use this endpoint to update existing customer data in the system. You must pass the customer id in the URL path. You can update one or more fields: fields not provided are left unchanged. This is useful for correcting customer details such as name, email, or phone number.
\n
The Customer APIs enable authenticated merchants to manage customer records within the Coastal Pay Gateway system. These endpoints allow merchants to create, retrieve, update, and list customers associated with their merchant account.
\nCustomer data includes essential information such as First name, Last name, email address, phone number, and other identifying details. These APIs are typically used for customer management, transaction processing, invoicing, and reporting.
\nAll Customer endpoints require valid authentication and operate only on customers linked to the authenticated merchant.
\nList Customers
Retrieves a list of all customer profiles associated with the authenticated merchant.
Fetch Customer by Email
Retrieves detailed information for a specific customer using their email address.
Create Customer
Creates a new customer profile and associates it with the authenticated merchant.
Update Customer
Updates existing customer information such as contact details or profile data.
Displaying customer lists in merchant dashboards
\nSearching for customers using email
\nCreating customer records before initiating transactions
\nUpdating customer information for billing or communication purposes
\nAll requests require a valid Bearer Access Token
\nCustomer data is scoped to the authenticated merchant
\nUnauthorized requests will be rejected
\nIndicates that the client expects the server to respond with a JSON formatted response. This is common for RESTful APIs to ensure consistent data exchange format.
\n","type":"text"}],"url":"https://www.gateway.coastalpay.com/api/tag/list","description":"\n\n","urlObject":{"protocol":"https","path":["api","tag","list"],"host":["www","gateway","coastalpay","com"],"query":[],"variable":[]}},"response":[{"id":"8a50fbf8-ae28-4ee7-916f-d8a5cde0e323","name":"List","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Indicates that the client expects the server to respond with a JSON formatted response. This is common for RESTful APIs to ensure consistent data exchange format.","type":"text"}],"url":"https://www.gateway.coastalpay.com/api/tag/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Tags fetched successfully.\",\n \"data\": [\n {\n \"id\": 101,\n \"tag_name\": \"Sample Tag\",\n \"created_at\": \"2025-08-01T10:00:00.000000Z\",\n \"updated_at\": \"2025-08-01T10:00:00.000000Z\",\n \"deleted_at\": null\n }\n ]\n}"}],"_postman_id":"226982b3-6cf0-41f7-b785-903bce653409"},{"name":"Create Tag","id":"e562778d-f69a-4d51-a1e1-1cb5e591766d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Fetch a comprehensive list of tags associated with the current authenticated merchant. Tags are identifiers or labels used within the CoastalPay system to organize and filter merchant-specific data. This endpoint returns structured tag data—including id, tag_name, and timestamp details—for easy consumption by client applications.
\n
Indicates that the client expects the server to respond with a JSON formatted response. This is common for RESTful APIs to ensure consistent data exchange format.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"tag_name","value":"Marketing","description":"The name of the tag to be created.
\n","type":"text","uuid":"7acbc44a-9312-4b28-a2d0-51d462c532e8"}]},"url":"https://www.gateway.coastalpay.com/api/tag/create","description":"\n\nThis endpoint allows you to create a new tag associated with the authenticated merchant. Tags help in categorizing and organizing resources such as customers, transactions, or business groups under meaningful labels.
\n
Informs the server that the client expects a JSON response.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"Indicates that the request body is in JSON format. Essential for PUT/POST APIs.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tag_name\": \"Retail Customers\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/api/tag/update/{id}","description":"\n\nUse this endpoint to update an existing tag for the authenticated merchant by its unique id. Only the tag_name field is currently supported for updates, allowing you to rename or correct existing tags.
\n
This error is returned when the id provided in the URL does not match any existing tag.
\n{\n \"status\": false,\n \"message\": \"Tag not found or unauthorized access.\"\n}\nInforms the server that the client expects a JSON response.
\n","type":"text"}],"url":"https://www.gateway.coastalpay.com/api/tag/delete/{id}","description":"\n\nThis endpoint allows the authenticated merchant to permanently delete a tag by its id. Use this to remove outdated or incorrect tags from the system.
\n
Returned when the specified id does not match any existing tag, or the tag may have already been deleted.
\n{\n \"status\": false,\n \"message\": \"Tag not found or unauthorized.\"\n}\nInforms the server that the client expects a JSON response.
\n","type":"text"}],"url":"https://www.gateway.coastalpay.com/api/invoice/list","description":"\n\n","urlObject":{"protocol":"https","path":["api","invoice","list"],"host":["www","gateway","coastalpay","com"],"query":[],"variable":[]}},"response":[{"id":"be241533-0019-4feb-b15f-21a621e5ede8","name":"List","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Informs the server that the client expects a JSON response.","type":"text"}],"url":"https://www.gateway.coastalpay.com/api/invoice/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Invoice list fetched successfully.\",\n \"data\": [\n {\n \"id\": 1,\n \"random_id\": \"abc123xyz456def789\",\n \"invoice_name\": \"Invoice-A\",\n \"invoice_number\": \"INV-000101\",\n \"tag_id\": \"[5]\",\n \"user_id\": \"101\",\n \"merchant_id\": \"10\",\n \"issue_date\": \"2025-08-01 00:00:00\",\n \"due_date\": \"2025-08-10 00:00:00\",\n \"tax\": 5,\n \"tax_amount\": \"50\",\n \"shipping\": 20,\n \"total_amount\": \"500\",\n \"note\": \"Application# 123456\",\n \"memo_statement\": \"Merchant Ref:\",\n \"is_archive\": 0,\n \"created_at\": \"2025-08-01T10:00:00.000000Z\",\n \"updated_at\": \"2025-08-01T10:00:00.000000Z\",\n \"deleted_at\": null,\n \"user\": {\n \"id\": 101,\n \"merchant_data\": \"{\\\"10\\\":{\\\"merchant_id\\\":10,\\\"customer_id\\\":\\\"9999\\\",\\\"billing_id\\\":null,\\\"ach_customer_id\\\":null}}\",\n \"urole\": 2,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"otp\": null,\n \"otp_valid\": null,\n \"email_verified_at\": null,\n \"email_is_verify\": null,\n \"email_verification_token\": null,\n \"is_password_set\": 1,\n \"pass_reset_token\": null,\n \"phone\": \"+1234567890\",\n \"status\": \"1\",\n \"address\": \"123 Elm Street\",\n \"city\": \"Metropolis\",\n \"state\": \"CA\",\n \"zipcode\": \"90210\",\n \"country\": \"USA\",\n \"created_at\": \"2025-07-15T09:00:00.000000Z\",\n \"updated_at\": \"2025-07-15T09:00:00.000000Z\",\n \"deleted_at\": null\n },\n \"transactions\": {\n \"id\": 1,\n \"invoice_id\": 1,\n \"customer_name\": \"Jane Smith\",\n \"transaction_type\": \"card\",\n \"transaction_id\": 100001,\n \"amount\": 500,\n \"status\": \"Approved\",\n \"response_data\": \"{\\\"id\\\":\\\"100001\\\",\\\"amount\\\":\\\"500.00\\\",\\\"type\\\":\\\"Auth\\\",\\\"authCode\\\":\\\"AUTH123\\\",\\\"card\\\":{\\\"bin\\\":411111,\\\"name\\\":\\\"Jane Smith\\\",\\\"number\\\":1234,\\\"exp\\\":\\\"2031-12-31\\\"},\\\"contact\\\":{\\\"name\\\":\\\"John Doe\\\",\\\"email\\\":\\\"john.doe@example.com\\\"},\\\"status\\\":{\\\"status\\\":\\\"Approved\\\"},\\\"createdOn\\\":\\\"2025-08-01 10:00:00\\\"}\",\n \"created_at\": \"2025-08-01T10:00:00.000000Z\",\n \"updated_at\": \"2025-08-01T10:00:00.000000Z\"\n }\n },\n {\n \"id\": 2,\n \"random_id\": \"xyz789abc123def456\",\n \"invoice_name\": \"Invoice-B\",\n \"invoice_number\": \"INV-000102\",\n \"tag_id\": \"[6]\",\n \"user_id\": \"101\",\n \"merchant_id\": \"10\",\n \"issue_date\": \"2025-08-02 00:00:00\",\n \"due_date\": \"2025-08-11 00:00:00\",\n \"tax\": 10,\n \"tax_amount\": \"75\",\n \"shipping\": 30,\n \"total_amount\": \"675\",\n \"note\": \"Application# 654321\",\n \"memo_statement\": \"Merchant Ref:\",\n \"is_archive\": 0,\n \"created_at\": \"2025-08-02T11:00:00.000000Z\",\n \"updated_at\": \"2025-08-02T11:00:00.000000Z\",\n \"deleted_at\": null,\n \"user\": {\n \"id\": 101,\n \"merchant_data\": \"{\\\"10\\\":{\\\"merchant_id\\\":10,\\\"customer_id\\\":\\\"9999\\\",\\\"billing_id\\\":null,\\\"ach_customer_id\\\":null}}\",\n \"urole\": 2,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"otp\": null,\n \"otp_valid\": null,\n \"email_verified_at\": null,\n \"email_is_verify\": null,\n \"email_verification_token\": null,\n \"is_password_set\": 1,\n \"pass_reset_token\": null,\n \"phone\": \"+1234567890\",\n \"status\": \"1\",\n \"address\": \"123 Elm Street\",\n \"city\": \"Metropolis\",\n \"state\": \"CA\",\n \"zipcode\": \"90210\",\n \"country\": \"USA\",\n \"created_at\": \"2025-07-15T09:00:00.000000Z\",\n \"updated_at\": \"2025-07-15T09:00:00.000000Z\",\n \"deleted_at\": null\n },\n \"transactions\": {\n \"id\": 2,\n \"invoice_id\": 2,\n \"customer_name\": \"Alice Walker\",\n \"transaction_type\": \"card\",\n \"transaction_id\": 100002,\n \"amount\": 675,\n \"status\": \"Approved\",\n \"response_data\": \"{\\\"id\\\":\\\"100002\\\",\\\"amount\\\":\\\"675.00\\\",\\\"type\\\":\\\"Auth\\\",\\\"authCode\\\":\\\"AUTH456\\\",\\\"card\\\":{\\\"bin\\\":555555,\\\"name\\\":\\\"Alice Walker\\\",\\\"number\\\":5678,\\\"exp\\\":\\\"2032-11-30\\\"},\\\"contact\\\":{\\\"name\\\":\\\"John Doe\\\",\\\"email\\\":\\\"john.doe@example.com\\\"},\\\"status\\\":{\\\"status\\\":\\\"Approved\\\"},\\\"createdOn\\\":\\\"2025-08-02 11:00:00\\\"}\",\n \"created_at\": \"2025-08-02T11:00:00.000000Z\",\n \"updated_at\": \"2025-08-02T11:00:00.000000Z\"\n }\n }\n ]\n}"}],"_postman_id":"e13a526d-31c4-475d-9fce-acc1966e2ab9"},{"name":"Fetch Invoice by Identifier","id":"8a963ac0-b19e-450f-b7f5-9745345854a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Retrieves a list of all invoices associated with the authenticated merchant in the system. Each invoice includes details such as invoice ID, date, status, amount due, and summary line items. This endpoint is ideal for displaying invoice history.
\n
Informs the server that the client expects a JSON response.
\n","type":"text"}],"url":"https://www.gateway.coastalpay.com/api/invoice/{random_id}","description":"\n\nFetch detailed information for a specific invoice using its unique identifier (could be a numeric a random_id). The returned data includes invoice metadata, customer details, line items, merchant info, and transaction status. This endpoint supports rendering or exporting full invoice details in merchant dashboards or apps.
\n
Returned when the invoice random identifier does not match any invoice.
\n{\n \"status\": false,\n \"message\": \"Invoice not found.\"\n}\nInforms the server that the client expects a JSON response.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"Indicates that the request body is in JSON format. Essential for PUT/POST APIs.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_id\": 2,\n \"issue_date\": \"2025-07-30\",\n \"due_date\": \"2025-08-06\",\n \"products\": [\n {\n \"product_name\": \"Website Design\",\n \"quantity\": 1,\n \"rate\": 500.00,\n \"price\": 500.00\n },\n {\n \"product_name\": \"Hosting\",\n \"quantity\": 1,\n \"rate\": 100.00,\n \"price\": 100.00\n }\n ],\n \"tax\":\"on\",\n \"shipping\": 20,\n \"note\": \"Thank you for your business.\",\n \"memo_statement\": \"Payable upon receipt.\",\n \"tag_id\": [1],\n \"notify_customer\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/api/invoice/create","description":"\n\nThis API allows you to create a new invoice for a user by providing invoice details including product list, issue/due dates, tax settings, shipping fee, and optional customer notes or memos. On success, it returns the unique invoice ID and a sharable invoice URL.
\n
Informs the server that the client expects a JSON response.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"Indicates that the request body is in JSON format. Essential for PUT/POST APIs.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_id\": 2,\n \"issue_date\": \"2025-07-14\",\n \"due_date\": \"2025-07-21\",\n \"products\": [\n {\n \"product_name\": \"Website Design\",\n \"quantity\": 1,\n \"rate\": 200.00,\n \"price\": 100.00\n },\n {\n \"product_name\": \"Hosting\",\n \"quantity\": 1,\n \"rate\": 200.00,\n \"price\": 200.00\n }\n ],\n \"notify_customer\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/api/invoice/update/{id}","description":"\n\nThis API allows you to update an existing invoice by specifying its ID in the URL. You can modify invoice details such as products, dates, tax settings, shipping, tags, notes, and customer notification preferences. Only the fields provided in the request will be updated, while others remain unchanged.
\n
Informs the server that the client expects a JSON response.
\n","type":"text"}],"url":"https://www.gateway.coastalpay.com/api/invoice/delete/{id}","description":"\n\nThis API is used to archive an existing invoice based on its unique ID.\nArchiving does not permanently delete the invoice but marks it as archived
\n(is_archive = 1)in the database.\nAll associated products under the invoice will also be archived.
GET /api/transaction/list
Parameter: status
Type: String
\nValues: success, failed, refunded, partially_refunded, pending
Example: ?status=success
Parameter: payment_type
Type: String
\nValues: card, ach
Example: ?payment_type=card
Parameter: transaction_id
Type: String
\nDescription: Filter by exact transaction ID (payment_auth_id)
\nExample: ?transaction_id=PAY123456789
Parameter: customer_id
Type: Integer
\nDescription: Filter transactions by specific customer ID
\nExample: ?customer_id=123
Parameter: customer_email
Type: String
\nDescription: Filter transactions by customer email (partial match)
\nExample: ?customer_email=john@example.com
Parameters:
\ndate_from - Start date (Y-m-d format)
date_to - End date (Y-m-d format)
Type: String (Date)
\nFormat: Y-m-d (e.g., 2024-01-01)
Example: ?date_from=2024-01-01&date_to=2024-12-31
Parameter: search
Type: String
\nDescription: Search by customer name, email, or payment_auth_id
\nExample: ?search=john
Parameter: type
Type: String
\nValues: one-time, recurring
Example: ?type=recurring
Parameters:
\namount_min - Minimum amount
amount_max - Maximum amount
Type: Float/Decimal
\nExample: ?amount_min=10.00&amount_max=1000.00
Parameters:
\nsort_by - Field to sort by
sort_order - Sort direction
Type: String
\nsort_by Values: id, created_at, updated_at, total_amount, transaction_status, payment_type
sort_order Values: asc, desc
Default: sort_by=id, sort_order=desc
Example: ?sort_by=total_amount&sort_order=asc
page: Page number (default: 1, minimum: 1)
\nper_page: Items per page (default: 15, maximum: 100)
\n?page=1&per_page=50
If per_page exceeds 100, the API will return a 422 Unprocessable Entity error with a clear message
Example error response when per_page=300:
{\n \"status\": false,\n \"message\": \"The per_page parameter cannot exceed 100. You requested 300 items per page.\",\n \"error\": \"per_page_exceeded\",\n \"max_per_page\": 100,\n \"requested_per_page\": 300\n}\n\nGET /api/transaction/list?status=success&payment_type=card&transaction_id=PAY123456&date_from=2024-01-01&date_to=2024-12-31&page=1&per_page=50&sort_by=created_at&sort_order=desc\n\nInforms the server that the client expects a JSON response.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"St*********\",\n \"url\": \"northbay-solutions\",\n \"surcharge_active\": \"yes\",\n \"surcharge_type\": \"per\",\n \"surcharge\": 3.0,\n \"api_mode\": \"live\",\n \"api_key\": \"live_key_xyz123456789\",\n \"terminal_id\": \"TERM123456789\",\n \"dba_id_card\": \"CARD456789XYZ\"\n\n}\n","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/api/profile/update","description":"EndpointPUT /api/profile/update
The Update Profile API allows an authenticated merchant to update their profile and business-related information.
\nThis endpoint supports partial updates, meaning only the fields provided in the request will be updated, while all other existing data will remain unchanged.
\nMerchants can use this API to modify personal details, business information, login credentials, surcharge configuration, payment preferences, and API-related settings.
\nAuthentication is required for this endpoint, and a valid access token must be included in the request headers.
\nAccept: application/jsonAuthorization: Bearer {access_token}
surcharge_active = yesapi_mode = liveapi_mode = sandbox\n\n","urlObject":{"protocol":"https","path":["api","profile","update"],"host":["www","gateway","coastalpay","com"],"query":[],"variable":[]}},"response":[{"id":"dbb9e845-4a02-40e3-b7f1-963c45b5a1b6","name":"Update Profile","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","description":"Informs the server that the client expects a JSON response.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"StrongPass!2025\",\n \"url\": \"northbay-solutions\",\n \"surcharge_active\": \"yes\",\n \"surcharge_type\": \"per\",\n \"surcharge\": 3.0,\n \"api_mode\": \"live\",\n \"api_key\": \"live_key_xyz123456789\",\n \"terminal_id\": \"TERM123456789\",\n \"dba_id_card\": \"CARD456789XYZ\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/api/profile/update"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Merchant updated successfully.\"\n}"}],"_postman_id":"9c81a012-c281-4852-a150-be92eee645d2"}],"id":"c897a6ff-44a8-4cc0-9c1a-86586c28acc1","_postman_id":"c897a6ff-44a8-4cc0-9c1a-86586c28acc1","description":""},{"name":"Card Payments","item":[{"name":"Process Card Payment","id":"c3b5e95c-282b-4511-8870-e1f33d48895a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"🔔 Conditionally Required: Fields marked as ✅ Yes are required only if their respective conditions are met (e.g.,
\napi_mode = live,payment_method = ach, etc.).
Process a one-time card payment. Supports both new card and saved card (token) payments.
\nAuthorization: Bearer {access_token}
Content-Type: application/json
This request processes a one-time card payment using a previously saved card token.
No raw card details are required, making it more secure and faster for repeat payments.
{\n \"terminal\": {\n \"id\": 309\n },\n \"amount\": 75.25,\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"token\": \"card_token_abc123xyz789\"\n },\n \"contact\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+1234567890\"\n },\n \"sendReceipt\": \"Yes\"\n}\n\nTokenization is the process of replacing sensitive card data with a unique token, ensuring security when the card is used for future payments.
A token can be up to 64 characters in length.
Tokenization can be performed during a Sale, Auth, or CardAuthentication request by setting the card.save parameter to Yes.\nWhen enabled:
card.number field.card.token field.\nThe token can be safely stored and used for future transactions in place of the actual card number.Use this endpoint to create ACH Transactions.
\nThis endpoint requires authentication. Include a Bearer token in the Authorization header.
\nContent-Type: application/json\nAuthorization: Bearer {token}\n\nUse this flow when processing an ACH payment AND saving the customer information to the vault for future use. This allows you to process subsequent payments using only the customer ID without providing full account details each time.
\n{\n \"status\": false,\n \"message\": \"Authentication required.\"\n}\n\n{\n \"status\": false,\n \"message\": \"Merchant account not found for this user.\"\n}\n\n{\n \"status\": false,\n \"message\": \"DBA ID does not match your merchant account.\"\n}\n\n{\n \"status\": false,\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"amount\": [\"The amount field is required.\"],\n \"routingNumber\": [\"The routing number field is required.\"],\n \"accountName\": [\"The account name field is required.\"],\n \"accountNumber\": [\"The account number field is required.\"],\n \"accountType\": [\"The account type must be Checking or Savings.\"],\n \"transactionType\": [\"The transaction type must be Debit or Credit.\"],\n \"dba.id\": [\"The dba.id field is required.\"],\n \"customer.email\": [\"The customer.email field is required.\"],\n \"customer.save\": [\"The customer.save field must be Yes.\"],\n \"customer.firstName\": [\"The customer.firstName field is required.\"],\n \"customer.lastName\": [\"The customer.lastName field is required.\"],\n \"customer.phone\": [\"The customer.phone field is required.\"],\n \"customer.address1\": [\"The customer.address1 field is required.\"],\n \"customer.city\": [\"The customer.city field is required.\"],\n \"customer.state\": [\"The customer.state field is required.\"],\n \"customer.zipCode\": [\"The customer.zipCode field is required.\"]\n }\n}\n\n{\n \"status\": false,\n \"message\": \"ACH payment processing failed.\",\n \"error\": {\n \"error\": \"Invalid routing number\",\n \"code\": \"INVALID_ROUTING\"\n }\n}\n\n{\n \"status\": false,\n \"message\": \"An unexpected error occurred.\",\n \"error\": \"Error details (only in debug mode)\"\n}\n\nUse this flow when processing a payment for a customer already stored in the vault who has only one saved account. This is the simplest and fastest payment flow, requiring minimal information.
\nNone - this flow uses the simplest possible request format.
\n{\n \"status\": false,\n \"message\": \"Authentication required.\"\n}\n{\n \"status\": false,\n \"message\": \"Merchant account not found for this user.\"\n}\n{\n \"status\": false,\n \"message\": \"DBA ID does not match your merchant account.\"\n}\n{\n \"status\": false,\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"amount\": [\"The amount field is required.\"],\n \"transactionType\": [\"The transaction type must be Debit or Credit.\"],\n \"dba.id\": [\"The dba.id field is required.\"],\n \"customer.id\": [\"The customer.id field is required.\"]\n }\n}\n{\n \"status\": false,\n \"message\": \"ACH payment processing failed.\",\n \"error\": {\n \"error\": \"Customer account not found\",\n \"code\": \"ACCOUNT_NOT_FOUND\"\n }\n}\nRetrieve all saved cards for a specific customer from the vault.
\n{\n \"status\": true,\n \"message\": \"Cards retrieved successfully.\",\n \"data\": [\n {\n \"id\": \"card_123\",\n \"last4\": \"4242\",\n \"brand\": \"VISA\",\n \"exp\": \"1226\"\n }\n ],\n \"total\": 1\n}\n\n{\n \"status\": true,\n \"message\": \"No cards found for this customer.\",\n \"data\": [],\n \"total\": 0\n}\n\nRetrieve details of a specific card for a customer.
\n{\n \"status\": true,\n \"message\": \"Card retrieved successfully.\",\n \"data\": {\n \"id\": \"card_123\",\n \"last4\": \"4242\",\n \"brand\": \"VISA\",\n \"exp\": \"1226\"\n }\n}\n\n\nCard Not Found – 404
\n{\n \"status\": false,\n \"message\": \"Card not found.\"\n}\n\n\nAdd a new card to the customer vault.
\nThis endpoint allows you to update the expiration date of an existing card stored in a customer’s vault. By providing the customer ID, card ID, and a new expiration date in MM/YY format, the system securely updates the card details without requiring the card number or other sensitive information. This is useful for handling card renewals and preventing payment failures due to expired cards.
URL Parameters
\nContent-Type: application/json\nAuthorization: Bearer {token} (if required)\n{\n \"status\": false,\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"expiration\": [\"The expiration field is required.\"]\n }\n}\n{\n \"status\": false,\n \"message\": \"Merchant not found.\"\n}\nThis endpoint archives an existing card in the customer vault, marking it as inactive while retaining its data for record-keeping and auditing purposes. Archived cards cannot be used for transactions but remain associated with the customer, allowing safe deactivation without permanent deletion.
\nContent-Type: application/json\nAuthorization: Bearer {token} (if required)\nNo request body required.
\n{\n \"status\": true,\n \"message\": \"Card archived successfully.\",\n \"data\": {\n \"id\": \"card_123456\",\n \"archived\": true\n }\n}\n{\n \"status\": false,\n \"message\": \"Merchant not found.\"\n}\n{\n \"status\": false,\n \"message\": \"Failed to archive card.\"\n}\nPermanently deletes a card from the customer vault.
\nContent-Type: application/json\nAuthorization: Bearer {token} (if required)\nNo request body required.
\n{\n \"status\": true,\n \"message\": \"Card deleted successfully.\"\n}\n{\n \"status\": false,\n \"message\": \"Merchant not found.\"\n}\n{\n \"status\": false,\n \"message\": \"An unexpected error occurred.\",\n \"error\": \"Error details (only in debug mode)\"\n}\nRetrieve all billing information records for a customer.
\nURL Parameters:
\nRequest Example:
\nGET /api/customer-vault/123/billing-information\nAuthorization: Bearer {token}\n\nRetrieve a specific billing information record by ID.
\nURL Parameters:
\nRequest Example:
\nGET /api/customer-vault/129/billing-information/12345\nAuthorization: Bearer {token}\n\nCreate a new billing information record for a customer.
\nURL Parameters:
\nRequired Fields:
\n","urlObject":{"protocol":"https","path":["api","customer-vault","129","billing-information"],"host":["www","gateway","coastalpay","com"],"query":[],"variable":[]}},"response":[{"id":"102bc6bf-bf5d-42ef-a0eb-47fd09f440ba","name":"Create","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"address\": \"123 Main St\",\r\n \"city\": \"New York\",\r\n \"state\": \"NY\",\r\n \"zip\": \"10001\",\r\n \"country\": \"US\",\r\n \"dba\": {\r\n \"id\": 330\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/api/customer-vault/{customer_id}/billing-information"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"status\": true,\r\n \"message\": \"Billing information created successfully.\",\r\n \"data\": {\r\n \"billing_id\": \"3301\",\r\n \"billing_information\": {\r\n \"id\": \"3301\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"address\": \"123 Main St\",\r\n \"state\": \"New York\",\r\n \"city\": \"New York\",\r\n \"zip\": \"10001\",\r\n \"country\": \"United States\",\r\n \"archived\": \"No\",\r\n \"createdOn\": \"2026-01-30 05:17:30\"\r\n }\r\n }\r\n}"}],"_postman_id":"2166d086-55fd-416a-ad4b-16e1122f0c3b"},{"name":"Update","id":"26df47bf-40d0-4635-869f-6efdc2235f7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Update an existing billing information record. All fields are optional - only provided fields will be updated.
\nURL Parameters:
\nRequired Fields:
\n","urlObject":{"protocol":"https","path":["api","customer-vault","129","billing-information","3301"],"host":["www","gateway","coastalpay","com"],"query":[],"variable":[]}},"response":[{"id":"273ed0e5-ac56-4780-b1c6-455b3cce4a87","name":"Update","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Emmett\",\r\n \"lastName\": \"Brown\",\r\n \"state\": \"CA\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.gateway.coastalpay.com/api/customer-vault/{customer_id}/billing-information/{id}"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"status\": true,\r\n \"message\": \"Billing information updated successfully.\",\r\n \"data\": {\r\n \"id\": \"12345\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"address\": \"123 Main St\",\r\n \"city\": \"Los Angeles\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90001\",\r\n \"country\": \"US\",\r\n \"customer\": {\r\n \"id\": \"5060\"\r\n },\r\n \"dba\": {\r\n \"id\": 13\r\n }\r\n }\r\n}"}],"_postman_id":"26df47bf-40d0-4635-869f-6efdc2235f7e"}],"id":"c6382fb5-2ff8-416f-848a-dff2d79662c4","description":"You can use this endpoint for customer billing-related operations in the customer vault. You can create, update, delete, or archive customer billing information.
\n","_postman_id":"c6382fb5-2ff8-416f-848a-dff2d79662c4"}],"id":"656512b0-4376-4fb5-8719-a0515d20ad88","description":"This API allows merchants to manage customer cards stored in the secure customer vault.
\nSupported operations include listing cards, viewing card details, adding new cards, updating expiration dates, archiving/unarchiving cards, and deleting cards.
\n","_postman_id":"656512b0-4376-4fb5-8719-a0515d20ad88"},{"name":"Recurring Payment","item":[{"name":"Card","item":[{"name":"Recurring Card Payment - New Customer","id":"1db6a66f-7bcb-4585-8925-ec2e81effcc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This API endpoint allows you to create a recurring card payment for a new customer. The system will automatically:
\nRequired: Bearer Token Authentication
\nThe API requires authentication. Include your bearer token in the Authorization header:
\nAuthorization: Bearer {your_token}\n\nContent-Type: application/json\nAuthorization: Bearer {your_token}\nAccept: application/json\n\nThis API endpoint allows you to create a recurring card payment for an existing customer. The system will automatically:
\nFind the existing customer by user ID
\nExtract customer vault ID from merchant_data
\nUse existing customer information from vault
\nAdd card to customer vault (if new card provided)
\nCreate a recurring payment schedule
\nGenerate a PDF invoice
\nSend a payment receipt email with invoice attachment to the customer
\nUse this flow when creating a recurring ACH payment subscription for a new customer. The system will create a user account, ACH customer in vault, and then create the recurring payment.
\nKey Features:
\nCreates new user account
\nCreates ACH customer in vault
\nCreates recurring ACH payment subscription
\nGenerates invoice PDF
\nSends email
\nUse this flow when creating a recurring ACH payment subscription for an existing customer who already has an ACH customer ID in the vault.
\nKey Features:
\nUses existing customer account
\nUses existing ACH customer ID
\nCreates recurring ACH payment subscription
\nGenerates invoice PDF
\nSends email
\nRetrieves a list of all recurring payment subscriptions for a specific customer.
\nContent-Type: application/json\nAuthorization: Bearer {token}\n\nRetrieves detailed information about a specific recurring payment subscription.
\nThis endpoint requires authentication. Include a Bearer token in the Authorization header.
\nContent-Type: application/json\nAuthorization: Bearer {token}\nWe provide test card details for the sandbox environment to help you validate your integration before processing real card data.
\nThere are cases where you will encounter partial approvals, such as gift cards etc. To test this use the following:
\n","_postman_id":"90e2e97e-f8ec-4528-8944-33dd83bb68c2"}],"id":"3f5db1e7-6ffb-4850-9549-ef7482b85dc8","_postman_id":"3f5db1e7-6ffb-4850-9549-ef7482b85dc8","description":""}]}